nxos.getPhysicalInterface

Explore with Pulumi AI

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

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

return await Deployment.RunAsync(() => 
{
    var example = Nxos.GetPhysicalInterface.Invoke(new()
    {
        InterfaceId = "eth1/10",
    });

});

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.LookupPhysicalInterface(ctx, &nxos.LookupPhysicalInterfaceArgs{
			InterfaceId: "eth1/10",
		}, 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.GetPhysicalInterfaceArgs;
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.getPhysicalInterface(GetPhysicalInterfaceArgs.builder()
            .interfaceId("eth1/10")
            .build());

    }
}

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

const example = nxos.getPhysicalInterface({
    interfaceId: "eth1/10",
});

import pulumi
import pulumi_nxos as nxos

example = nxos.get_physical_interface(interface_id="eth1/10")

variables:
  example:
    fn::invoke:
      Function: nxos:getPhysicalInterface
      Arguments:
        interfaceId: eth1/10

Using getPhysicalInterface

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.

TypeScript
Python
Go
C#
Java
YAML

function getPhysicalInterface(args: GetPhysicalInterfaceArgs, opts?: InvokeOptions): Promise<GetPhysicalInterfaceResult>
function getPhysicalInterfaceOutput(args: GetPhysicalInterfaceOutputArgs, opts?: InvokeOptions): Output<GetPhysicalInterfaceResult>

def get_physical_interface(device: Optional[str] = None,
                           interface_id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetPhysicalInterfaceResult
def get_physical_interface_output(device: Optional[pulumi.Input[str]] = None,
                           interface_id: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetPhysicalInterfaceResult]

func LookupPhysicalInterface(ctx *Context, args *LookupPhysicalInterfaceArgs, opts ...InvokeOption) (*LookupPhysicalInterfaceResult, error)
func LookupPhysicalInterfaceOutput(ctx *Context, args *LookupPhysicalInterfaceOutputArgs, opts ...InvokeOption) LookupPhysicalInterfaceResultOutput

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

public static class GetPhysicalInterface 
{
    public static Task<GetPhysicalInterfaceResult> InvokeAsync(GetPhysicalInterfaceArgs args, InvokeOptions? opts = null)
    public static Output<GetPhysicalInterfaceResult> Invoke(GetPhysicalInterfaceInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPhysicalInterfaceResult> getPhysicalInterface(GetPhysicalInterfaceArgs args, InvokeOptions options)
public static Output<GetPhysicalInterfaceResult> getPhysicalInterface(GetPhysicalInterfaceArgs args, InvokeOptions options)

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

The following arguments are supported:

InterfaceId string: Must match first field in the output of show intf brief. Example: eth1/1.
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.
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.
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.
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.
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.
device String: A device name from the provider configuration.

getPhysicalInterface 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.
FecMode string: FEC mode.
Id string: The distinguished name of the object.
InterfaceId string: Must match first field in the output of show intf brief. Example: eth1/1.
Layer string: Administrative port layer.
LinkDebounceDown int: Administrative port link debounce interval.
LinkDebounceUp int: Link Debounce Interval - LinkUp Event.
LinkLogging string: Administrative link logging.
Medium string: The administrative port medium type.
Mode string: Administrative port mode.
Mtu int: Administrative port MTU.
NativeVlan string: Native VLAN. Possible values are unknown, vlan-XX or vxlan-XX.
Speed string: Administrative port speed.
SpeedGroup string: Speed group.
TrunkVlans string: List of trunk VLANs.
UniDirectionalEthernet string: UDE (Uni-Directional Ethernet).
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.
FecMode string: FEC mode.
Id string: The distinguished name of the object.
InterfaceId string: Must match first field in the output of show intf brief. Example: eth1/1.
Layer string: Administrative port layer.
LinkDebounceDown int: Administrative port link debounce interval.
LinkDebounceUp int: Link Debounce Interval - LinkUp Event.
LinkLogging string: Administrative link logging.
Medium string: The administrative port medium type.
Mode string: Administrative port mode.
Mtu int: Administrative port MTU.
NativeVlan string: Native VLAN. Possible values are unknown, vlan-XX or vxlan-XX.
Speed string: Administrative port speed.
SpeedGroup string: Speed group.
TrunkVlans string: List of trunk VLANs.
UniDirectionalEthernet string: UDE (Uni-Directional Ethernet).
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.
fecMode String: FEC mode.
id String: The distinguished name of the object.
interfaceId String: Must match first field in the output of show intf brief. Example: eth1/1.
layer String: Administrative port layer.
linkDebounceDown Integer: Administrative port link debounce interval.
linkDebounceUp Integer: Link Debounce Interval - LinkUp Event.
linkLogging String: Administrative link logging.
medium String: The administrative port medium type.
mode String: Administrative port mode.
mtu Integer: Administrative port MTU.
nativeVlan String: Native VLAN. Possible values are unknown, vlan-XX or vxlan-XX.
speed String: Administrative port speed.
speedGroup String: Speed group.
trunkVlans String: List of trunk VLANs.
uniDirectionalEthernet String: UDE (Uni-Directional Ethernet).
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.
fecMode string: FEC mode.
id string: The distinguished name of the object.
interfaceId string: Must match first field in the output of show intf brief. Example: eth1/1.
layer string: Administrative port layer.
linkDebounceDown number: Administrative port link debounce interval.
linkDebounceUp number: Link Debounce Interval - LinkUp Event.
linkLogging string: Administrative link logging.
medium string: The administrative port medium type.
mode string: Administrative port mode.
mtu number: Administrative port MTU.
nativeVlan string: Native VLAN. Possible values are unknown, vlan-XX or vxlan-XX.
speed string: Administrative port speed.
speedGroup string: Speed group.
trunkVlans string: List of trunk VLANs.
uniDirectionalEthernet string: UDE (Uni-Directional Ethernet).
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.
fec_mode str: FEC mode.
id str: The distinguished name of the object.
interface_id str: Must match first field in the output of show intf brief. Example: eth1/1.
layer str: Administrative port layer.
link_debounce_down int: Administrative port link debounce interval.
link_debounce_up int: Link Debounce Interval - LinkUp Event.
link_logging str: Administrative link logging.
medium str: The administrative port medium type.
mode str: Administrative port mode.
mtu int: Administrative port MTU.
native_vlan str: Native VLAN. Possible values are unknown, vlan-XX or vxlan-XX.
speed str: Administrative port speed.
speed_group str: Speed group.
trunk_vlans str: List of trunk VLANs.
uni_directional_ethernet str: UDE (Uni-Directional Ethernet).
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.
fecMode String: FEC mode.
id String: The distinguished name of the object.
interfaceId String: Must match first field in the output of show intf brief. Example: eth1/1.
layer String: Administrative port layer.
linkDebounceDown Number: Administrative port link debounce interval.
linkDebounceUp Number: Link Debounce Interval - LinkUp Event.
linkLogging String: Administrative link logging.
medium String: The administrative port medium type.
mode String: Administrative port mode.
mtu Number: Administrative port MTU.
nativeVlan String: Native VLAN. Possible values are unknown, vlan-XX or vxlan-XX.
speed String: Administrative port speed.
speedGroup String: Speed group.
trunkVlans String: List of trunk VLANs.
uniDirectionalEthernet String: UDE (Uni-Directional Ethernet).
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.

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

lbrlabs/pulumi-nxos

nxos.getPhysicalInterface

On this page

On this page

Example Usage

Using getPhysicalInterface

getPhysicalInterface Result

Package Details

On this page

On this page