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

nxos.PimAnycastRp

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 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.PimAnycastRp("example", new()
        {
            LocalInterface = "eth1/10",
            SourceInterface = "eth1/10",
            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.NewPimAnycastRp(ctx, "example", &nxos.PimAnycastRpArgs{
    			LocalInterface:  pulumi.String("eth1/10"),
    			SourceInterface: pulumi.String("eth1/10"),
    			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.PimAnycastRp;
    import com.pulumi.nxos.PimAnycastRpArgs;
    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 PimAnycastRp("example", PimAnycastRpArgs.builder()        
                .localInterface("eth1/10")
                .sourceInterface("eth1/10")
                .vrfName("default")
                .build());
    
        }
    }
    
    import pulumi
    import lbrlabs_pulumi_nxos as nxos
    
    example = nxos.PimAnycastRp("example",
        local_interface="eth1/10",
        source_interface="eth1/10",
        vrf_name="default")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as nxos from "@lbrlabs/pulumi-nxos";
    
    const example = new nxos.PimAnycastRp("example", {
        localInterface: "eth1/10",
        sourceInterface: "eth1/10",
        vrfName: "default",
    });
    
    resources:
      example:
        type: nxos:PimAnycastRp
        properties:
          localInterface: eth1/10
          sourceInterface: eth1/10
          vrfName: default
    

    Create PimAnycastRp Resource

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

    Constructor syntax

    new PimAnycastRp(name: string, args: PimAnycastRpArgs, opts?: CustomResourceOptions);
    @overload
    def PimAnycastRp(resource_name: str,
                     args: PimAnycastRpArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def PimAnycastRp(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     vrf_name: Optional[str] = None,
                     device: Optional[str] = None,
                     local_interface: Optional[str] = None,
                     source_interface: Optional[str] = None)
    func NewPimAnycastRp(ctx *Context, name string, args PimAnycastRpArgs, opts ...ResourceOption) (*PimAnycastRp, error)
    public PimAnycastRp(string name, PimAnycastRpArgs args, CustomResourceOptions? opts = null)
    public PimAnycastRp(String name, PimAnycastRpArgs args)
    public PimAnycastRp(String name, PimAnycastRpArgs args, CustomResourceOptions options)
    
    type: nxos:PimAnycastRp
    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 PimAnycastRpArgs
    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 PimAnycastRpArgs
    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 PimAnycastRpArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PimAnycastRpArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PimAnycastRpArgs
    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 pimAnycastRpResource = new Nxos.PimAnycastRp("pimAnycastRpResource", new()
    {
        VrfName = "string",
        Device = "string",
        LocalInterface = "string",
        SourceInterface = "string",
    });
    
    example, err := nxos.NewPimAnycastRp(ctx, "pimAnycastRpResource", &nxos.PimAnycastRpArgs{
    	VrfName:         pulumi.String("string"),
    	Device:          pulumi.String("string"),
    	LocalInterface:  pulumi.String("string"),
    	SourceInterface: pulumi.String("string"),
    })
    
    var pimAnycastRpResource = new PimAnycastRp("pimAnycastRpResource", PimAnycastRpArgs.builder()
        .vrfName("string")
        .device("string")
        .localInterface("string")
        .sourceInterface("string")
        .build());
    
    pim_anycast_rp_resource = nxos.PimAnycastRp("pimAnycastRpResource",
        vrf_name="string",
        device="string",
        local_interface="string",
        source_interface="string")
    
    const pimAnycastRpResource = new nxos.PimAnycastRp("pimAnycastRpResource", {
        vrfName: "string",
        device: "string",
        localInterface: "string",
        sourceInterface: "string",
    });
    
    type: nxos:PimAnycastRp
    properties:
        device: string
        localInterface: string
        sourceInterface: string
        vrfName: string
    

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

    VrfName string
    VRF name.
    Device string
    A device name from the provider configuration.
    LocalInterface string
    Must match first field in the output of show intf brief. Example: eth1/1.
    SourceInterface string
    Must match first field in the output of show intf brief. Example: eth1/1.
    VrfName string
    VRF name.
    Device string
    A device name from the provider configuration.
    LocalInterface string
    Must match first field in the output of show intf brief. Example: eth1/1.
    SourceInterface string
    Must match first field in the output of show intf brief. Example: eth1/1.
    vrfName String
    VRF name.
    device String
    A device name from the provider configuration.
    localInterface String
    Must match first field in the output of show intf brief. Example: eth1/1.
    sourceInterface String
    Must match first field in the output of show intf brief. Example: eth1/1.
    vrfName string
    VRF name.
    device string
    A device name from the provider configuration.
    localInterface string
    Must match first field in the output of show intf brief. Example: eth1/1.
    sourceInterface string
    Must match first field in the output of show intf brief. Example: eth1/1.
    vrf_name str
    VRF name.
    device str
    A device name from the provider configuration.
    local_interface str
    Must match first field in the output of show intf brief. Example: eth1/1.
    source_interface str
    Must match first field in the output of show intf brief. Example: eth1/1.
    vrfName String
    VRF name.
    device String
    A device name from the provider configuration.
    localInterface String
    Must match first field in the output of show intf brief. Example: eth1/1.
    sourceInterface String
    Must match first field in the output of show intf brief. Example: eth1/1.

    Outputs

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

    Get an existing PimAnycastRp 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?: PimAnycastRpState, opts?: CustomResourceOptions): PimAnycastRp
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            device: Optional[str] = None,
            local_interface: Optional[str] = None,
            source_interface: Optional[str] = None,
            vrf_name: Optional[str] = None) -> PimAnycastRp
    func GetPimAnycastRp(ctx *Context, name string, id IDInput, state *PimAnycastRpState, opts ...ResourceOption) (*PimAnycastRp, error)
    public static PimAnycastRp Get(string name, Input<string> id, PimAnycastRpState? state, CustomResourceOptions? opts = null)
    public static PimAnycastRp get(String name, Output<String> id, PimAnycastRpState 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:
    Device string
    A device name from the provider configuration.
    LocalInterface string
    Must match first field in the output of show intf brief. Example: eth1/1.
    SourceInterface string
    Must match first field in the output of show intf brief. Example: eth1/1.
    VrfName string
    VRF name.
    Device string
    A device name from the provider configuration.
    LocalInterface string
    Must match first field in the output of show intf brief. Example: eth1/1.
    SourceInterface string
    Must match first field in the output of show intf brief. Example: eth1/1.
    VrfName string
    VRF name.
    device String
    A device name from the provider configuration.
    localInterface String
    Must match first field in the output of show intf brief. Example: eth1/1.
    sourceInterface String
    Must match first field in the output of show intf brief. Example: eth1/1.
    vrfName String
    VRF name.
    device string
    A device name from the provider configuration.
    localInterface string
    Must match first field in the output of show intf brief. Example: eth1/1.
    sourceInterface string
    Must match first field in the output of show intf brief. Example: eth1/1.
    vrfName string
    VRF name.
    device str
    A device name from the provider configuration.
    local_interface str
    Must match first field in the output of show intf brief. Example: eth1/1.
    source_interface str
    Must match first field in the output of show intf brief. Example: eth1/1.
    vrf_name str
    VRF name.
    device String
    A device name from the provider configuration.
    localInterface String
    Must match first field in the output of show intf brief. Example: eth1/1.
    sourceInterface String
    Must match first field in the output of show intf brief. Example: eth1/1.
    vrfName String
    VRF name.

    Import

     $ pulumi import nxos:index/pimAnycastRp:PimAnycastRp example "sys/pim/inst/dom-[default]/acastrpfunc"
    

    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