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

nxos.getVrfAddressFamily

Explore with Pulumi AI

Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs

This data source can read a VRF Address Family.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var example = Nxos.GetVrfAddressFamily.Invoke(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.LookupVrfAddressFamily(ctx, &nxos.LookupVrfAddressFamilyArgs{
			AddressFamily: "ipv4-ucast",
			Vrf:           "VRF1",
		}, nil)
		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.NxosFunctions;
import com.pulumi.nxos.inputs.GetVrfAddressFamilyArgs;
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) {
        final var example = NxosFunctions.getVrfAddressFamily(GetVrfAddressFamilyArgs.builder()
            .addressFamily("ipv4-ucast")
            .vrf("VRF1")
            .build());

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

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

example = nxos.get_vrf_address_family(address_family="ipv4-ucast",
    vrf="VRF1")
Copy
variables:
  example:
    fn::invoke:
      Function: nxos:getVrfAddressFamily
      Arguments:
        addressFamily: ipv4-ucast
        vrf: VRF1
Copy

Using getVrfAddressFamily

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getVrfAddressFamily(args: GetVrfAddressFamilyArgs, opts?: InvokeOptions): Promise<GetVrfAddressFamilyResult>
function getVrfAddressFamilyOutput(args: GetVrfAddressFamilyOutputArgs, opts?: InvokeOptions): Output<GetVrfAddressFamilyResult>
Copy
def get_vrf_address_family(address_family: Optional[str] = None,
                           device: Optional[str] = None,
                           vrf: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetVrfAddressFamilyResult
def get_vrf_address_family_output(address_family: Optional[pulumi.Input[str]] = None,
                           device: Optional[pulumi.Input[str]] = None,
                           vrf: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetVrfAddressFamilyResult]
Copy
func LookupVrfAddressFamily(ctx *Context, args *LookupVrfAddressFamilyArgs, opts ...InvokeOption) (*LookupVrfAddressFamilyResult, error)
func LookupVrfAddressFamilyOutput(ctx *Context, args *LookupVrfAddressFamilyOutputArgs, opts ...InvokeOption) LookupVrfAddressFamilyResultOutput
Copy

> Note: This function is named LookupVrfAddressFamily in the Go SDK.

public static class GetVrfAddressFamily 
{
    public static Task<GetVrfAddressFamilyResult> InvokeAsync(GetVrfAddressFamilyArgs args, InvokeOptions? opts = null)
    public static Output<GetVrfAddressFamilyResult> Invoke(GetVrfAddressFamilyInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetVrfAddressFamilyResult> getVrfAddressFamily(GetVrfAddressFamilyArgs args, InvokeOptions options)
public static Output<GetVrfAddressFamilyResult> getVrfAddressFamily(GetVrfAddressFamilyArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: nxos:index/getVrfAddressFamily:getVrfAddressFamily
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AddressFamily This property is required. string
Address family.
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.
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.
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.
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.
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.
vrf This property is required. String
VRF name.
device String
A device name from the provider configuration.

getVrfAddressFamily Result

The following output properties are available:

AddressFamily string
Address family.
Id string
The distinguished name of the object.
Vrf string
VRF name.
Device string
A device name from the provider configuration.
AddressFamily string
Address family.
Id string
The distinguished name of the object.
Vrf string
VRF name.
Device string
A device name from the provider configuration.
addressFamily String
Address family.
id String
The distinguished name of the object.
vrf String
VRF name.
device String
A device name from the provider configuration.
addressFamily string
Address family.
id string
The distinguished name of the object.
vrf string
VRF name.
device string
A device name from the provider configuration.
address_family str
Address family.
id str
The distinguished name of the object.
vrf str
VRF name.
device str
A device name from the provider configuration.
addressFamily String
Address family.
id String
The distinguished name of the object.
vrf String
VRF name.
device String
A device name from the provider configuration.

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