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

nxos.BridgeDomain

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 a bridge domain.

  • API Documentation: l2BD

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Nxos = Lbrlabs.PulumiPackage.Nxos;

return await Deployment.RunAsync(() => 
{
    var example = new Nxos.BridgeDomain("example", new()
    {
        AccessEncap = "unknown",
        FabricEncap = "vlan-10",
    });

});
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.NewBridgeDomain(ctx, "example", &nxos.BridgeDomainArgs{
			AccessEncap: pulumi.String("unknown"),
			FabricEncap: pulumi.String("vlan-10"),
		})
		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.BridgeDomain;
import com.pulumi.nxos.BridgeDomainArgs;
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 BridgeDomain("example", BridgeDomainArgs.builder()        
            .accessEncap("unknown")
            .fabricEncap("vlan-10")
            .build());

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

const example = new nxos.BridgeDomain("example", {
    accessEncap: "unknown",
    fabricEncap: "vlan-10",
});
Copy
import pulumi
import lbrlabs_pulumi_nxos as nxos

example = nxos.BridgeDomain("example",
    access_encap="unknown",
    fabric_encap="vlan-10")
Copy
resources:
  example:
    type: nxos:BridgeDomain
    properties:
      accessEncap: unknown
      fabricEncap: vlan-10
Copy

Create BridgeDomain Resource

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

Constructor syntax

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

@overload
def BridgeDomain(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 fabric_encap: Optional[str] = None,
                 access_encap: Optional[str] = None,
                 device: Optional[str] = None,
                 name: Optional[str] = None)
func NewBridgeDomain(ctx *Context, name string, args BridgeDomainArgs, opts ...ResourceOption) (*BridgeDomain, error)
public BridgeDomain(string name, BridgeDomainArgs args, CustomResourceOptions? opts = null)
public BridgeDomain(String name, BridgeDomainArgs args)
public BridgeDomain(String name, BridgeDomainArgs args, CustomResourceOptions options)

type: nxos:BridgeDomain
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. BridgeDomainArgs
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. BridgeDomainArgs
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. BridgeDomainArgs
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. BridgeDomainArgs
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. BridgeDomainArgs
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 bridgeDomainResource = new Nxos.BridgeDomain("bridgeDomainResource", new()
{
    FabricEncap = "string",
    AccessEncap = "string",
    Device = "string",
    Name = "string",
});
Copy
example, err := nxos.NewBridgeDomain(ctx, "bridgeDomainResource", &nxos.BridgeDomainArgs{
	FabricEncap: pulumi.String("string"),
	AccessEncap: pulumi.String("string"),
	Device:      pulumi.String("string"),
	Name:        pulumi.String("string"),
})
Copy
var bridgeDomainResource = new BridgeDomain("bridgeDomainResource", BridgeDomainArgs.builder()
    .fabricEncap("string")
    .accessEncap("string")
    .device("string")
    .name("string")
    .build());
Copy
bridge_domain_resource = nxos.BridgeDomain("bridgeDomainResource",
    fabric_encap="string",
    access_encap="string",
    device="string",
    name="string")
Copy
const bridgeDomainResource = new nxos.BridgeDomain("bridgeDomainResource", {
    fabricEncap: "string",
    accessEncap: "string",
    device: "string",
    name: "string",
});
Copy
type: nxos:BridgeDomain
properties:
    accessEncap: string
    device: string
    fabricEncap: string
    name: string
Copy

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

FabricEncap This property is required. string
Fabric encapsulation. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: unknown
AccessEncap string
Access encapsulation. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: unknown
Device string
A device name from the provider configuration.
Name string
Bridge domain name.
FabricEncap This property is required. string
Fabric encapsulation. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: unknown
AccessEncap string
Access encapsulation. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: unknown
Device string
A device name from the provider configuration.
Name string
Bridge domain name.
fabricEncap This property is required. String
Fabric encapsulation. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: unknown
accessEncap String
Access encapsulation. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: unknown
device String
A device name from the provider configuration.
name String
Bridge domain name.
fabricEncap This property is required. string
Fabric encapsulation. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: unknown
accessEncap string
Access encapsulation. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: unknown
device string
A device name from the provider configuration.
name string
Bridge domain name.
fabric_encap This property is required. str
Fabric encapsulation. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: unknown
access_encap str
Access encapsulation. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: unknown
device str
A device name from the provider configuration.
name str
Bridge domain name.
fabricEncap This property is required. String
Fabric encapsulation. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: unknown
accessEncap String
Access encapsulation. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: unknown
device String
A device name from the provider configuration.
name String
Bridge domain name.

Outputs

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

Get an existing BridgeDomain 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?: BridgeDomainState, opts?: CustomResourceOptions): BridgeDomain
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_encap: Optional[str] = None,
        device: Optional[str] = None,
        fabric_encap: Optional[str] = None,
        name: Optional[str] = None) -> BridgeDomain
func GetBridgeDomain(ctx *Context, name string, id IDInput, state *BridgeDomainState, opts ...ResourceOption) (*BridgeDomain, error)
public static BridgeDomain Get(string name, Input<string> id, BridgeDomainState? state, CustomResourceOptions? opts = null)
public static BridgeDomain get(String name, Output<String> id, BridgeDomainState state, CustomResourceOptions options)
resources:  _:    type: nxos:BridgeDomain    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:
AccessEncap string
Access encapsulation. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: unknown
Device string
A device name from the provider configuration.
FabricEncap string
Fabric encapsulation. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: unknown
Name string
Bridge domain name.
AccessEncap string
Access encapsulation. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: unknown
Device string
A device name from the provider configuration.
FabricEncap string
Fabric encapsulation. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: unknown
Name string
Bridge domain name.
accessEncap String
Access encapsulation. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: unknown
device String
A device name from the provider configuration.
fabricEncap String
Fabric encapsulation. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: unknown
name String
Bridge domain name.
accessEncap string
Access encapsulation. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: unknown
device string
A device name from the provider configuration.
fabricEncap string
Fabric encapsulation. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: unknown
name string
Bridge domain name.
access_encap str
Access encapsulation. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: unknown
device str
A device name from the provider configuration.
fabric_encap str
Fabric encapsulation. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: unknown
name str
Bridge domain name.
accessEncap String
Access encapsulation. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: unknown
device String
A device name from the provider configuration.
fabricEncap String
Fabric encapsulation. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: unknown
name String
Bridge domain name.

Import

 $ pulumi import nxos:index/bridgeDomain:BridgeDomain example "sys/bd/bd-[vlan-10]"
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