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

nxos.SubinterfaceVrf

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 subinterface VRF association.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Nxos = Lbrlabs.PulumiPackage.Nxos;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Nxos.SubinterfaceVrf("example", new()
        {
            InterfaceId = "eth1/10.124",
            VrfDn = "sys/inst-VRF123",
        });
    
    });
    
    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.NewSubinterfaceVrf(ctx, "example", &nxos.SubinterfaceVrfArgs{
    			InterfaceId: pulumi.String("eth1/10.124"),
    			VrfDn:       pulumi.String("sys/inst-VRF123"),
    		})
    		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.SubinterfaceVrf;
    import com.pulumi.nxos.SubinterfaceVrfArgs;
    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 SubinterfaceVrf("example", SubinterfaceVrfArgs.builder()        
                .interfaceId("eth1/10.124")
                .vrfDn("sys/inst-VRF123")
                .build());
    
        }
    }
    
    import pulumi
    import lbrlabs_pulumi_nxos as nxos
    
    example = nxos.SubinterfaceVrf("example",
        interface_id="eth1/10.124",
        vrf_dn="sys/inst-VRF123")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as nxos from "@lbrlabs/pulumi-nxos";
    
    const example = new nxos.SubinterfaceVrf("example", {
        interfaceId: "eth1/10.124",
        vrfDn: "sys/inst-VRF123",
    });
    
    resources:
      example:
        type: nxos:SubinterfaceVrf
        properties:
          interfaceId: eth1/10.124
          vrfDn: sys/inst-VRF123
    

    Create SubinterfaceVrf Resource

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

    Constructor syntax

    new SubinterfaceVrf(name: string, args: SubinterfaceVrfArgs, opts?: CustomResourceOptions);
    @overload
    def SubinterfaceVrf(resource_name: str,
                        args: SubinterfaceVrfArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def SubinterfaceVrf(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        interface_id: Optional[str] = None,
                        vrf_dn: Optional[str] = None,
                        device: Optional[str] = None)
    func NewSubinterfaceVrf(ctx *Context, name string, args SubinterfaceVrfArgs, opts ...ResourceOption) (*SubinterfaceVrf, error)
    public SubinterfaceVrf(string name, SubinterfaceVrfArgs args, CustomResourceOptions? opts = null)
    public SubinterfaceVrf(String name, SubinterfaceVrfArgs args)
    public SubinterfaceVrf(String name, SubinterfaceVrfArgs args, CustomResourceOptions options)
    
    type: nxos:SubinterfaceVrf
    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 SubinterfaceVrfArgs
    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 SubinterfaceVrfArgs
    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 SubinterfaceVrfArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SubinterfaceVrfArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SubinterfaceVrfArgs
    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 subinterfaceVrfResource = new Nxos.SubinterfaceVrf("subinterfaceVrfResource", new()
    {
        InterfaceId = "string",
        VrfDn = "string",
        Device = "string",
    });
    
    example, err := nxos.NewSubinterfaceVrf(ctx, "subinterfaceVrfResource", &nxos.SubinterfaceVrfArgs{
    	InterfaceId: pulumi.String("string"),
    	VrfDn:       pulumi.String("string"),
    	Device:      pulumi.String("string"),
    })
    
    var subinterfaceVrfResource = new SubinterfaceVrf("subinterfaceVrfResource", SubinterfaceVrfArgs.builder()
        .interfaceId("string")
        .vrfDn("string")
        .device("string")
        .build());
    
    subinterface_vrf_resource = nxos.SubinterfaceVrf("subinterfaceVrfResource",
        interface_id="string",
        vrf_dn="string",
        device="string")
    
    const subinterfaceVrfResource = new nxos.SubinterfaceVrf("subinterfaceVrfResource", {
        interfaceId: "string",
        vrfDn: "string",
        device: "string",
    });
    
    type: nxos:SubinterfaceVrf
    properties:
        device: string
        interfaceId: string
        vrfDn: string
    

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

    InterfaceId string
    Must match first field in the output of show intf brief. Example: eth1/1.10.
    VrfDn string
    DN of VRF. For example: sys/inst-VRF1.
    Device string
    A device name from the provider configuration.
    InterfaceId string
    Must match first field in the output of show intf brief. Example: eth1/1.10.
    VrfDn string
    DN of VRF. For example: sys/inst-VRF1.
    Device string
    A device name from the provider configuration.
    interfaceId String
    Must match first field in the output of show intf brief. Example: eth1/1.10.
    vrfDn String
    DN of VRF. For example: sys/inst-VRF1.
    device String
    A device name from the provider configuration.
    interfaceId string
    Must match first field in the output of show intf brief. Example: eth1/1.10.
    vrfDn string
    DN of VRF. For example: sys/inst-VRF1.
    device string
    A device name from the provider configuration.
    interface_id str
    Must match first field in the output of show intf brief. Example: eth1/1.10.
    vrf_dn str
    DN of VRF. For example: sys/inst-VRF1.
    device str
    A device name from the provider configuration.
    interfaceId String
    Must match first field in the output of show intf brief. Example: eth1/1.10.
    vrfDn String
    DN of VRF. For example: sys/inst-VRF1.
    device String
    A device name from the provider configuration.

    Outputs

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

    Get an existing SubinterfaceVrf 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?: SubinterfaceVrfState, opts?: CustomResourceOptions): SubinterfaceVrf
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            device: Optional[str] = None,
            interface_id: Optional[str] = None,
            vrf_dn: Optional[str] = None) -> SubinterfaceVrf
    func GetSubinterfaceVrf(ctx *Context, name string, id IDInput, state *SubinterfaceVrfState, opts ...ResourceOption) (*SubinterfaceVrf, error)
    public static SubinterfaceVrf Get(string name, Input<string> id, SubinterfaceVrfState? state, CustomResourceOptions? opts = null)
    public static SubinterfaceVrf get(String name, Output<String> id, SubinterfaceVrfState 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.
    InterfaceId string
    Must match first field in the output of show intf brief. Example: eth1/1.10.
    VrfDn string
    DN of VRF. For example: sys/inst-VRF1.
    Device string
    A device name from the provider configuration.
    InterfaceId string
    Must match first field in the output of show intf brief. Example: eth1/1.10.
    VrfDn string
    DN of VRF. For example: sys/inst-VRF1.
    device String
    A device name from the provider configuration.
    interfaceId String
    Must match first field in the output of show intf brief. Example: eth1/1.10.
    vrfDn String
    DN of VRF. For example: sys/inst-VRF1.
    device string
    A device name from the provider configuration.
    interfaceId string
    Must match first field in the output of show intf brief. Example: eth1/1.10.
    vrfDn string
    DN of VRF. For example: sys/inst-VRF1.
    device str
    A device name from the provider configuration.
    interface_id str
    Must match first field in the output of show intf brief. Example: eth1/1.10.
    vrf_dn str
    DN of VRF. For example: sys/inst-VRF1.
    device String
    A device name from the provider configuration.
    interfaceId String
    Must match first field in the output of show intf brief. Example: eth1/1.10.
    vrfDn String
    DN of VRF. For example: sys/inst-VRF1.

    Import

     $ pulumi import nxos:index/subinterfaceVrf:SubinterfaceVrf example "sys/intf/encrtd-[eth1/10.124]/rtvrfMbr"
    

    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