nxos.getSviInterface

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.GetSviInterface.Invoke(new()
    {
        InterfaceId = "vlan293",
    });

});

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.LookupSviInterface(ctx, &nxos.LookupSviInterfaceArgs{
			InterfaceId: "vlan293",
		}, 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.GetSviInterfaceArgs;
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.getSviInterface(GetSviInterfaceArgs.builder()
            .interfaceId("vlan293")
            .build());

    }
}

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

const example = nxos.getSviInterface({
    interfaceId: "vlan293",
});

import pulumi
import pulumi_nxos as nxos

example = nxos.get_svi_interface(interface_id="vlan293")

variables:
  example:
    fn::invoke:
      Function: nxos:getSviInterface
      Arguments:
        interfaceId: vlan293

Using getSviInterface

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 getSviInterface(args: GetSviInterfaceArgs, opts?: InvokeOptions): Promise<GetSviInterfaceResult>
function getSviInterfaceOutput(args: GetSviInterfaceOutputArgs, opts?: InvokeOptions): Output<GetSviInterfaceResult>

def get_svi_interface(device: Optional[str] = None,
                      interface_id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetSviInterfaceResult
def get_svi_interface_output(device: Optional[pulumi.Input[str]] = None,
                      interface_id: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetSviInterfaceResult]

func LookupSviInterface(ctx *Context, args *LookupSviInterfaceArgs, opts ...InvokeOption) (*LookupSviInterfaceResult, error)
func LookupSviInterfaceOutput(ctx *Context, args *LookupSviInterfaceOutputArgs, opts ...InvokeOption) LookupSviInterfaceResultOutput

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

public static class GetSviInterface 
{
    public static Task<GetSviInterfaceResult> InvokeAsync(GetSviInterfaceArgs args, InvokeOptions? opts = null)
    public static Output<GetSviInterfaceResult> Invoke(GetSviInterfaceInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetSviInterfaceResult> getSviInterface(GetSviInterfaceArgs args, InvokeOptions options)
public static Output<GetSviInterfaceResult> getSviInterface(GetSviInterfaceArgs args, InvokeOptions options)

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

The following arguments are supported:

InterfaceId string: Must match first field in the output of show intf brief. Example: vlan100.
Device string: A device name from the provider configuration.

InterfaceId string: Must match first field in the output of show intf brief. Example: vlan100.
Device string: A device name from the provider configuration.

interfaceId String: Must match first field in the output of show intf brief. Example: vlan100.
device String: A device name from the provider configuration.

interfaceId string: Must match first field in the output of show intf brief. Example: vlan100.
device string: A device name from the provider configuration.

interface_id str: Must match first field in the output of show intf brief. Example: vlan100.
device str: A device name from the provider configuration.

interfaceId String: Must match first field in the output of show intf brief. Example: vlan100.
device String: A device name from the provider configuration.

getSviInterface Result

The following output properties are available:

AdminState string: Administrative port state.
Bandwidth int: Specifies the administrative port bandwidth.
Delay int: Specifies the administrative port delay.
Description string: Interface description.
Id string: The distinguished name of the object.
InterfaceId string: Must match first field in the output of show intf brief. Example: vlan100.
Medium string: The administrative port medium type.
Mtu int: Administrative port MTU.
Device string: A device name from the provider configuration.

AdminState string: Administrative port state.
Bandwidth int: Specifies the administrative port bandwidth.
Delay int: Specifies the administrative port delay.
Description string: Interface description.
Id string: The distinguished name of the object.
InterfaceId string: Must match first field in the output of show intf brief. Example: vlan100.
Medium string: The administrative port medium type.
Mtu int: Administrative port MTU.
Device string: A device name from the provider configuration.

adminState String: Administrative port state.
bandwidth Integer: Specifies the administrative port bandwidth.
delay Integer: Specifies the administrative port delay.
description String: Interface description.
id String: The distinguished name of the object.
interfaceId String: Must match first field in the output of show intf brief. Example: vlan100.
medium String: The administrative port medium type.
mtu Integer: Administrative port MTU.
device String: A device name from the provider configuration.

adminState string: Administrative port state.
bandwidth number: Specifies the administrative port bandwidth.
delay number: Specifies the administrative port delay.
description string: Interface description.
id string: The distinguished name of the object.
interfaceId string: Must match first field in the output of show intf brief. Example: vlan100.
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 port state.
bandwidth int: Specifies the administrative port bandwidth.
delay int: Specifies the administrative port delay.
description str: Interface description.
id str: The distinguished name of the object.
interface_id str: Must match first field in the output of show intf brief. Example: vlan100.
medium str: The administrative port medium type.
mtu int: Administrative port MTU.
device str: A device name from the provider configuration.

adminState String: Administrative port state.
bandwidth Number: Specifies the administrative port bandwidth.
delay Number: Specifies the administrative port delay.
description String: Interface description.
id String: The distinguished name of the object.
interfaceId String: Must match first field in the output of show intf brief. Example: vlan100.
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.getSviInterface

On this page

On this page

Example Usage

Using getSviInterface

getSviInterface Result

Package Details

On this page

On this page