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

nxos.VrfAddressFamily

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 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.VrfAddressFamily("example", new()
    {
        AddressFamily = "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.NewVrfAddressFamily(ctx, "example", &nxos.VrfAddressFamilyArgs{
			AddressFamily: 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.VrfAddressFamily;
import com.pulumi.nxos.VrfAddressFamilyArgs;
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 VrfAddressFamily("example", VrfAddressFamilyArgs.builder()        
            .addressFamily("ipv4-ucast")
            .vrf("VRF1")
            .build());

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

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

example = nxos.VrfAddressFamily("example",
    address_family="ipv4-ucast",
    vrf="VRF1")
Copy
resources:
  example:
    type: nxos:VrfAddressFamily
    properties:
      addressFamily: ipv4-ucast
      vrf: VRF1
Copy

Create VrfAddressFamily Resource

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

Constructor syntax

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

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

type: nxos:VrfAddressFamily
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. VrfAddressFamilyArgs
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. VrfAddressFamilyArgs
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. VrfAddressFamilyArgs
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. VrfAddressFamilyArgs
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. VrfAddressFamilyArgs
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 vrfAddressFamilyResource = new Nxos.VrfAddressFamily("vrfAddressFamilyResource", new()
{
    AddressFamily = "string",
    Vrf = "string",
    Device = "string",
});
Copy
example, err := nxos.NewVrfAddressFamily(ctx, "vrfAddressFamilyResource", &nxos.VrfAddressFamilyArgs{
	AddressFamily: pulumi.String("string"),
	Vrf:           pulumi.String("string"),
	Device:        pulumi.String("string"),
})
Copy
var vrfAddressFamilyResource = new VrfAddressFamily("vrfAddressFamilyResource", VrfAddressFamilyArgs.builder()
    .addressFamily("string")
    .vrf("string")
    .device("string")
    .build());
Copy
vrf_address_family_resource = nxos.VrfAddressFamily("vrfAddressFamilyResource",
    address_family="string",
    vrf="string",
    device="string")
Copy
const vrfAddressFamilyResource = new nxos.VrfAddressFamily("vrfAddressFamilyResource", {
    addressFamily: "string",
    vrf: "string",
    device: "string",
});
Copy
type: nxos:VrfAddressFamily
properties:
    addressFamily: string
    device: string
    vrf: string
Copy

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

AddressFamily This property is required. string
Address family. - Choices: ipv4-ucast, ipv6-ucast
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
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
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
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
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
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 VrfAddressFamily 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 VrfAddressFamily Resource

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

Import

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