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

nxos.PortChannelInterface

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 port-channel interface.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Nxos = Lbrlabs.PulumiPackage.Nxos;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Nxos.PortChannelInterface("example", new()
        {
            AccessVlan = "vlan-1",
            AdminState = "up",
            AutoNegotiation = "on",
            Bandwidth = 0,
            Delay = 1,
            Description = "My Description",
            Duplex = "auto",
            InterfaceId = "po1",
            Layer = "Layer2",
            LinkLogging = "enable",
            MaximumLinks = 10,
            Medium = "broadcast",
            MinimumLinks = 2,
            Mode = "access",
            Mtu = 1500,
            NativeVlan = "unknown",
            PortChannelMode = "active",
            Speed = "auto",
            SuspendIndividual = "disable",
            TrunkVlans = "1-4094",
            UserConfiguredFlags = "admin_layer,admin_mtu,admin_state",
        });
    
    });
    
    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.NewPortChannelInterface(ctx, "example", &nxos.PortChannelInterfaceArgs{
    			AccessVlan:          pulumi.String("vlan-1"),
    			AdminState:          pulumi.String("up"),
    			AutoNegotiation:     pulumi.String("on"),
    			Bandwidth:           pulumi.Int(0),
    			Delay:               pulumi.Int(1),
    			Description:         pulumi.String("My Description"),
    			Duplex:              pulumi.String("auto"),
    			InterfaceId:         pulumi.String("po1"),
    			Layer:               pulumi.String("Layer2"),
    			LinkLogging:         pulumi.String("enable"),
    			MaximumLinks:        pulumi.Int(10),
    			Medium:              pulumi.String("broadcast"),
    			MinimumLinks:        pulumi.Int(2),
    			Mode:                pulumi.String("access"),
    			Mtu:                 pulumi.Int(1500),
    			NativeVlan:          pulumi.String("unknown"),
    			PortChannelMode:     pulumi.String("active"),
    			Speed:               pulumi.String("auto"),
    			SuspendIndividual:   pulumi.String("disable"),
    			TrunkVlans:          pulumi.String("1-4094"),
    			UserConfiguredFlags: pulumi.String("admin_layer,admin_mtu,admin_state"),
    		})
    		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.PortChannelInterface;
    import com.pulumi.nxos.PortChannelInterfaceArgs;
    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 PortChannelInterface("example", PortChannelInterfaceArgs.builder()        
                .accessVlan("vlan-1")
                .adminState("up")
                .autoNegotiation("on")
                .bandwidth(0)
                .delay(1)
                .description("My Description")
                .duplex("auto")
                .interfaceId("po1")
                .layer("Layer2")
                .linkLogging("enable")
                .maximumLinks(10)
                .medium("broadcast")
                .minimumLinks(2)
                .mode("access")
                .mtu(1500)
                .nativeVlan("unknown")
                .portChannelMode("active")
                .speed("auto")
                .suspendIndividual("disable")
                .trunkVlans("1-4094")
                .userConfiguredFlags("admin_layer,admin_mtu,admin_state")
                .build());
    
        }
    }
    
    import pulumi
    import lbrlabs_pulumi_nxos as nxos
    
    example = nxos.PortChannelInterface("example",
        access_vlan="vlan-1",
        admin_state="up",
        auto_negotiation="on",
        bandwidth=0,
        delay=1,
        description="My Description",
        duplex="auto",
        interface_id="po1",
        layer="Layer2",
        link_logging="enable",
        maximum_links=10,
        medium="broadcast",
        minimum_links=2,
        mode="access",
        mtu=1500,
        native_vlan="unknown",
        port_channel_mode="active",
        speed="auto",
        suspend_individual="disable",
        trunk_vlans="1-4094",
        user_configured_flags="admin_layer,admin_mtu,admin_state")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as nxos from "@lbrlabs/pulumi-nxos";
    
    const example = new nxos.PortChannelInterface("example", {
        accessVlan: "vlan-1",
        adminState: "up",
        autoNegotiation: "on",
        bandwidth: 0,
        delay: 1,
        description: "My Description",
        duplex: "auto",
        interfaceId: "po1",
        layer: "Layer2",
        linkLogging: "enable",
        maximumLinks: 10,
        medium: "broadcast",
        minimumLinks: 2,
        mode: "access",
        mtu: 1500,
        nativeVlan: "unknown",
        portChannelMode: "active",
        speed: "auto",
        suspendIndividual: "disable",
        trunkVlans: "1-4094",
        userConfiguredFlags: "admin_layer,admin_mtu,admin_state",
    });
    
    resources:
      example:
        type: nxos:PortChannelInterface
        properties:
          accessVlan: vlan-1
          adminState: up
          autoNegotiation: on
          bandwidth: 0
          delay: 1
          description: My Description
          duplex: auto
          interfaceId: po1
          layer: Layer2
          linkLogging: enable
          maximumLinks: 10
          medium: broadcast
          minimumLinks: 2
          mode: access
          mtu: 1500
          nativeVlan: unknown
          portChannelMode: active
          speed: auto
          suspendIndividual: disable
          trunkVlans: 1-4094
          userConfiguredFlags: admin_layer,admin_mtu,admin_state
    

    Create PortChannelInterface Resource

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

    Constructor syntax

    new PortChannelInterface(name: string, args: PortChannelInterfaceArgs, opts?: CustomResourceOptions);
    @overload
    def PortChannelInterface(resource_name: str,
                             args: PortChannelInterfaceArgs,
                             opts: Optional[ResourceOptions] = None)
    
    @overload
    def PortChannelInterface(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             interface_id: Optional[str] = None,
                             link_logging: Optional[str] = None,
                             description: Optional[str] = None,
                             maximum_links: Optional[int] = None,
                             minimum_links: Optional[int] = None,
                             medium: Optional[str] = None,
                             device: Optional[str] = None,
                             duplex: Optional[str] = None,
                             admin_state: Optional[str] = None,
                             layer: Optional[str] = None,
                             access_vlan: Optional[str] = None,
                             bandwidth: Optional[int] = None,
                             auto_negotiation: Optional[str] = None,
                             delay: Optional[int] = None,
                             mode: Optional[str] = None,
                             mtu: Optional[int] = None,
                             native_vlan: Optional[str] = None,
                             port_channel_mode: Optional[str] = None,
                             speed: Optional[str] = None,
                             suspend_individual: Optional[str] = None,
                             trunk_vlans: Optional[str] = None,
                             user_configured_flags: Optional[str] = None)
    func NewPortChannelInterface(ctx *Context, name string, args PortChannelInterfaceArgs, opts ...ResourceOption) (*PortChannelInterface, error)
    public PortChannelInterface(string name, PortChannelInterfaceArgs args, CustomResourceOptions? opts = null)
    public PortChannelInterface(String name, PortChannelInterfaceArgs args)
    public PortChannelInterface(String name, PortChannelInterfaceArgs args, CustomResourceOptions options)
    
    type: nxos:PortChannelInterface
    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 PortChannelInterfaceArgs
    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 PortChannelInterfaceArgs
    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 PortChannelInterfaceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PortChannelInterfaceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PortChannelInterfaceArgs
    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 portChannelInterfaceResource = new Nxos.PortChannelInterface("portChannelInterfaceResource", new()
    {
        InterfaceId = "string",
        LinkLogging = "string",
        Description = "string",
        MaximumLinks = 0,
        MinimumLinks = 0,
        Medium = "string",
        Device = "string",
        Duplex = "string",
        AdminState = "string",
        Layer = "string",
        AccessVlan = "string",
        Bandwidth = 0,
        AutoNegotiation = "string",
        Delay = 0,
        Mode = "string",
        Mtu = 0,
        NativeVlan = "string",
        PortChannelMode = "string",
        Speed = "string",
        SuspendIndividual = "string",
        TrunkVlans = "string",
        UserConfiguredFlags = "string",
    });
    
    example, err := nxos.NewPortChannelInterface(ctx, "portChannelInterfaceResource", &nxos.PortChannelInterfaceArgs{
    	InterfaceId:         pulumi.String("string"),
    	LinkLogging:         pulumi.String("string"),
    	Description:         pulumi.String("string"),
    	MaximumLinks:        pulumi.Int(0),
    	MinimumLinks:        pulumi.Int(0),
    	Medium:              pulumi.String("string"),
    	Device:              pulumi.String("string"),
    	Duplex:              pulumi.String("string"),
    	AdminState:          pulumi.String("string"),
    	Layer:               pulumi.String("string"),
    	AccessVlan:          pulumi.String("string"),
    	Bandwidth:           pulumi.Int(0),
    	AutoNegotiation:     pulumi.String("string"),
    	Delay:               pulumi.Int(0),
    	Mode:                pulumi.String("string"),
    	Mtu:                 pulumi.Int(0),
    	NativeVlan:          pulumi.String("string"),
    	PortChannelMode:     pulumi.String("string"),
    	Speed:               pulumi.String("string"),
    	SuspendIndividual:   pulumi.String("string"),
    	TrunkVlans:          pulumi.String("string"),
    	UserConfiguredFlags: pulumi.String("string"),
    })
    
    var portChannelInterfaceResource = new PortChannelInterface("portChannelInterfaceResource", PortChannelInterfaceArgs.builder()
        .interfaceId("string")
        .linkLogging("string")
        .description("string")
        .maximumLinks(0)
        .minimumLinks(0)
        .medium("string")
        .device("string")
        .duplex("string")
        .adminState("string")
        .layer("string")
        .accessVlan("string")
        .bandwidth(0)
        .autoNegotiation("string")
        .delay(0)
        .mode("string")
        .mtu(0)
        .nativeVlan("string")
        .portChannelMode("string")
        .speed("string")
        .suspendIndividual("string")
        .trunkVlans("string")
        .userConfiguredFlags("string")
        .build());
    
    port_channel_interface_resource = nxos.PortChannelInterface("portChannelInterfaceResource",
        interface_id="string",
        link_logging="string",
        description="string",
        maximum_links=0,
        minimum_links=0,
        medium="string",
        device="string",
        duplex="string",
        admin_state="string",
        layer="string",
        access_vlan="string",
        bandwidth=0,
        auto_negotiation="string",
        delay=0,
        mode="string",
        mtu=0,
        native_vlan="string",
        port_channel_mode="string",
        speed="string",
        suspend_individual="string",
        trunk_vlans="string",
        user_configured_flags="string")
    
    const portChannelInterfaceResource = new nxos.PortChannelInterface("portChannelInterfaceResource", {
        interfaceId: "string",
        linkLogging: "string",
        description: "string",
        maximumLinks: 0,
        minimumLinks: 0,
        medium: "string",
        device: "string",
        duplex: "string",
        adminState: "string",
        layer: "string",
        accessVlan: "string",
        bandwidth: 0,
        autoNegotiation: "string",
        delay: 0,
        mode: "string",
        mtu: 0,
        nativeVlan: "string",
        portChannelMode: "string",
        speed: "string",
        suspendIndividual: "string",
        trunkVlans: "string",
        userConfiguredFlags: "string",
    });
    
    type: nxos:PortChannelInterface
    properties:
        accessVlan: string
        adminState: string
        autoNegotiation: string
        bandwidth: 0
        delay: 0
        description: string
        device: string
        duplex: string
        interfaceId: string
        layer: string
        linkLogging: string
        maximumLinks: 0
        medium: string
        minimumLinks: 0
        mode: string
        mtu: 0
        nativeVlan: string
        portChannelMode: string
        speed: string
        suspendIndividual: string
        trunkVlans: string
        userConfiguredFlags: string
    

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

    InterfaceId string
    Must match first field in the output of show intf brief. Example: po1.
    AccessVlan string
    Access VLAN. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: vlan-1
    AdminState string
    Administrative port state. - Choices: up, down - Default value: up
    AutoNegotiation string
    Administrative port auto-negotiation. - Choices: on, off, 25G - Default value: on
    Bandwidth int
    The bandwidth parameter for a routed interface, port channel, or subinterface. - Range: 0-3200000000 - Default value: 0
    Delay int
    The administrative port delay time. - Range: 1-16777215 - Default value: 1
    Description string
    Interface description.
    Device string
    A device name from the provider configuration.
    Duplex string
    Duplex. - Choices: auto, full, half - Default value: auto
    Layer string
    Administrative port layer. - Choices: Layer2, Layer3 - Default value: Layer2
    LinkLogging string
    Administrative link logging. - Choices: default, enable, disable - Default value: default
    MaximumLinks int
    Maximum links. - Range: 1-32 - Default value: 32
    Medium string
    The administrative port medium type. - Choices: broadcast, p2p - Default value: broadcast
    MinimumLinks int
    Minimum links. - Range: 1-32 - Default value: 1
    Mode string
    Administrative port mode. - Choices: access, trunk, fex-fabric, dot1q-tunnel, promiscuous, host, trunk_secondary, trunk_promiscuous, vntag - Default value: access
    Mtu int
    Administrative port MTU. - Range: 576-9216 - Default value: 1500
    NativeVlan string
    Native VLAN. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: vlan-1
    PortChannelMode string
    The aggregated interface protocol channel mode. - Choices: on, static, active, passive, mac-pin - Default value: on
    Speed string
    Administrative port speed. - Choices: unknown, 100M, 1G, 10G, 40G, auto, auto 100M, auto 100M 1G, 100G, 25G, 10M, 50G, 200G, 400G, 2.5G, 5G, auto 2.5G 5G 10G, auto 100M 1G 2.5G 5G - Default value: auto
    SuspendIndividual string
    Suspend Individual Port. - Choices: enable, disable - Default value: enable
    TrunkVlans string
    List of trunk VLANs. - Default value: 1-4094
    UserConfiguredFlags string
    Port User Config Flags.
    InterfaceId string
    Must match first field in the output of show intf brief. Example: po1.
    AccessVlan string
    Access VLAN. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: vlan-1
    AdminState string
    Administrative port state. - Choices: up, down - Default value: up
    AutoNegotiation string
    Administrative port auto-negotiation. - Choices: on, off, 25G - Default value: on
    Bandwidth int
    The bandwidth parameter for a routed interface, port channel, or subinterface. - Range: 0-3200000000 - Default value: 0
    Delay int
    The administrative port delay time. - Range: 1-16777215 - Default value: 1
    Description string
    Interface description.
    Device string
    A device name from the provider configuration.
    Duplex string
    Duplex. - Choices: auto, full, half - Default value: auto
    Layer string
    Administrative port layer. - Choices: Layer2, Layer3 - Default value: Layer2
    LinkLogging string
    Administrative link logging. - Choices: default, enable, disable - Default value: default
    MaximumLinks int
    Maximum links. - Range: 1-32 - Default value: 32
    Medium string
    The administrative port medium type. - Choices: broadcast, p2p - Default value: broadcast
    MinimumLinks int
    Minimum links. - Range: 1-32 - Default value: 1
    Mode string
    Administrative port mode. - Choices: access, trunk, fex-fabric, dot1q-tunnel, promiscuous, host, trunk_secondary, trunk_promiscuous, vntag - Default value: access
    Mtu int
    Administrative port MTU. - Range: 576-9216 - Default value: 1500
    NativeVlan string
    Native VLAN. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: vlan-1
    PortChannelMode string
    The aggregated interface protocol channel mode. - Choices: on, static, active, passive, mac-pin - Default value: on
    Speed string
    Administrative port speed. - Choices: unknown, 100M, 1G, 10G, 40G, auto, auto 100M, auto 100M 1G, 100G, 25G, 10M, 50G, 200G, 400G, 2.5G, 5G, auto 2.5G 5G 10G, auto 100M 1G 2.5G 5G - Default value: auto
    SuspendIndividual string
    Suspend Individual Port. - Choices: enable, disable - Default value: enable
    TrunkVlans string
    List of trunk VLANs. - Default value: 1-4094
    UserConfiguredFlags string
    Port User Config Flags.
    interfaceId String
    Must match first field in the output of show intf brief. Example: po1.
    accessVlan String
    Access VLAN. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: vlan-1
    adminState String
    Administrative port state. - Choices: up, down - Default value: up
    autoNegotiation String
    Administrative port auto-negotiation. - Choices: on, off, 25G - Default value: on
    bandwidth Integer
    The bandwidth parameter for a routed interface, port channel, or subinterface. - Range: 0-3200000000 - Default value: 0
    delay Integer
    The administrative port delay time. - Range: 1-16777215 - Default value: 1
    description String
    Interface description.
    device String
    A device name from the provider configuration.
    duplex String
    Duplex. - Choices: auto, full, half - Default value: auto
    layer String
    Administrative port layer. - Choices: Layer2, Layer3 - Default value: Layer2
    linkLogging String
    Administrative link logging. - Choices: default, enable, disable - Default value: default
    maximumLinks Integer
    Maximum links. - Range: 1-32 - Default value: 32
    medium String
    The administrative port medium type. - Choices: broadcast, p2p - Default value: broadcast
    minimumLinks Integer
    Minimum links. - Range: 1-32 - Default value: 1
    mode String
    Administrative port mode. - Choices: access, trunk, fex-fabric, dot1q-tunnel, promiscuous, host, trunk_secondary, trunk_promiscuous, vntag - Default value: access
    mtu Integer
    Administrative port MTU. - Range: 576-9216 - Default value: 1500
    nativeVlan String
    Native VLAN. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: vlan-1
    portChannelMode String
    The aggregated interface protocol channel mode. - Choices: on, static, active, passive, mac-pin - Default value: on
    speed String
    Administrative port speed. - Choices: unknown, 100M, 1G, 10G, 40G, auto, auto 100M, auto 100M 1G, 100G, 25G, 10M, 50G, 200G, 400G, 2.5G, 5G, auto 2.5G 5G 10G, auto 100M 1G 2.5G 5G - Default value: auto
    suspendIndividual String
    Suspend Individual Port. - Choices: enable, disable - Default value: enable
    trunkVlans String
    List of trunk VLANs. - Default value: 1-4094
    userConfiguredFlags String
    Port User Config Flags.
    interfaceId string
    Must match first field in the output of show intf brief. Example: po1.
    accessVlan string
    Access VLAN. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: vlan-1
    adminState string
    Administrative port state. - Choices: up, down - Default value: up
    autoNegotiation string
    Administrative port auto-negotiation. - Choices: on, off, 25G - Default value: on
    bandwidth number
    The bandwidth parameter for a routed interface, port channel, or subinterface. - Range: 0-3200000000 - Default value: 0
    delay number
    The administrative port delay time. - Range: 1-16777215 - Default value: 1
    description string
    Interface description.
    device string
    A device name from the provider configuration.
    duplex string
    Duplex. - Choices: auto, full, half - Default value: auto
    layer string
    Administrative port layer. - Choices: Layer2, Layer3 - Default value: Layer2
    linkLogging string
    Administrative link logging. - Choices: default, enable, disable - Default value: default
    maximumLinks number
    Maximum links. - Range: 1-32 - Default value: 32
    medium string
    The administrative port medium type. - Choices: broadcast, p2p - Default value: broadcast
    minimumLinks number
    Minimum links. - Range: 1-32 - Default value: 1
    mode string
    Administrative port mode. - Choices: access, trunk, fex-fabric, dot1q-tunnel, promiscuous, host, trunk_secondary, trunk_promiscuous, vntag - Default value: access
    mtu number
    Administrative port MTU. - Range: 576-9216 - Default value: 1500
    nativeVlan string
    Native VLAN. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: vlan-1
    portChannelMode string
    The aggregated interface protocol channel mode. - Choices: on, static, active, passive, mac-pin - Default value: on
    speed string
    Administrative port speed. - Choices: unknown, 100M, 1G, 10G, 40G, auto, auto 100M, auto 100M 1G, 100G, 25G, 10M, 50G, 200G, 400G, 2.5G, 5G, auto 2.5G 5G 10G, auto 100M 1G 2.5G 5G - Default value: auto
    suspendIndividual string
    Suspend Individual Port. - Choices: enable, disable - Default value: enable
    trunkVlans string
    List of trunk VLANs. - Default value: 1-4094
    userConfiguredFlags string
    Port User Config Flags.
    interface_id str
    Must match first field in the output of show intf brief. Example: po1.
    access_vlan str
    Access VLAN. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: vlan-1
    admin_state str
    Administrative port state. - Choices: up, down - Default value: up
    auto_negotiation str
    Administrative port auto-negotiation. - Choices: on, off, 25G - Default value: on
    bandwidth int
    The bandwidth parameter for a routed interface, port channel, or subinterface. - Range: 0-3200000000 - Default value: 0
    delay int
    The administrative port delay time. - Range: 1-16777215 - Default value: 1
    description str
    Interface description.
    device str
    A device name from the provider configuration.
    duplex str
    Duplex. - Choices: auto, full, half - Default value: auto
    layer str
    Administrative port layer. - Choices: Layer2, Layer3 - Default value: Layer2
    link_logging str
    Administrative link logging. - Choices: default, enable, disable - Default value: default
    maximum_links int
    Maximum links. - Range: 1-32 - Default value: 32
    medium str
    The administrative port medium type. - Choices: broadcast, p2p - Default value: broadcast
    minimum_links int
    Minimum links. - Range: 1-32 - Default value: 1
    mode str
    Administrative port mode. - Choices: access, trunk, fex-fabric, dot1q-tunnel, promiscuous, host, trunk_secondary, trunk_promiscuous, vntag - Default value: access
    mtu int
    Administrative port MTU. - Range: 576-9216 - Default value: 1500
    native_vlan str
    Native VLAN. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: vlan-1
    port_channel_mode str
    The aggregated interface protocol channel mode. - Choices: on, static, active, passive, mac-pin - Default value: on
    speed str
    Administrative port speed. - Choices: unknown, 100M, 1G, 10G, 40G, auto, auto 100M, auto 100M 1G, 100G, 25G, 10M, 50G, 200G, 400G, 2.5G, 5G, auto 2.5G 5G 10G, auto 100M 1G 2.5G 5G - Default value: auto
    suspend_individual str
    Suspend Individual Port. - Choices: enable, disable - Default value: enable
    trunk_vlans str
    List of trunk VLANs. - Default value: 1-4094
    user_configured_flags str
    Port User Config Flags.
    interfaceId String
    Must match first field in the output of show intf brief. Example: po1.
    accessVlan String
    Access VLAN. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: vlan-1
    adminState String
    Administrative port state. - Choices: up, down - Default value: up
    autoNegotiation String
    Administrative port auto-negotiation. - Choices: on, off, 25G - Default value: on
    bandwidth Number
    The bandwidth parameter for a routed interface, port channel, or subinterface. - Range: 0-3200000000 - Default value: 0
    delay Number
    The administrative port delay time. - Range: 1-16777215 - Default value: 1
    description String
    Interface description.
    device String
    A device name from the provider configuration.
    duplex String
    Duplex. - Choices: auto, full, half - Default value: auto
    layer String
    Administrative port layer. - Choices: Layer2, Layer3 - Default value: Layer2
    linkLogging String
    Administrative link logging. - Choices: default, enable, disable - Default value: default
    maximumLinks Number
    Maximum links. - Range: 1-32 - Default value: 32
    medium String
    The administrative port medium type. - Choices: broadcast, p2p - Default value: broadcast
    minimumLinks Number
    Minimum links. - Range: 1-32 - Default value: 1
    mode String
    Administrative port mode. - Choices: access, trunk, fex-fabric, dot1q-tunnel, promiscuous, host, trunk_secondary, trunk_promiscuous, vntag - Default value: access
    mtu Number
    Administrative port MTU. - Range: 576-9216 - Default value: 1500
    nativeVlan String
    Native VLAN. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: vlan-1
    portChannelMode String
    The aggregated interface protocol channel mode. - Choices: on, static, active, passive, mac-pin - Default value: on
    speed String
    Administrative port speed. - Choices: unknown, 100M, 1G, 10G, 40G, auto, auto 100M, auto 100M 1G, 100G, 25G, 10M, 50G, 200G, 400G, 2.5G, 5G, auto 2.5G 5G 10G, auto 100M 1G 2.5G 5G - Default value: auto
    suspendIndividual String
    Suspend Individual Port. - Choices: enable, disable - Default value: enable
    trunkVlans String
    List of trunk VLANs. - Default value: 1-4094
    userConfiguredFlags String
    Port User Config Flags.

    Outputs

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

    Get an existing PortChannelInterface 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?: PortChannelInterfaceState, opts?: CustomResourceOptions): PortChannelInterface
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            access_vlan: Optional[str] = None,
            admin_state: Optional[str] = None,
            auto_negotiation: Optional[str] = None,
            bandwidth: Optional[int] = None,
            delay: Optional[int] = None,
            description: Optional[str] = None,
            device: Optional[str] = None,
            duplex: Optional[str] = None,
            interface_id: Optional[str] = None,
            layer: Optional[str] = None,
            link_logging: Optional[str] = None,
            maximum_links: Optional[int] = None,
            medium: Optional[str] = None,
            minimum_links: Optional[int] = None,
            mode: Optional[str] = None,
            mtu: Optional[int] = None,
            native_vlan: Optional[str] = None,
            port_channel_mode: Optional[str] = None,
            speed: Optional[str] = None,
            suspend_individual: Optional[str] = None,
            trunk_vlans: Optional[str] = None,
            user_configured_flags: Optional[str] = None) -> PortChannelInterface
    func GetPortChannelInterface(ctx *Context, name string, id IDInput, state *PortChannelInterfaceState, opts ...ResourceOption) (*PortChannelInterface, error)
    public static PortChannelInterface Get(string name, Input<string> id, PortChannelInterfaceState? state, CustomResourceOptions? opts = null)
    public static PortChannelInterface get(String name, Output<String> id, PortChannelInterfaceState 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:
    AccessVlan string
    Access VLAN. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: vlan-1
    AdminState string
    Administrative port state. - Choices: up, down - Default value: up
    AutoNegotiation string
    Administrative port auto-negotiation. - Choices: on, off, 25G - Default value: on
    Bandwidth int
    The bandwidth parameter for a routed interface, port channel, or subinterface. - Range: 0-3200000000 - Default value: 0
    Delay int
    The administrative port delay time. - Range: 1-16777215 - Default value: 1
    Description string
    Interface description.
    Device string
    A device name from the provider configuration.
    Duplex string
    Duplex. - Choices: auto, full, half - Default value: auto
    InterfaceId string
    Must match first field in the output of show intf brief. Example: po1.
    Layer string
    Administrative port layer. - Choices: Layer2, Layer3 - Default value: Layer2
    LinkLogging string
    Administrative link logging. - Choices: default, enable, disable - Default value: default
    MaximumLinks int
    Maximum links. - Range: 1-32 - Default value: 32
    Medium string
    The administrative port medium type. - Choices: broadcast, p2p - Default value: broadcast
    MinimumLinks int
    Minimum links. - Range: 1-32 - Default value: 1
    Mode string
    Administrative port mode. - Choices: access, trunk, fex-fabric, dot1q-tunnel, promiscuous, host, trunk_secondary, trunk_promiscuous, vntag - Default value: access
    Mtu int
    Administrative port MTU. - Range: 576-9216 - Default value: 1500
    NativeVlan string
    Native VLAN. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: vlan-1
    PortChannelMode string
    The aggregated interface protocol channel mode. - Choices: on, static, active, passive, mac-pin - Default value: on
    Speed string
    Administrative port speed. - Choices: unknown, 100M, 1G, 10G, 40G, auto, auto 100M, auto 100M 1G, 100G, 25G, 10M, 50G, 200G, 400G, 2.5G, 5G, auto 2.5G 5G 10G, auto 100M 1G 2.5G 5G - Default value: auto
    SuspendIndividual string
    Suspend Individual Port. - Choices: enable, disable - Default value: enable
    TrunkVlans string
    List of trunk VLANs. - Default value: 1-4094
    UserConfiguredFlags string
    Port User Config Flags.
    AccessVlan string
    Access VLAN. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: vlan-1
    AdminState string
    Administrative port state. - Choices: up, down - Default value: up
    AutoNegotiation string
    Administrative port auto-negotiation. - Choices: on, off, 25G - Default value: on
    Bandwidth int
    The bandwidth parameter for a routed interface, port channel, or subinterface. - Range: 0-3200000000 - Default value: 0
    Delay int
    The administrative port delay time. - Range: 1-16777215 - Default value: 1
    Description string
    Interface description.
    Device string
    A device name from the provider configuration.
    Duplex string
    Duplex. - Choices: auto, full, half - Default value: auto
    InterfaceId string
    Must match first field in the output of show intf brief. Example: po1.
    Layer string
    Administrative port layer. - Choices: Layer2, Layer3 - Default value: Layer2
    LinkLogging string
    Administrative link logging. - Choices: default, enable, disable - Default value: default
    MaximumLinks int
    Maximum links. - Range: 1-32 - Default value: 32
    Medium string
    The administrative port medium type. - Choices: broadcast, p2p - Default value: broadcast
    MinimumLinks int
    Minimum links. - Range: 1-32 - Default value: 1
    Mode string
    Administrative port mode. - Choices: access, trunk, fex-fabric, dot1q-tunnel, promiscuous, host, trunk_secondary, trunk_promiscuous, vntag - Default value: access
    Mtu int
    Administrative port MTU. - Range: 576-9216 - Default value: 1500
    NativeVlan string
    Native VLAN. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: vlan-1
    PortChannelMode string
    The aggregated interface protocol channel mode. - Choices: on, static, active, passive, mac-pin - Default value: on
    Speed string
    Administrative port speed. - Choices: unknown, 100M, 1G, 10G, 40G, auto, auto 100M, auto 100M 1G, 100G, 25G, 10M, 50G, 200G, 400G, 2.5G, 5G, auto 2.5G 5G 10G, auto 100M 1G 2.5G 5G - Default value: auto
    SuspendIndividual string
    Suspend Individual Port. - Choices: enable, disable - Default value: enable
    TrunkVlans string
    List of trunk VLANs. - Default value: 1-4094
    UserConfiguredFlags string
    Port User Config Flags.
    accessVlan String
    Access VLAN. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: vlan-1
    adminState String
    Administrative port state. - Choices: up, down - Default value: up
    autoNegotiation String
    Administrative port auto-negotiation. - Choices: on, off, 25G - Default value: on
    bandwidth Integer
    The bandwidth parameter for a routed interface, port channel, or subinterface. - Range: 0-3200000000 - Default value: 0
    delay Integer
    The administrative port delay time. - Range: 1-16777215 - Default value: 1
    description String
    Interface description.
    device String
    A device name from the provider configuration.
    duplex String
    Duplex. - Choices: auto, full, half - Default value: auto
    interfaceId String
    Must match first field in the output of show intf brief. Example: po1.
    layer String
    Administrative port layer. - Choices: Layer2, Layer3 - Default value: Layer2
    linkLogging String
    Administrative link logging. - Choices: default, enable, disable - Default value: default
    maximumLinks Integer
    Maximum links. - Range: 1-32 - Default value: 32
    medium String
    The administrative port medium type. - Choices: broadcast, p2p - Default value: broadcast
    minimumLinks Integer
    Minimum links. - Range: 1-32 - Default value: 1
    mode String
    Administrative port mode. - Choices: access, trunk, fex-fabric, dot1q-tunnel, promiscuous, host, trunk_secondary, trunk_promiscuous, vntag - Default value: access
    mtu Integer
    Administrative port MTU. - Range: 576-9216 - Default value: 1500
    nativeVlan String
    Native VLAN. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: vlan-1
    portChannelMode String
    The aggregated interface protocol channel mode. - Choices: on, static, active, passive, mac-pin - Default value: on
    speed String
    Administrative port speed. - Choices: unknown, 100M, 1G, 10G, 40G, auto, auto 100M, auto 100M 1G, 100G, 25G, 10M, 50G, 200G, 400G, 2.5G, 5G, auto 2.5G 5G 10G, auto 100M 1G 2.5G 5G - Default value: auto
    suspendIndividual String
    Suspend Individual Port. - Choices: enable, disable - Default value: enable
    trunkVlans String
    List of trunk VLANs. - Default value: 1-4094
    userConfiguredFlags String
    Port User Config Flags.
    accessVlan string
    Access VLAN. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: vlan-1
    adminState string
    Administrative port state. - Choices: up, down - Default value: up
    autoNegotiation string
    Administrative port auto-negotiation. - Choices: on, off, 25G - Default value: on
    bandwidth number
    The bandwidth parameter for a routed interface, port channel, or subinterface. - Range: 0-3200000000 - Default value: 0
    delay number
    The administrative port delay time. - Range: 1-16777215 - Default value: 1
    description string
    Interface description.
    device string
    A device name from the provider configuration.
    duplex string
    Duplex. - Choices: auto, full, half - Default value: auto
    interfaceId string
    Must match first field in the output of show intf brief. Example: po1.
    layer string
    Administrative port layer. - Choices: Layer2, Layer3 - Default value: Layer2
    linkLogging string
    Administrative link logging. - Choices: default, enable, disable - Default value: default
    maximumLinks number
    Maximum links. - Range: 1-32 - Default value: 32
    medium string
    The administrative port medium type. - Choices: broadcast, p2p - Default value: broadcast
    minimumLinks number
    Minimum links. - Range: 1-32 - Default value: 1
    mode string
    Administrative port mode. - Choices: access, trunk, fex-fabric, dot1q-tunnel, promiscuous, host, trunk_secondary, trunk_promiscuous, vntag - Default value: access
    mtu number
    Administrative port MTU. - Range: 576-9216 - Default value: 1500
    nativeVlan string
    Native VLAN. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: vlan-1
    portChannelMode string
    The aggregated interface protocol channel mode. - Choices: on, static, active, passive, mac-pin - Default value: on
    speed string
    Administrative port speed. - Choices: unknown, 100M, 1G, 10G, 40G, auto, auto 100M, auto 100M 1G, 100G, 25G, 10M, 50G, 200G, 400G, 2.5G, 5G, auto 2.5G 5G 10G, auto 100M 1G 2.5G 5G - Default value: auto
    suspendIndividual string
    Suspend Individual Port. - Choices: enable, disable - Default value: enable
    trunkVlans string
    List of trunk VLANs. - Default value: 1-4094
    userConfiguredFlags string
    Port User Config Flags.
    access_vlan str
    Access VLAN. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: vlan-1
    admin_state str
    Administrative port state. - Choices: up, down - Default value: up
    auto_negotiation str
    Administrative port auto-negotiation. - Choices: on, off, 25G - Default value: on
    bandwidth int
    The bandwidth parameter for a routed interface, port channel, or subinterface. - Range: 0-3200000000 - Default value: 0
    delay int
    The administrative port delay time. - Range: 1-16777215 - Default value: 1
    description str
    Interface description.
    device str
    A device name from the provider configuration.
    duplex str
    Duplex. - Choices: auto, full, half - Default value: auto
    interface_id str
    Must match first field in the output of show intf brief. Example: po1.
    layer str
    Administrative port layer. - Choices: Layer2, Layer3 - Default value: Layer2
    link_logging str
    Administrative link logging. - Choices: default, enable, disable - Default value: default
    maximum_links int
    Maximum links. - Range: 1-32 - Default value: 32
    medium str
    The administrative port medium type. - Choices: broadcast, p2p - Default value: broadcast
    minimum_links int
    Minimum links. - Range: 1-32 - Default value: 1
    mode str
    Administrative port mode. - Choices: access, trunk, fex-fabric, dot1q-tunnel, promiscuous, host, trunk_secondary, trunk_promiscuous, vntag - Default value: access
    mtu int
    Administrative port MTU. - Range: 576-9216 - Default value: 1500
    native_vlan str
    Native VLAN. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: vlan-1
    port_channel_mode str
    The aggregated interface protocol channel mode. - Choices: on, static, active, passive, mac-pin - Default value: on
    speed str
    Administrative port speed. - Choices: unknown, 100M, 1G, 10G, 40G, auto, auto 100M, auto 100M 1G, 100G, 25G, 10M, 50G, 200G, 400G, 2.5G, 5G, auto 2.5G 5G 10G, auto 100M 1G 2.5G 5G - Default value: auto
    suspend_individual str
    Suspend Individual Port. - Choices: enable, disable - Default value: enable
    trunk_vlans str
    List of trunk VLANs. - Default value: 1-4094
    user_configured_flags str
    Port User Config Flags.
    accessVlan String
    Access VLAN. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: vlan-1
    adminState String
    Administrative port state. - Choices: up, down - Default value: up
    autoNegotiation String
    Administrative port auto-negotiation. - Choices: on, off, 25G - Default value: on
    bandwidth Number
    The bandwidth parameter for a routed interface, port channel, or subinterface. - Range: 0-3200000000 - Default value: 0
    delay Number
    The administrative port delay time. - Range: 1-16777215 - Default value: 1
    description String
    Interface description.
    device String
    A device name from the provider configuration.
    duplex String
    Duplex. - Choices: auto, full, half - Default value: auto
    interfaceId String
    Must match first field in the output of show intf brief. Example: po1.
    layer String
    Administrative port layer. - Choices: Layer2, Layer3 - Default value: Layer2
    linkLogging String
    Administrative link logging. - Choices: default, enable, disable - Default value: default
    maximumLinks Number
    Maximum links. - Range: 1-32 - Default value: 32
    medium String
    The administrative port medium type. - Choices: broadcast, p2p - Default value: broadcast
    minimumLinks Number
    Minimum links. - Range: 1-32 - Default value: 1
    mode String
    Administrative port mode. - Choices: access, trunk, fex-fabric, dot1q-tunnel, promiscuous, host, trunk_secondary, trunk_promiscuous, vntag - Default value: access
    mtu Number
    Administrative port MTU. - Range: 576-9216 - Default value: 1500
    nativeVlan String
    Native VLAN. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: vlan-1
    portChannelMode String
    The aggregated interface protocol channel mode. - Choices: on, static, active, passive, mac-pin - Default value: on
    speed String
    Administrative port speed. - Choices: unknown, 100M, 1G, 10G, 40G, auto, auto 100M, auto 100M 1G, 100G, 25G, 10M, 50G, 200G, 400G, 2.5G, 5G, auto 2.5G 5G 10G, auto 100M 1G 2.5G 5G - Default value: auto
    suspendIndividual String
    Suspend Individual Port. - Choices: enable, disable - Default value: enable
    trunkVlans String
    List of trunk VLANs. - Default value: 1-4094
    userConfiguredFlags String
    Port User Config Flags.

    Import

     $ pulumi import nxos:index/portChannelInterface:PortChannelInterface example "sys/intf/aggr-[po1]"
    

    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