nxos.getSubinterface

Explore with Pulumi AI

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

Example Usage

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

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

});

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.LookupSubinterface(ctx, &nxos.LookupSubinterfaceArgs{
			InterfaceId: "eth1/10.124",
		}, 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.GetSubinterfaceArgs;
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.getSubinterface(GetSubinterfaceArgs.builder()
            .interfaceId("eth1/10.124")
            .build());

    }
}

import pulumi
import pulumi_nxos as nxos

example = nxos.get_subinterface(interface_id="eth1/10.124")

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

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

variables:
  example:
    fn::invoke:
      Function: nxos:getSubinterface
      Arguments:
        interfaceId: eth1/10.124

Using getSubinterface

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 getSubinterface(args: GetSubinterfaceArgs, opts?: InvokeOptions): Promise<GetSubinterfaceResult>
function getSubinterfaceOutput(args: GetSubinterfaceOutputArgs, opts?: InvokeOptions): Output<GetSubinterfaceResult>

def get_subinterface(device: Optional[str] = None,
                     interface_id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetSubinterfaceResult
def get_subinterface_output(device: Optional[pulumi.Input[str]] = None,
                     interface_id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetSubinterfaceResult]

func LookupSubinterface(ctx *Context, args *LookupSubinterfaceArgs, opts ...InvokeOption) (*LookupSubinterfaceResult, error)
func LookupSubinterfaceOutput(ctx *Context, args *LookupSubinterfaceOutputArgs, opts ...InvokeOption) LookupSubinterfaceResultOutput

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

public static class GetSubinterface 
{
    public static Task<GetSubinterfaceResult> InvokeAsync(GetSubinterfaceArgs args, InvokeOptions? opts = null)
    public static Output<GetSubinterfaceResult> Invoke(GetSubinterfaceInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetSubinterfaceResult> getSubinterface(GetSubinterfaceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

The following arguments are supported:

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

getSubinterface Result

The following output properties are available:

AdminState string: Administrative state.
Bandwidth int: Specifies the administrative port bandwidth.
Delay int: Specifies the administrative port delay.
Description string: Interface description.
Encap string: Subinterface encapsulation. Possible values are unknown, vlan-XX or vxlan-XX.
Id string: The distinguished name of the object.
InterfaceId string: Must match first field in the output of show intf brief. Example: eth1/1.10.
LinkLogging string: Administrative link logging.
Medium string: The administrative port medium type.
Mtu int: Administrative port MTU.
Device string: A device name from the provider configuration.

AdminState string: Administrative state.
Bandwidth int: Specifies the administrative port bandwidth.
Delay int: Specifies the administrative port delay.
Description string: Interface description.
Encap string: Subinterface encapsulation. Possible values are unknown, vlan-XX or vxlan-XX.
Id string: The distinguished name of the object.
InterfaceId string: Must match first field in the output of show intf brief. Example: eth1/1.10.
LinkLogging string: Administrative link logging.
Medium string: The administrative port medium type.
Mtu int: Administrative port MTU.
Device string: A device name from the provider configuration.

adminState String: Administrative state.
bandwidth Integer: Specifies the administrative port bandwidth.
delay Integer: Specifies the administrative port delay.
description String: Interface description.
encap String: Subinterface encapsulation. Possible values are unknown, vlan-XX or vxlan-XX.
id String: The distinguished name of the object.
interfaceId String: Must match first field in the output of show intf brief. Example: eth1/1.10.
linkLogging String: Administrative link logging.
medium String: The administrative port medium type.
mtu Integer: Administrative port MTU.
device String: A device name from the provider configuration.

adminState string: Administrative state.
bandwidth number: Specifies the administrative port bandwidth.
delay number: Specifies the administrative port delay.
description string: Interface description.
encap string: Subinterface encapsulation. Possible values are unknown, vlan-XX or vxlan-XX.
id string: The distinguished name of the object.
interfaceId string: Must match first field in the output of show intf brief. Example: eth1/1.10.
linkLogging string: Administrative link logging.
medium string: The administrative port medium type.
mtu number: Administrative port MTU.
device string: A device name from the provider configuration.

admin_state str: Administrative state.
bandwidth int: Specifies the administrative port bandwidth.
delay int: Specifies the administrative port delay.
description str: Interface description.
encap str: Subinterface encapsulation. Possible values are unknown, vlan-XX or vxlan-XX.
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.10.
link_logging str: Administrative link logging.
medium str: The administrative port medium type.
mtu int: Administrative port MTU.
device str: A device name from the provider configuration.

adminState String: Administrative state.
bandwidth Number: Specifies the administrative port bandwidth.
delay Number: Specifies the administrative port delay.
description String: Interface description.
encap String: Subinterface encapsulation. Possible values are unknown, vlan-XX or vxlan-XX.
id String: The distinguished name of the object.
interfaceId String: Must match first field in the output of show intf brief. Example: eth1/1.10.
linkLogging String: Administrative link logging.
medium String: The administrative port medium type.
mtu Number: Administrative port MTU.
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.getSubinterface

On this page

On this page

Example Usage

Using getSubinterface

getSubinterface Result

Package Details

On this page

On this page