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

nxos.OspfVrf

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 VRF 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.OspfVrf("example", new()
    {
        AdminState = "enabled",
        BandwidthReference = 400000,
        BanwidthReferenceUnit = "mbps",
        Distance = 110,
        InstanceName = "OSPF1",
        RouterId = "34.56.78.90",
    });

});

    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.NewOspfVrf(ctx, "example", &nxos.OspfVrfArgs{
			AdminState:            pulumi.String("enabled"),
			BandwidthReference:    pulumi.Int(400000),
			BanwidthReferenceUnit: pulumi.String("mbps"),
			Distance:              pulumi.Int(110),
			InstanceName:          pulumi.String("OSPF1"),
			RouterId:              pulumi.String("34.56.78.90"),
		})
		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.OspfVrf;
import com.pulumi.nxos.OspfVrfArgs;
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 OspfVrf("example", OspfVrfArgs.builder()        
            .adminState("enabled")
            .bandwidthReference(400000)
            .banwidthReferenceUnit("mbps")
            .distance(110)
            .instanceName("OSPF1")
            .routerId("34.56.78.90")
            .build());

    }
}

    import pulumi
import lbrlabs_pulumi_nxos as nxos

example = nxos.OspfVrf("example",
    admin_state="enabled",
    bandwidth_reference=400000,
    banwidth_reference_unit="mbps",
    distance=110,
    instance_name="OSPF1",
    router_id="34.56.78.90")

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

const example = new nxos.OspfVrf("example", {
    adminState: "enabled",
    bandwidthReference: 400000,
    banwidthReferenceUnit: "mbps",
    distance: 110,
    instanceName: "OSPF1",
    routerId: "34.56.78.90",
});

    resources:
  example:
    type: nxos:OspfVrf
    properties:
      adminState: enabled
      bandwidthReference: 400000
      banwidthReferenceUnit: mbps
      distance: 110
      instanceName: OSPF1
      routerId: 34.56.78.90

    Create OspfVrf Resource

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

    Constructor syntax

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

@overload
def OspfVrf(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            instance_name: Optional[str] = None,
            admin_state: Optional[str] = None,
            bandwidth_reference: Optional[int] = None,
            banwidth_reference_unit: Optional[str] = None,
            device: Optional[str] = None,
            distance: Optional[int] = None,
            name: Optional[str] = None,
            router_id: Optional[str] = None)
    func NewOspfVrf(ctx *Context, name string, args OspfVrfArgs, opts ...ResourceOption) (*OspfVrf, error)
    public OspfVrf(string name, OspfVrfArgs args, CustomResourceOptions? opts = null)
    public OspfVrf(String name, OspfVrfArgs args)
public OspfVrf(String name, OspfVrfArgs args, CustomResourceOptions options)

    type: nxos:OspfVrf
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 OspfVrfArgs
    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 OspfVrfArgs
    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 OspfVrfArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OspfVrfArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OspfVrfArgs
    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 ospfVrfResource = new Nxos.OspfVrf("ospfVrfResource", new()
{
    InstanceName = "string",
    AdminState = "string",
    BandwidthReference = 0,
    BanwidthReferenceUnit = "string",
    Device = "string",
    Distance = 0,
    Name = "string",
    RouterId = "string",
});

    example, err := nxos.NewOspfVrf(ctx, "ospfVrfResource", &nxos.OspfVrfArgs{
	InstanceName:          pulumi.String("string"),
	AdminState:            pulumi.String("string"),
	BandwidthReference:    pulumi.Int(0),
	BanwidthReferenceUnit: pulumi.String("string"),
	Device:                pulumi.String("string"),
	Distance:              pulumi.Int(0),
	Name:                  pulumi.String("string"),
	RouterId:              pulumi.String("string"),
})

    var ospfVrfResource = new OspfVrf("ospfVrfResource", OspfVrfArgs.builder()
    .instanceName("string")
    .adminState("string")
    .bandwidthReference(0)
    .banwidthReferenceUnit("string")
    .device("string")
    .distance(0)
    .name("string")
    .routerId("string")
    .build());

    ospf_vrf_resource = nxos.OspfVrf("ospfVrfResource",
    instance_name="string",
    admin_state="string",
    bandwidth_reference=0,
    banwidth_reference_unit="string",
    device="string",
    distance=0,
    name="string",
    router_id="string")

    const ospfVrfResource = new nxos.OspfVrf("ospfVrfResource", {
    instanceName: "string",
    adminState: "string",
    bandwidthReference: 0,
    banwidthReferenceUnit: "string",
    device: "string",
    distance: 0,
    name: "string",
    routerId: "string",
});

    type: nxos:OspfVrf
properties:
    adminState: string
    bandwidthReference: 0
    banwidthReferenceUnit: string
    device: string
    distance: 0
    instanceName: string
    name: string
    routerId: string

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

    InstanceName string
    OSPF instance name.
    AdminState string
    Administrative state. - Choices: enabled, disabled - Default value: enabled
    BandwidthReference int
    Bandwidth reference value. - Range: 0-4294967295 - Default value: 40000
    BanwidthReferenceUnit string
    Bandwidth reference unit. - Choices: mbps, gbps - Default value: mbps
    Device string
    A device name from the provider configuration.
    Distance int
    Administrative distance preference. - Range: 1-255 - Default value: 110
    Name string
    VRF name.
    RouterId string
    Router ID. - Default value: 0.0.0.0
    InstanceName string
    OSPF instance name.
    AdminState string
    Administrative state. - Choices: enabled, disabled - Default value: enabled
    BandwidthReference int
    Bandwidth reference value. - Range: 0-4294967295 - Default value: 40000
    BanwidthReferenceUnit string
    Bandwidth reference unit. - Choices: mbps, gbps - Default value: mbps
    Device string
    A device name from the provider configuration.
    Distance int
    Administrative distance preference. - Range: 1-255 - Default value: 110
    Name string
    VRF name.
    RouterId string
    Router ID. - Default value: 0.0.0.0
    instanceName String
    OSPF instance name.
    adminState String
    Administrative state. - Choices: enabled, disabled - Default value: enabled
    bandwidthReference Integer
    Bandwidth reference value. - Range: 0-4294967295 - Default value: 40000
    banwidthReferenceUnit String
    Bandwidth reference unit. - Choices: mbps, gbps - Default value: mbps
    device String
    A device name from the provider configuration.
    distance Integer
    Administrative distance preference. - Range: 1-255 - Default value: 110
    name String
    VRF name.
    routerId String
    Router ID. - Default value: 0.0.0.0
    instanceName string
    OSPF instance name.
    adminState string
    Administrative state. - Choices: enabled, disabled - Default value: enabled
    bandwidthReference number
    Bandwidth reference value. - Range: 0-4294967295 - Default value: 40000
    banwidthReferenceUnit string
    Bandwidth reference unit. - Choices: mbps, gbps - Default value: mbps
    device string
    A device name from the provider configuration.
    distance number
    Administrative distance preference. - Range: 1-255 - Default value: 110
    name string
    VRF name.
    routerId string
    Router ID. - Default value: 0.0.0.0
    instance_name str
    OSPF instance name.
    admin_state str
    Administrative state. - Choices: enabled, disabled - Default value: enabled
    bandwidth_reference int
    Bandwidth reference value. - Range: 0-4294967295 - Default value: 40000
    banwidth_reference_unit str
    Bandwidth reference unit. - Choices: mbps, gbps - Default value: mbps
    device str
    A device name from the provider configuration.
    distance int
    Administrative distance preference. - Range: 1-255 - Default value: 110
    name str
    VRF name.
    router_id str
    Router ID. - Default value: 0.0.0.0
    instanceName String
    OSPF instance name.
    adminState String
    Administrative state. - Choices: enabled, disabled - Default value: enabled
    bandwidthReference Number
    Bandwidth reference value. - Range: 0-4294967295 - Default value: 40000
    banwidthReferenceUnit String
    Bandwidth reference unit. - Choices: mbps, gbps - Default value: mbps
    device String
    A device name from the provider configuration.
    distance Number
    Administrative distance preference. - Range: 1-255 - Default value: 110
    name String
    VRF name.
    routerId String
    Router ID. - Default value: 0.0.0.0

    Outputs

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

    Get an existing OspfVrf 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?: OspfVrfState, opts?: CustomResourceOptions): OspfVrf
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        admin_state: Optional[str] = None,
        bandwidth_reference: Optional[int] = None,
        banwidth_reference_unit: Optional[str] = None,
        device: Optional[str] = None,
        distance: Optional[int] = None,
        instance_name: Optional[str] = None,
        name: Optional[str] = None,
        router_id: Optional[str] = None) -> OspfVrf
    func GetOspfVrf(ctx *Context, name string, id IDInput, state *OspfVrfState, opts ...ResourceOption) (*OspfVrf, error)
    public static OspfVrf Get(string name, Input<string> id, OspfVrfState? state, CustomResourceOptions? opts = null)
    public static OspfVrf get(String name, Output<String> id, OspfVrfState 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
    BandwidthReference int
    Bandwidth reference value. - Range: 0-4294967295 - Default value: 40000
    BanwidthReferenceUnit string
    Bandwidth reference unit. - Choices: mbps, gbps - Default value: mbps
    Device string
    A device name from the provider configuration.
    Distance int
    Administrative distance preference. - Range: 1-255 - Default value: 110
    InstanceName string
    OSPF instance name.
    Name string
    VRF name.
    RouterId string
    Router ID. - Default value: 0.0.0.0
    AdminState string
    Administrative state. - Choices: enabled, disabled - Default value: enabled
    BandwidthReference int
    Bandwidth reference value. - Range: 0-4294967295 - Default value: 40000
    BanwidthReferenceUnit string
    Bandwidth reference unit. - Choices: mbps, gbps - Default value: mbps
    Device string
    A device name from the provider configuration.
    Distance int
    Administrative distance preference. - Range: 1-255 - Default value: 110
    InstanceName string
    OSPF instance name.
    Name string
    VRF name.
    RouterId string
    Router ID. - Default value: 0.0.0.0
    adminState String
    Administrative state. - Choices: enabled, disabled - Default value: enabled
    bandwidthReference Integer
    Bandwidth reference value. - Range: 0-4294967295 - Default value: 40000
    banwidthReferenceUnit String
    Bandwidth reference unit. - Choices: mbps, gbps - Default value: mbps
    device String
    A device name from the provider configuration.
    distance Integer
    Administrative distance preference. - Range: 1-255 - Default value: 110
    instanceName String
    OSPF instance name.
    name String
    VRF name.
    routerId String
    Router ID. - Default value: 0.0.0.0
    adminState string
    Administrative state. - Choices: enabled, disabled - Default value: enabled
    bandwidthReference number
    Bandwidth reference value. - Range: 0-4294967295 - Default value: 40000
    banwidthReferenceUnit string
    Bandwidth reference unit. - Choices: mbps, gbps - Default value: mbps
    device string
    A device name from the provider configuration.
    distance number
    Administrative distance preference. - Range: 1-255 - Default value: 110
    instanceName string
    OSPF instance name.
    name string
    VRF name.
    routerId string
    Router ID. - Default value: 0.0.0.0
    admin_state str
    Administrative state. - Choices: enabled, disabled - Default value: enabled
    bandwidth_reference int
    Bandwidth reference value. - Range: 0-4294967295 - Default value: 40000
    banwidth_reference_unit str
    Bandwidth reference unit. - Choices: mbps, gbps - Default value: mbps
    device str
    A device name from the provider configuration.
    distance int
    Administrative distance preference. - Range: 1-255 - Default value: 110
    instance_name str
    OSPF instance name.
    name str
    VRF name.
    router_id str
    Router ID. - Default value: 0.0.0.0
    adminState String
    Administrative state. - Choices: enabled, disabled - Default value: enabled
    bandwidthReference Number
    Bandwidth reference value. - Range: 0-4294967295 - Default value: 40000
    banwidthReferenceUnit String
    Bandwidth reference unit. - Choices: mbps, gbps - Default value: mbps
    device String
    A device name from the provider configuration.
    distance Number
    Administrative distance preference. - Range: 1-255 - Default value: 110
    instanceName String
    OSPF instance name.
    name String
    VRF name.
    routerId String
    Router ID. - Default value: 0.0.0.0

    Import

     $ pulumi import nxos:index/ospfVrf:OspfVrf example "sys/ospf/inst-[OSPF1]/dom-[VRF1]"

    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