1. Packages
  2. Cisco Catalyst SD-WAN
  3. API Docs
  4. CedgeMulticastFeatureTemplate
Cisco Catalyst SD-WAN v0.1.1 published on Friday, May 31, 2024 by Pulumi

sdwan.CedgeMulticastFeatureTemplate

Explore with Pulumi AI

sdwan logo
Cisco Catalyst SD-WAN v0.1.1 published on Friday, May 31, 2024 by Pulumi

    This resource can manage a cEdge Multicast feature template.

    • Minimum SD-WAN Manager version: 15.0.0

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as sdwan from "@pulumi/sdwan";
    
    const example = new sdwan.CedgeMulticastFeatureTemplate("example", {
        name: "Example",
        description: "My Example",
        deviceTypes: ["vedge-C8000V"],
        sptOnly: true,
        localReplicator: true,
        threshold: 200,
    });
    
    import pulumi
    import pulumi_sdwan as sdwan
    
    example = sdwan.CedgeMulticastFeatureTemplate("example",
        name="Example",
        description="My Example",
        device_types=["vedge-C8000V"],
        spt_only=True,
        local_replicator=True,
        threshold=200)
    
    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.NewCedgeMulticastFeatureTemplate(ctx, "example", &sdwan.CedgeMulticastFeatureTemplateArgs{
    			Name:        pulumi.String("Example"),
    			Description: pulumi.String("My Example"),
    			DeviceTypes: pulumi.StringArray{
    				pulumi.String("vedge-C8000V"),
    			},
    			SptOnly:         pulumi.Bool(true),
    			LocalReplicator: pulumi.Bool(true),
    			Threshold:       pulumi.Int(200),
    		})
    		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 = new Sdwan.CedgeMulticastFeatureTemplate("example", new()
        {
            Name = "Example",
            Description = "My Example",
            DeviceTypes = new[]
            {
                "vedge-C8000V",
            },
            SptOnly = true,
            LocalReplicator = true,
            Threshold = 200,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.sdwan.CedgeMulticastFeatureTemplate;
    import com.pulumi.sdwan.CedgeMulticastFeatureTemplateArgs;
    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) {
            var example = new CedgeMulticastFeatureTemplate("example", CedgeMulticastFeatureTemplateArgs.builder()        
                .name("Example")
                .description("My Example")
                .deviceTypes("vedge-C8000V")
                .sptOnly(true)
                .localReplicator(true)
                .threshold(200)
                .build());
    
        }
    }
    
    resources:
      example:
        type: sdwan:CedgeMulticastFeatureTemplate
        properties:
          name: Example
          description: My Example
          deviceTypes:
            - vedge-C8000V
          sptOnly: true
          localReplicator: true
          threshold: 200
    

    Create CedgeMulticastFeatureTemplate Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new CedgeMulticastFeatureTemplate(name: string, args: CedgeMulticastFeatureTemplateArgs, opts?: CustomResourceOptions);
    @overload
    def CedgeMulticastFeatureTemplate(resource_name: str,
                                      args: CedgeMulticastFeatureTemplateArgs,
                                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def CedgeMulticastFeatureTemplate(resource_name: str,
                                      opts: Optional[ResourceOptions] = None,
                                      description: Optional[str] = None,
                                      device_types: Optional[Sequence[str]] = None,
                                      local_replicator: Optional[bool] = None,
                                      local_replicator_variable: Optional[str] = None,
                                      name: Optional[str] = None,
                                      spt_only: Optional[bool] = None,
                                      spt_only_variable: Optional[str] = None,
                                      threshold: Optional[int] = None,
                                      threshold_variable: Optional[str] = None)
    func NewCedgeMulticastFeatureTemplate(ctx *Context, name string, args CedgeMulticastFeatureTemplateArgs, opts ...ResourceOption) (*CedgeMulticastFeatureTemplate, error)
    public CedgeMulticastFeatureTemplate(string name, CedgeMulticastFeatureTemplateArgs args, CustomResourceOptions? opts = null)
    public CedgeMulticastFeatureTemplate(String name, CedgeMulticastFeatureTemplateArgs args)
    public CedgeMulticastFeatureTemplate(String name, CedgeMulticastFeatureTemplateArgs args, CustomResourceOptions options)
    
    type: sdwan:CedgeMulticastFeatureTemplate
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args CedgeMulticastFeatureTemplateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args CedgeMulticastFeatureTemplateArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args CedgeMulticastFeatureTemplateArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CedgeMulticastFeatureTemplateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CedgeMulticastFeatureTemplateArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var cedgeMulticastFeatureTemplateResource = new Sdwan.CedgeMulticastFeatureTemplate("cedgeMulticastFeatureTemplateResource", new()
    {
        Description = "string",
        DeviceTypes = new[]
        {
            "string",
        },
        LocalReplicator = false,
        LocalReplicatorVariable = "string",
        Name = "string",
        SptOnly = false,
        SptOnlyVariable = "string",
        Threshold = 0,
        ThresholdVariable = "string",
    });
    
    example, err := sdwan.NewCedgeMulticastFeatureTemplate(ctx, "cedgeMulticastFeatureTemplateResource", &sdwan.CedgeMulticastFeatureTemplateArgs{
    	Description: pulumi.String("string"),
    	DeviceTypes: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	LocalReplicator:         pulumi.Bool(false),
    	LocalReplicatorVariable: pulumi.String("string"),
    	Name:                    pulumi.String("string"),
    	SptOnly:                 pulumi.Bool(false),
    	SptOnlyVariable:         pulumi.String("string"),
    	Threshold:               pulumi.Int(0),
    	ThresholdVariable:       pulumi.String("string"),
    })
    
    var cedgeMulticastFeatureTemplateResource = new CedgeMulticastFeatureTemplate("cedgeMulticastFeatureTemplateResource", CedgeMulticastFeatureTemplateArgs.builder()
        .description("string")
        .deviceTypes("string")
        .localReplicator(false)
        .localReplicatorVariable("string")
        .name("string")
        .sptOnly(false)
        .sptOnlyVariable("string")
        .threshold(0)
        .thresholdVariable("string")
        .build());
    
    cedge_multicast_feature_template_resource = sdwan.CedgeMulticastFeatureTemplate("cedgeMulticastFeatureTemplateResource",
        description="string",
        device_types=["string"],
        local_replicator=False,
        local_replicator_variable="string",
        name="string",
        spt_only=False,
        spt_only_variable="string",
        threshold=0,
        threshold_variable="string")
    
    const cedgeMulticastFeatureTemplateResource = new sdwan.CedgeMulticastFeatureTemplate("cedgeMulticastFeatureTemplateResource", {
        description: "string",
        deviceTypes: ["string"],
        localReplicator: false,
        localReplicatorVariable: "string",
        name: "string",
        sptOnly: false,
        sptOnlyVariable: "string",
        threshold: 0,
        thresholdVariable: "string",
    });
    
    type: sdwan:CedgeMulticastFeatureTemplate
    properties:
        description: string
        deviceTypes:
            - string
        localReplicator: false
        localReplicatorVariable: string
        name: string
        sptOnly: false
        sptOnlyVariable: string
        threshold: 0
        thresholdVariable: string
    

    CedgeMulticastFeatureTemplate Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The CedgeMulticastFeatureTemplate resource accepts the following input properties:

    Description string
    The description of the feature template
    DeviceTypes List<string>
    List of supported device types - Choices: vedge-C8000V, vedge-C8300-1N1S-4T2X, vedge-C8300-1N1S-6T, vedge-C8300-2N2S-6T, vedge-C8300-2N2S-4T2X, vedge-C8500-12X4QC, vedge-C8500-12X, vedge-C8500-20X6C, vedge-C8500L-8S4X, vedge-C8200-1N-4T, vedge-C8200L-1N-4T
    LocalReplicator bool
    Replicator is local to this device - Default value: false
    LocalReplicatorVariable string
    Variable name
    Name string
    The name of the feature template
    SptOnly bool
    Shortest Path Tree (SPT) Only Mode - Default value: false
    SptOnlyVariable string
    Variable name
    Threshold int
    Set number of joins per group the router supports - Range: 0-1000
    ThresholdVariable string
    Variable name
    Description string
    The description of the feature template
    DeviceTypes []string
    List of supported device types - Choices: vedge-C8000V, vedge-C8300-1N1S-4T2X, vedge-C8300-1N1S-6T, vedge-C8300-2N2S-6T, vedge-C8300-2N2S-4T2X, vedge-C8500-12X4QC, vedge-C8500-12X, vedge-C8500-20X6C, vedge-C8500L-8S4X, vedge-C8200-1N-4T, vedge-C8200L-1N-4T
    LocalReplicator bool
    Replicator is local to this device - Default value: false
    LocalReplicatorVariable string
    Variable name
    Name string
    The name of the feature template
    SptOnly bool
    Shortest Path Tree (SPT) Only Mode - Default value: false
    SptOnlyVariable string
    Variable name
    Threshold int
    Set number of joins per group the router supports - Range: 0-1000
    ThresholdVariable string
    Variable name
    description String
    The description of the feature template
    deviceTypes List<String>
    List of supported device types - Choices: vedge-C8000V, vedge-C8300-1N1S-4T2X, vedge-C8300-1N1S-6T, vedge-C8300-2N2S-6T, vedge-C8300-2N2S-4T2X, vedge-C8500-12X4QC, vedge-C8500-12X, vedge-C8500-20X6C, vedge-C8500L-8S4X, vedge-C8200-1N-4T, vedge-C8200L-1N-4T
    localReplicator Boolean
    Replicator is local to this device - Default value: false
    localReplicatorVariable String
    Variable name
    name String
    The name of the feature template
    sptOnly Boolean
    Shortest Path Tree (SPT) Only Mode - Default value: false
    sptOnlyVariable String
    Variable name
    threshold Integer
    Set number of joins per group the router supports - Range: 0-1000
    thresholdVariable String
    Variable name
    description string
    The description of the feature template
    deviceTypes string[]
    List of supported device types - Choices: vedge-C8000V, vedge-C8300-1N1S-4T2X, vedge-C8300-1N1S-6T, vedge-C8300-2N2S-6T, vedge-C8300-2N2S-4T2X, vedge-C8500-12X4QC, vedge-C8500-12X, vedge-C8500-20X6C, vedge-C8500L-8S4X, vedge-C8200-1N-4T, vedge-C8200L-1N-4T
    localReplicator boolean
    Replicator is local to this device - Default value: false
    localReplicatorVariable string
    Variable name
    name string
    The name of the feature template
    sptOnly boolean
    Shortest Path Tree (SPT) Only Mode - Default value: false
    sptOnlyVariable string
    Variable name
    threshold number
    Set number of joins per group the router supports - Range: 0-1000
    thresholdVariable string
    Variable name
    description str
    The description of the feature template
    device_types Sequence[str]
    List of supported device types - Choices: vedge-C8000V, vedge-C8300-1N1S-4T2X, vedge-C8300-1N1S-6T, vedge-C8300-2N2S-6T, vedge-C8300-2N2S-4T2X, vedge-C8500-12X4QC, vedge-C8500-12X, vedge-C8500-20X6C, vedge-C8500L-8S4X, vedge-C8200-1N-4T, vedge-C8200L-1N-4T
    local_replicator bool
    Replicator is local to this device - Default value: false
    local_replicator_variable str
    Variable name
    name str
    The name of the feature template
    spt_only bool
    Shortest Path Tree (SPT) Only Mode - Default value: false
    spt_only_variable str
    Variable name
    threshold int
    Set number of joins per group the router supports - Range: 0-1000
    threshold_variable str
    Variable name
    description String
    The description of the feature template
    deviceTypes List<String>
    List of supported device types - Choices: vedge-C8000V, vedge-C8300-1N1S-4T2X, vedge-C8300-1N1S-6T, vedge-C8300-2N2S-6T, vedge-C8300-2N2S-4T2X, vedge-C8500-12X4QC, vedge-C8500-12X, vedge-C8500-20X6C, vedge-C8500L-8S4X, vedge-C8200-1N-4T, vedge-C8200L-1N-4T
    localReplicator Boolean
    Replicator is local to this device - Default value: false
    localReplicatorVariable String
    Variable name
    name String
    The name of the feature template
    sptOnly Boolean
    Shortest Path Tree (SPT) Only Mode - Default value: false
    sptOnlyVariable String
    Variable name
    threshold Number
    Set number of joins per group the router supports - Range: 0-1000
    thresholdVariable String
    Variable name

    Outputs

    All input properties are implicitly available as output properties. Additionally, the CedgeMulticastFeatureTemplate resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    TemplateType string
    The template type
    Version int
    The version of the feature template
    Id string
    The provider-assigned unique ID for this managed resource.
    TemplateType string
    The template type
    Version int
    The version of the feature template
    id String
    The provider-assigned unique ID for this managed resource.
    templateType String
    The template type
    version Integer
    The version of the feature template
    id string
    The provider-assigned unique ID for this managed resource.
    templateType string
    The template type
    version number
    The version of the feature template
    id str
    The provider-assigned unique ID for this managed resource.
    template_type str
    The template type
    version int
    The version of the feature template
    id String
    The provider-assigned unique ID for this managed resource.
    templateType String
    The template type
    version Number
    The version of the feature template

    Look up Existing CedgeMulticastFeatureTemplate Resource

    Get an existing CedgeMulticastFeatureTemplate resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: CedgeMulticastFeatureTemplateState, opts?: CustomResourceOptions): CedgeMulticastFeatureTemplate
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            device_types: Optional[Sequence[str]] = None,
            local_replicator: Optional[bool] = None,
            local_replicator_variable: Optional[str] = None,
            name: Optional[str] = None,
            spt_only: Optional[bool] = None,
            spt_only_variable: Optional[str] = None,
            template_type: Optional[str] = None,
            threshold: Optional[int] = None,
            threshold_variable: Optional[str] = None,
            version: Optional[int] = None) -> CedgeMulticastFeatureTemplate
    func GetCedgeMulticastFeatureTemplate(ctx *Context, name string, id IDInput, state *CedgeMulticastFeatureTemplateState, opts ...ResourceOption) (*CedgeMulticastFeatureTemplate, error)
    public static CedgeMulticastFeatureTemplate Get(string name, Input<string> id, CedgeMulticastFeatureTemplateState? state, CustomResourceOptions? opts = null)
    public static CedgeMulticastFeatureTemplate get(String name, Output<String> id, CedgeMulticastFeatureTemplateState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Description string
    The description of the feature template
    DeviceTypes List<string>
    List of supported device types - Choices: vedge-C8000V, vedge-C8300-1N1S-4T2X, vedge-C8300-1N1S-6T, vedge-C8300-2N2S-6T, vedge-C8300-2N2S-4T2X, vedge-C8500-12X4QC, vedge-C8500-12X, vedge-C8500-20X6C, vedge-C8500L-8S4X, vedge-C8200-1N-4T, vedge-C8200L-1N-4T
    LocalReplicator bool
    Replicator is local to this device - Default value: false
    LocalReplicatorVariable string
    Variable name
    Name string
    The name of the feature template
    SptOnly bool
    Shortest Path Tree (SPT) Only Mode - Default value: false
    SptOnlyVariable string
    Variable name
    TemplateType string
    The template type
    Threshold int
    Set number of joins per group the router supports - Range: 0-1000
    ThresholdVariable string
    Variable name
    Version int
    The version of the feature template
    Description string
    The description of the feature template
    DeviceTypes []string
    List of supported device types - Choices: vedge-C8000V, vedge-C8300-1N1S-4T2X, vedge-C8300-1N1S-6T, vedge-C8300-2N2S-6T, vedge-C8300-2N2S-4T2X, vedge-C8500-12X4QC, vedge-C8500-12X, vedge-C8500-20X6C, vedge-C8500L-8S4X, vedge-C8200-1N-4T, vedge-C8200L-1N-4T
    LocalReplicator bool
    Replicator is local to this device - Default value: false
    LocalReplicatorVariable string
    Variable name
    Name string
    The name of the feature template
    SptOnly bool
    Shortest Path Tree (SPT) Only Mode - Default value: false
    SptOnlyVariable string
    Variable name
    TemplateType string
    The template type
    Threshold int
    Set number of joins per group the router supports - Range: 0-1000
    ThresholdVariable string
    Variable name
    Version int
    The version of the feature template
    description String
    The description of the feature template
    deviceTypes List<String>
    List of supported device types - Choices: vedge-C8000V, vedge-C8300-1N1S-4T2X, vedge-C8300-1N1S-6T, vedge-C8300-2N2S-6T, vedge-C8300-2N2S-4T2X, vedge-C8500-12X4QC, vedge-C8500-12X, vedge-C8500-20X6C, vedge-C8500L-8S4X, vedge-C8200-1N-4T, vedge-C8200L-1N-4T
    localReplicator Boolean
    Replicator is local to this device - Default value: false
    localReplicatorVariable String
    Variable name
    name String
    The name of the feature template
    sptOnly Boolean
    Shortest Path Tree (SPT) Only Mode - Default value: false
    sptOnlyVariable String
    Variable name
    templateType String
    The template type
    threshold Integer
    Set number of joins per group the router supports - Range: 0-1000
    thresholdVariable String
    Variable name
    version Integer
    The version of the feature template
    description string
    The description of the feature template
    deviceTypes string[]
    List of supported device types - Choices: vedge-C8000V, vedge-C8300-1N1S-4T2X, vedge-C8300-1N1S-6T, vedge-C8300-2N2S-6T, vedge-C8300-2N2S-4T2X, vedge-C8500-12X4QC, vedge-C8500-12X, vedge-C8500-20X6C, vedge-C8500L-8S4X, vedge-C8200-1N-4T, vedge-C8200L-1N-4T
    localReplicator boolean
    Replicator is local to this device - Default value: false
    localReplicatorVariable string
    Variable name
    name string
    The name of the feature template
    sptOnly boolean
    Shortest Path Tree (SPT) Only Mode - Default value: false
    sptOnlyVariable string
    Variable name
    templateType string
    The template type
    threshold number
    Set number of joins per group the router supports - Range: 0-1000
    thresholdVariable string
    Variable name
    version number
    The version of the feature template
    description str
    The description of the feature template
    device_types Sequence[str]
    List of supported device types - Choices: vedge-C8000V, vedge-C8300-1N1S-4T2X, vedge-C8300-1N1S-6T, vedge-C8300-2N2S-6T, vedge-C8300-2N2S-4T2X, vedge-C8500-12X4QC, vedge-C8500-12X, vedge-C8500-20X6C, vedge-C8500L-8S4X, vedge-C8200-1N-4T, vedge-C8200L-1N-4T
    local_replicator bool
    Replicator is local to this device - Default value: false
    local_replicator_variable str
    Variable name
    name str
    The name of the feature template
    spt_only bool
    Shortest Path Tree (SPT) Only Mode - Default value: false
    spt_only_variable str
    Variable name
    template_type str
    The template type
    threshold int
    Set number of joins per group the router supports - Range: 0-1000
    threshold_variable str
    Variable name
    version int
    The version of the feature template
    description String
    The description of the feature template
    deviceTypes List<String>
    List of supported device types - Choices: vedge-C8000V, vedge-C8300-1N1S-4T2X, vedge-C8300-1N1S-6T, vedge-C8300-2N2S-6T, vedge-C8300-2N2S-4T2X, vedge-C8500-12X4QC, vedge-C8500-12X, vedge-C8500-20X6C, vedge-C8500L-8S4X, vedge-C8200-1N-4T, vedge-C8200L-1N-4T
    localReplicator Boolean
    Replicator is local to this device - Default value: false
    localReplicatorVariable String
    Variable name
    name String
    The name of the feature template
    sptOnly Boolean
    Shortest Path Tree (SPT) Only Mode - Default value: false
    sptOnlyVariable String
    Variable name
    templateType String
    The template type
    threshold Number
    Set number of joins per group the router supports - Range: 0-1000
    thresholdVariable String
    Variable name
    version Number
    The version of the feature template

    Import

    $ pulumi import sdwan:index/cedgeMulticastFeatureTemplate:CedgeMulticastFeatureTemplate example "f6b2c44c-693c-4763-b010-895aa3d236bd"
    

    To learn more about importing existing cloud resources, see Importing resources.

    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.1.1 published on Friday, May 31, 2024 by Pulumi