Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cisco Catalyst SD-WAN
  3. API Docs
  4. getHubAndSpokeTopologyPolicyDefinition
Cisco Catalyst SD-WAN v0.2.0 published on Friday, Nov 1, 2024 by Pulumi
pulumi/pulumi-sdwan

sdwan.getHubAndSpokeTopologyPolicyDefinition

Explore with Pulumi AI

sdwan logo
Cisco Catalyst SD-WAN v0.2.0 published on Friday, Nov 1, 2024 by Pulumi
pulumi/pulumi-sdwan

    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",
});

    import pulumi
import pulumi_sdwan as sdwan

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

    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
	})
}

    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",
    });

});

    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());

    }
}

    variables:
  example:
    fn::invoke:
      Function: sdwan:getHubAndSpokeTopologyPolicyDefinition
      Arguments:
        id: f6b2c44c-693c-4763-b010-895aa3d236bd

    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>
    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]
    func LookupHubAndSpokeTopologyPolicyDefinition(ctx *Context, args *LookupHubAndSpokeTopologyPolicyDefinitionArgs, opts ...InvokeOption) (*LookupHubAndSpokeTopologyPolicyDefinitionResult, error)
func LookupHubAndSpokeTopologyPolicyDefinitionOutput(ctx *Context, args *LookupHubAndSpokeTopologyPolicyDefinitionOutputArgs, opts ...InvokeOption) LookupHubAndSpokeTopologyPolicyDefinitionResultOutput

    > 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)
}
    public static CompletableFuture<GetHubAndSpokeTopologyPolicyDefinitionResult> getHubAndSpokeTopologyPolicyDefinition(GetHubAndSpokeTopologyPolicyDefinitionArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: sdwan:index/getHubAndSpokeTopologyPolicyDefinition:getHubAndSpokeTopologyPolicyDefinition
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    The id of the object
    Id string
    The id of the object
    id String
    The id of the object
    id string
    The id of the object
    id str
    The id of the object
    id 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 bool
    Advertise Hub TLOCs
    AllHubsAreEqual bool
    All hubs are equal (All Spokes Sites connect to all Hubs)
    Name string
    Topology name
    Spokes List<GetHubAndSpokeTopologyPolicyDefinitionTopologySpoke>
    List of spokes
    TlocListId string
    TLOC list ID (required when advertise_hub_tlocs is 'true')
    AdvertiseHubTlocs bool
    Advertise Hub TLOCs
    AllHubsAreEqual bool
    All hubs are equal (All Spokes Sites connect to all Hubs)
    Name string
    Topology name
    Spokes []GetHubAndSpokeTopologyPolicyDefinitionTopologySpoke
    List of spokes
    TlocListId string
    TLOC list ID (required when advertise_hub_tlocs is 'true')
    advertiseHubTlocs Boolean
    Advertise Hub TLOCs
    allHubsAreEqual Boolean
    All hubs are equal (All Spokes Sites connect to all Hubs)
    name String
    Topology name
    spokes List<GetHubAndSpokeTopologyPolicyDefinitionTopologySpoke>
    List of spokes
    tlocListId String
    TLOC list ID (required when advertise_hub_tlocs is 'true')
    advertiseHubTlocs boolean
    Advertise Hub TLOCs
    allHubsAreEqual boolean
    All hubs are equal (All Spokes Sites connect to all Hubs)
    name string
    Topology name
    spokes GetHubAndSpokeTopologyPolicyDefinitionTopologySpoke[]
    List of spokes
    tlocListId string
    TLOC list ID (required when advertise_hub_tlocs is 'true')
    bool
    Advertise Hub TLOCs
    all_hubs_are_equal bool
    All hubs are equal (All Spokes Sites connect to all Hubs)
    name str
    Topology name
    spokes Sequence[GetHubAndSpokeTopologyPolicyDefinitionTopologySpoke]
    List of spokes
    tloc_list_id str
    TLOC list ID (required when advertise_hub_tlocs is 'true')
    advertiseHubTlocs Boolean
    Advertise Hub TLOCs
    allHubsAreEqual Boolean
    All hubs are equal (All Spokes Sites connect to all Hubs)
    name String
    Topology name
    spokes List<Property Map>
    List of spokes
    tlocListId String
    TLOC list ID (required when advertise_hub_tlocs is 'true')

    GetHubAndSpokeTopologyPolicyDefinitionTopologySpoke

    hubs List<Property Map>
    List of hubs
    siteListId String
    Site list ID
    siteListVersion Number
    Site list version

    GetHubAndSpokeTopologyPolicyDefinitionTopologySpokeHub

    Ipv4PrefixListIds List<string>
    List of IPv4 prefix list IDs
    Ipv6PrefixListIds List<string>
    List of IPv6 prefix list IDs
    Preference 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 string
    Site list ID
    SiteListVersion int
    Site list version
    Ipv4PrefixListIds []string
    List of IPv4 prefix list IDs
    Ipv6PrefixListIds []string
    List of IPv6 prefix list IDs
    Preference 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 string
    Site list ID
    SiteListVersion int
    Site list version
    ipv4PrefixListIds List<String>
    List of IPv4 prefix list IDs
    ipv6PrefixListIds List<String>
    List of IPv6 prefix list IDs
    preference 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 String
    Site list ID
    siteListVersion Integer
    Site list version
    ipv4PrefixListIds string[]
    List of IPv4 prefix list IDs
    ipv6PrefixListIds string[]
    List of IPv6 prefix list IDs
    preference 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 string
    Site list ID
    siteListVersion number
    Site list version
    ipv4_prefix_list_ids Sequence[str]
    List of IPv4 prefix list IDs
    ipv6_prefix_list_ids Sequence[str]
    List of IPv6 prefix list IDs
    preference 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 str
    Site list ID
    site_list_version int
    Site list version
    ipv4PrefixListIds List<String>
    List of IPv4 prefix list IDs
    ipv6PrefixListIds List<String>
    List of IPv6 prefix list IDs
    preference 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 String
    Site list ID
    siteListVersion 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.
    sdwan logo
    Cisco Catalyst SD-WAN v0.2.0 published on Friday, Nov 1, 2024 by Pulumi
    pulumi/pulumi-sdwan