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

nxos.FeatureHsrp

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 HSRP feature configuration.

    Example Usage

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

    Create FeatureHsrp Resource

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

    Constructor syntax

    new FeatureHsrp(name: string, args: FeatureHsrpArgs, opts?: CustomResourceOptions);
    @overload
    def FeatureHsrp(resource_name: str,
                    args: FeatureHsrpArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def FeatureHsrp(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    admin_state: Optional[str] = None,
                    device: Optional[str] = None)
    func NewFeatureHsrp(ctx *Context, name string, args FeatureHsrpArgs, opts ...ResourceOption) (*FeatureHsrp, error)
    public FeatureHsrp(string name, FeatureHsrpArgs args, CustomResourceOptions? opts = null)
    public FeatureHsrp(String name, FeatureHsrpArgs args)
    public FeatureHsrp(String name, FeatureHsrpArgs args, CustomResourceOptions options)
    
    type: nxos:FeatureHsrp
    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 FeatureHsrpArgs
    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 FeatureHsrpArgs
    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 FeatureHsrpArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FeatureHsrpArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FeatureHsrpArgs
    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 featureHsrpResource = new Nxos.FeatureHsrp("featureHsrpResource", new()
    {
        AdminState = "string",
        Device = "string",
    });
    
    example, err := nxos.NewFeatureHsrp(ctx, "featureHsrpResource", &nxos.FeatureHsrpArgs{
    	AdminState: pulumi.String("string"),
    	Device:     pulumi.String("string"),
    })
    
    var featureHsrpResource = new FeatureHsrp("featureHsrpResource", FeatureHsrpArgs.builder()
        .adminState("string")
        .device("string")
        .build());
    
    feature_hsrp_resource = nxos.FeatureHsrp("featureHsrpResource",
        admin_state="string",
        device="string")
    
    const featureHsrpResource = new nxos.FeatureHsrp("featureHsrpResource", {
        adminState: "string",
        device: "string",
    });
    
    type: nxos:FeatureHsrp
    properties:
        adminState: string
        device: string
    

    FeatureHsrp 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 FeatureHsrp resource accepts the following input properties:

    AdminState string
    Administrative state. - Choices: enabled, disabled
    Device string
    A device name from the provider configuration.
    AdminState string
    Administrative state. - Choices: enabled, disabled
    Device string
    A device name from the provider configuration.
    adminState String
    Administrative state. - Choices: enabled, disabled
    device String
    A device name from the provider configuration.
    adminState string
    Administrative state. - Choices: enabled, disabled
    device string
    A device name from the provider configuration.
    admin_state str
    Administrative state. - Choices: enabled, disabled
    device str
    A device name from the provider configuration.
    adminState String
    Administrative state. - Choices: enabled, disabled
    device String
    A device name from the provider configuration.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the FeatureHsrp 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 FeatureHsrp Resource

    Get an existing FeatureHsrp 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?: FeatureHsrpState, opts?: CustomResourceOptions): FeatureHsrp
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            admin_state: Optional[str] = None,
            device: Optional[str] = None) -> FeatureHsrp
    func GetFeatureHsrp(ctx *Context, name string, id IDInput, state *FeatureHsrpState, opts ...ResourceOption) (*FeatureHsrp, error)
    public static FeatureHsrp Get(string name, Input<string> id, FeatureHsrpState? state, CustomResourceOptions? opts = null)
    public static FeatureHsrp get(String name, Output<String> id, FeatureHsrpState 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
    Device string
    A device name from the provider configuration.
    AdminState string
    Administrative state. - Choices: enabled, disabled
    Device string
    A device name from the provider configuration.
    adminState String
    Administrative state. - Choices: enabled, disabled
    device String
    A device name from the provider configuration.
    adminState string
    Administrative state. - Choices: enabled, disabled
    device string
    A device name from the provider configuration.
    admin_state str
    Administrative state. - Choices: enabled, disabled
    device str
    A device name from the provider configuration.
    adminState String
    Administrative state. - Choices: enabled, disabled
    device String
    A device name from the provider configuration.

    Import

     $ pulumi import nxos:index/featureHsrp:FeatureHsrp example "sys/fm/hsrp"
    

    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