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

nxos.VrfRouteTargetAddressFamily

Explore with Pulumi AI

nxos logo
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 Address Family.

    Example Usage

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

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

});

    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.NewVrfRouteTargetAddressFamily(ctx, "example", &nxos.VrfRouteTargetAddressFamilyArgs{
			AddressFamily:            pulumi.String("ipv4-ucast"),
			RouteTargetAddressFamily: pulumi.String("ipv4-ucast"),
			Vrf:                      pulumi.String("VRF1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.nxos.VrfRouteTargetAddressFamily;
import com.pulumi.nxos.VrfRouteTargetAddressFamilyArgs;
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 VrfRouteTargetAddressFamily("example", VrfRouteTargetAddressFamilyArgs.builder()        
            .addressFamily("ipv4-ucast")
            .routeTargetAddressFamily("ipv4-ucast")
            .vrf("VRF1")
            .build());

    }
}

    import pulumi
import lbrlabs_pulumi_nxos as nxos

example = nxos.VrfRouteTargetAddressFamily("example",
    address_family="ipv4-ucast",
    route_target_address_family="ipv4-ucast",
    vrf="VRF1")

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

const example = new nxos.VrfRouteTargetAddressFamily("example", {
    addressFamily: "ipv4-ucast",
    routeTargetAddressFamily: "ipv4-ucast",
    vrf: "VRF1",
});

    resources:
  example:
    type: nxos:VrfRouteTargetAddressFamily
    properties:
      addressFamily: ipv4-ucast
      routeTargetAddressFamily: ipv4-ucast
      vrf: VRF1

    Create VrfRouteTargetAddressFamily Resource

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

    Constructor syntax

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

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

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

    Parameters

    name string
    The unique name of the resource.
    args VrfRouteTargetAddressFamilyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args VrfRouteTargetAddressFamilyArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args VrfRouteTargetAddressFamilyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VrfRouteTargetAddressFamilyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VrfRouteTargetAddressFamilyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var vrfRouteTargetAddressFamilyResource = new Nxos.VrfRouteTargetAddressFamily("vrfRouteTargetAddressFamilyResource", new()
{
    AddressFamily = "string",
    RouteTargetAddressFamily = "string",
    Vrf = "string",
    Device = "string",
});

    example, err := nxos.NewVrfRouteTargetAddressFamily(ctx, "vrfRouteTargetAddressFamilyResource", &nxos.VrfRouteTargetAddressFamilyArgs{
	AddressFamily:            pulumi.String("string"),
	RouteTargetAddressFamily: pulumi.String("string"),
	Vrf:                      pulumi.String("string"),
	Device:                   pulumi.String("string"),
})

    var vrfRouteTargetAddressFamilyResource = new VrfRouteTargetAddressFamily("vrfRouteTargetAddressFamilyResource", VrfRouteTargetAddressFamilyArgs.builder()
    .addressFamily("string")
    .routeTargetAddressFamily("string")
    .vrf("string")
    .device("string")
    .build());

    vrf_route_target_address_family_resource = nxos.VrfRouteTargetAddressFamily("vrfRouteTargetAddressFamilyResource",
    address_family="string",
    route_target_address_family="string",
    vrf="string",
    device="string")

    const vrfRouteTargetAddressFamilyResource = new nxos.VrfRouteTargetAddressFamily("vrfRouteTargetAddressFamilyResource", {
    addressFamily: "string",
    routeTargetAddressFamily: "string",
    vrf: "string",
    device: "string",
});

    type: nxos:VrfRouteTargetAddressFamily
properties:
    addressFamily: string
    device: string
    routeTargetAddressFamily: string
    vrf: string

    VrfRouteTargetAddressFamily Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The VrfRouteTargetAddressFamily resource accepts the following input properties:

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

    Outputs

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

    Get an existing VrfRouteTargetAddressFamily 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?: VrfRouteTargetAddressFamilyState, opts?: CustomResourceOptions): VrfRouteTargetAddressFamily
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        address_family: Optional[str] = None,
        device: Optional[str] = None,
        route_target_address_family: Optional[str] = None,
        vrf: Optional[str] = None) -> VrfRouteTargetAddressFamily
    func GetVrfRouteTargetAddressFamily(ctx *Context, name string, id IDInput, state *VrfRouteTargetAddressFamilyState, opts ...ResourceOption) (*VrfRouteTargetAddressFamily, error)
    public static VrfRouteTargetAddressFamily Get(string name, Input<string> id, VrfRouteTargetAddressFamilyState? state, CustomResourceOptions? opts = null)
    public static VrfRouteTargetAddressFamily get(String name, Output<String> id, VrfRouteTargetAddressFamilyState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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.
    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.
    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.
    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.
    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.
    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.
    routeTargetAddressFamily String
    Route Target Address Family. - Choices: ipv4-ucast, ipv6-ucast, l2vpn-evpn
    vrf String
    VRF name.

    Import

     $ pulumi import nxos:index/vrfRouteTargetAddressFamily:VrfRouteTargetAddressFamily example "sys/inst-[VRF1]/dom-[VRF1]/af-[ipv4-ucast]/ctrl-[ipv4-ucast]"

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