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

nxos.getPortChannelInterface

Explore with Pulumi AI

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

    This data source can read the configuration of a port-channel interface.

    Example Usage

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

return await Deployment.RunAsync(() => 
{
    var example = Nxos.GetPortChannelInterface.Invoke(new()
    {
        InterfaceId = "po1",
    });

});

    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.LookupPortChannelInterface(ctx, &nxos.LookupPortChannelInterfaceArgs{
			InterfaceId: "po1",
		}, nil)
		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.NxosFunctions;
import com.pulumi.nxos.inputs.GetPortChannelInterfaceArgs;
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) {
        final var example = NxosFunctions.getPortChannelInterface(GetPortChannelInterfaceArgs.builder()
            .interfaceId("po1")
            .build());

    }
}

    import pulumi
import pulumi_nxos as nxos

example = nxos.get_port_channel_interface(interface_id="po1")

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

const example = nxos.getPortChannelInterface({
    interfaceId: "po1",
});

    variables:
  example:
    fn::invoke:
      Function: nxos:getPortChannelInterface
      Arguments:
        interfaceId: po1

    Using getPortChannelInterface

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getPortChannelInterface(args: GetPortChannelInterfaceArgs, opts?: InvokeOptions): Promise<GetPortChannelInterfaceResult>
function getPortChannelInterfaceOutput(args: GetPortChannelInterfaceOutputArgs, opts?: InvokeOptions): Output<GetPortChannelInterfaceResult>
    def get_port_channel_interface(device: Optional[str] = None,
                               interface_id: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetPortChannelInterfaceResult
def get_port_channel_interface_output(device: Optional[pulumi.Input[str]] = None,
                               interface_id: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetPortChannelInterfaceResult]
    func LookupPortChannelInterface(ctx *Context, args *LookupPortChannelInterfaceArgs, opts ...InvokeOption) (*LookupPortChannelInterfaceResult, error)
func LookupPortChannelInterfaceOutput(ctx *Context, args *LookupPortChannelInterfaceOutputArgs, opts ...InvokeOption) LookupPortChannelInterfaceResultOutput

    > Note: This function is named LookupPortChannelInterface in the Go SDK.

    public static class GetPortChannelInterface 
{
    public static Task<GetPortChannelInterfaceResult> InvokeAsync(GetPortChannelInterfaceArgs args, InvokeOptions? opts = null)
    public static Output<GetPortChannelInterfaceResult> Invoke(GetPortChannelInterfaceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPortChannelInterfaceResult> getPortChannelInterface(GetPortChannelInterfaceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: nxos:index/getPortChannelInterface:getPortChannelInterface
  arguments:
    # arguments dictionary

    The following arguments are supported:

    InterfaceId string
    Must match first field in the output of show intf brief. Example: po1.
    Device string
    A device name from the provider configuration.
    InterfaceId string
    Must match first field in the output of show intf brief. Example: po1.
    Device string
    A device name from the provider configuration.
    interfaceId String
    Must match first field in the output of show intf brief. Example: po1.
    device String
    A device name from the provider configuration.
    interfaceId string
    Must match first field in the output of show intf brief. Example: po1.
    device string
    A device name from the provider configuration.
    interface_id str
    Must match first field in the output of show intf brief. Example: po1.
    device str
    A device name from the provider configuration.
    interfaceId String
    Must match first field in the output of show intf brief. Example: po1.
    device String
    A device name from the provider configuration.

    getPortChannelInterface Result

    The following output properties are available:

    AccessVlan string
    Access VLAN. Possible values are unknown, vlan-XX or vxlan-XX.
    AdminState string
    Administrative port state.
    AutoNegotiation string
    Administrative port auto-negotiation.
    Bandwidth int
    The bandwidth parameter for a routed interface, port channel, or subinterface.
    Delay int
    The administrative port delay time.
    Description string
    Interface description.
    Duplex string
    Duplex.
    Id string
    The distinguished name of the object.
    InterfaceId string
    Must match first field in the output of show intf brief. Example: po1.
    Layer string
    Administrative port layer.
    LinkLogging string
    Administrative link logging.
    MaximumLinks int
    Maximum links.
    Medium string
    The administrative port medium type.
    MinimumLinks int
    Minimum links.
    Mode string
    Administrative port mode.
    Mtu int
    Administrative port MTU.
    NativeVlan string
    Native VLAN. Possible values are unknown, vlan-XX or vxlan-XX.
    PortChannelMode string
    The aggregated interface protocol channel mode.
    Speed string
    Administrative port speed.
    SuspendIndividual string
    Suspend Individual Port.
    TrunkVlans string
    List of trunk VLANs.
    UserConfiguredFlags string
    Port User Config Flags.
    Device string
    A device name from the provider configuration.
    AccessVlan string
    Access VLAN. Possible values are unknown, vlan-XX or vxlan-XX.
    AdminState string
    Administrative port state.
    AutoNegotiation string
    Administrative port auto-negotiation.
    Bandwidth int
    The bandwidth parameter for a routed interface, port channel, or subinterface.
    Delay int
    The administrative port delay time.
    Description string
    Interface description.
    Duplex string
    Duplex.
    Id string
    The distinguished name of the object.
    InterfaceId string
    Must match first field in the output of show intf brief. Example: po1.
    Layer string
    Administrative port layer.
    LinkLogging string
    Administrative link logging.
    MaximumLinks int
    Maximum links.
    Medium string
    The administrative port medium type.
    MinimumLinks int
    Minimum links.
    Mode string
    Administrative port mode.
    Mtu int
    Administrative port MTU.
    NativeVlan string
    Native VLAN. Possible values are unknown, vlan-XX or vxlan-XX.
    PortChannelMode string
    The aggregated interface protocol channel mode.
    Speed string
    Administrative port speed.
    SuspendIndividual string
    Suspend Individual Port.
    TrunkVlans string
    List of trunk VLANs.
    UserConfiguredFlags string
    Port User Config Flags.
    Device string
    A device name from the provider configuration.
    accessVlan String
    Access VLAN. Possible values are unknown, vlan-XX or vxlan-XX.
    adminState String
    Administrative port state.
    autoNegotiation String
    Administrative port auto-negotiation.
    bandwidth Integer
    The bandwidth parameter for a routed interface, port channel, or subinterface.
    delay Integer
    The administrative port delay time.
    description String
    Interface description.
    duplex String
    Duplex.
    id String
    The distinguished name of the object.
    interfaceId String
    Must match first field in the output of show intf brief. Example: po1.
    layer String
    Administrative port layer.
    linkLogging String
    Administrative link logging.
    maximumLinks Integer
    Maximum links.
    medium String
    The administrative port medium type.
    minimumLinks Integer
    Minimum links.
    mode String
    Administrative port mode.
    mtu Integer
    Administrative port MTU.
    nativeVlan String
    Native VLAN. Possible values are unknown, vlan-XX or vxlan-XX.
    portChannelMode String
    The aggregated interface protocol channel mode.
    speed String
    Administrative port speed.
    suspendIndividual String
    Suspend Individual Port.
    trunkVlans String
    List of trunk VLANs.
    userConfiguredFlags String
    Port User Config Flags.
    device String
    A device name from the provider configuration.
    accessVlan string
    Access VLAN. Possible values are unknown, vlan-XX or vxlan-XX.
    adminState string
    Administrative port state.
    autoNegotiation string
    Administrative port auto-negotiation.
    bandwidth number
    The bandwidth parameter for a routed interface, port channel, or subinterface.
    delay number
    The administrative port delay time.
    description string
    Interface description.
    duplex string
    Duplex.
    id string
    The distinguished name of the object.
    interfaceId string
    Must match first field in the output of show intf brief. Example: po1.
    layer string
    Administrative port layer.
    linkLogging string
    Administrative link logging.
    maximumLinks number
    Maximum links.
    medium string
    The administrative port medium type.
    minimumLinks number
    Minimum links.
    mode string
    Administrative port mode.
    mtu number
    Administrative port MTU.
    nativeVlan string
    Native VLAN. Possible values are unknown, vlan-XX or vxlan-XX.
    portChannelMode string
    The aggregated interface protocol channel mode.
    speed string
    Administrative port speed.
    suspendIndividual string
    Suspend Individual Port.
    trunkVlans string
    List of trunk VLANs.
    userConfiguredFlags string
    Port User Config Flags.
    device string
    A device name from the provider configuration.
    access_vlan str
    Access VLAN. Possible values are unknown, vlan-XX or vxlan-XX.
    admin_state str
    Administrative port state.
    auto_negotiation str
    Administrative port auto-negotiation.
    bandwidth int
    The bandwidth parameter for a routed interface, port channel, or subinterface.
    delay int
    The administrative port delay time.
    description str
    Interface description.
    duplex str
    Duplex.
    id str
    The distinguished name of the object.
    interface_id str
    Must match first field in the output of show intf brief. Example: po1.
    layer str
    Administrative port layer.
    link_logging str
    Administrative link logging.
    maximum_links int
    Maximum links.
    medium str
    The administrative port medium type.
    minimum_links int
    Minimum links.
    mode str
    Administrative port mode.
    mtu int
    Administrative port MTU.
    native_vlan str
    Native VLAN. Possible values are unknown, vlan-XX or vxlan-XX.
    port_channel_mode str
    The aggregated interface protocol channel mode.
    speed str
    Administrative port speed.
    suspend_individual str
    Suspend Individual Port.
    trunk_vlans str
    List of trunk VLANs.
    user_configured_flags str
    Port User Config Flags.
    device str
    A device name from the provider configuration.
    accessVlan String
    Access VLAN. Possible values are unknown, vlan-XX or vxlan-XX.
    adminState String
    Administrative port state.
    autoNegotiation String
    Administrative port auto-negotiation.
    bandwidth Number
    The bandwidth parameter for a routed interface, port channel, or subinterface.
    delay Number
    The administrative port delay time.
    description String
    Interface description.
    duplex String
    Duplex.
    id String
    The distinguished name of the object.
    interfaceId String
    Must match first field in the output of show intf brief. Example: po1.
    layer String
    Administrative port layer.
    linkLogging String
    Administrative link logging.
    maximumLinks Number
    Maximum links.
    medium String
    The administrative port medium type.
    minimumLinks Number
    Minimum links.
    mode String
    Administrative port mode.
    mtu Number
    Administrative port MTU.
    nativeVlan String
    Native VLAN. Possible values are unknown, vlan-XX or vxlan-XX.
    portChannelMode String
    The aggregated interface protocol channel mode.
    speed String
    Administrative port speed.
    suspendIndividual String
    Suspend Individual Port.
    trunkVlans String
    List of trunk VLANs.
    userConfiguredFlags String
    Port User Config Flags.
    device String
    A device name from the provider configuration.

    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