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

nxos.Evpn

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 global EVPN 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.Evpn("example", new()
    {
        AdminState = "enabled",
    });

});
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.NewEvpn(ctx, "example", &nxos.EvpnArgs{
			AdminState: pulumi.String("enabled"),
		})
		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.Evpn;
import com.pulumi.nxos.EvpnArgs;
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 Evpn("example", EvpnArgs.builder()        
            .adminState("enabled")
            .build());

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

const example = new nxos.Evpn("example", {adminState: "enabled"});
Copy
import pulumi
import lbrlabs_pulumi_nxos as nxos

example = nxos.Evpn("example", admin_state="enabled")
Copy
resources:
  example:
    type: nxos:Evpn
    properties:
      adminState: enabled
Copy

Create Evpn Resource

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

Constructor syntax

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

@overload
def Evpn(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         admin_state: Optional[str] = None,
         device: Optional[str] = None)
func NewEvpn(ctx *Context, name string, args *EvpnArgs, opts ...ResourceOption) (*Evpn, error)
public Evpn(string name, EvpnArgs? args = null, CustomResourceOptions? opts = null)
public Evpn(String name, EvpnArgs args)
public Evpn(String name, EvpnArgs args, CustomResourceOptions options)

type: nxos:Evpn
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 EvpnArgs
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 EvpnArgs
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 EvpnArgs
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 EvpnArgs
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. EvpnArgs
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 evpnResource = new Nxos.Evpn("evpnResource", new()
{
    AdminState = "string",
    Device = "string",
});
Copy
example, err := nxos.NewEvpn(ctx, "evpnResource", &nxos.EvpnArgs{
	AdminState: pulumi.String("string"),
	Device:     pulumi.String("string"),
})
Copy
var evpnResource = new Evpn("evpnResource", EvpnArgs.builder()
    .adminState("string")
    .device("string")
    .build());
Copy
evpn_resource = nxos.Evpn("evpnResource",
    admin_state="string",
    device="string")
Copy
const evpnResource = new nxos.Evpn("evpnResource", {
    adminState: "string",
    device: "string",
});
Copy
type: nxos:Evpn
properties:
    adminState: string
    device: string
Copy

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

AdminState string
Administrative state. - Choices: enabled, disabled - Default value: enabled
Device string
A device name from the provider configuration.
AdminState string
Administrative state. - Choices: enabled, disabled - Default value: enabled
Device string
A device name from the provider configuration.
adminState String
Administrative state. - Choices: enabled, disabled - Default value: enabled
device String
A device name from the provider configuration.
adminState string
Administrative state. - Choices: enabled, disabled - Default value: enabled
device string
A device name from the provider configuration.
admin_state str
Administrative state. - Choices: enabled, disabled - Default value: enabled
device str
A device name from the provider configuration.
adminState String
Administrative state. - Choices: enabled, disabled - Default value: enabled
device String
A device name from the provider configuration.

Outputs

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

Get an existing Evpn 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?: EvpnState, opts?: CustomResourceOptions): Evpn
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        admin_state: Optional[str] = None,
        device: Optional[str] = None) -> Evpn
func GetEvpn(ctx *Context, name string, id IDInput, state *EvpnState, opts ...ResourceOption) (*Evpn, error)
public static Evpn Get(string name, Input<string> id, EvpnState? state, CustomResourceOptions? opts = null)
public static Evpn get(String name, Output<String> id, EvpnState state, CustomResourceOptions options)
resources:  _:    type: nxos:Evpn    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
Device string
A device name from the provider configuration.
AdminState string
Administrative state. - Choices: enabled, disabled - Default value: enabled
Device string
A device name from the provider configuration.
adminState String
Administrative state. - Choices: enabled, disabled - Default value: enabled
device String
A device name from the provider configuration.
adminState string
Administrative state. - Choices: enabled, disabled - Default value: enabled
device string
A device name from the provider configuration.
admin_state str
Administrative state. - Choices: enabled, disabled - Default value: enabled
device str
A device name from the provider configuration.
adminState String
Administrative state. - Choices: enabled, disabled - Default value: enabled
device String
A device name from the provider configuration.

Import

 $ pulumi import nxos:index/evpn:Evpn example "sys/evpn"
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