Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cisco NX OS Resource Provider
  3. API Docs
  4. VpcInterface
Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs
lbrlabs/pulumi-nxos

nxos.VpcInterface

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 the vPC interface 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.VpcInterface("example", new()
    {
        PortChannelInterfaceDn = "sys/intf/aggr-[po1]",
        VpcInterfaceId = 1,
    });

});

    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.NewVpcInterface(ctx, "example", &nxos.VpcInterfaceArgs{
			PortChannelInterfaceDn: pulumi.String("sys/intf/aggr-[po1]"),
			VpcInterfaceId:         pulumi.Int(1),
		})
		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.VpcInterface;
import com.pulumi.nxos.VpcInterfaceArgs;
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 VpcInterface("example", VpcInterfaceArgs.builder()        
            .portChannelInterfaceDn("sys/intf/aggr-[po1]")
            .vpcInterfaceId(1)
            .build());

    }
}

    import pulumi
import lbrlabs_pulumi_nxos as nxos

example = nxos.VpcInterface("example",
    port_channel_interface_dn="sys/intf/aggr-[po1]",
    vpc_interface_id=1)

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

const example = new nxos.VpcInterface("example", {
    portChannelInterfaceDn: "sys/intf/aggr-[po1]",
    vpcInterfaceId: 1,
});

    resources:
  example:
    type: nxos:VpcInterface
    properties:
      portChannelInterfaceDn: sys/intf/aggr-[po1]
      vpcInterfaceId: 1

    Create VpcInterface Resource

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

    Constructor syntax

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

@overload
def VpcInterface(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 vpc_interface_id: Optional[int] = None,
                 device: Optional[str] = None,
                 port_channel_interface_dn: Optional[str] = None)
    func NewVpcInterface(ctx *Context, name string, args VpcInterfaceArgs, opts ...ResourceOption) (*VpcInterface, error)
    public VpcInterface(string name, VpcInterfaceArgs args, CustomResourceOptions? opts = null)
    public VpcInterface(String name, VpcInterfaceArgs args)
public VpcInterface(String name, VpcInterfaceArgs args, CustomResourceOptions options)

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

    example, err := nxos.NewVpcInterface(ctx, "vpcInterfaceResource", &nxos.VpcInterfaceArgs{
	VpcInterfaceId:         pulumi.Int(0),
	Device:                 pulumi.String("string"),
	PortChannelInterfaceDn: pulumi.String("string"),
})

    var vpcInterfaceResource = new VpcInterface("vpcInterfaceResource", VpcInterfaceArgs.builder()
    .vpcInterfaceId(0)
    .device("string")
    .portChannelInterfaceDn("string")
    .build());

    vpc_interface_resource = nxos.VpcInterface("vpcInterfaceResource",
    vpc_interface_id=0,
    device="string",
    port_channel_interface_dn="string")

    const vpcInterfaceResource = new nxos.VpcInterface("vpcInterfaceResource", {
    vpcInterfaceId: 0,
    device: "string",
    portChannelInterfaceDn: "string",
});

    type: nxos:VpcInterface
properties:
    device: string
    portChannelInterfaceDn: string
    vpcInterfaceId: 0

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

    VpcInterfaceId int
    The vPC interface identifier. - Range: 1-16384
    Device string
    A device name from the provider configuration.
    PortChannelInterfaceDn string
    Port-channel interface DN.
    VpcInterfaceId int
    The vPC interface identifier. - Range: 1-16384
    Device string
    A device name from the provider configuration.
    PortChannelInterfaceDn string
    Port-channel interface DN.
    vpcInterfaceId Integer
    The vPC interface identifier. - Range: 1-16384
    device String
    A device name from the provider configuration.
    portChannelInterfaceDn String
    Port-channel interface DN.
    vpcInterfaceId number
    The vPC interface identifier. - Range: 1-16384
    device string
    A device name from the provider configuration.
    portChannelInterfaceDn string
    Port-channel interface DN.
    vpc_interface_id int
    The vPC interface identifier. - Range: 1-16384
    device str
    A device name from the provider configuration.
    port_channel_interface_dn str
    Port-channel interface DN.
    vpcInterfaceId Number
    The vPC interface identifier. - Range: 1-16384
    device String
    A device name from the provider configuration.
    portChannelInterfaceDn String
    Port-channel interface DN.

    Outputs

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

    Get an existing VpcInterface 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?: VpcInterfaceState, opts?: CustomResourceOptions): VpcInterface
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        device: Optional[str] = None,
        port_channel_interface_dn: Optional[str] = None,
        vpc_interface_id: Optional[int] = None) -> VpcInterface
    func GetVpcInterface(ctx *Context, name string, id IDInput, state *VpcInterfaceState, opts ...ResourceOption) (*VpcInterface, error)
    public static VpcInterface Get(string name, Input<string> id, VpcInterfaceState? state, CustomResourceOptions? opts = null)
    public static VpcInterface get(String name, Output<String> id, VpcInterfaceState 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.
    PortChannelInterfaceDn string
    Port-channel interface DN.
    VpcInterfaceId int
    The vPC interface identifier. - Range: 1-16384
    Device string
    A device name from the provider configuration.
    PortChannelInterfaceDn string
    Port-channel interface DN.
    VpcInterfaceId int
    The vPC interface identifier. - Range: 1-16384
    device String
    A device name from the provider configuration.
    portChannelInterfaceDn String
    Port-channel interface DN.
    vpcInterfaceId Integer
    The vPC interface identifier. - Range: 1-16384
    device string
    A device name from the provider configuration.
    portChannelInterfaceDn string
    Port-channel interface DN.
    vpcInterfaceId number
    The vPC interface identifier. - Range: 1-16384
    device str
    A device name from the provider configuration.
    port_channel_interface_dn str
    Port-channel interface DN.
    vpc_interface_id int
    The vPC interface identifier. - Range: 1-16384
    device String
    A device name from the provider configuration.
    portChannelInterfaceDn String
    Port-channel interface DN.
    vpcInterfaceId Number
    The vPC interface identifier. - Range: 1-16384

    Import

     $ pulumi import nxos:index/vpcInterface:VpcInterface example "sys/vpc/inst/dom/if-[1]"

    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