1. Packages
  2. Cisco Catalyst SD-WAN Provider
  3. API Docs
  4. getHubAndSpokeTopologyPolicyDefinition
Cisco Catalyst SD-WAN v0.3.0 published on Friday, Mar 28, 2025 by Pulumi

sdwan.getHubAndSpokeTopologyPolicyDefinition

Explore with Pulumi AI

This data source can read the Hub and Spoke Topology Policy Definition .

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as sdwan from "@pulumi/sdwan";

const example = sdwan.getHubAndSpokeTopologyPolicyDefinition({
    id: "f6b2c44c-693c-4763-b010-895aa3d236bd",
});
Copy
import pulumi
import pulumi_sdwan as sdwan

example = sdwan.get_hub_and_spoke_topology_policy_definition(id="f6b2c44c-693c-4763-b010-895aa3d236bd")
Copy
package main

import (
	"github.com/pulumi/pulumi-sdwan/sdk/go/sdwan"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sdwan.LookupHubAndSpokeTopologyPolicyDefinition(ctx, &sdwan.LookupHubAndSpokeTopologyPolicyDefinitionArgs{
			Id: "f6b2c44c-693c-4763-b010-895aa3d236bd",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Sdwan = Pulumi.Sdwan;

return await Deployment.RunAsync(() => 
{
    var example = Sdwan.GetHubAndSpokeTopologyPolicyDefinition.Invoke(new()
    {
        Id = "f6b2c44c-693c-4763-b010-895aa3d236bd",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.sdwan.SdwanFunctions;
import com.pulumi.sdwan.inputs.GetHubAndSpokeTopologyPolicyDefinitionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = SdwanFunctions.getHubAndSpokeTopologyPolicyDefinition(GetHubAndSpokeTopologyPolicyDefinitionArgs.builder()
            .id("f6b2c44c-693c-4763-b010-895aa3d236bd")
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: sdwan:getHubAndSpokeTopologyPolicyDefinition
      arguments:
        id: f6b2c44c-693c-4763-b010-895aa3d236bd
Copy

Using getHubAndSpokeTopologyPolicyDefinition

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getHubAndSpokeTopologyPolicyDefinition(args: GetHubAndSpokeTopologyPolicyDefinitionArgs, opts?: InvokeOptions): Promise<GetHubAndSpokeTopologyPolicyDefinitionResult>
function getHubAndSpokeTopologyPolicyDefinitionOutput(args: GetHubAndSpokeTopologyPolicyDefinitionOutputArgs, opts?: InvokeOptions): Output<GetHubAndSpokeTopologyPolicyDefinitionResult>
Copy
def get_hub_and_spoke_topology_policy_definition(id: Optional[str] = None,
                                                 opts: Optional[InvokeOptions] = None) -> GetHubAndSpokeTopologyPolicyDefinitionResult
def get_hub_and_spoke_topology_policy_definition_output(id: Optional[pulumi.Input[str]] = None,
                                                 opts: Optional[InvokeOptions] = None) -> Output[GetHubAndSpokeTopologyPolicyDefinitionResult]
Copy
func LookupHubAndSpokeTopologyPolicyDefinition(ctx *Context, args *LookupHubAndSpokeTopologyPolicyDefinitionArgs, opts ...InvokeOption) (*LookupHubAndSpokeTopologyPolicyDefinitionResult, error)
func LookupHubAndSpokeTopologyPolicyDefinitionOutput(ctx *Context, args *LookupHubAndSpokeTopologyPolicyDefinitionOutputArgs, opts ...InvokeOption) LookupHubAndSpokeTopologyPolicyDefinitionResultOutput
Copy

> Note: This function is named LookupHubAndSpokeTopologyPolicyDefinition in the Go SDK.

public static class GetHubAndSpokeTopologyPolicyDefinition 
{
    public static Task<GetHubAndSpokeTopologyPolicyDefinitionResult> InvokeAsync(GetHubAndSpokeTopologyPolicyDefinitionArgs args, InvokeOptions? opts = null)
    public static Output<GetHubAndSpokeTopologyPolicyDefinitionResult> Invoke(GetHubAndSpokeTopologyPolicyDefinitionInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetHubAndSpokeTopologyPolicyDefinitionResult> getHubAndSpokeTopologyPolicyDefinition(GetHubAndSpokeTopologyPolicyDefinitionArgs args, InvokeOptions options)
public static Output<GetHubAndSpokeTopologyPolicyDefinitionResult> getHubAndSpokeTopologyPolicyDefinition(GetHubAndSpokeTopologyPolicyDefinitionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: sdwan:index/getHubAndSpokeTopologyPolicyDefinition:getHubAndSpokeTopologyPolicyDefinition
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id This property is required. string
The id of the object
Id This property is required. string
The id of the object
id This property is required. String
The id of the object
id This property is required. string
The id of the object
id This property is required. str
The id of the object
id This property is required. String
The id of the object

getHubAndSpokeTopologyPolicyDefinition Result

The following output properties are available:

Description string
The description of the policy definition
Id string
The id of the object
Name string
The name of the policy definition
Topologies List<GetHubAndSpokeTopologyPolicyDefinitionTopology>
List of topologies
Type string
Type
Version int
The version of the object
VpnListId string
VPN list ID
VpnListVersion int
VPN list version
Description string
The description of the policy definition
Id string
The id of the object
Name string
The name of the policy definition
Topologies []GetHubAndSpokeTopologyPolicyDefinitionTopology
List of topologies
Type string
Type
Version int
The version of the object
VpnListId string
VPN list ID
VpnListVersion int
VPN list version
description String
The description of the policy definition
id String
The id of the object
name String
The name of the policy definition
topologies List<GetHubAndSpokeTopologyPolicyDefinitionTopology>
List of topologies
type String
Type
version Integer
The version of the object
vpnListId String
VPN list ID
vpnListVersion Integer
VPN list version
description string
The description of the policy definition
id string
The id of the object
name string
The name of the policy definition
topologies GetHubAndSpokeTopologyPolicyDefinitionTopology[]
List of topologies
type string
Type
version number
The version of the object
vpnListId string
VPN list ID
vpnListVersion number
VPN list version
description str
The description of the policy definition
id str
The id of the object
name str
The name of the policy definition
topologies Sequence[GetHubAndSpokeTopologyPolicyDefinitionTopology]
List of topologies
type str
Type
version int
The version of the object
vpn_list_id str
VPN list ID
vpn_list_version int
VPN list version
description String
The description of the policy definition
id String
The id of the object
name String
The name of the policy definition
topologies List<Property Map>
List of topologies
type String
Type
version Number
The version of the object
vpnListId String
VPN list ID
vpnListVersion Number
VPN list version

Supporting Types

GetHubAndSpokeTopologyPolicyDefinitionTopology

AdvertiseHubTlocs This property is required. bool
Advertise Hub TLOCs
AllHubsAreEqual This property is required. bool
All hubs are equal (All Spokes Sites connect to all Hubs)
Name This property is required. string
Topology name
Spokes This property is required. List<GetHubAndSpokeTopologyPolicyDefinitionTopologySpoke>
List of spokes
TlocListId This property is required. string
TLOC list ID (required when advertise_hub_tlocs is 'true')
AdvertiseHubTlocs This property is required. bool
Advertise Hub TLOCs
AllHubsAreEqual This property is required. bool
All hubs are equal (All Spokes Sites connect to all Hubs)
Name This property is required. string
Topology name
Spokes This property is required. []GetHubAndSpokeTopologyPolicyDefinitionTopologySpoke
List of spokes
TlocListId This property is required. string
TLOC list ID (required when advertise_hub_tlocs is 'true')
advertiseHubTlocs This property is required. Boolean
Advertise Hub TLOCs
allHubsAreEqual This property is required. Boolean
All hubs are equal (All Spokes Sites connect to all Hubs)
name This property is required. String
Topology name
spokes This property is required. List<GetHubAndSpokeTopologyPolicyDefinitionTopologySpoke>
List of spokes
tlocListId This property is required. String
TLOC list ID (required when advertise_hub_tlocs is 'true')
advertiseHubTlocs This property is required. boolean
Advertise Hub TLOCs
allHubsAreEqual This property is required. boolean
All hubs are equal (All Spokes Sites connect to all Hubs)
name This property is required. string
Topology name
spokes This property is required. GetHubAndSpokeTopologyPolicyDefinitionTopologySpoke[]
List of spokes
tlocListId This property is required. string
TLOC list ID (required when advertise_hub_tlocs is 'true')
This property is required. bool
Advertise Hub TLOCs
all_hubs_are_equal This property is required. bool
All hubs are equal (All Spokes Sites connect to all Hubs)
name This property is required. str
Topology name
spokes This property is required. Sequence[GetHubAndSpokeTopologyPolicyDefinitionTopologySpoke]
List of spokes
tloc_list_id This property is required. str
TLOC list ID (required when advertise_hub_tlocs is 'true')
advertiseHubTlocs This property is required. Boolean
Advertise Hub TLOCs
allHubsAreEqual This property is required. Boolean
All hubs are equal (All Spokes Sites connect to all Hubs)
name This property is required. String
Topology name
spokes This property is required. List<Property Map>
List of spokes
tlocListId This property is required. String
TLOC list ID (required when advertise_hub_tlocs is 'true')

GetHubAndSpokeTopologyPolicyDefinitionTopologySpoke

Hubs This property is required. List<GetHubAndSpokeTopologyPolicyDefinitionTopologySpokeHub>
List of hubs
SiteListId This property is required. string
Site list ID
SiteListVersion This property is required. int
Site list version
Hubs This property is required. []GetHubAndSpokeTopologyPolicyDefinitionTopologySpokeHub
List of hubs
SiteListId This property is required. string
Site list ID
SiteListVersion This property is required. int
Site list version
hubs This property is required. List<GetHubAndSpokeTopologyPolicyDefinitionTopologySpokeHub>
List of hubs
siteListId This property is required. String
Site list ID
siteListVersion This property is required. Integer
Site list version
hubs This property is required. GetHubAndSpokeTopologyPolicyDefinitionTopologySpokeHub[]
List of hubs
siteListId This property is required. string
Site list ID
siteListVersion This property is required. number
Site list version
hubs This property is required. Sequence[GetHubAndSpokeTopologyPolicyDefinitionTopologySpokeHub]
List of hubs
site_list_id This property is required. str
Site list ID
site_list_version This property is required. int
Site list version
hubs This property is required. List<Property Map>
List of hubs
siteListId This property is required. String
Site list ID
siteListVersion This property is required. Number
Site list version

GetHubAndSpokeTopologyPolicyDefinitionTopologySpokeHub

Ipv4PrefixListIds This property is required. List<string>
List of IPv4 prefix list IDs
Ipv6PrefixListIds This property is required. List<string>
List of IPv6 prefix list IDs
Preference This property is required. string
Preference, multiple of 10 (for example 70, 80, 90, 100). The higher the value the higher the priority of the associated hub (required when all_hubs_are_equal is 'false')
SiteListId This property is required. string
Site list ID
SiteListVersion This property is required. int
Site list version
Ipv4PrefixListIds This property is required. []string
List of IPv4 prefix list IDs
Ipv6PrefixListIds This property is required. []string
List of IPv6 prefix list IDs
Preference This property is required. string
Preference, multiple of 10 (for example 70, 80, 90, 100). The higher the value the higher the priority of the associated hub (required when all_hubs_are_equal is 'false')
SiteListId This property is required. string
Site list ID
SiteListVersion This property is required. int
Site list version
ipv4PrefixListIds This property is required. List<String>
List of IPv4 prefix list IDs
ipv6PrefixListIds This property is required. List<String>
List of IPv6 prefix list IDs
preference This property is required. String
Preference, multiple of 10 (for example 70, 80, 90, 100). The higher the value the higher the priority of the associated hub (required when all_hubs_are_equal is 'false')
siteListId This property is required. String
Site list ID
siteListVersion This property is required. Integer
Site list version
ipv4PrefixListIds This property is required. string[]
List of IPv4 prefix list IDs
ipv6PrefixListIds This property is required. string[]
List of IPv6 prefix list IDs
preference This property is required. string
Preference, multiple of 10 (for example 70, 80, 90, 100). The higher the value the higher the priority of the associated hub (required when all_hubs_are_equal is 'false')
siteListId This property is required. string
Site list ID
siteListVersion This property is required. number
Site list version
ipv4_prefix_list_ids This property is required. Sequence[str]
List of IPv4 prefix list IDs
ipv6_prefix_list_ids This property is required. Sequence[str]
List of IPv6 prefix list IDs
preference This property is required. str
Preference, multiple of 10 (for example 70, 80, 90, 100). The higher the value the higher the priority of the associated hub (required when all_hubs_are_equal is 'false')
site_list_id This property is required. str
Site list ID
site_list_version This property is required. int
Site list version
ipv4PrefixListIds This property is required. List<String>
List of IPv4 prefix list IDs
ipv6PrefixListIds This property is required. List<String>
List of IPv6 prefix list IDs
preference This property is required. String
Preference, multiple of 10 (for example 70, 80, 90, 100). The higher the value the higher the priority of the associated hub (required when all_hubs_are_equal is 'false')
siteListId This property is required. String
Site list ID
siteListVersion This property is required. Number
Site list version

Package Details

Repository
sdwan pulumi/pulumi-sdwan
License
Apache-2.0
Notes
This Pulumi package is based on the sdwan Terraform Provider.