1. Packages
  2. Cisco NX OS Resource Provider
  3. API Docs
  4. PimStaticRpGroupList
Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs

nxos.PimStaticRpGroupList

Explore with Pulumi AI

nxos logo
Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs

    This resource can manage the PIM Static RP group list configuration.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Nxos = Lbrlabs.PulumiPackage.Nxos;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Nxos.PimStaticRpGroupList("example", new()
        {
            Address = "224.0.0.0/4",
            Bidir = true,
            Override = true,
            RpAddress = "1.2.3.4",
            VrfName = "default",
        });
    
    });
    
    package main
    
    import (
    	"github.com/lbrlabs/pulumi-nxos/sdk/go/nxos"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := nxos.NewPimStaticRpGroupList(ctx, "example", &nxos.PimStaticRpGroupListArgs{
    			Address:   pulumi.String("224.0.0.0/4"),
    			Bidir:     pulumi.Bool(true),
    			Override:  pulumi.Bool(true),
    			RpAddress: pulumi.String("1.2.3.4"),
    			VrfName:   pulumi.String("default"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.nxos.PimStaticRpGroupList;
    import com.pulumi.nxos.PimStaticRpGroupListArgs;
    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 PimStaticRpGroupList("example", PimStaticRpGroupListArgs.builder()        
                .address("224.0.0.0/4")
                .bidir(true)
                .override(true)
                .rpAddress("1.2.3.4")
                .vrfName("default")
                .build());
    
        }
    }
    
    import pulumi
    import lbrlabs_pulumi_nxos as nxos
    
    example = nxos.PimStaticRpGroupList("example",
        address="224.0.0.0/4",
        bidir=True,
        override=True,
        rp_address="1.2.3.4",
        vrf_name="default")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as nxos from "@lbrlabs/pulumi-nxos";
    
    const example = new nxos.PimStaticRpGroupList("example", {
        address: "224.0.0.0/4",
        bidir: true,
        override: true,
        rpAddress: "1.2.3.4",
        vrfName: "default",
    });
    
    resources:
      example:
        type: nxos:PimStaticRpGroupList
        properties:
          address: 224.0.0.0/4
          bidir: true
          override: true
          rpAddress: 1.2.3.4
          vrfName: default
    

    Create PimStaticRpGroupList Resource

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

    Constructor syntax

    new PimStaticRpGroupList(name: string, args: PimStaticRpGroupListArgs, opts?: CustomResourceOptions);
    @overload
    def PimStaticRpGroupList(resource_name: str,
                             args: PimStaticRpGroupListArgs,
                             opts: Optional[ResourceOptions] = None)
    
    @overload
    def PimStaticRpGroupList(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             address: Optional[str] = None,
                             rp_address: Optional[str] = None,
                             vrf_name: Optional[str] = None,
                             bidir: Optional[bool] = None,
                             device: Optional[str] = None,
                             override: Optional[bool] = None)
    func NewPimStaticRpGroupList(ctx *Context, name string, args PimStaticRpGroupListArgs, opts ...ResourceOption) (*PimStaticRpGroupList, error)
    public PimStaticRpGroupList(string name, PimStaticRpGroupListArgs args, CustomResourceOptions? opts = null)
    public PimStaticRpGroupList(String name, PimStaticRpGroupListArgs args)
    public PimStaticRpGroupList(String name, PimStaticRpGroupListArgs args, CustomResourceOptions options)
    
    type: nxos:PimStaticRpGroupList
    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 PimStaticRpGroupListArgs
    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 PimStaticRpGroupListArgs
    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 PimStaticRpGroupListArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PimStaticRpGroupListArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PimStaticRpGroupListArgs
    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 pimStaticRpGroupListResource = new Nxos.PimStaticRpGroupList("pimStaticRpGroupListResource", new()
    {
        Address = "string",
        RpAddress = "string",
        VrfName = "string",
        Bidir = false,
        Device = "string",
        Override = false,
    });
    
    example, err := nxos.NewPimStaticRpGroupList(ctx, "pimStaticRpGroupListResource", &nxos.PimStaticRpGroupListArgs{
    	Address:   pulumi.String("string"),
    	RpAddress: pulumi.String("string"),
    	VrfName:   pulumi.String("string"),
    	Bidir:     pulumi.Bool(false),
    	Device:    pulumi.String("string"),
    	Override:  pulumi.Bool(false),
    })
    
    var pimStaticRpGroupListResource = new PimStaticRpGroupList("pimStaticRpGroupListResource", PimStaticRpGroupListArgs.builder()
        .address("string")
        .rpAddress("string")
        .vrfName("string")
        .bidir(false)
        .device("string")
        .override(false)
        .build());
    
    pim_static_rp_group_list_resource = nxos.PimStaticRpGroupList("pimStaticRpGroupListResource",
        address="string",
        rp_address="string",
        vrf_name="string",
        bidir=False,
        device="string",
        override=False)
    
    const pimStaticRpGroupListResource = new nxos.PimStaticRpGroupList("pimStaticRpGroupListResource", {
        address: "string",
        rpAddress: "string",
        vrfName: "string",
        bidir: false,
        device: "string",
        override: false,
    });
    
    type: nxos:PimStaticRpGroupList
    properties:
        address: string
        bidir: false
        device: string
        override: false
        rpAddress: string
        vrfName: string
    

    PimStaticRpGroupList 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 PimStaticRpGroupList resource accepts the following input properties:

    Address string
    Group list address information.
    RpAddress string
    RP address.
    VrfName string
    VRF name.
    Bidir bool
    Flag to treat Group Ranges as BiDir. - Default value: false
    Device string
    A device name from the provider configuration.
    Override bool
    Flag to override RP preference to use Static over Dynamic RP. - Default value: false
    Address string
    Group list address information.
    RpAddress string
    RP address.
    VrfName string
    VRF name.
    Bidir bool
    Flag to treat Group Ranges as BiDir. - Default value: false
    Device string
    A device name from the provider configuration.
    Override bool
    Flag to override RP preference to use Static over Dynamic RP. - Default value: false
    address String
    Group list address information.
    rpAddress String
    RP address.
    vrfName String
    VRF name.
    bidir Boolean
    Flag to treat Group Ranges as BiDir. - Default value: false
    device String
    A device name from the provider configuration.
    override Boolean
    Flag to override RP preference to use Static over Dynamic RP. - Default value: false
    address string
    Group list address information.
    rpAddress string
    RP address.
    vrfName string
    VRF name.
    bidir boolean
    Flag to treat Group Ranges as BiDir. - Default value: false
    device string
    A device name from the provider configuration.
    override boolean
    Flag to override RP preference to use Static over Dynamic RP. - Default value: false
    address str
    Group list address information.
    rp_address str
    RP address.
    vrf_name str
    VRF name.
    bidir bool
    Flag to treat Group Ranges as BiDir. - Default value: false
    device str
    A device name from the provider configuration.
    override bool
    Flag to override RP preference to use Static over Dynamic RP. - Default value: false
    address String
    Group list address information.
    rpAddress String
    RP address.
    vrfName String
    VRF name.
    bidir Boolean
    Flag to treat Group Ranges as BiDir. - Default value: false
    device String
    A device name from the provider configuration.
    override Boolean
    Flag to override RP preference to use Static over Dynamic RP. - Default value: false

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing PimStaticRpGroupList Resource

    Get an existing PimStaticRpGroupList 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?: PimStaticRpGroupListState, opts?: CustomResourceOptions): PimStaticRpGroupList
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            address: Optional[str] = None,
            bidir: Optional[bool] = None,
            device: Optional[str] = None,
            override: Optional[bool] = None,
            rp_address: Optional[str] = None,
            vrf_name: Optional[str] = None) -> PimStaticRpGroupList
    func GetPimStaticRpGroupList(ctx *Context, name string, id IDInput, state *PimStaticRpGroupListState, opts ...ResourceOption) (*PimStaticRpGroupList, error)
    public static PimStaticRpGroupList Get(string name, Input<string> id, PimStaticRpGroupListState? state, CustomResourceOptions? opts = null)
    public static PimStaticRpGroupList get(String name, Output<String> id, PimStaticRpGroupListState 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:
    Address string
    Group list address information.
    Bidir bool
    Flag to treat Group Ranges as BiDir. - Default value: false
    Device string
    A device name from the provider configuration.
    Override bool
    Flag to override RP preference to use Static over Dynamic RP. - Default value: false
    RpAddress string
    RP address.
    VrfName string
    VRF name.
    Address string
    Group list address information.
    Bidir bool
    Flag to treat Group Ranges as BiDir. - Default value: false
    Device string
    A device name from the provider configuration.
    Override bool
    Flag to override RP preference to use Static over Dynamic RP. - Default value: false
    RpAddress string
    RP address.
    VrfName string
    VRF name.
    address String
    Group list address information.
    bidir Boolean
    Flag to treat Group Ranges as BiDir. - Default value: false
    device String
    A device name from the provider configuration.
    override Boolean
    Flag to override RP preference to use Static over Dynamic RP. - Default value: false
    rpAddress String
    RP address.
    vrfName String
    VRF name.
    address string
    Group list address information.
    bidir boolean
    Flag to treat Group Ranges as BiDir. - Default value: false
    device string
    A device name from the provider configuration.
    override boolean
    Flag to override RP preference to use Static over Dynamic RP. - Default value: false
    rpAddress string
    RP address.
    vrfName string
    VRF name.
    address str
    Group list address information.
    bidir bool
    Flag to treat Group Ranges as BiDir. - Default value: false
    device str
    A device name from the provider configuration.
    override bool
    Flag to override RP preference to use Static over Dynamic RP. - Default value: false
    rp_address str
    RP address.
    vrf_name str
    VRF name.
    address String
    Group list address information.
    bidir Boolean
    Flag to treat Group Ranges as BiDir. - Default value: false
    device String
    A device name from the provider configuration.
    override Boolean
    Flag to override RP preference to use Static over Dynamic RP. - Default value: false
    rpAddress String
    RP address.
    vrfName String
    VRF name.

    Import

     $ pulumi import nxos:index/pimStaticRpGroupList:PimStaticRpGroupList example "sys/pim/inst/dom-[default]/staticrp/rp-[1.2.3.4]/rpgrplist-[224.0.0.0/4]"
    

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

    Package Details

    Repository
    nxos lbrlabs/pulumi-nxos
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the nxos Terraform Provider.
    nxos logo
    Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs