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

nxos.Vrf

Explore with Pulumi AI

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

    This resource can manage a VRF.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Nxos = Lbrlabs.PulumiPackage.Nxos;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Nxos.Vrf("example", new()
        {
            Description = "My VRF1 Description",
            Encap = "vxlan-103901",
        });
    
    });
    
    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.NewVrf(ctx, "example", &nxos.VrfArgs{
    			Description: pulumi.String("My VRF1 Description"),
    			Encap:       pulumi.String("vxlan-103901"),
    		})
    		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.Vrf;
    import com.pulumi.nxos.VrfArgs;
    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 Vrf("example", VrfArgs.builder()        
                .description("My VRF1 Description")
                .encap("vxlan-103901")
                .build());
    
        }
    }
    
    import pulumi
    import lbrlabs_pulumi_nxos as nxos
    
    example = nxos.Vrf("example",
        description="My VRF1 Description",
        encap="vxlan-103901")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as nxos from "@lbrlabs/pulumi-nxos";
    
    const example = new nxos.Vrf("example", {
        description: "My VRF1 Description",
        encap: "vxlan-103901",
    });
    
    resources:
      example:
        type: nxos:Vrf
        properties:
          description: My VRF1 Description
          encap: vxlan-103901
    

    Create Vrf Resource

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

    Constructor syntax

    new Vrf(name: string, args?: VrfArgs, opts?: CustomResourceOptions);
    @overload
    def Vrf(resource_name: str,
            args: Optional[VrfArgs] = None,
            opts: Optional[ResourceOptions] = None)
    
    @overload
    def Vrf(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            device: Optional[str] = None,
            encap: Optional[str] = None,
            name: Optional[str] = None)
    func NewVrf(ctx *Context, name string, args *VrfArgs, opts ...ResourceOption) (*Vrf, error)
    public Vrf(string name, VrfArgs? args = null, CustomResourceOptions? opts = null)
    public Vrf(String name, VrfArgs args)
    public Vrf(String name, VrfArgs args, CustomResourceOptions options)
    
    type: nxos:Vrf
    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 VrfArgs
    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 VrfArgs
    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 VrfArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VrfArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VrfArgs
    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 vrfResource = new Nxos.Vrf("vrfResource", new()
    {
        Description = "string",
        Device = "string",
        Encap = "string",
        Name = "string",
    });
    
    example, err := nxos.NewVrf(ctx, "vrfResource", &nxos.VrfArgs{
    	Description: pulumi.String("string"),
    	Device:      pulumi.String("string"),
    	Encap:       pulumi.String("string"),
    	Name:        pulumi.String("string"),
    })
    
    var vrfResource = new Vrf("vrfResource", VrfArgs.builder()
        .description("string")
        .device("string")
        .encap("string")
        .name("string")
        .build());
    
    vrf_resource = nxos.Vrf("vrfResource",
        description="string",
        device="string",
        encap="string",
        name="string")
    
    const vrfResource = new nxos.Vrf("vrfResource", {
        description: "string",
        device: "string",
        encap: "string",
        name: "string",
    });
    
    type: nxos:Vrf
    properties:
        description: string
        device: string
        encap: string
        name: string
    

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

    Description string
    VRF description.
    Device string
    A device name from the provider configuration.
    Encap string
    Encap for this Context, supported formats: unknown, vlan-%d or vxlan-%d. - Default value: unknown
    Name string
    VRF name.
    Description string
    VRF description.
    Device string
    A device name from the provider configuration.
    Encap string
    Encap for this Context, supported formats: unknown, vlan-%d or vxlan-%d. - Default value: unknown
    Name string
    VRF name.
    description String
    VRF description.
    device String
    A device name from the provider configuration.
    encap String
    Encap for this Context, supported formats: unknown, vlan-%d or vxlan-%d. - Default value: unknown
    name String
    VRF name.
    description string
    VRF description.
    device string
    A device name from the provider configuration.
    encap string
    Encap for this Context, supported formats: unknown, vlan-%d or vxlan-%d. - Default value: unknown
    name string
    VRF name.
    description str
    VRF description.
    device str
    A device name from the provider configuration.
    encap str
    Encap for this Context, supported formats: unknown, vlan-%d or vxlan-%d. - Default value: unknown
    name str
    VRF name.
    description String
    VRF description.
    device String
    A device name from the provider configuration.
    encap String
    Encap for this Context, supported formats: unknown, vlan-%d or vxlan-%d. - Default value: unknown
    name String
    VRF name.

    Outputs

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

    Get an existing Vrf 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?: VrfState, opts?: CustomResourceOptions): Vrf
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            device: Optional[str] = None,
            encap: Optional[str] = None,
            name: Optional[str] = None) -> Vrf
    func GetVrf(ctx *Context, name string, id IDInput, state *VrfState, opts ...ResourceOption) (*Vrf, error)
    public static Vrf Get(string name, Input<string> id, VrfState? state, CustomResourceOptions? opts = null)
    public static Vrf get(String name, Output<String> id, VrfState 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
    VRF description.
    Device string
    A device name from the provider configuration.
    Encap string
    Encap for this Context, supported formats: unknown, vlan-%d or vxlan-%d. - Default value: unknown
    Name string
    VRF name.
    Description string
    VRF description.
    Device string
    A device name from the provider configuration.
    Encap string
    Encap for this Context, supported formats: unknown, vlan-%d or vxlan-%d. - Default value: unknown
    Name string
    VRF name.
    description String
    VRF description.
    device String
    A device name from the provider configuration.
    encap String
    Encap for this Context, supported formats: unknown, vlan-%d or vxlan-%d. - Default value: unknown
    name String
    VRF name.
    description string
    VRF description.
    device string
    A device name from the provider configuration.
    encap string
    Encap for this Context, supported formats: unknown, vlan-%d or vxlan-%d. - Default value: unknown
    name string
    VRF name.
    description str
    VRF description.
    device str
    A device name from the provider configuration.
    encap str
    Encap for this Context, supported formats: unknown, vlan-%d or vxlan-%d. - Default value: unknown
    name str
    VRF name.
    description String
    VRF description.
    device String
    A device name from the provider configuration.
    encap String
    Encap for this Context, supported formats: unknown, vlan-%d or vxlan-%d. - Default value: unknown
    name String
    VRF name.

    Import

     $ pulumi import nxos:index/vrf:Vrf example "sys/inst-[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