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

nxos.VrfRouteTargetDirection

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 VRF Route Target direction.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var example = new Nxos.VrfRouteTargetDirection("example", new()
    {
        AddressFamily = "ipv4-ucast",
        Direction = "import",
        RouteTargetAddressFamily = "ipv4-ucast",
        Vrf = "VRF1",
    });

});
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.NewVrfRouteTargetDirection(ctx, "example", &nxos.VrfRouteTargetDirectionArgs{
			AddressFamily:            pulumi.String("ipv4-ucast"),
			Direction:                pulumi.String("import"),
			RouteTargetAddressFamily: pulumi.String("ipv4-ucast"),
			Vrf:                      pulumi.String("VRF1"),
		})
		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.VrfRouteTargetDirection;
import com.pulumi.nxos.VrfRouteTargetDirectionArgs;
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 VrfRouteTargetDirection("example", VrfRouteTargetDirectionArgs.builder()        
            .addressFamily("ipv4-ucast")
            .direction("import")
            .routeTargetAddressFamily("ipv4-ucast")
            .vrf("VRF1")
            .build());

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

const example = new nxos.VrfRouteTargetDirection("example", {
    addressFamily: "ipv4-ucast",
    direction: "import",
    routeTargetAddressFamily: "ipv4-ucast",
    vrf: "VRF1",
});
Copy
import pulumi
import lbrlabs_pulumi_nxos as nxos

example = nxos.VrfRouteTargetDirection("example",
    address_family="ipv4-ucast",
    direction="import",
    route_target_address_family="ipv4-ucast",
    vrf="VRF1")
Copy
resources:
  example:
    type: nxos:VrfRouteTargetDirection
    properties:
      addressFamily: ipv4-ucast
      direction: import
      routeTargetAddressFamily: ipv4-ucast
      vrf: VRF1
Copy

Create VrfRouteTargetDirection Resource

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

Constructor syntax

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

@overload
def VrfRouteTargetDirection(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            address_family: Optional[str] = None,
                            direction: Optional[str] = None,
                            route_target_address_family: Optional[str] = None,
                            vrf: Optional[str] = None,
                            device: Optional[str] = None)
func NewVrfRouteTargetDirection(ctx *Context, name string, args VrfRouteTargetDirectionArgs, opts ...ResourceOption) (*VrfRouteTargetDirection, error)
public VrfRouteTargetDirection(string name, VrfRouteTargetDirectionArgs args, CustomResourceOptions? opts = null)
public VrfRouteTargetDirection(String name, VrfRouteTargetDirectionArgs args)
public VrfRouteTargetDirection(String name, VrfRouteTargetDirectionArgs args, CustomResourceOptions options)

type: nxos:VrfRouteTargetDirection
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. VrfRouteTargetDirectionArgs
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. VrfRouteTargetDirectionArgs
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. VrfRouteTargetDirectionArgs
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. VrfRouteTargetDirectionArgs
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. VrfRouteTargetDirectionArgs
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 vrfRouteTargetDirectionResource = new Nxos.VrfRouteTargetDirection("vrfRouteTargetDirectionResource", new()
{
    AddressFamily = "string",
    Direction = "string",
    RouteTargetAddressFamily = "string",
    Vrf = "string",
    Device = "string",
});
Copy
example, err := nxos.NewVrfRouteTargetDirection(ctx, "vrfRouteTargetDirectionResource", &nxos.VrfRouteTargetDirectionArgs{
	AddressFamily:            pulumi.String("string"),
	Direction:                pulumi.String("string"),
	RouteTargetAddressFamily: pulumi.String("string"),
	Vrf:                      pulumi.String("string"),
	Device:                   pulumi.String("string"),
})
Copy
var vrfRouteTargetDirectionResource = new VrfRouteTargetDirection("vrfRouteTargetDirectionResource", VrfRouteTargetDirectionArgs.builder()
    .addressFamily("string")
    .direction("string")
    .routeTargetAddressFamily("string")
    .vrf("string")
    .device("string")
    .build());
Copy
vrf_route_target_direction_resource = nxos.VrfRouteTargetDirection("vrfRouteTargetDirectionResource",
    address_family="string",
    direction="string",
    route_target_address_family="string",
    vrf="string",
    device="string")
Copy
const vrfRouteTargetDirectionResource = new nxos.VrfRouteTargetDirection("vrfRouteTargetDirectionResource", {
    addressFamily: "string",
    direction: "string",
    routeTargetAddressFamily: "string",
    vrf: "string",
    device: "string",
});
Copy
type: nxos:VrfRouteTargetDirection
properties:
    addressFamily: string
    device: string
    direction: string
    routeTargetAddressFamily: string
    vrf: string
Copy

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

AddressFamily This property is required. string
Address family. - Choices: ipv4-ucast, ipv6-ucast
Direction This property is required. string
Route Target direction. - Choices: import, export
RouteTargetAddressFamily This property is required. string
Route Target Address Family. - Choices: ipv4-ucast, ipv6-ucast, l2vpn-evpn
Vrf This property is required. string
VRF name.
Device string
A device name from the provider configuration.
AddressFamily This property is required. string
Address family. - Choices: ipv4-ucast, ipv6-ucast
Direction This property is required. string
Route Target direction. - Choices: import, export
RouteTargetAddressFamily This property is required. string
Route Target Address Family. - Choices: ipv4-ucast, ipv6-ucast, l2vpn-evpn
Vrf This property is required. string
VRF name.
Device string
A device name from the provider configuration.
addressFamily This property is required. String
Address family. - Choices: ipv4-ucast, ipv6-ucast
direction This property is required. String
Route Target direction. - Choices: import, export
routeTargetAddressFamily This property is required. String
Route Target Address Family. - Choices: ipv4-ucast, ipv6-ucast, l2vpn-evpn
vrf This property is required. String
VRF name.
device String
A device name from the provider configuration.
addressFamily This property is required. string
Address family. - Choices: ipv4-ucast, ipv6-ucast
direction This property is required. string
Route Target direction. - Choices: import, export
routeTargetAddressFamily This property is required. string
Route Target Address Family. - Choices: ipv4-ucast, ipv6-ucast, l2vpn-evpn
vrf This property is required. string
VRF name.
device string
A device name from the provider configuration.
address_family This property is required. str
Address family. - Choices: ipv4-ucast, ipv6-ucast
direction This property is required. str
Route Target direction. - Choices: import, export
route_target_address_family This property is required. str
Route Target Address Family. - Choices: ipv4-ucast, ipv6-ucast, l2vpn-evpn
vrf This property is required. str
VRF name.
device str
A device name from the provider configuration.
addressFamily This property is required. String
Address family. - Choices: ipv4-ucast, ipv6-ucast
direction This property is required. String
Route Target direction. - Choices: import, export
routeTargetAddressFamily This property is required. String
Route Target Address Family. - Choices: ipv4-ucast, ipv6-ucast, l2vpn-evpn
vrf This property is required. String
VRF name.
device String
A device name from the provider configuration.

Outputs

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

Get an existing VrfRouteTargetDirection 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?: VrfRouteTargetDirectionState, opts?: CustomResourceOptions): VrfRouteTargetDirection
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        address_family: Optional[str] = None,
        device: Optional[str] = None,
        direction: Optional[str] = None,
        route_target_address_family: Optional[str] = None,
        vrf: Optional[str] = None) -> VrfRouteTargetDirection
func GetVrfRouteTargetDirection(ctx *Context, name string, id IDInput, state *VrfRouteTargetDirectionState, opts ...ResourceOption) (*VrfRouteTargetDirection, error)
public static VrfRouteTargetDirection Get(string name, Input<string> id, VrfRouteTargetDirectionState? state, CustomResourceOptions? opts = null)
public static VrfRouteTargetDirection get(String name, Output<String> id, VrfRouteTargetDirectionState state, CustomResourceOptions options)
resources:  _:    type: nxos:VrfRouteTargetDirection    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:
AddressFamily string
Address family. - Choices: ipv4-ucast, ipv6-ucast
Device string
A device name from the provider configuration.
Direction string
Route Target direction. - Choices: import, export
RouteTargetAddressFamily string
Route Target Address Family. - Choices: ipv4-ucast, ipv6-ucast, l2vpn-evpn
Vrf string
VRF name.
AddressFamily string
Address family. - Choices: ipv4-ucast, ipv6-ucast
Device string
A device name from the provider configuration.
Direction string
Route Target direction. - Choices: import, export
RouteTargetAddressFamily string
Route Target Address Family. - Choices: ipv4-ucast, ipv6-ucast, l2vpn-evpn
Vrf string
VRF name.
addressFamily String
Address family. - Choices: ipv4-ucast, ipv6-ucast
device String
A device name from the provider configuration.
direction String
Route Target direction. - Choices: import, export
routeTargetAddressFamily String
Route Target Address Family. - Choices: ipv4-ucast, ipv6-ucast, l2vpn-evpn
vrf String
VRF name.
addressFamily string
Address family. - Choices: ipv4-ucast, ipv6-ucast
device string
A device name from the provider configuration.
direction string
Route Target direction. - Choices: import, export
routeTargetAddressFamily string
Route Target Address Family. - Choices: ipv4-ucast, ipv6-ucast, l2vpn-evpn
vrf string
VRF name.
address_family str
Address family. - Choices: ipv4-ucast, ipv6-ucast
device str
A device name from the provider configuration.
direction str
Route Target direction. - Choices: import, export
route_target_address_family str
Route Target Address Family. - Choices: ipv4-ucast, ipv6-ucast, l2vpn-evpn
vrf str
VRF name.
addressFamily String
Address family. - Choices: ipv4-ucast, ipv6-ucast
device String
A device name from the provider configuration.
direction String
Route Target direction. - Choices: import, export
routeTargetAddressFamily String
Route Target Address Family. - Choices: ipv4-ucast, ipv6-ucast, l2vpn-evpn
vrf String
VRF name.

Import

 $ pulumi import nxos:index/vrfRouteTargetDirection:VrfRouteTargetDirection example "sys/inst-[VRF1]/dom-[VRF1]/af-[ipv4-ucast]/ctrl-[ipv4-ucast]/rttp-[import]"
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