Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cisco NX OS Resource Provider
  3. API Docs
  4. getSpanningTreeInterface
Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs
lbrlabs/pulumi-nxos

nxos.getSpanningTreeInterface

Explore with Pulumi AI

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

This data source can read the Spanning Tree interface configuration.

Example Usage

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

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

});
Copy
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.LookupSpanningTreeInterface(ctx, &nxos.LookupSpanningTreeInterfaceArgs{
			InterfaceId: "eth1/9",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
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.GetSpanningTreeInterfaceArgs;
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.getSpanningTreeInterface(GetSpanningTreeInterfaceArgs.builder()
            .interfaceId("eth1/9")
            .build());

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

const example = nxos.getSpanningTreeInterface({
    interfaceId: "eth1/9",
});
Copy
import pulumi
import pulumi_nxos as nxos

example = nxos.get_spanning_tree_interface(interface_id="eth1/9")
Copy
variables:
  example:
    fn::invoke:
      Function: nxos:getSpanningTreeInterface
      Arguments:
        interfaceId: eth1/9
Copy

Using getSpanningTreeInterface

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 getSpanningTreeInterface(args: GetSpanningTreeInterfaceArgs, opts?: InvokeOptions): Promise<GetSpanningTreeInterfaceResult>
function getSpanningTreeInterfaceOutput(args: GetSpanningTreeInterfaceOutputArgs, opts?: InvokeOptions): Output<GetSpanningTreeInterfaceResult>
Copy
def get_spanning_tree_interface(device: Optional[str] = None,
                                interface_id: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetSpanningTreeInterfaceResult
def get_spanning_tree_interface_output(device: Optional[pulumi.Input[str]] = None,
                                interface_id: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetSpanningTreeInterfaceResult]
Copy
func LookupSpanningTreeInterface(ctx *Context, args *LookupSpanningTreeInterfaceArgs, opts ...InvokeOption) (*LookupSpanningTreeInterfaceResult, error)
func LookupSpanningTreeInterfaceOutput(ctx *Context, args *LookupSpanningTreeInterfaceOutputArgs, opts ...InvokeOption) LookupSpanningTreeInterfaceResultOutput
Copy

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

public static class GetSpanningTreeInterface 
{
    public static Task<GetSpanningTreeInterfaceResult> InvokeAsync(GetSpanningTreeInterfaceArgs args, InvokeOptions? opts = null)
    public static Output<GetSpanningTreeInterfaceResult> Invoke(GetSpanningTreeInterfaceInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetSpanningTreeInterfaceResult> getSpanningTreeInterface(GetSpanningTreeInterfaceArgs args, InvokeOptions options)
public static Output<GetSpanningTreeInterfaceResult> getSpanningTreeInterface(GetSpanningTreeInterfaceArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: nxos:index/getSpanningTreeInterface:getSpanningTreeInterface
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

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

getSpanningTreeInterface Result

The following output properties are available:

AdminState string
The administrative state of the object or policy.
BpduFilter string
BPDU filter mode.
BpduGuard string
BPDU guard mode.
Cost int
Port path cost.
Guard string
Guard 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.
LinkType string
Link type.
Mode string
Port mode.
Priority int
Port priority.
Device string
A device name from the provider configuration.
AdminState string
The administrative state of the object or policy.
BpduFilter string
BPDU filter mode.
BpduGuard string
BPDU guard mode.
Cost int
Port path cost.
Guard string
Guard 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.
LinkType string
Link type.
Mode string
Port mode.
Priority int
Port priority.
Device string
A device name from the provider configuration.
adminState String
The administrative state of the object or policy.
bpduFilter String
BPDU filter mode.
bpduGuard String
BPDU guard mode.
cost Integer
Port path cost.
guard String
Guard 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.
linkType String
Link type.
mode String
Port mode.
priority Integer
Port priority.
device String
A device name from the provider configuration.
adminState string
The administrative state of the object or policy.
bpduFilter string
BPDU filter mode.
bpduGuard string
BPDU guard mode.
cost number
Port path cost.
guard string
Guard 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.
linkType string
Link type.
mode string
Port mode.
priority number
Port priority.
device string
A device name from the provider configuration.
admin_state str
The administrative state of the object or policy.
bpdu_filter str
BPDU filter mode.
bpdu_guard str
BPDU guard mode.
cost int
Port path cost.
guard str
Guard 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.
link_type str
Link type.
mode str
Port mode.
priority int
Port priority.
device str
A device name from the provider configuration.
adminState String
The administrative state of the object or policy.
bpduFilter String
BPDU filter mode.
bpduGuard String
BPDU guard mode.
cost Number
Port path cost.
guard String
Guard 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.
linkType String
Link type.
mode String
Port mode.
priority Number
Port priority.
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