Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs
nxos.getSpanningTreeInterface
Explore with Pulumi AI
This data source can read the Spanning Tree interface configuration.
- API Documentation: stpIf
 
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",
    });
});
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
	})
}
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());
    }
}
import * as pulumi from "@pulumi/pulumi";
import * as nxos from "@pulumi/nxos";
const example = nxos.getSpanningTreeInterface({
    interfaceId: "eth1/9",
});
import pulumi
import pulumi_nxos as nxos
example = nxos.get_spanning_tree_interface(interface_id="eth1/9")
variables:
  example:
    fn::invoke:
      Function: nxos:getSpanningTreeInterface
      Arguments:
        interfaceId: eth1/9
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>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]func LookupSpanningTreeInterface(ctx *Context, args *LookupSpanningTreeInterfaceArgs, opts ...InvokeOption) (*LookupSpanningTreeInterfaceResult, error)
func LookupSpanningTreeInterfaceOutput(ctx *Context, args *LookupSpanningTreeInterfaceOutputArgs, opts ...InvokeOption) LookupSpanningTreeInterfaceResultOutput> 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)
}public static CompletableFuture<GetSpanningTreeInterfaceResult> getSpanningTreeInterface(GetSpanningTreeInterfaceArgs args, InvokeOptions options)
public static Output<GetSpanningTreeInterfaceResult> getSpanningTreeInterface(GetSpanningTreeInterfaceArgs args, InvokeOptions options)
fn::invoke:
  function: nxos:index/getSpanningTreeInterface:getSpanningTreeInterface
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Interface
Id 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 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 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 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.
 
- interface
Id 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:
- Admin
State string - The administrative state of the object or policy.
 - Bpdu
Filter string - BPDU filter mode.
 - Bpdu
Guard string - BPDU guard mode.
 - Cost int
 - Port path cost.
 - Guard string
 - Guard mode.
 - Id string
 - The distinguished name of the object.
 - Interface
Id string - Must match first field in the output of 
show intf brief. Example:eth1/1. - Link
Type string - Link type.
 - Mode string
 - Port mode.
 - Priority int
 - Port priority.
 - Device string
 - A device name from the provider configuration.
 
- Admin
State string - The administrative state of the object or policy.
 - Bpdu
Filter string - BPDU filter mode.
 - Bpdu
Guard string - BPDU guard mode.
 - Cost int
 - Port path cost.
 - Guard string
 - Guard mode.
 - Id string
 - The distinguished name of the object.
 - Interface
Id string - Must match first field in the output of 
show intf brief. Example:eth1/1. - Link
Type string - Link type.
 - Mode string
 - Port mode.
 - Priority int
 - Port priority.
 - Device string
 - A device name from the provider configuration.
 
- admin
State String - The administrative state of the object or policy.
 - bpdu
Filter String - BPDU filter mode.
 - bpdu
Guard String - BPDU guard mode.
 - cost Integer
 - Port path cost.
 - guard String
 - Guard mode.
 - id String
 - The distinguished name of the object.
 - interface
Id String - Must match first field in the output of 
show intf brief. Example:eth1/1. - link
Type String - Link type.
 - mode String
 - Port mode.
 - priority Integer
 - Port priority.
 - device String
 - A device name from the provider configuration.
 
- admin
State string - The administrative state of the object or policy.
 - bpdu
Filter string - BPDU filter mode.
 - bpdu
Guard string - BPDU guard mode.
 - cost number
 - Port path cost.
 - guard string
 - Guard mode.
 - id string
 - The distinguished name of the object.
 - interface
Id string - Must match first field in the output of 
show intf brief. Example:eth1/1. - link
Type 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.
 
- admin
State String - The administrative state of the object or policy.
 - bpdu
Filter String - BPDU filter mode.
 - bpdu
Guard String - BPDU guard mode.
 - cost Number
 - Port path cost.
 - guard String
 - Guard mode.
 - id String
 - The distinguished name of the object.
 - interface
Id String - Must match first field in the output of 
show intf brief. Example:eth1/1. - link
Type 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 
nxosTerraform Provider.