1. Packages
  2. Cisco Catalyst SD-WAN Provider
  3. API Docs
  4. CedgeIgmpFeatureTemplate
Cisco Catalyst SD-WAN v0.2.3 published on Wednesday, Dec 4, 2024 by Pulumi

sdwan.CedgeIgmpFeatureTemplate

Explore with Pulumi AI

sdwan logo
Cisco Catalyst SD-WAN v0.2.3 published on Wednesday, Dec 4, 2024 by Pulumi

    This resource can manage a cEdge IGMP feature template.

    • Minimum SD-WAN Manager version: 15.0.0

    Example Usage

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.sdwan.CedgeIgmpFeatureTemplate;
    import com.pulumi.sdwan.CedgeIgmpFeatureTemplateArgs;
    import com.pulumi.sdwan.inputs.CedgeIgmpFeatureTemplateInterfaceArgs;
    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 CedgeIgmpFeatureTemplate("example", CedgeIgmpFeatureTemplateArgs.builder()
                .name("Example")
                .description("My Example")
                .deviceTypes("vedge-C8000V")
                .interfaces(CedgeIgmpFeatureTemplateInterfaceArgs.builder()
                    .name("Ethernet0")
                    .join_groups(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                    .build())
                .build());
    
        }
    }
    
    resources:
      example:
        type: sdwan:CedgeIgmpFeatureTemplate
        properties:
          name: Example
          description: My Example
          deviceTypes:
            - vedge-C8000V
          interfaces:
            - name: Ethernet0
              join_groups:
                - groupAddress: 235.1.1.1
                  source: 1.2.3.4
    

    Create CedgeIgmpFeatureTemplate Resource

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

    Constructor syntax

    new CedgeIgmpFeatureTemplate(name: string, args: CedgeIgmpFeatureTemplateArgs, opts?: CustomResourceOptions);
    @overload
    def CedgeIgmpFeatureTemplate(resource_name: str,
                                 args: CedgeIgmpFeatureTemplateArgs,
                                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def CedgeIgmpFeatureTemplate(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 description: Optional[str] = None,
                                 device_types: Optional[Sequence[str]] = None,
                                 interfaces: Optional[Sequence[CedgeIgmpFeatureTemplateInterfaceArgs]] = None,
                                 name: Optional[str] = None)
    func NewCedgeIgmpFeatureTemplate(ctx *Context, name string, args CedgeIgmpFeatureTemplateArgs, opts ...ResourceOption) (*CedgeIgmpFeatureTemplate, error)
    public CedgeIgmpFeatureTemplate(string name, CedgeIgmpFeatureTemplateArgs args, CustomResourceOptions? opts = null)
    public CedgeIgmpFeatureTemplate(String name, CedgeIgmpFeatureTemplateArgs args)
    public CedgeIgmpFeatureTemplate(String name, CedgeIgmpFeatureTemplateArgs args, CustomResourceOptions options)
    
    type: sdwan:CedgeIgmpFeatureTemplate
    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 CedgeIgmpFeatureTemplateArgs
    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 CedgeIgmpFeatureTemplateArgs
    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 CedgeIgmpFeatureTemplateArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CedgeIgmpFeatureTemplateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CedgeIgmpFeatureTemplateArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var cedgeIgmpFeatureTemplateResource = new Sdwan.CedgeIgmpFeatureTemplate("cedgeIgmpFeatureTemplateResource", new()
    {
        Description = "string",
        DeviceTypes = new[]
        {
            "string",
        },
        Interfaces = new[]
        {
            new Sdwan.Inputs.CedgeIgmpFeatureTemplateInterfaceArgs
            {
                JoinGroups = new[]
                {
                    new Sdwan.Inputs.CedgeIgmpFeatureTemplateInterfaceJoinGroupArgs
                    {
                        GroupAddress = "string",
                        GroupAddressVariable = "string",
                        Optional = false,
                        Source = "string",
                        SourceVariable = "string",
                    },
                },
                Name = "string",
                NameVariable = "string",
                Optional = false,
            },
        },
        Name = "string",
    });
    
    example, err := sdwan.NewCedgeIgmpFeatureTemplate(ctx, "cedgeIgmpFeatureTemplateResource", &sdwan.CedgeIgmpFeatureTemplateArgs{
    	Description: pulumi.String("string"),
    	DeviceTypes: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Interfaces: sdwan.CedgeIgmpFeatureTemplateInterfaceArray{
    		&sdwan.CedgeIgmpFeatureTemplateInterfaceArgs{
    			JoinGroups: sdwan.CedgeIgmpFeatureTemplateInterfaceJoinGroupArray{
    				&sdwan.CedgeIgmpFeatureTemplateInterfaceJoinGroupArgs{
    					GroupAddress:         pulumi.String("string"),
    					GroupAddressVariable: pulumi.String("string"),
    					Optional:             pulumi.Bool(false),
    					Source:               pulumi.String("string"),
    					SourceVariable:       pulumi.String("string"),
    				},
    			},
    			Name:         pulumi.String("string"),
    			NameVariable: pulumi.String("string"),
    			Optional:     pulumi.Bool(false),
    		},
    	},
    	Name: pulumi.String("string"),
    })
    
    var cedgeIgmpFeatureTemplateResource = new CedgeIgmpFeatureTemplate("cedgeIgmpFeatureTemplateResource", CedgeIgmpFeatureTemplateArgs.builder()
        .description("string")
        .deviceTypes("string")
        .interfaces(CedgeIgmpFeatureTemplateInterfaceArgs.builder()
            .joinGroups(CedgeIgmpFeatureTemplateInterfaceJoinGroupArgs.builder()
                .groupAddress("string")
                .groupAddressVariable("string")
                .optional(false)
                .source("string")
                .sourceVariable("string")
                .build())
            .name("string")
            .nameVariable("string")
            .optional(false)
            .build())
        .name("string")
        .build());
    
    cedge_igmp_feature_template_resource = sdwan.CedgeIgmpFeatureTemplate("cedgeIgmpFeatureTemplateResource",
        description="string",
        device_types=["string"],
        interfaces=[{
            "join_groups": [{
                "group_address": "string",
                "group_address_variable": "string",
                "optional": False,
                "source": "string",
                "source_variable": "string",
            }],
            "name": "string",
            "name_variable": "string",
            "optional": False,
        }],
        name="string")
    
    const cedgeIgmpFeatureTemplateResource = new sdwan.CedgeIgmpFeatureTemplate("cedgeIgmpFeatureTemplateResource", {
        description: "string",
        deviceTypes: ["string"],
        interfaces: [{
            joinGroups: [{
                groupAddress: "string",
                groupAddressVariable: "string",
                optional: false,
                source: "string",
                sourceVariable: "string",
            }],
            name: "string",
            nameVariable: "string",
            optional: false,
        }],
        name: "string",
    });
    
    type: sdwan:CedgeIgmpFeatureTemplate
    properties:
        description: string
        deviceTypes:
            - string
        interfaces:
            - joinGroups:
                - groupAddress: string
                  groupAddressVariable: string
                  optional: false
                  source: string
                  sourceVariable: string
              name: string
              nameVariable: string
              optional: false
        name: string
    

    CedgeIgmpFeatureTemplate Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The CedgeIgmpFeatureTemplate 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
    Interfaces List<CedgeIgmpFeatureTemplateInterface>
    Set IGMP interface parameters
    Name string
    The name 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
    Interfaces []CedgeIgmpFeatureTemplateInterfaceArgs
    Set IGMP interface parameters
    Name string
    The name 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
    interfaces List<CedgeIgmpFeatureTemplateInterface>
    Set IGMP interface parameters
    name String
    The name 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
    interfaces CedgeIgmpFeatureTemplateInterface[]
    Set IGMP interface parameters
    name string
    The name 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
    interfaces Sequence[CedgeIgmpFeatureTemplateInterfaceArgs]
    Set IGMP interface parameters
    name str
    The name 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
    interfaces List<Property Map>
    Set IGMP interface parameters
    name String
    The name of the feature template

    Outputs

    All input properties are implicitly available as output properties. Additionally, the CedgeIgmpFeatureTemplate 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 CedgeIgmpFeatureTemplate Resource

    Get an existing CedgeIgmpFeatureTemplate 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?: CedgeIgmpFeatureTemplateState, opts?: CustomResourceOptions): CedgeIgmpFeatureTemplate
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            device_types: Optional[Sequence[str]] = None,
            interfaces: Optional[Sequence[CedgeIgmpFeatureTemplateInterfaceArgs]] = None,
            name: Optional[str] = None,
            template_type: Optional[str] = None,
            version: Optional[int] = None) -> CedgeIgmpFeatureTemplate
    func GetCedgeIgmpFeatureTemplate(ctx *Context, name string, id IDInput, state *CedgeIgmpFeatureTemplateState, opts ...ResourceOption) (*CedgeIgmpFeatureTemplate, error)
    public static CedgeIgmpFeatureTemplate Get(string name, Input<string> id, CedgeIgmpFeatureTemplateState? state, CustomResourceOptions? opts = null)
    public static CedgeIgmpFeatureTemplate get(String name, Output<String> id, CedgeIgmpFeatureTemplateState 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
    Interfaces List<CedgeIgmpFeatureTemplateInterface>
    Set IGMP interface parameters
    Name string
    The name of the feature template
    TemplateType string
    The template type
    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
    Interfaces []CedgeIgmpFeatureTemplateInterfaceArgs
    Set IGMP interface parameters
    Name string
    The name of the feature template
    TemplateType string
    The template type
    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
    interfaces List<CedgeIgmpFeatureTemplateInterface>
    Set IGMP interface parameters
    name String
    The name of the feature template
    templateType String
    The template type
    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
    interfaces CedgeIgmpFeatureTemplateInterface[]
    Set IGMP interface parameters
    name string
    The name of the feature template
    templateType string
    The template type
    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
    interfaces Sequence[CedgeIgmpFeatureTemplateInterfaceArgs]
    Set IGMP interface parameters
    name str
    The name of the feature template
    template_type str
    The template type
    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
    interfaces List<Property Map>
    Set IGMP interface parameters
    name String
    The name of the feature template
    templateType String
    The template type
    version Number
    The version of the feature template

    Supporting Types

    CedgeIgmpFeatureTemplateInterface, CedgeIgmpFeatureTemplateInterfaceArgs

    JoinGroups List<CedgeIgmpFeatureTemplateInterfaceJoinGroup>
    Configure static joins
    Name string
    Set interface name
    NameVariable string
    Variable name
    Optional bool
    Indicates if list item is considered optional.
    JoinGroups []CedgeIgmpFeatureTemplateInterfaceJoinGroup
    Configure static joins
    Name string
    Set interface name
    NameVariable string
    Variable name
    Optional bool
    Indicates if list item is considered optional.
    joinGroups List<CedgeIgmpFeatureTemplateInterfaceJoinGroup>
    Configure static joins
    name String
    Set interface name
    nameVariable String
    Variable name
    optional Boolean
    Indicates if list item is considered optional.
    joinGroups CedgeIgmpFeatureTemplateInterfaceJoinGroup[]
    Configure static joins
    name string
    Set interface name
    nameVariable string
    Variable name
    optional boolean
    Indicates if list item is considered optional.
    join_groups Sequence[CedgeIgmpFeatureTemplateInterfaceJoinGroup]
    Configure static joins
    name str
    Set interface name
    name_variable str
    Variable name
    optional bool
    Indicates if list item is considered optional.
    joinGroups List<Property Map>
    Configure static joins
    name String
    Set interface name
    nameVariable String
    Variable name
    optional Boolean
    Indicates if list item is considered optional.

    CedgeIgmpFeatureTemplateInterfaceJoinGroup, CedgeIgmpFeatureTemplateInterfaceJoinGroupArgs

    GroupAddress string
    Set group address
    GroupAddressVariable string
    Variable name
    Optional bool
    Indicates if list item is considered optional.
    Source string
    Set source address
    SourceVariable string
    Variable name
    GroupAddress string
    Set group address
    GroupAddressVariable string
    Variable name
    Optional bool
    Indicates if list item is considered optional.
    Source string
    Set source address
    SourceVariable string
    Variable name
    groupAddress String
    Set group address
    groupAddressVariable String
    Variable name
    optional Boolean
    Indicates if list item is considered optional.
    source String
    Set source address
    sourceVariable String
    Variable name
    groupAddress string
    Set group address
    groupAddressVariable string
    Variable name
    optional boolean
    Indicates if list item is considered optional.
    source string
    Set source address
    sourceVariable string
    Variable name
    group_address str
    Set group address
    group_address_variable str
    Variable name
    optional bool
    Indicates if list item is considered optional.
    source str
    Set source address
    source_variable str
    Variable name
    groupAddress String
    Set group address
    groupAddressVariable String
    Variable name
    optional Boolean
    Indicates if list item is considered optional.
    source String
    Set source address
    sourceVariable String
    Variable name

    Import

    $ pulumi import sdwan:index/cedgeIgmpFeatureTemplate:CedgeIgmpFeatureTemplate 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.2.3 published on Wednesday, Dec 4, 2024 by Pulumi