1. Packages
  2. Cisco NX OS Resource Provider
  3. API Docs
  4. getHmmInterface
Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs

nxos.getHmmInterface

Explore with Pulumi AI

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

This data source can read the HMM Fabric Forwarding mode information related to an Interface.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var example = Nxos.GetHmmInterface.Invoke(new()
    {
        InterfaceId = "vlan10",
    });

});
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.LookupHmmInterface(ctx, &nxos.LookupHmmInterfaceArgs{
			InterfaceId: "vlan10",
		}, 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.GetHmmInterfaceArgs;
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.getHmmInterface(GetHmmInterfaceArgs.builder()
            .interfaceId("vlan10")
            .build());

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

const example = nxos.getHmmInterface({
    interfaceId: "vlan10",
});
Copy
import pulumi
import pulumi_nxos as nxos

example = nxos.get_hmm_interface(interface_id="vlan10")
Copy
variables:
  example:
    fn::invoke:
      Function: nxos:getHmmInterface
      Arguments:
        interfaceId: vlan10
Copy

Using getHmmInterface

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 getHmmInterface(args: GetHmmInterfaceArgs, opts?: InvokeOptions): Promise<GetHmmInterfaceResult>
function getHmmInterfaceOutput(args: GetHmmInterfaceOutputArgs, opts?: InvokeOptions): Output<GetHmmInterfaceResult>
Copy
def get_hmm_interface(device: Optional[str] = None,
                      interface_id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetHmmInterfaceResult
def get_hmm_interface_output(device: Optional[pulumi.Input[str]] = None,
                      interface_id: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetHmmInterfaceResult]
Copy
func LookupHmmInterface(ctx *Context, args *LookupHmmInterfaceArgs, opts ...InvokeOption) (*LookupHmmInterfaceResult, error)
func LookupHmmInterfaceOutput(ctx *Context, args *LookupHmmInterfaceOutputArgs, opts ...InvokeOption) LookupHmmInterfaceResultOutput
Copy

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

public static class GetHmmInterface 
{
    public static Task<GetHmmInterfaceResult> InvokeAsync(GetHmmInterfaceArgs args, InvokeOptions? opts = null)
    public static Output<GetHmmInterfaceResult> Invoke(GetHmmInterfaceInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetHmmInterfaceResult> getHmmInterface(GetHmmInterfaceArgs args, InvokeOptions options)
public static Output<GetHmmInterfaceResult> getHmmInterface(GetHmmInterfaceArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: nxos:index/getHmmInterface:getHmmInterface
  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: vlan10.
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: vlan10.
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: vlan10.
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: vlan10.
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: vlan10.
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: vlan10.
device String
A device name from the provider configuration.

getHmmInterface Result

The following output properties are available:

AdminState string
Administrative state.
Id string
The distinguished name of the object.
InterfaceId string
Must match first field in the output of show intf brief. Example: vlan10.
Mode string
HMM Fabric Forwarding mode information for the interface.
Device string
A device name from the provider configuration.
AdminState string
Administrative state.
Id string
The distinguished name of the object.
InterfaceId string
Must match first field in the output of show intf brief. Example: vlan10.
Mode string
HMM Fabric Forwarding mode information for the interface.
Device string
A device name from the provider configuration.
adminState String
Administrative state.
id String
The distinguished name of the object.
interfaceId String
Must match first field in the output of show intf brief. Example: vlan10.
mode String
HMM Fabric Forwarding mode information for the interface.
device String
A device name from the provider configuration.
adminState string
Administrative state.
id string
The distinguished name of the object.
interfaceId string
Must match first field in the output of show intf brief. Example: vlan10.
mode string
HMM Fabric Forwarding mode information for the interface.
device string
A device name from the provider configuration.
admin_state str
Administrative state.
id str
The distinguished name of the object.
interface_id str
Must match first field in the output of show intf brief. Example: vlan10.
mode str
HMM Fabric Forwarding mode information for the interface.
device str
A device name from the provider configuration.
adminState String
Administrative state.
id String
The distinguished name of the object.
interfaceId String
Must match first field in the output of show intf brief. Example: vlan10.
mode String
HMM Fabric Forwarding mode information for the interface.
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