Cisco Catalyst SD-WAN v0.3.0, Mar 28 25

Cisco Catalyst SD-WAN v0.3.0 published on Friday, Mar 28, 2025 by Pulumi

sdwan.getRoutePolicyDefinition

Explore with Pulumi AI

Cisco Catalyst SD-WAN v0.3.0 published on Friday, Mar 28, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const example = sdwan.getRoutePolicyDefinition({
    id: "f6b2c44c-693c-4763-b010-895aa3d236bd",
});

import pulumi
import pulumi_sdwan as sdwan

example = sdwan.get_route_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.LookupRoutePolicyDefinition(ctx, &sdwan.LookupRoutePolicyDefinitionArgs{
			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.GetRoutePolicyDefinition.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.GetRoutePolicyDefinitionArgs;
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.getRoutePolicyDefinition(GetRoutePolicyDefinitionArgs.builder()
            .id("f6b2c44c-693c-4763-b010-895aa3d236bd")
            .build());

    }
}

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

Using getRoutePolicyDefinition

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.

TypeScript
Python
Go
C#
Java
YAML

function getRoutePolicyDefinition(args: GetRoutePolicyDefinitionArgs, opts?: InvokeOptions): Promise<GetRoutePolicyDefinitionResult>
function getRoutePolicyDefinitionOutput(args: GetRoutePolicyDefinitionOutputArgs, opts?: InvokeOptions): Output<GetRoutePolicyDefinitionResult>

def get_route_policy_definition(id: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetRoutePolicyDefinitionResult
def get_route_policy_definition_output(id: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetRoutePolicyDefinitionResult]

func LookupRoutePolicyDefinition(ctx *Context, args *LookupRoutePolicyDefinitionArgs, opts ...InvokeOption) (*LookupRoutePolicyDefinitionResult, error)
func LookupRoutePolicyDefinitionOutput(ctx *Context, args *LookupRoutePolicyDefinitionOutputArgs, opts ...InvokeOption) LookupRoutePolicyDefinitionResultOutput

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

public static class GetRoutePolicyDefinition 
{
    public static Task<GetRoutePolicyDefinitionResult> InvokeAsync(GetRoutePolicyDefinitionArgs args, InvokeOptions? opts = null)
    public static Output<GetRoutePolicyDefinitionResult> Invoke(GetRoutePolicyDefinitionInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetRoutePolicyDefinitionResult> getRoutePolicyDefinition(GetRoutePolicyDefinitionArgs args, InvokeOptions options)
public static Output<GetRoutePolicyDefinitionResult> getRoutePolicyDefinition(GetRoutePolicyDefinitionArgs args, InvokeOptions options)

fn::invoke:
  function: sdwan:index/getRoutePolicyDefinition:getRoutePolicyDefinition
  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

getRoutePolicyDefinition Result

The following output properties are available:

DefaultAction string: Default action, either accept or reject
Description string: The description of the policy definition
Id string: The id of the object
Name string: The name of the policy definition
Sequences List<GetRoutePolicyDefinitionSequence>: List of ACL sequences
Type string: Type
Version int: The version of the object

DefaultAction string: Default action, either accept or reject
Description string: The description of the policy definition
Id string: The id of the object
Name string: The name of the policy definition
Sequences []GetRoutePolicyDefinitionSequence: List of ACL sequences
Type string: Type
Version int: The version of the object

defaultAction String: Default action, either accept or reject
description String: The description of the policy definition
id String: The id of the object
name String: The name of the policy definition
sequences List<GetRoutePolicyDefinitionSequence>: List of ACL sequences
type String: Type
version Integer: The version of the object

defaultAction string: Default action, either accept or reject
description string: The description of the policy definition
id string: The id of the object
name string: The name of the policy definition
sequences GetRoutePolicyDefinitionSequence[]: List of ACL sequences
type string: Type
version number: The version of the object

default_action str: Default action, either accept or reject
description str: The description of the policy definition
id str: The id of the object
name str: The name of the policy definition
sequences Sequence[GetRoutePolicyDefinitionSequence]: List of ACL sequences
type str: Type
version int: The version of the object

defaultAction String: Default action, either accept or reject
description String: The description of the policy definition
id String: The id of the object
name String: The name of the policy definition
sequences List<Property Map>: List of ACL sequences
type String: Type
version Number: The version of the object

Supporting Types

GetRoutePolicyDefinitionSequence

ActionEntries List<GetRoutePolicyDefinitionSequenceActionEntry>: List of action entries
BaseAction string: Base action, either accept or reject
Id int: Sequence ID
IpType string: IP version, either ipv4 or ipv6
MatchEntries List<GetRoutePolicyDefinitionSequenceMatchEntry>: List of match entries
Name string: Sequence name

ActionEntries []GetRoutePolicyDefinitionSequenceActionEntry: List of action entries
BaseAction string: Base action, either accept or reject
Id int: Sequence ID
IpType string: IP version, either ipv4 or ipv6
MatchEntries []GetRoutePolicyDefinitionSequenceMatchEntry: List of match entries
Name string: Sequence name

actionEntries List<GetRoutePolicyDefinitionSequenceActionEntry>: List of action entries
baseAction String: Base action, either accept or reject
id Integer: Sequence ID
ipType String: IP version, either ipv4 or ipv6
matchEntries List<GetRoutePolicyDefinitionSequenceMatchEntry>: List of match entries
name String: Sequence name

actionEntries GetRoutePolicyDefinitionSequenceActionEntry[]: List of action entries
baseAction string: Base action, either accept or reject
id number: Sequence ID
ipType string: IP version, either ipv4 or ipv6
matchEntries GetRoutePolicyDefinitionSequenceMatchEntry[]: List of match entries
name string: Sequence name

action_entries Sequence[GetRoutePolicyDefinitionSequenceActionEntry]: List of action entries
base_action str: Base action, either accept or reject
id int: Sequence ID
ip_type str: IP version, either ipv4 or ipv6
match_entries Sequence[GetRoutePolicyDefinitionSequenceMatchEntry]: List of match entries
name str: Sequence name

actionEntries List<Property Map>: List of action entries
baseAction String: Base action, either accept or reject
id Number: Sequence ID
ipType String: IP version, either ipv4 or ipv6
matchEntries List<Property Map>: List of match entries
name String: Sequence name

GetRoutePolicyDefinitionSequenceActionEntry

Aggregator int: Aggregator
AggregatorIpAddress string: IP address
AsPathExclude string: Space separated list of ASN to exclude
AsPathPrepend string: Space separated list of ASN to prepend
AtomicAggregate bool: Atomic aggregate
Community string: Community value, e.g. 1000:10000 or internet or local-AS
CommunityAdditive bool: Community additive
LocalPreference int: Local preference
Metric int: Metric
MetricType string: Metric type
NextHop string: Next hop IP
OmpTag int: OMP tag
Origin string: Origin
Originator string: Originator IP
OspfTag int: OSPF tag
Type string: Type of action entry
Weight int: Weight

Aggregator int: Aggregator
AggregatorIpAddress string: IP address
AsPathExclude string: Space separated list of ASN to exclude
AsPathPrepend string: Space separated list of ASN to prepend
AtomicAggregate bool: Atomic aggregate
Community string: Community value, e.g. 1000:10000 or internet or local-AS
CommunityAdditive bool: Community additive
LocalPreference int: Local preference
Metric int: Metric
MetricType string: Metric type
NextHop string: Next hop IP
OmpTag int: OMP tag
Origin string: Origin
Originator string: Originator IP
OspfTag int: OSPF tag
Type string: Type of action entry
Weight int: Weight

aggregator Integer: Aggregator
aggregatorIpAddress String: IP address
asPathExclude String: Space separated list of ASN to exclude
asPathPrepend String: Space separated list of ASN to prepend
atomicAggregate Boolean: Atomic aggregate
community String: Community value, e.g. 1000:10000 or internet or local-AS
communityAdditive Boolean: Community additive
localPreference Integer: Local preference
metric Integer: Metric
metricType String: Metric type
nextHop String: Next hop IP
ompTag Integer: OMP tag
origin String: Origin
originator String: Originator IP
ospfTag Integer: OSPF tag
type String: Type of action entry
weight Integer: Weight

aggregator number: Aggregator
aggregatorIpAddress string: IP address
asPathExclude string: Space separated list of ASN to exclude
asPathPrepend string: Space separated list of ASN to prepend
atomicAggregate boolean: Atomic aggregate
community string: Community value, e.g. 1000:10000 or internet or local-AS
communityAdditive boolean: Community additive
localPreference number: Local preference
metric number: Metric
metricType string: Metric type
nextHop string: Next hop IP
ompTag number: OMP tag
origin string: Origin
originator string: Originator IP
ospfTag number: OSPF tag
type string: Type of action entry
weight number: Weight

aggregator int: Aggregator
aggregator_ip_address str: IP address
as_path_exclude str: Space separated list of ASN to exclude
as_path_prepend str: Space separated list of ASN to prepend
atomic_aggregate bool: Atomic aggregate
community str: Community value, e.g. 1000:10000 or internet or local-AS
community_additive bool: Community additive
local_preference int: Local preference
metric int: Metric
metric_type str: Metric type
next_hop str: Next hop IP
omp_tag int: OMP tag
origin str: Origin
originator str: Originator IP
ospf_tag int: OSPF tag
type str: Type of action entry
weight int: Weight

aggregator Number: Aggregator
aggregatorIpAddress String: IP address
asPathExclude String: Space separated list of ASN to exclude
asPathPrepend String: Space separated list of ASN to prepend
atomicAggregate Boolean: Atomic aggregate
community String: Community value, e.g. 1000:10000 or internet or local-AS
communityAdditive Boolean: Community additive
localPreference Number: Local preference
metric Number: Metric
metricType String: Metric type
nextHop String: Next hop IP
ompTag Number: OMP tag
origin String: Origin
originator String: Originator IP
ospfTag Number: OSPF tag
type String: Type of action entry
weight Number: Weight

GetRoutePolicyDefinitionSequenceMatchEntry

AsPathListId string: AS path list ID
AsPathListVersion int: AS path list version
CommunityListIds List<string>: Community list IDs
CommunityListMatchFlag string: Community list match flag
CommunityListVersions List<string>: Community list versions
ExpandedCommunityListId string: Expanded community list ID
ExpandedCommunityListVersion int: Expanded community list version
ExtendedCommunityListId string: Extended community list ID
ExtendedCommunityListVersion int: Extended community list version
LocalPreference int: Local preference
Metric int: Metric
NextHopPrefixListId string: Next hop prefix list ID
NextHopPrefixListVersion int: Next hop prefix list version
OmpTag int: OMP tag
Origin string: Origin
OspfTag int: OSPF tag
Peer string: Peer IP
PrefixListId string: Prefix list ID
PrefixListVersion int: Prefix list version
Type string: Type of match entry

AsPathListId string: AS path list ID
AsPathListVersion int: AS path list version
CommunityListIds []string: Community list IDs
CommunityListMatchFlag string: Community list match flag
CommunityListVersions []string: Community list versions
ExpandedCommunityListId string: Expanded community list ID
ExpandedCommunityListVersion int: Expanded community list version
ExtendedCommunityListId string: Extended community list ID
ExtendedCommunityListVersion int: Extended community list version
LocalPreference int: Local preference
Metric int: Metric
NextHopPrefixListId string: Next hop prefix list ID
NextHopPrefixListVersion int: Next hop prefix list version
OmpTag int: OMP tag
Origin string: Origin
OspfTag int: OSPF tag
Peer string: Peer IP
PrefixListId string: Prefix list ID
PrefixListVersion int: Prefix list version
Type string: Type of match entry

asPathListId String: AS path list ID
asPathListVersion Integer: AS path list version
communityListIds List<String>: Community list IDs
communityListMatchFlag String: Community list match flag
communityListVersions List<String>: Community list versions
expandedCommunityListId String: Expanded community list ID
expandedCommunityListVersion Integer: Expanded community list version
extendedCommunityListId String: Extended community list ID
extendedCommunityListVersion Integer: Extended community list version
localPreference Integer: Local preference
metric Integer: Metric
nextHopPrefixListId String: Next hop prefix list ID
nextHopPrefixListVersion Integer: Next hop prefix list version
ompTag Integer: OMP tag
origin String: Origin
ospfTag Integer: OSPF tag
peer String: Peer IP
prefixListId String: Prefix list ID
prefixListVersion Integer: Prefix list version
type String: Type of match entry

asPathListId string: AS path list ID
asPathListVersion number: AS path list version
communityListIds string[]: Community list IDs
communityListMatchFlag string: Community list match flag
communityListVersions string[]: Community list versions
expandedCommunityListId string: Expanded community list ID
expandedCommunityListVersion number: Expanded community list version
extendedCommunityListId string: Extended community list ID
extendedCommunityListVersion number: Extended community list version
localPreference number: Local preference
metric number: Metric
nextHopPrefixListId string: Next hop prefix list ID
nextHopPrefixListVersion number: Next hop prefix list version
ompTag number: OMP tag
origin string: Origin
ospfTag number: OSPF tag
peer string: Peer IP
prefixListId string: Prefix list ID
prefixListVersion number: Prefix list version
type string: Type of match entry

as_path_list_id str: AS path list ID
as_path_list_version int: AS path list version
community_list_ids Sequence[str]: Community list IDs
community_list_match_flag str: Community list match flag
community_list_versions Sequence[str]: Community list versions
expanded_community_list_id str: Expanded community list ID
expanded_community_list_version int: Expanded community list version
extended_community_list_id str: Extended community list ID
extended_community_list_version int: Extended community list version
local_preference int: Local preference
metric int: Metric
next_hop_prefix_list_id str: Next hop prefix list ID
next_hop_prefix_list_version int: Next hop prefix list version
omp_tag int: OMP tag
origin str: Origin
ospf_tag int: OSPF tag
peer str: Peer IP
prefix_list_id str: Prefix list ID
prefix_list_version int: Prefix list version
type str: Type of match entry

asPathListId String: AS path list ID
asPathListVersion Number: AS path list version
communityListIds List<String>: Community list IDs
communityListMatchFlag String: Community list match flag
communityListVersions List<String>: Community list versions
expandedCommunityListId String: Expanded community list ID
expandedCommunityListVersion Number: Expanded community list version
extendedCommunityListId String: Extended community list ID
extendedCommunityListVersion Number: Extended community list version
localPreference Number: Local preference
metric Number: Metric
nextHopPrefixListId String: Next hop prefix list ID
nextHopPrefixListVersion Number: Next hop prefix list version
ompTag Number: OMP tag
origin String: Origin
ospfTag Number: OSPF tag
peer String: Peer IP
prefixListId String: Prefix list ID
prefixListVersion Number: Prefix list version
type String: Type of match entry

Package Details

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

Cisco Catalyst SD-WAN v0.3.0 published on Friday, Mar 28, 2025 by Pulumi

pulumi/pulumi-sdwan

sdwan.getRoutePolicyDefinition

On this page

On this page

Example Usage

Using getRoutePolicyDefinition

getRoutePolicyDefinition Result

Supporting Types

GetRoutePolicyDefinitionSequence

GetRoutePolicyDefinitionSequenceActionEntry

GetRoutePolicyDefinitionSequenceMatchEntry

Package Details

On this page

On this page