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

nxos.HmmInterface

Explore with Pulumi AI

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

    This resource can manage the HMM Fabric Forwarding mode information related to an Interface.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Nxos = Lbrlabs.PulumiPackage.Nxos;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Nxos.HmmInterface("example", new()
        {
            AdminState = "enabled",
            InterfaceId = "vlan10",
            Mode = "anycastGW",
        });
    
    });
    
    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.NewHmmInterface(ctx, "example", &nxos.HmmInterfaceArgs{
    			AdminState:  pulumi.String("enabled"),
    			InterfaceId: pulumi.String("vlan10"),
    			Mode:        pulumi.String("anycastGW"),
    		})
    		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.HmmInterface;
    import com.pulumi.nxos.HmmInterfaceArgs;
    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) {
            var example = new HmmInterface("example", HmmInterfaceArgs.builder()        
                .adminState("enabled")
                .interfaceId("vlan10")
                .mode("anycastGW")
                .build());
    
        }
    }
    
    import pulumi
    import lbrlabs_pulumi_nxos as nxos
    
    example = nxos.HmmInterface("example",
        admin_state="enabled",
        interface_id="vlan10",
        mode="anycastGW")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as nxos from "@lbrlabs/pulumi-nxos";
    
    const example = new nxos.HmmInterface("example", {
        adminState: "enabled",
        interfaceId: "vlan10",
        mode: "anycastGW",
    });
    
    resources:
      example:
        type: nxos:HmmInterface
        properties:
          adminState: enabled
          interfaceId: vlan10
          mode: anycastGW
    

    Create HmmInterface Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new HmmInterface(name: string, args: HmmInterfaceArgs, opts?: CustomResourceOptions);
    @overload
    def HmmInterface(resource_name: str,
                     args: HmmInterfaceArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def HmmInterface(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     interface_id: Optional[str] = None,
                     admin_state: Optional[str] = None,
                     device: Optional[str] = None,
                     mode: Optional[str] = None)
    func NewHmmInterface(ctx *Context, name string, args HmmInterfaceArgs, opts ...ResourceOption) (*HmmInterface, error)
    public HmmInterface(string name, HmmInterfaceArgs args, CustomResourceOptions? opts = null)
    public HmmInterface(String name, HmmInterfaceArgs args)
    public HmmInterface(String name, HmmInterfaceArgs args, CustomResourceOptions options)
    
    type: nxos:HmmInterface
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args HmmInterfaceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args HmmInterfaceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args HmmInterfaceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args HmmInterfaceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args HmmInterfaceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var hmmInterfaceResource = new Nxos.HmmInterface("hmmInterfaceResource", new()
    {
        InterfaceId = "string",
        AdminState = "string",
        Device = "string",
        Mode = "string",
    });
    
    example, err := nxos.NewHmmInterface(ctx, "hmmInterfaceResource", &nxos.HmmInterfaceArgs{
    	InterfaceId: pulumi.String("string"),
    	AdminState:  pulumi.String("string"),
    	Device:      pulumi.String("string"),
    	Mode:        pulumi.String("string"),
    })
    
    var hmmInterfaceResource = new HmmInterface("hmmInterfaceResource", HmmInterfaceArgs.builder()
        .interfaceId("string")
        .adminState("string")
        .device("string")
        .mode("string")
        .build());
    
    hmm_interface_resource = nxos.HmmInterface("hmmInterfaceResource",
        interface_id="string",
        admin_state="string",
        device="string",
        mode="string")
    
    const hmmInterfaceResource = new nxos.HmmInterface("hmmInterfaceResource", {
        interfaceId: "string",
        adminState: "string",
        device: "string",
        mode: "string",
    });
    
    type: nxos:HmmInterface
    properties:
        adminState: string
        device: string
        interfaceId: string
        mode: string
    

    HmmInterface Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The HmmInterface resource accepts the following input properties:

    InterfaceId string
    Must match first field in the output of show intf brief. Example: vlan10.
    AdminState string
    Administrative state. - Choices: enabled, disabled - Default value: enabled
    Device string
    A device name from the provider configuration.
    Mode string
    HMM Fabric Forwarding mode information for the interface. - Choices: standard, anycastGW, proxyGW - Default value: standard
    InterfaceId string
    Must match first field in the output of show intf brief. Example: vlan10.
    AdminState string
    Administrative state. - Choices: enabled, disabled - Default value: enabled
    Device string
    A device name from the provider configuration.
    Mode string
    HMM Fabric Forwarding mode information for the interface. - Choices: standard, anycastGW, proxyGW - Default value: standard
    interfaceId String
    Must match first field in the output of show intf brief. Example: vlan10.
    adminState String
    Administrative state. - Choices: enabled, disabled - Default value: enabled
    device String
    A device name from the provider configuration.
    mode String
    HMM Fabric Forwarding mode information for the interface. - Choices: standard, anycastGW, proxyGW - Default value: standard
    interfaceId string
    Must match first field in the output of show intf brief. Example: vlan10.
    adminState string
    Administrative state. - Choices: enabled, disabled - Default value: enabled
    device string
    A device name from the provider configuration.
    mode string
    HMM Fabric Forwarding mode information for the interface. - Choices: standard, anycastGW, proxyGW - Default value: standard
    interface_id str
    Must match first field in the output of show intf brief. Example: vlan10.
    admin_state str
    Administrative state. - Choices: enabled, disabled - Default value: enabled
    device str
    A device name from the provider configuration.
    mode str
    HMM Fabric Forwarding mode information for the interface. - Choices: standard, anycastGW, proxyGW - Default value: standard
    interfaceId String
    Must match first field in the output of show intf brief. Example: vlan10.
    adminState String
    Administrative state. - Choices: enabled, disabled - Default value: enabled
    device String
    A device name from the provider configuration.
    mode String
    HMM Fabric Forwarding mode information for the interface. - Choices: standard, anycastGW, proxyGW - Default value: standard

    Outputs

    All input properties are implicitly available as output properties. Additionally, the HmmInterface resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing HmmInterface Resource

    Get an existing HmmInterface resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: HmmInterfaceState, opts?: CustomResourceOptions): HmmInterface
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            admin_state: Optional[str] = None,
            device: Optional[str] = None,
            interface_id: Optional[str] = None,
            mode: Optional[str] = None) -> HmmInterface
    func GetHmmInterface(ctx *Context, name string, id IDInput, state *HmmInterfaceState, opts ...ResourceOption) (*HmmInterface, error)
    public static HmmInterface Get(string name, Input<string> id, HmmInterfaceState? state, CustomResourceOptions? opts = null)
    public static HmmInterface get(String name, Output<String> id, HmmInterfaceState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AdminState string
    Administrative state. - Choices: enabled, disabled - Default value: enabled
    Device string
    A device name from the provider configuration.
    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. - Choices: standard, anycastGW, proxyGW - Default value: standard
    AdminState string
    Administrative state. - Choices: enabled, disabled - Default value: enabled
    Device string
    A device name from the provider configuration.
    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. - Choices: standard, anycastGW, proxyGW - Default value: standard
    adminState String
    Administrative state. - Choices: enabled, disabled - Default value: enabled
    device String
    A device name from the provider configuration.
    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. - Choices: standard, anycastGW, proxyGW - Default value: standard
    adminState string
    Administrative state. - Choices: enabled, disabled - Default value: enabled
    device string
    A device name from the provider configuration.
    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. - Choices: standard, anycastGW, proxyGW - Default value: standard
    admin_state str
    Administrative state. - Choices: enabled, disabled - Default value: enabled
    device str
    A device name from the provider configuration.
    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. - Choices: standard, anycastGW, proxyGW - Default value: standard
    adminState String
    Administrative state. - Choices: enabled, disabled - Default value: enabled
    device String
    A device name from the provider configuration.
    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. - Choices: standard, anycastGW, proxyGW - Default value: standard

    Import

     $ pulumi import nxos:index/hmmInterface:HmmInterface example "sys/hmm/fwdinst/if-[vlan10]"
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    nxos lbrlabs/pulumi-nxos
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the nxos Terraform Provider.
    nxos logo
    Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs