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

nxos.PimAnycastRpPeer

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 Anycast RP peer 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.PimAnycastRpPeer("example", new()
        {
            Address = "10.1.1.1/32",
            RpSetAddress = "20.1.1.1/32",
            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.NewPimAnycastRpPeer(ctx, "example", &nxos.PimAnycastRpPeerArgs{
    			Address:      pulumi.String("10.1.1.1/32"),
    			RpSetAddress: pulumi.String("20.1.1.1/32"),
    			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.PimAnycastRpPeer;
    import com.pulumi.nxos.PimAnycastRpPeerArgs;
    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 PimAnycastRpPeer("example", PimAnycastRpPeerArgs.builder()        
                .address("10.1.1.1/32")
                .rpSetAddress("20.1.1.1/32")
                .vrfName("default")
                .build());
    
        }
    }
    
    import pulumi
    import lbrlabs_pulumi_nxos as nxos
    
    example = nxos.PimAnycastRpPeer("example",
        address="10.1.1.1/32",
        rp_set_address="20.1.1.1/32",
        vrf_name="default")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as nxos from "@lbrlabs/pulumi-nxos";
    
    const example = new nxos.PimAnycastRpPeer("example", {
        address: "10.1.1.1/32",
        rpSetAddress: "20.1.1.1/32",
        vrfName: "default",
    });
    
    resources:
      example:
        type: nxos:PimAnycastRpPeer
        properties:
          address: 10.1.1.1/32
          rpSetAddress: 20.1.1.1/32
          vrfName: default
    

    Create PimAnycastRpPeer Resource

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

    Constructor syntax

    new PimAnycastRpPeer(name: string, args: PimAnycastRpPeerArgs, opts?: CustomResourceOptions);
    @overload
    def PimAnycastRpPeer(resource_name: str,
                         args: PimAnycastRpPeerArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def PimAnycastRpPeer(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         address: Optional[str] = None,
                         rp_set_address: Optional[str] = None,
                         vrf_name: Optional[str] = None,
                         device: Optional[str] = None)
    func NewPimAnycastRpPeer(ctx *Context, name string, args PimAnycastRpPeerArgs, opts ...ResourceOption) (*PimAnycastRpPeer, error)
    public PimAnycastRpPeer(string name, PimAnycastRpPeerArgs args, CustomResourceOptions? opts = null)
    public PimAnycastRpPeer(String name, PimAnycastRpPeerArgs args)
    public PimAnycastRpPeer(String name, PimAnycastRpPeerArgs args, CustomResourceOptions options)
    
    type: nxos:PimAnycastRpPeer
    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 PimAnycastRpPeerArgs
    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 PimAnycastRpPeerArgs
    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 PimAnycastRpPeerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PimAnycastRpPeerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PimAnycastRpPeerArgs
    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 pimAnycastRpPeerResource = new Nxos.PimAnycastRpPeer("pimAnycastRpPeerResource", new()
    {
        Address = "string",
        RpSetAddress = "string",
        VrfName = "string",
        Device = "string",
    });
    
    example, err := nxos.NewPimAnycastRpPeer(ctx, "pimAnycastRpPeerResource", &nxos.PimAnycastRpPeerArgs{
    	Address:      pulumi.String("string"),
    	RpSetAddress: pulumi.String("string"),
    	VrfName:      pulumi.String("string"),
    	Device:       pulumi.String("string"),
    })
    
    var pimAnycastRpPeerResource = new PimAnycastRpPeer("pimAnycastRpPeerResource", PimAnycastRpPeerArgs.builder()
        .address("string")
        .rpSetAddress("string")
        .vrfName("string")
        .device("string")
        .build());
    
    pim_anycast_rp_peer_resource = nxos.PimAnycastRpPeer("pimAnycastRpPeerResource",
        address="string",
        rp_set_address="string",
        vrf_name="string",
        device="string")
    
    const pimAnycastRpPeerResource = new nxos.PimAnycastRpPeer("pimAnycastRpPeerResource", {
        address: "string",
        rpSetAddress: "string",
        vrfName: "string",
        device: "string",
    });
    
    type: nxos:PimAnycastRpPeer
    properties:
        address: string
        device: string
        rpSetAddress: string
        vrfName: string
    

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

    Address string
    Anycast RP address.
    RpSetAddress string
    RP set address.
    VrfName string
    VRF name.
    Device string
    A device name from the provider configuration.
    Address string
    Anycast RP address.
    RpSetAddress string
    RP set address.
    VrfName string
    VRF name.
    Device string
    A device name from the provider configuration.
    address String
    Anycast RP address.
    rpSetAddress String
    RP set address.
    vrfName String
    VRF name.
    device String
    A device name from the provider configuration.
    address string
    Anycast RP address.
    rpSetAddress string
    RP set address.
    vrfName string
    VRF name.
    device string
    A device name from the provider configuration.
    address str
    Anycast RP address.
    rp_set_address str
    RP set address.
    vrf_name str
    VRF name.
    device str
    A device name from the provider configuration.
    address String
    Anycast RP address.
    rpSetAddress String
    RP set address.
    vrfName String
    VRF name.
    device String
    A device name from the provider configuration.

    Outputs

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

    Get an existing PimAnycastRpPeer 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?: PimAnycastRpPeerState, opts?: CustomResourceOptions): PimAnycastRpPeer
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            address: Optional[str] = None,
            device: Optional[str] = None,
            rp_set_address: Optional[str] = None,
            vrf_name: Optional[str] = None) -> PimAnycastRpPeer
    func GetPimAnycastRpPeer(ctx *Context, name string, id IDInput, state *PimAnycastRpPeerState, opts ...ResourceOption) (*PimAnycastRpPeer, error)
    public static PimAnycastRpPeer Get(string name, Input<string> id, PimAnycastRpPeerState? state, CustomResourceOptions? opts = null)
    public static PimAnycastRpPeer get(String name, Output<String> id, PimAnycastRpPeerState 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
    Anycast RP address.
    Device string
    A device name from the provider configuration.
    RpSetAddress string
    RP set address.
    VrfName string
    VRF name.
    Address string
    Anycast RP address.
    Device string
    A device name from the provider configuration.
    RpSetAddress string
    RP set address.
    VrfName string
    VRF name.
    address String
    Anycast RP address.
    device String
    A device name from the provider configuration.
    rpSetAddress String
    RP set address.
    vrfName String
    VRF name.
    address string
    Anycast RP address.
    device string
    A device name from the provider configuration.
    rpSetAddress string
    RP set address.
    vrfName string
    VRF name.
    address str
    Anycast RP address.
    device str
    A device name from the provider configuration.
    rp_set_address str
    RP set address.
    vrf_name str
    VRF name.
    address String
    Anycast RP address.
    device String
    A device name from the provider configuration.
    rpSetAddress String
    RP set address.
    vrfName String
    VRF name.

    Import

     $ pulumi import nxos:index/pimAnycastRpPeer:PimAnycastRpPeer example "sys/pim/inst/dom-[default]/acastrpfunc/peer-[10.1.1.1/32]-peer-[20.1.1.1/32]"
    

    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