1. Packages
  2. Cisco Catalyst SD-WAN
  3. API Docs
  4. getCedgePimFeatureTemplate
Cisco Catalyst SD-WAN v0.2.0 published on Friday, Nov 1, 2024 by Pulumi

sdwan.getCedgePimFeatureTemplate

Explore with Pulumi AI

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

    This data source can read the cEdge PIM feature template.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as sdwan from "@pulumi/sdwan";
    
    const example = sdwan.getCedgePimFeatureTemplate({
        id: "f6b2c44c-693c-4763-b010-895aa3d236bd",
    });
    
    import pulumi
    import pulumi_sdwan as sdwan
    
    example = sdwan.get_cedge_pim_feature_template(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.LookupCedgePimFeatureTemplate(ctx, &sdwan.LookupCedgePimFeatureTemplateArgs{
    			Id: pulumi.StringRef("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.GetCedgePimFeatureTemplate.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.GetCedgePimFeatureTemplateArgs;
    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.getCedgePimFeatureTemplate(GetCedgePimFeatureTemplateArgs.builder()
                .id("f6b2c44c-693c-4763-b010-895aa3d236bd")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: sdwan:getCedgePimFeatureTemplate
          Arguments:
            id: f6b2c44c-693c-4763-b010-895aa3d236bd
    

    Using getCedgePimFeatureTemplate

    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 getCedgePimFeatureTemplate(args: GetCedgePimFeatureTemplateArgs, opts?: InvokeOptions): Promise<GetCedgePimFeatureTemplateResult>
    function getCedgePimFeatureTemplateOutput(args: GetCedgePimFeatureTemplateOutputArgs, opts?: InvokeOptions): Output<GetCedgePimFeatureTemplateResult>
    def get_cedge_pim_feature_template(id: Optional[str] = None,
                                       name: Optional[str] = None,
                                       opts: Optional[InvokeOptions] = None) -> GetCedgePimFeatureTemplateResult
    def get_cedge_pim_feature_template_output(id: Optional[pulumi.Input[str]] = None,
                                       name: Optional[pulumi.Input[str]] = None,
                                       opts: Optional[InvokeOptions] = None) -> Output[GetCedgePimFeatureTemplateResult]
    func LookupCedgePimFeatureTemplate(ctx *Context, args *LookupCedgePimFeatureTemplateArgs, opts ...InvokeOption) (*LookupCedgePimFeatureTemplateResult, error)
    func LookupCedgePimFeatureTemplateOutput(ctx *Context, args *LookupCedgePimFeatureTemplateOutputArgs, opts ...InvokeOption) LookupCedgePimFeatureTemplateResultOutput

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

    public static class GetCedgePimFeatureTemplate 
    {
        public static Task<GetCedgePimFeatureTemplateResult> InvokeAsync(GetCedgePimFeatureTemplateArgs args, InvokeOptions? opts = null)
        public static Output<GetCedgePimFeatureTemplateResult> Invoke(GetCedgePimFeatureTemplateInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCedgePimFeatureTemplateResult> getCedgePimFeatureTemplate(GetCedgePimFeatureTemplateArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: sdwan:index/getCedgePimFeatureTemplate:getCedgePimFeatureTemplate
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    The id of the feature template
    Name string
    The name of the feature template
    Id string
    The id of the feature template
    Name string
    The name of the feature template
    id String
    The id of the feature template
    name String
    The name of the feature template
    id string
    The id of the feature template
    name string
    The name of the feature template
    id str
    The id of the feature template
    name str
    The name of the feature template
    id String
    The id of the feature template
    name String
    The name of the feature template

    getCedgePimFeatureTemplate Result

    The following output properties are available:

    AutoRp bool
    Enable or disable auto-RP
    AutoRpVariable string
    Variable name
    BsrCandidate string
    Set Autonomic-Networking virtual interface
    BsrCandidateVariable string
    Variable name
    Default bool
    Turn SSM On / Off
    DefaultVariable string
    Variable name
    Description string
    The description of the feature template
    DeviceTypes List<string>
    List of supported device types
    HashMaskLength string
    Hash Mask length for RP selection
    HashMaskLengthVariable string
    Variable name
    Id string
    The id of the feature template
    InterfaceName string
    Set RP Discovery Interface Name
    InterfaceNameVariable string
    Variable name
    Interfaces List<GetCedgePimFeatureTemplateInterface>
    Set PIM interface parameters
    Name string
    The name of the feature template
    Priority int
    Set RP candidate priority
    PriorityVariable string
    Variable name
    Range string
    Set Access List for PIM SSM
    RangeVariable string
    Variable name
    RpAddresses List<GetCedgePimFeatureTemplateRpAddress>
    Set Static RP Address(es)
    RpAnnounceFields List<GetCedgePimFeatureTemplateRpAnnounceField>
    Enable or disable RP Announce
    RpCandidateAccessList string
    Set BSR RP candidate filter
    RpCandidateAccessListVariable string
    Variable name
    RpCandidates List<GetCedgePimFeatureTemplateRpCandidate>
    Set RP Discovery Scope
    Scope int
    Set RP Discovery Scope
    ScopeVariable string
    Variable name
    SptThreshold string
    Set when PIM router joins the SPT (kbps)
    SptThresholdVariable string
    Variable name
    TemplateType string
    The template type
    Version int
    The version of the feature template
    AutoRp bool
    Enable or disable auto-RP
    AutoRpVariable string
    Variable name
    BsrCandidate string
    Set Autonomic-Networking virtual interface
    BsrCandidateVariable string
    Variable name
    Default bool
    Turn SSM On / Off
    DefaultVariable string
    Variable name
    Description string
    The description of the feature template
    DeviceTypes []string
    List of supported device types
    HashMaskLength string
    Hash Mask length for RP selection
    HashMaskLengthVariable string
    Variable name
    Id string
    The id of the feature template
    InterfaceName string
    Set RP Discovery Interface Name
    InterfaceNameVariable string
    Variable name
    Interfaces []GetCedgePimFeatureTemplateInterface
    Set PIM interface parameters
    Name string
    The name of the feature template
    Priority int
    Set RP candidate priority
    PriorityVariable string
    Variable name
    Range string
    Set Access List for PIM SSM
    RangeVariable string
    Variable name
    RpAddresses []GetCedgePimFeatureTemplateRpAddress
    Set Static RP Address(es)
    RpAnnounceFields []GetCedgePimFeatureTemplateRpAnnounceField
    Enable or disable RP Announce
    RpCandidateAccessList string
    Set BSR RP candidate filter
    RpCandidateAccessListVariable string
    Variable name
    RpCandidates []GetCedgePimFeatureTemplateRpCandidate
    Set RP Discovery Scope
    Scope int
    Set RP Discovery Scope
    ScopeVariable string
    Variable name
    SptThreshold string
    Set when PIM router joins the SPT (kbps)
    SptThresholdVariable string
    Variable name
    TemplateType string
    The template type
    Version int
    The version of the feature template
    autoRp Boolean
    Enable or disable auto-RP
    autoRpVariable String
    Variable name
    bsrCandidate String
    Set Autonomic-Networking virtual interface
    bsrCandidateVariable String
    Variable name
    defaultVariable String
    Variable name
    default_ Boolean
    Turn SSM On / Off
    description String
    The description of the feature template
    deviceTypes List<String>
    List of supported device types
    hashMaskLength String
    Hash Mask length for RP selection
    hashMaskLengthVariable String
    Variable name
    id String
    The id of the feature template
    interfaceName String
    Set RP Discovery Interface Name
    interfaceNameVariable String
    Variable name
    interfaces List<GetCedgePimFeatureTemplateInterface>
    Set PIM interface parameters
    name String
    The name of the feature template
    priority Integer
    Set RP candidate priority
    priorityVariable String
    Variable name
    range String
    Set Access List for PIM SSM
    rangeVariable String
    Variable name
    rpAddresses List<GetCedgePimFeatureTemplateRpAddress>
    Set Static RP Address(es)
    rpAnnounceFields List<GetCedgePimFeatureTemplateRpAnnounceField>
    Enable or disable RP Announce
    rpCandidateAccessList String
    Set BSR RP candidate filter
    rpCandidateAccessListVariable String
    Variable name
    rpCandidates List<GetCedgePimFeatureTemplateRpCandidate>
    Set RP Discovery Scope
    scope Integer
    Set RP Discovery Scope
    scopeVariable String
    Variable name
    sptThreshold String
    Set when PIM router joins the SPT (kbps)
    sptThresholdVariable String
    Variable name
    templateType String
    The template type
    version Integer
    The version of the feature template
    autoRp boolean
    Enable or disable auto-RP
    autoRpVariable string
    Variable name
    bsrCandidate string
    Set Autonomic-Networking virtual interface
    bsrCandidateVariable string
    Variable name
    default boolean
    Turn SSM On / Off
    defaultVariable string
    Variable name
    description string
    The description of the feature template
    deviceTypes string[]
    List of supported device types
    hashMaskLength string
    Hash Mask length for RP selection
    hashMaskLengthVariable string
    Variable name
    id string
    The id of the feature template
    interfaceName string
    Set RP Discovery Interface Name
    interfaceNameVariable string
    Variable name
    interfaces GetCedgePimFeatureTemplateInterface[]
    Set PIM interface parameters
    name string
    The name of the feature template
    priority number
    Set RP candidate priority
    priorityVariable string
    Variable name
    range string
    Set Access List for PIM SSM
    rangeVariable string
    Variable name
    rpAddresses GetCedgePimFeatureTemplateRpAddress[]
    Set Static RP Address(es)
    rpAnnounceFields GetCedgePimFeatureTemplateRpAnnounceField[]
    Enable or disable RP Announce
    rpCandidateAccessList string
    Set BSR RP candidate filter
    rpCandidateAccessListVariable string
    Variable name
    rpCandidates GetCedgePimFeatureTemplateRpCandidate[]
    Set RP Discovery Scope
    scope number
    Set RP Discovery Scope
    scopeVariable string
    Variable name
    sptThreshold string
    Set when PIM router joins the SPT (kbps)
    sptThresholdVariable string
    Variable name
    templateType string
    The template type
    version number
    The version of the feature template
    auto_rp bool
    Enable or disable auto-RP
    auto_rp_variable str
    Variable name
    bsr_candidate str
    Set Autonomic-Networking virtual interface
    bsr_candidate_variable str
    Variable name
    default bool
    Turn SSM On / Off
    default_variable str
    Variable name
    description str
    The description of the feature template
    device_types Sequence[str]
    List of supported device types
    hash_mask_length str
    Hash Mask length for RP selection
    hash_mask_length_variable str
    Variable name
    id str
    The id of the feature template
    interface_name str
    Set RP Discovery Interface Name
    interface_name_variable str
    Variable name
    interfaces Sequence[GetCedgePimFeatureTemplateInterface]
    Set PIM interface parameters
    name str
    The name of the feature template
    priority int
    Set RP candidate priority
    priority_variable str
    Variable name
    range str
    Set Access List for PIM SSM
    range_variable str
    Variable name
    rp_addresses Sequence[GetCedgePimFeatureTemplateRpAddress]
    Set Static RP Address(es)
    rp_announce_fields Sequence[GetCedgePimFeatureTemplateRpAnnounceField]
    Enable or disable RP Announce
    rp_candidate_access_list str
    Set BSR RP candidate filter
    rp_candidate_access_list_variable str
    Variable name
    rp_candidates Sequence[GetCedgePimFeatureTemplateRpCandidate]
    Set RP Discovery Scope
    scope int
    Set RP Discovery Scope
    scope_variable str
    Variable name
    spt_threshold str
    Set when PIM router joins the SPT (kbps)
    spt_threshold_variable str
    Variable name
    template_type str
    The template type
    version int
    The version of the feature template
    autoRp Boolean
    Enable or disable auto-RP
    autoRpVariable String
    Variable name
    bsrCandidate String
    Set Autonomic-Networking virtual interface
    bsrCandidateVariable String
    Variable name
    default Boolean
    Turn SSM On / Off
    defaultVariable String
    Variable name
    description String
    The description of the feature template
    deviceTypes List<String>
    List of supported device types
    hashMaskLength String
    Hash Mask length for RP selection
    hashMaskLengthVariable String
    Variable name
    id String
    The id of the feature template
    interfaceName String
    Set RP Discovery Interface Name
    interfaceNameVariable String
    Variable name
    interfaces List<Property Map>
    Set PIM interface parameters
    name String
    The name of the feature template
    priority Number
    Set RP candidate priority
    priorityVariable String
    Variable name
    range String
    Set Access List for PIM SSM
    rangeVariable String
    Variable name
    rpAddresses List<Property Map>
    Set Static RP Address(es)
    rpAnnounceFields List<Property Map>
    Enable or disable RP Announce
    rpCandidateAccessList String
    Set BSR RP candidate filter
    rpCandidateAccessListVariable String
    Variable name
    rpCandidates List<Property Map>
    Set RP Discovery Scope
    scope Number
    Set RP Discovery Scope
    scopeVariable String
    Variable name
    sptThreshold String
    Set when PIM router joins the SPT (kbps)
    sptThresholdVariable String
    Variable name
    templateType String
    The template type
    version Number
    The version of the feature template

    Supporting Types

    GetCedgePimFeatureTemplateInterface

    InterfaceName string
    Set interface name
    InterfaceNameVariable string
    Variable name
    JoinPruneInterval int
    Set interval at which PIM multicast traffic can join or be removed from RPT or SPT
    JoinPruneIntervalVariable string
    Variable name
    Optional bool
    Indicates if list item is considered optional.
    QueryInterval int
    Set PIM query interval
    QueryIntervalVariable string
    Variable name
    InterfaceName string
    Set interface name
    InterfaceNameVariable string
    Variable name
    JoinPruneInterval int
    Set interval at which PIM multicast traffic can join or be removed from RPT or SPT
    JoinPruneIntervalVariable string
    Variable name
    Optional bool
    Indicates if list item is considered optional.
    QueryInterval int
    Set PIM query interval
    QueryIntervalVariable string
    Variable name
    interfaceName String
    Set interface name
    interfaceNameVariable String
    Variable name
    joinPruneInterval Integer
    Set interval at which PIM multicast traffic can join or be removed from RPT or SPT
    joinPruneIntervalVariable String
    Variable name
    optional Boolean
    Indicates if list item is considered optional.
    queryInterval Integer
    Set PIM query interval
    queryIntervalVariable String
    Variable name
    interfaceName string
    Set interface name
    interfaceNameVariable string
    Variable name
    joinPruneInterval number
    Set interval at which PIM multicast traffic can join or be removed from RPT or SPT
    joinPruneIntervalVariable string
    Variable name
    optional boolean
    Indicates if list item is considered optional.
    queryInterval number
    Set PIM query interval
    queryIntervalVariable string
    Variable name
    interface_name str
    Set interface name
    interface_name_variable str
    Variable name
    join_prune_interval int
    Set interval at which PIM multicast traffic can join or be removed from RPT or SPT
    join_prune_interval_variable str
    Variable name
    optional bool
    Indicates if list item is considered optional.
    query_interval int
    Set PIM query interval
    query_interval_variable str
    Variable name
    interfaceName String
    Set interface name
    interfaceNameVariable String
    Variable name
    joinPruneInterval Number
    Set interval at which PIM multicast traffic can join or be removed from RPT or SPT
    joinPruneIntervalVariable String
    Variable name
    optional Boolean
    Indicates if list item is considered optional.
    queryInterval Number
    Set PIM query interval
    queryIntervalVariable String
    Variable name

    GetCedgePimFeatureTemplateRpAddress

    AccessList string
    Set Static RP Access List
    AccessListVariable string
    Variable name
    IpAddress string
    Set Static RP IP Address
    IpAddressVariable string
    Variable name
    Optional bool
    Indicates if list item is considered optional.
    Override bool
    Set override flag
    OverrideVariable string
    Variable name
    AccessList string
    Set Static RP Access List
    AccessListVariable string
    Variable name
    IpAddress string
    Set Static RP IP Address
    IpAddressVariable string
    Variable name
    Optional bool
    Indicates if list item is considered optional.
    Override bool
    Set override flag
    OverrideVariable string
    Variable name
    accessList String
    Set Static RP Access List
    accessListVariable String
    Variable name
    ipAddress String
    Set Static RP IP Address
    ipAddressVariable String
    Variable name
    optional Boolean
    Indicates if list item is considered optional.
    override Boolean
    Set override flag
    overrideVariable String
    Variable name
    accessList string
    Set Static RP Access List
    accessListVariable string
    Variable name
    ipAddress string
    Set Static RP IP Address
    ipAddressVariable string
    Variable name
    optional boolean
    Indicates if list item is considered optional.
    override boolean
    Set override flag
    overrideVariable string
    Variable name
    access_list str
    Set Static RP Access List
    access_list_variable str
    Variable name
    ip_address str
    Set Static RP IP Address
    ip_address_variable str
    Variable name
    optional bool
    Indicates if list item is considered optional.
    override bool
    Set override flag
    override_variable str
    Variable name
    accessList String
    Set Static RP Access List
    accessListVariable String
    Variable name
    ipAddress String
    Set Static RP IP Address
    ipAddressVariable String
    Variable name
    optional Boolean
    Indicates if list item is considered optional.
    override Boolean
    Set override flag
    overrideVariable String
    Variable name

    GetCedgePimFeatureTemplateRpAnnounceField

    InterfaceName string
    Set RP Announce Interface Name
    InterfaceNameVariable string
    Variable name
    Optional bool
    Indicates if list item is considered optional.
    Scope int
    Set RP Announce Scope
    ScopeVariable string
    Variable name
    InterfaceName string
    Set RP Announce Interface Name
    InterfaceNameVariable string
    Variable name
    Optional bool
    Indicates if list item is considered optional.
    Scope int
    Set RP Announce Scope
    ScopeVariable string
    Variable name
    interfaceName String
    Set RP Announce Interface Name
    interfaceNameVariable String
    Variable name
    optional Boolean
    Indicates if list item is considered optional.
    scope Integer
    Set RP Announce Scope
    scopeVariable String
    Variable name
    interfaceName string
    Set RP Announce Interface Name
    interfaceNameVariable string
    Variable name
    optional boolean
    Indicates if list item is considered optional.
    scope number
    Set RP Announce Scope
    scopeVariable string
    Variable name
    interface_name str
    Set RP Announce Interface Name
    interface_name_variable str
    Variable name
    optional bool
    Indicates if list item is considered optional.
    scope int
    Set RP Announce Scope
    scope_variable str
    Variable name
    interfaceName String
    Set RP Announce Interface Name
    interfaceNameVariable String
    Variable name
    optional Boolean
    Indicates if list item is considered optional.
    scope Number
    Set RP Announce Scope
    scopeVariable String
    Variable name

    GetCedgePimFeatureTemplateRpCandidate

    AccessList string
    Set IP Access List for PIM RP Candidate
    AccessListVariable string
    Variable name
    Interface string
    Set Autonomic-Networking virtual interface
    InterfaceVariable string
    Variable name
    Interval int
    Set RP candidate advertisement interval
    IntervalVariable string
    Variable name
    Optional bool
    Indicates if list item is considered optional.
    Priority int
    Set RP candidate priority
    PriorityVariable string
    Variable name
    AccessList string
    Set IP Access List for PIM RP Candidate
    AccessListVariable string
    Variable name
    Interface string
    Set Autonomic-Networking virtual interface
    InterfaceVariable string
    Variable name
    Interval int
    Set RP candidate advertisement interval
    IntervalVariable string
    Variable name
    Optional bool
    Indicates if list item is considered optional.
    Priority int
    Set RP candidate priority
    PriorityVariable string
    Variable name
    accessList String
    Set IP Access List for PIM RP Candidate
    accessListVariable String
    Variable name
    interfaceVariable String
    Variable name
    interface_ String
    Set Autonomic-Networking virtual interface
    interval Integer
    Set RP candidate advertisement interval
    intervalVariable String
    Variable name
    optional Boolean
    Indicates if list item is considered optional.
    priority Integer
    Set RP candidate priority
    priorityVariable String
    Variable name
    accessList string
    Set IP Access List for PIM RP Candidate
    accessListVariable string
    Variable name
    interface string
    Set Autonomic-Networking virtual interface
    interfaceVariable string
    Variable name
    interval number
    Set RP candidate advertisement interval
    intervalVariable string
    Variable name
    optional boolean
    Indicates if list item is considered optional.
    priority number
    Set RP candidate priority
    priorityVariable string
    Variable name
    access_list str
    Set IP Access List for PIM RP Candidate
    access_list_variable str
    Variable name
    interface str
    Set Autonomic-Networking virtual interface
    interface_variable str
    Variable name
    interval int
    Set RP candidate advertisement interval
    interval_variable str
    Variable name
    optional bool
    Indicates if list item is considered optional.
    priority int
    Set RP candidate priority
    priority_variable str
    Variable name
    accessList String
    Set IP Access List for PIM RP Candidate
    accessListVariable String
    Variable name
    interface String
    Set Autonomic-Networking virtual interface
    interfaceVariable String
    Variable name
    interval Number
    Set RP candidate advertisement interval
    intervalVariable String
    Variable name
    optional Boolean
    Indicates if list item is considered optional.
    priority Number
    Set RP candidate priority
    priorityVariable String
    Variable name

    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