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

nxos.BgpInstance

Explore with Pulumi AI

This resource can manage the BGP 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.BgpInstance("example", new()
    {
        AdminState = "enabled",
        Asn = "65001",
        EnhancedErrorHandling = false,
    });

});
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.NewBgpInstance(ctx, "example", &nxos.BgpInstanceArgs{
			AdminState:            pulumi.String("enabled"),
			Asn:                   pulumi.String("65001"),
			EnhancedErrorHandling: pulumi.Bool(false),
		})
		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.BgpInstance;
import com.pulumi.nxos.BgpInstanceArgs;
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 BgpInstance("example", BgpInstanceArgs.builder()        
            .adminState("enabled")
            .asn("65001")
            .enhancedErrorHandling(false)
            .build());

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

const example = new nxos.BgpInstance("example", {
    adminState: "enabled",
    asn: "65001",
    enhancedErrorHandling: false,
});
Copy
import pulumi
import lbrlabs_pulumi_nxos as nxos

example = nxos.BgpInstance("example",
    admin_state="enabled",
    asn="65001",
    enhanced_error_handling=False)
Copy
resources:
  example:
    type: nxos:BgpInstance
    properties:
      adminState: enabled
      asn: '65001'
      enhancedErrorHandling: false
Copy

Create BgpInstance Resource

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

Constructor syntax

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

@overload
def BgpInstance(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                admin_state: Optional[str] = None,
                asn: Optional[str] = None,
                device: Optional[str] = None,
                enhanced_error_handling: Optional[bool] = None)
func NewBgpInstance(ctx *Context, name string, args *BgpInstanceArgs, opts ...ResourceOption) (*BgpInstance, error)
public BgpInstance(string name, BgpInstanceArgs? args = null, CustomResourceOptions? opts = null)
public BgpInstance(String name, BgpInstanceArgs args)
public BgpInstance(String name, BgpInstanceArgs args, CustomResourceOptions options)
type: nxos:BgpInstance
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 BgpInstanceArgs
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 BgpInstanceArgs
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 BgpInstanceArgs
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 BgpInstanceArgs
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. BgpInstanceArgs
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 bgpInstanceResource = new Nxos.BgpInstance("bgpInstanceResource", new()
{
    AdminState = "string",
    Asn = "string",
    Device = "string",
    EnhancedErrorHandling = false,
});
Copy
example, err := nxos.NewBgpInstance(ctx, "bgpInstanceResource", &nxos.BgpInstanceArgs{
	AdminState:            pulumi.String("string"),
	Asn:                   pulumi.String("string"),
	Device:                pulumi.String("string"),
	EnhancedErrorHandling: pulumi.Bool(false),
})
Copy
var bgpInstanceResource = new BgpInstance("bgpInstanceResource", BgpInstanceArgs.builder()
    .adminState("string")
    .asn("string")
    .device("string")
    .enhancedErrorHandling(false)
    .build());
Copy
bgp_instance_resource = nxos.BgpInstance("bgpInstanceResource",
    admin_state="string",
    asn="string",
    device="string",
    enhanced_error_handling=False)
Copy
const bgpInstanceResource = new nxos.BgpInstance("bgpInstanceResource", {
    adminState: "string",
    asn: "string",
    device: "string",
    enhancedErrorHandling: false,
});
Copy
type: nxos:BgpInstance
properties:
    adminState: string
    asn: string
    device: string
    enhancedErrorHandling: false
Copy

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

AdminState string
Administrative state. - Choices: enabled, disabled - Default value: enabled
Asn string
Autonomous system number.
Device string
A device name from the provider configuration.
EnhancedErrorHandling bool
Enable BGP Enhanced Error Handling. - Default value: true
AdminState string
Administrative state. - Choices: enabled, disabled - Default value: enabled
Asn string
Autonomous system number.
Device string
A device name from the provider configuration.
EnhancedErrorHandling bool
Enable BGP Enhanced Error Handling. - Default value: true
adminState String
Administrative state. - Choices: enabled, disabled - Default value: enabled
asn String
Autonomous system number.
device String
A device name from the provider configuration.
enhancedErrorHandling Boolean
Enable BGP Enhanced Error Handling. - Default value: true
adminState string
Administrative state. - Choices: enabled, disabled - Default value: enabled
asn string
Autonomous system number.
device string
A device name from the provider configuration.
enhancedErrorHandling boolean
Enable BGP Enhanced Error Handling. - Default value: true
admin_state str
Administrative state. - Choices: enabled, disabled - Default value: enabled
asn str
Autonomous system number.
device str
A device name from the provider configuration.
enhanced_error_handling bool
Enable BGP Enhanced Error Handling. - Default value: true
adminState String
Administrative state. - Choices: enabled, disabled - Default value: enabled
asn String
Autonomous system number.
device String
A device name from the provider configuration.
enhancedErrorHandling Boolean
Enable BGP Enhanced Error Handling. - Default value: true

Outputs

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

Get an existing BgpInstance 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?: BgpInstanceState, opts?: CustomResourceOptions): BgpInstance
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        admin_state: Optional[str] = None,
        asn: Optional[str] = None,
        device: Optional[str] = None,
        enhanced_error_handling: Optional[bool] = None) -> BgpInstance
func GetBgpInstance(ctx *Context, name string, id IDInput, state *BgpInstanceState, opts ...ResourceOption) (*BgpInstance, error)
public static BgpInstance Get(string name, Input<string> id, BgpInstanceState? state, CustomResourceOptions? opts = null)
public static BgpInstance get(String name, Output<String> id, BgpInstanceState state, CustomResourceOptions options)
resources:  _:    type: nxos:BgpInstance    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:
AdminState string
Administrative state. - Choices: enabled, disabled - Default value: enabled
Asn string
Autonomous system number.
Device string
A device name from the provider configuration.
EnhancedErrorHandling bool
Enable BGP Enhanced Error Handling. - Default value: true
AdminState string
Administrative state. - Choices: enabled, disabled - Default value: enabled
Asn string
Autonomous system number.
Device string
A device name from the provider configuration.
EnhancedErrorHandling bool
Enable BGP Enhanced Error Handling. - Default value: true
adminState String
Administrative state. - Choices: enabled, disabled - Default value: enabled
asn String
Autonomous system number.
device String
A device name from the provider configuration.
enhancedErrorHandling Boolean
Enable BGP Enhanced Error Handling. - Default value: true
adminState string
Administrative state. - Choices: enabled, disabled - Default value: enabled
asn string
Autonomous system number.
device string
A device name from the provider configuration.
enhancedErrorHandling boolean
Enable BGP Enhanced Error Handling. - Default value: true
admin_state str
Administrative state. - Choices: enabled, disabled - Default value: enabled
asn str
Autonomous system number.
device str
A device name from the provider configuration.
enhanced_error_handling bool
Enable BGP Enhanced Error Handling. - Default value: true
adminState String
Administrative state. - Choices: enabled, disabled - Default value: enabled
asn String
Autonomous system number.
device String
A device name from the provider configuration.
enhancedErrorHandling Boolean
Enable BGP Enhanced Error Handling. - Default value: true

Import

 $ pulumi import nxos:index/bgpInstance:BgpInstance example "sys/bgp/inst"
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.