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

nxos.OspfInstance

Explore with Pulumi AI

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

    This resource can manage the OSPF instance 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.OspfInstance("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.NewOspfInstance(ctx, "example", &nxos.OspfInstanceArgs{
			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.OspfInstance;
import com.pulumi.nxos.OspfInstanceArgs;
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 OspfInstance("example", OspfInstanceArgs.builder()        
            .adminState("enabled")
            .build());

    }
}

    import pulumi
import lbrlabs_pulumi_nxos as nxos

example = nxos.OspfInstance("example", admin_state="enabled")

    import * as pulumi from "@pulumi/pulumi";
import * as nxos from "@lbrlabs/pulumi-nxos";

const example = new nxos.OspfInstance("example", {adminState: "enabled"});

    resources:
  example:
    type: nxos:OspfInstance
    properties:
      adminState: enabled

    Create OspfInstance Resource

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

    Constructor syntax

    new OspfInstance(name: string, args?: OspfInstanceArgs, opts?: CustomResourceOptions);
    @overload
def OspfInstance(resource_name: str,
                 args: Optional[OspfInstanceArgs] = None,
                 opts: Optional[ResourceOptions] = None)

@overload
def OspfInstance(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 admin_state: Optional[str] = None,
                 device: Optional[str] = None,
                 name: Optional[str] = None)
    func NewOspfInstance(ctx *Context, name string, args *OspfInstanceArgs, opts ...ResourceOption) (*OspfInstance, error)
    public OspfInstance(string name, OspfInstanceArgs? args = null, CustomResourceOptions? opts = null)
    public OspfInstance(String name, OspfInstanceArgs args)
public OspfInstance(String name, OspfInstanceArgs args, CustomResourceOptions options)

    type: nxos:OspfInstance
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 OspfInstanceArgs
    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 OspfInstanceArgs
    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 OspfInstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OspfInstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OspfInstanceArgs
    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 ospfInstanceResource = new Nxos.OspfInstance("ospfInstanceResource", new()
{
    AdminState = "string",
    Device = "string",
    Name = "string",
});

    example, err := nxos.NewOspfInstance(ctx, "ospfInstanceResource", &nxos.OspfInstanceArgs{
	AdminState: pulumi.String("string"),
	Device:     pulumi.String("string"),
	Name:       pulumi.String("string"),
})

    var ospfInstanceResource = new OspfInstance("ospfInstanceResource", OspfInstanceArgs.builder()
    .adminState("string")
    .device("string")
    .name("string")
    .build());

    ospf_instance_resource = nxos.OspfInstance("ospfInstanceResource",
    admin_state="string",
    device="string",
    name="string")

    const ospfInstanceResource = new nxos.OspfInstance("ospfInstanceResource", {
    adminState: "string",
    device: "string",
    name: "string",
});

    type: nxos:OspfInstance
properties:
    adminState: string
    device: string
    name: string

    OspfInstance Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The OspfInstance resource accepts the following input properties:

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

    Outputs

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

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

    Import

     $ pulumi import nxos:index/ospfInstance:OspfInstance example "sys/ospf/inst-[OSPF1]"

    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
    lbrlabs/pulumi-nxos