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

nxos.VrfRouting

Explore with Pulumi AI

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

    This resource can manage a VRF Route Distinguisher and VRF VNI.

    Example Usage

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Nxos = Lbrlabs.PulumiPackage.Nxos;

return await Deployment.RunAsync(() => 
{
    var example = new Nxos.VrfRouting("example", new()
    {
        RouteDistinguisher = "rd:unknown:0:0",
        Vrf = "VRF1",
    });

});

    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.NewVrfRouting(ctx, "example", &nxos.VrfRoutingArgs{
			RouteDistinguisher: pulumi.String("rd:unknown:0:0"),
			Vrf:                pulumi.String("VRF1"),
		})
		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.VrfRouting;
import com.pulumi.nxos.VrfRoutingArgs;
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 VrfRouting("example", VrfRoutingArgs.builder()        
            .routeDistinguisher("rd:unknown:0:0")
            .vrf("VRF1")
            .build());

    }
}

    import pulumi
import lbrlabs_pulumi_nxos as nxos

example = nxos.VrfRouting("example",
    route_distinguisher="rd:unknown:0:0",
    vrf="VRF1")

    import * as pulumi from "@pulumi/pulumi";
import * as nxos from "@lbrlabs/pulumi-nxos";

const example = new nxos.VrfRouting("example", {
    routeDistinguisher: "rd:unknown:0:0",
    vrf: "VRF1",
});

    resources:
  example:
    type: nxos:VrfRouting
    properties:
      routeDistinguisher: rd:unknown:0:0
      vrf: VRF1

    Create VrfRouting Resource

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

    Constructor syntax

    new VrfRouting(name: string, args: VrfRoutingArgs, opts?: CustomResourceOptions);
    @overload
def VrfRouting(resource_name: str,
               args: VrfRoutingArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def VrfRouting(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               vrf: Optional[str] = None,
               device: Optional[str] = None,
               route_distinguisher: Optional[str] = None)
    func NewVrfRouting(ctx *Context, name string, args VrfRoutingArgs, opts ...ResourceOption) (*VrfRouting, error)
    public VrfRouting(string name, VrfRoutingArgs args, CustomResourceOptions? opts = null)
    public VrfRouting(String name, VrfRoutingArgs args)
public VrfRouting(String name, VrfRoutingArgs args, CustomResourceOptions options)

    type: nxos:VrfRouting
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 VrfRoutingArgs
    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 VrfRoutingArgs
    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 VrfRoutingArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VrfRoutingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VrfRoutingArgs
    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 vrfRoutingResource = new Nxos.VrfRouting("vrfRoutingResource", new()
{
    Vrf = "string",
    Device = "string",
    RouteDistinguisher = "string",
});

    example, err := nxos.NewVrfRouting(ctx, "vrfRoutingResource", &nxos.VrfRoutingArgs{
	Vrf:                pulumi.String("string"),
	Device:             pulumi.String("string"),
	RouteDistinguisher: pulumi.String("string"),
})

    var vrfRoutingResource = new VrfRouting("vrfRoutingResource", VrfRoutingArgs.builder()
    .vrf("string")
    .device("string")
    .routeDistinguisher("string")
    .build());

    vrf_routing_resource = nxos.VrfRouting("vrfRoutingResource",
    vrf="string",
    device="string",
    route_distinguisher="string")

    const vrfRoutingResource = new nxos.VrfRouting("vrfRoutingResource", {
    vrf: "string",
    device: "string",
    routeDistinguisher: "string",
});

    type: nxos:VrfRouting
properties:
    device: string
    routeDistinguisher: string
    vrf: string

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

    Vrf string
    VRF name.
    Device string
    A device name from the provider configuration.
    RouteDistinguisher string
    Route Distinguisher value in NX-OS DME format. - Default value: unknown:unknown:0:0
    Vrf string
    VRF name.
    Device string
    A device name from the provider configuration.
    RouteDistinguisher string
    Route Distinguisher value in NX-OS DME format. - Default value: unknown:unknown:0:0
    vrf String
    VRF name.
    device String
    A device name from the provider configuration.
    routeDistinguisher String
    Route Distinguisher value in NX-OS DME format. - Default value: unknown:unknown:0:0
    vrf string
    VRF name.
    device string
    A device name from the provider configuration.
    routeDistinguisher string
    Route Distinguisher value in NX-OS DME format. - Default value: unknown:unknown:0:0
    vrf str
    VRF name.
    device str
    A device name from the provider configuration.
    route_distinguisher str
    Route Distinguisher value in NX-OS DME format. - Default value: unknown:unknown:0:0
    vrf String
    VRF name.
    device String
    A device name from the provider configuration.
    routeDistinguisher String
    Route Distinguisher value in NX-OS DME format. - Default value: unknown:unknown:0:0

    Outputs

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

    Get an existing VrfRouting 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?: VrfRoutingState, opts?: CustomResourceOptions): VrfRouting
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        device: Optional[str] = None,
        route_distinguisher: Optional[str] = None,
        vrf: Optional[str] = None) -> VrfRouting
    func GetVrfRouting(ctx *Context, name string, id IDInput, state *VrfRoutingState, opts ...ResourceOption) (*VrfRouting, error)
    public static VrfRouting Get(string name, Input<string> id, VrfRoutingState? state, CustomResourceOptions? opts = null)
    public static VrfRouting get(String name, Output<String> id, VrfRoutingState 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.
    RouteDistinguisher string
    Route Distinguisher value in NX-OS DME format. - Default value: unknown:unknown:0:0
    Vrf string
    VRF name.
    Device string
    A device name from the provider configuration.
    RouteDistinguisher string
    Route Distinguisher value in NX-OS DME format. - Default value: unknown:unknown:0:0
    Vrf string
    VRF name.
    device String
    A device name from the provider configuration.
    routeDistinguisher String
    Route Distinguisher value in NX-OS DME format. - Default value: unknown:unknown:0:0
    vrf String
    VRF name.
    device string
    A device name from the provider configuration.
    routeDistinguisher string
    Route Distinguisher value in NX-OS DME format. - Default value: unknown:unknown:0:0
    vrf string
    VRF name.
    device str
    A device name from the provider configuration.
    route_distinguisher str
    Route Distinguisher value in NX-OS DME format. - Default value: unknown:unknown:0:0
    vrf str
    VRF name.
    device String
    A device name from the provider configuration.
    routeDistinguisher String
    Route Distinguisher value in NX-OS DME format. - Default value: unknown:unknown:0:0
    vrf String
    VRF name.

    Import

     $ pulumi import nxos:index/vrfRouting:VrfRouting example "sys/inst-[VRF1]/dom-[VRF1]"

    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
    lbrlabs/pulumi-nxos