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

nxos.BgpVrf

Explore with Pulumi AI

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

This resource can manage the BGP domain (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.BgpVrf("example", new()
    {
        Asn = "65001",
        RouterId = "1.1.1.1",
    });

});
Copy
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.NewBgpVrf(ctx, "example", &nxos.BgpVrfArgs{
			Asn:      pulumi.String("65001"),
			RouterId: pulumi.String("1.1.1.1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.nxos.BgpVrf;
import com.pulumi.nxos.BgpVrfArgs;
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 BgpVrf("example", BgpVrfArgs.builder()        
            .asn("65001")
            .routerId("1.1.1.1")
            .build());

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

const example = new nxos.BgpVrf("example", {
    asn: "65001",
    routerId: "1.1.1.1",
});
Copy
import pulumi
import lbrlabs_pulumi_nxos as nxos

example = nxos.BgpVrf("example",
    asn="65001",
    router_id="1.1.1.1")
Copy
resources:
  example:
    type: nxos:BgpVrf
    properties:
      asn: '65001'
      routerId: 1.1.1.1
Copy

Create BgpVrf Resource

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

Constructor syntax

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

@overload
def BgpVrf(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           asn: Optional[str] = None,
           device: Optional[str] = None,
           name: Optional[str] = None,
           router_id: Optional[str] = None)
func NewBgpVrf(ctx *Context, name string, args BgpVrfArgs, opts ...ResourceOption) (*BgpVrf, error)
public BgpVrf(string name, BgpVrfArgs args, CustomResourceOptions? opts = null)
public BgpVrf(String name, BgpVrfArgs args)
public BgpVrf(String name, BgpVrfArgs args, CustomResourceOptions options)

type: nxos:BgpVrf
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. BgpVrfArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. BgpVrfArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. BgpVrfArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. BgpVrfArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. BgpVrfArgs
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 bgpVrfResource = new Nxos.BgpVrf("bgpVrfResource", new()
{
    Asn = "string",
    Device = "string",
    Name = "string",
    RouterId = "string",
});
Copy
example, err := nxos.NewBgpVrf(ctx, "bgpVrfResource", &nxos.BgpVrfArgs{
	Asn:      pulumi.String("string"),
	Device:   pulumi.String("string"),
	Name:     pulumi.String("string"),
	RouterId: pulumi.String("string"),
})
Copy
var bgpVrfResource = new BgpVrf("bgpVrfResource", BgpVrfArgs.builder()
    .asn("string")
    .device("string")
    .name("string")
    .routerId("string")
    .build());
Copy
bgp_vrf_resource = nxos.BgpVrf("bgpVrfResource",
    asn="string",
    device="string",
    name="string",
    router_id="string")
Copy
const bgpVrfResource = new nxos.BgpVrf("bgpVrfResource", {
    asn: "string",
    device: "string",
    name: "string",
    routerId: "string",
});
Copy
type: nxos:BgpVrf
properties:
    asn: string
    device: string
    name: string
    routerId: string
Copy

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

Asn This property is required. string
Autonomous system number.
Device string
A device name from the provider configuration.
Name string
VRF name.
RouterId string
Router ID.
Asn This property is required. string
Autonomous system number.
Device string
A device name from the provider configuration.
Name string
VRF name.
RouterId string
Router ID.
asn This property is required. String
Autonomous system number.
device String
A device name from the provider configuration.
name String
VRF name.
routerId String
Router ID.
asn This property is required. string
Autonomous system number.
device string
A device name from the provider configuration.
name string
VRF name.
routerId string
Router ID.
asn This property is required. str
Autonomous system number.
device str
A device name from the provider configuration.
name str
VRF name.
router_id str
Router ID.
asn This property is required. String
Autonomous system number.
device String
A device name from the provider configuration.
name String
VRF name.
routerId String
Router ID.

Outputs

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

Get an existing BgpVrf 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?: BgpVrfState, opts?: CustomResourceOptions): BgpVrf
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        asn: Optional[str] = None,
        device: Optional[str] = None,
        name: Optional[str] = None,
        router_id: Optional[str] = None) -> BgpVrf
func GetBgpVrf(ctx *Context, name string, id IDInput, state *BgpVrfState, opts ...ResourceOption) (*BgpVrf, error)
public static BgpVrf Get(string name, Input<string> id, BgpVrfState? state, CustomResourceOptions? opts = null)
public static BgpVrf get(String name, Output<String> id, BgpVrfState state, CustomResourceOptions options)
resources:  _:    type: nxos:BgpVrf    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Asn string
Autonomous system number.
Device string
A device name from the provider configuration.
Name string
VRF name.
RouterId string
Router ID.
Asn string
Autonomous system number.
Device string
A device name from the provider configuration.
Name string
VRF name.
RouterId string
Router ID.
asn String
Autonomous system number.
device String
A device name from the provider configuration.
name String
VRF name.
routerId String
Router ID.
asn string
Autonomous system number.
device string
A device name from the provider configuration.
name string
VRF name.
routerId string
Router ID.
asn str
Autonomous system number.
device str
A device name from the provider configuration.
name str
VRF name.
router_id str
Router ID.
asn String
Autonomous system number.
device String
A device name from the provider configuration.
name String
VRF name.
routerId String
Router ID.

Import

 $ pulumi import nxos:index/bgpVrf:BgpVrf example "sys/bgp/inst/dom-[default]"
Copy

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.
Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs
lbrlabs/pulumi-nxos