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

nxos.OspfArea

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 Area 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.OspfArea("example", new()
    {
        AreaId = "0.0.0.10",
        AuthenticationType = "none",
        Cost = 10,
        InstanceName = "OSPF1",
        Type = "stub",
        VrfName = "VRF1",
    });

});

    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.NewOspfArea(ctx, "example", &nxos.OspfAreaArgs{
			AreaId:             pulumi.String("0.0.0.10"),
			AuthenticationType: pulumi.String("none"),
			Cost:               pulumi.Int(10),
			InstanceName:       pulumi.String("OSPF1"),
			Type:               pulumi.String("stub"),
			VrfName:            pulumi.String("VRF1"),
		})
		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.OspfArea;
import com.pulumi.nxos.OspfAreaArgs;
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 OspfArea("example", OspfAreaArgs.builder()        
            .areaId("0.0.0.10")
            .authenticationType("none")
            .cost(10)
            .instanceName("OSPF1")
            .type("stub")
            .vrfName("VRF1")
            .build());

    }
}

    import pulumi
import lbrlabs_pulumi_nxos as nxos

example = nxos.OspfArea("example",
    area_id="0.0.0.10",
    authentication_type="none",
    cost=10,
    instance_name="OSPF1",
    type="stub",
    vrf_name="VRF1")

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

const example = new nxos.OspfArea("example", {
    areaId: "0.0.0.10",
    authenticationType: "none",
    cost: 10,
    instanceName: "OSPF1",
    type: "stub",
    vrfName: "VRF1",
});

    resources:
  example:
    type: nxos:OspfArea
    properties:
      areaId: 0.0.0.10
      authenticationType: none
      cost: 10
      instanceName: OSPF1
      type: stub
      vrfName: VRF1

    Create OspfArea Resource

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

    Constructor syntax

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

@overload
def OspfArea(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             area_id: Optional[str] = None,
             instance_name: Optional[str] = None,
             vrf_name: Optional[str] = None,
             authentication_type: Optional[str] = None,
             cost: Optional[int] = None,
             device: Optional[str] = None,
             type: Optional[str] = None)
    func NewOspfArea(ctx *Context, name string, args OspfAreaArgs, opts ...ResourceOption) (*OspfArea, error)
    public OspfArea(string name, OspfAreaArgs args, CustomResourceOptions? opts = null)
    public OspfArea(String name, OspfAreaArgs args)
public OspfArea(String name, OspfAreaArgs args, CustomResourceOptions options)

    type: nxos:OspfArea
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 OspfAreaArgs
    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 OspfAreaArgs
    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 OspfAreaArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OspfAreaArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OspfAreaArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var ospfAreaResource = new Nxos.OspfArea("ospfAreaResource", new()
{
    AreaId = "string",
    InstanceName = "string",
    VrfName = "string",
    AuthenticationType = "string",
    Cost = 0,
    Device = "string",
    Type = "string",
});

    example, err := nxos.NewOspfArea(ctx, "ospfAreaResource", &nxos.OspfAreaArgs{
	AreaId:             pulumi.String("string"),
	InstanceName:       pulumi.String("string"),
	VrfName:            pulumi.String("string"),
	AuthenticationType: pulumi.String("string"),
	Cost:               pulumi.Int(0),
	Device:             pulumi.String("string"),
	Type:               pulumi.String("string"),
})

    var ospfAreaResource = new OspfArea("ospfAreaResource", OspfAreaArgs.builder()
    .areaId("string")
    .instanceName("string")
    .vrfName("string")
    .authenticationType("string")
    .cost(0)
    .device("string")
    .type("string")
    .build());

    ospf_area_resource = nxos.OspfArea("ospfAreaResource",
    area_id="string",
    instance_name="string",
    vrf_name="string",
    authentication_type="string",
    cost=0,
    device="string",
    type="string")

    const ospfAreaResource = new nxos.OspfArea("ospfAreaResource", {
    areaId: "string",
    instanceName: "string",
    vrfName: "string",
    authenticationType: "string",
    cost: 0,
    device: "string",
    type: "string",
});

    type: nxos:OspfArea
properties:
    areaId: string
    authenticationType: string
    cost: 0
    device: string
    instanceName: string
    type: string
    vrfName: string

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

    AreaId string
    Area identifier to which a network or interface belongs in IPv4 address format. - Default value: 0.0.0.0
    InstanceName string
    OSPF instance name.
    VrfName string
    VRF name.
    AuthenticationType string
    Authentication type. - Choices: none, simple, md5, unspecified - Default value: unspecified
    Cost int
    Area cost, specifies cost for default summary LSAs. Used with nssa/stub area types. - Range: 0-16777215 - Default value: 1
    Device string
    A device name from the provider configuration.
    Type string
    Area type. - Choices: regular, stub, nssa - Default value: regular
    AreaId string
    Area identifier to which a network or interface belongs in IPv4 address format. - Default value: 0.0.0.0
    InstanceName string
    OSPF instance name.
    VrfName string
    VRF name.
    AuthenticationType string
    Authentication type. - Choices: none, simple, md5, unspecified - Default value: unspecified
    Cost int
    Area cost, specifies cost for default summary LSAs. Used with nssa/stub area types. - Range: 0-16777215 - Default value: 1
    Device string
    A device name from the provider configuration.
    Type string
    Area type. - Choices: regular, stub, nssa - Default value: regular
    areaId String
    Area identifier to which a network or interface belongs in IPv4 address format. - Default value: 0.0.0.0
    instanceName String
    OSPF instance name.
    vrfName String
    VRF name.
    authenticationType String
    Authentication type. - Choices: none, simple, md5, unspecified - Default value: unspecified
    cost Integer
    Area cost, specifies cost for default summary LSAs. Used with nssa/stub area types. - Range: 0-16777215 - Default value: 1
    device String
    A device name from the provider configuration.
    type String
    Area type. - Choices: regular, stub, nssa - Default value: regular
    areaId string
    Area identifier to which a network or interface belongs in IPv4 address format. - Default value: 0.0.0.0
    instanceName string
    OSPF instance name.
    vrfName string
    VRF name.
    authenticationType string
    Authentication type. - Choices: none, simple, md5, unspecified - Default value: unspecified
    cost number
    Area cost, specifies cost for default summary LSAs. Used with nssa/stub area types. - Range: 0-16777215 - Default value: 1
    device string
    A device name from the provider configuration.
    type string
    Area type. - Choices: regular, stub, nssa - Default value: regular
    area_id str
    Area identifier to which a network or interface belongs in IPv4 address format. - Default value: 0.0.0.0
    instance_name str
    OSPF instance name.
    vrf_name str
    VRF name.
    authentication_type str
    Authentication type. - Choices: none, simple, md5, unspecified - Default value: unspecified
    cost int
    Area cost, specifies cost for default summary LSAs. Used with nssa/stub area types. - Range: 0-16777215 - Default value: 1
    device str
    A device name from the provider configuration.
    type str
    Area type. - Choices: regular, stub, nssa - Default value: regular
    areaId String
    Area identifier to which a network or interface belongs in IPv4 address format. - Default value: 0.0.0.0
    instanceName String
    OSPF instance name.
    vrfName String
    VRF name.
    authenticationType String
    Authentication type. - Choices: none, simple, md5, unspecified - Default value: unspecified
    cost Number
    Area cost, specifies cost for default summary LSAs. Used with nssa/stub area types. - Range: 0-16777215 - Default value: 1
    device String
    A device name from the provider configuration.
    type String
    Area type. - Choices: regular, stub, nssa - Default value: regular

    Outputs

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

    Get an existing OspfArea 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?: OspfAreaState, opts?: CustomResourceOptions): OspfArea
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        area_id: Optional[str] = None,
        authentication_type: Optional[str] = None,
        cost: Optional[int] = None,
        device: Optional[str] = None,
        instance_name: Optional[str] = None,
        type: Optional[str] = None,
        vrf_name: Optional[str] = None) -> OspfArea
    func GetOspfArea(ctx *Context, name string, id IDInput, state *OspfAreaState, opts ...ResourceOption) (*OspfArea, error)
    public static OspfArea Get(string name, Input<string> id, OspfAreaState? state, CustomResourceOptions? opts = null)
    public static OspfArea get(String name, Output<String> id, OspfAreaState 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:
    AreaId string
    Area identifier to which a network or interface belongs in IPv4 address format. - Default value: 0.0.0.0
    AuthenticationType string
    Authentication type. - Choices: none, simple, md5, unspecified - Default value: unspecified
    Cost int
    Area cost, specifies cost for default summary LSAs. Used with nssa/stub area types. - Range: 0-16777215 - Default value: 1
    Device string
    A device name from the provider configuration.
    InstanceName string
    OSPF instance name.
    Type string
    Area type. - Choices: regular, stub, nssa - Default value: regular
    VrfName string
    VRF name.
    AreaId string
    Area identifier to which a network or interface belongs in IPv4 address format. - Default value: 0.0.0.0
    AuthenticationType string
    Authentication type. - Choices: none, simple, md5, unspecified - Default value: unspecified
    Cost int
    Area cost, specifies cost for default summary LSAs. Used with nssa/stub area types. - Range: 0-16777215 - Default value: 1
    Device string
    A device name from the provider configuration.
    InstanceName string
    OSPF instance name.
    Type string
    Area type. - Choices: regular, stub, nssa - Default value: regular
    VrfName string
    VRF name.
    areaId String
    Area identifier to which a network or interface belongs in IPv4 address format. - Default value: 0.0.0.0
    authenticationType String
    Authentication type. - Choices: none, simple, md5, unspecified - Default value: unspecified
    cost Integer
    Area cost, specifies cost for default summary LSAs. Used with nssa/stub area types. - Range: 0-16777215 - Default value: 1
    device String
    A device name from the provider configuration.
    instanceName String
    OSPF instance name.
    type String
    Area type. - Choices: regular, stub, nssa - Default value: regular
    vrfName String
    VRF name.
    areaId string
    Area identifier to which a network or interface belongs in IPv4 address format. - Default value: 0.0.0.0
    authenticationType string
    Authentication type. - Choices: none, simple, md5, unspecified - Default value: unspecified
    cost number
    Area cost, specifies cost for default summary LSAs. Used with nssa/stub area types. - Range: 0-16777215 - Default value: 1
    device string
    A device name from the provider configuration.
    instanceName string
    OSPF instance name.
    type string
    Area type. - Choices: regular, stub, nssa - Default value: regular
    vrfName string
    VRF name.
    area_id str
    Area identifier to which a network or interface belongs in IPv4 address format. - Default value: 0.0.0.0
    authentication_type str
    Authentication type. - Choices: none, simple, md5, unspecified - Default value: unspecified
    cost int
    Area cost, specifies cost for default summary LSAs. Used with nssa/stub area types. - Range: 0-16777215 - Default value: 1
    device str
    A device name from the provider configuration.
    instance_name str
    OSPF instance name.
    type str
    Area type. - Choices: regular, stub, nssa - Default value: regular
    vrf_name str
    VRF name.
    areaId String
    Area identifier to which a network or interface belongs in IPv4 address format. - Default value: 0.0.0.0
    authenticationType String
    Authentication type. - Choices: none, simple, md5, unspecified - Default value: unspecified
    cost Number
    Area cost, specifies cost for default summary LSAs. Used with nssa/stub area types. - Range: 0-16777215 - Default value: 1
    device String
    A device name from the provider configuration.
    instanceName String
    OSPF instance name.
    type String
    Area type. - Choices: regular, stub, nssa - Default value: regular
    vrfName String
    VRF name.

    Import

     $ pulumi import nxos:index/ospfArea:OspfArea example "sys/ospf/inst-[OSPF1]/dom-[VRF1]/area-[0.0.0.10]"

    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