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

nxos.getPimVrf

Explore with Pulumi AI

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

This data source can read the PIM VRF configuration.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var example = Nxos.GetPimVrf.Invoke(new()
    {
        Name = "default",
    });

});
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.LookupPimVrf(ctx, &nxos.LookupPimVrfArgs{
			Name: "default",
		}, 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.GetPimVrfArgs;
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.getPimVrf(GetPimVrfArgs.builder()
            .name("default")
            .build());

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

const example = nxos.getPimVrf({
    name: "default",
});
Copy
import pulumi
import pulumi_nxos as nxos

example = nxos.get_pim_vrf(name="default")
Copy
variables:
  example:
    fn::invoke:
      Function: nxos:getPimVrf
      Arguments:
        name: default
Copy

Using getPimVrf

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 getPimVrf(args: GetPimVrfArgs, opts?: InvokeOptions): Promise<GetPimVrfResult>
function getPimVrfOutput(args: GetPimVrfOutputArgs, opts?: InvokeOptions): Output<GetPimVrfResult>
Copy
def get_pim_vrf(device: Optional[str] = None,
                name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetPimVrfResult
def get_pim_vrf_output(device: Optional[pulumi.Input[str]] = None,
                name: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetPimVrfResult]
Copy
func LookupPimVrf(ctx *Context, args *LookupPimVrfArgs, opts ...InvokeOption) (*LookupPimVrfResult, error)
func LookupPimVrfOutput(ctx *Context, args *LookupPimVrfOutputArgs, opts ...InvokeOption) LookupPimVrfResultOutput
Copy

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

public static class GetPimVrf 
{
    public static Task<GetPimVrfResult> InvokeAsync(GetPimVrfArgs args, InvokeOptions? opts = null)
    public static Output<GetPimVrfResult> Invoke(GetPimVrfInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetPimVrfResult> getPimVrf(GetPimVrfArgs args, InvokeOptions options)
public static Output<GetPimVrfResult> getPimVrf(GetPimVrfArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: nxos:index/getPimVrf:getPimVrf
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
VRF name.
Device string
A device name from the provider configuration.
Name This property is required. string
VRF name.
Device string
A device name from the provider configuration.
name This property is required. String
VRF name.
device String
A device name from the provider configuration.
name This property is required. string
VRF name.
device string
A device name from the provider configuration.
name This property is required. str
VRF name.
device str
A device name from the provider configuration.
name This property is required. String
VRF name.
device String
A device name from the provider configuration.

getPimVrf Result

The following output properties are available:

AdminState string
Administrative state.
Bfd bool
BFD.
Id string
The distinguished name of the object.
Name string
VRF name.
Device string
A device name from the provider configuration.
AdminState string
Administrative state.
Bfd bool
BFD.
Id string
The distinguished name of the object.
Name string
VRF name.
Device string
A device name from the provider configuration.
adminState String
Administrative state.
bfd Boolean
BFD.
id String
The distinguished name of the object.
name String
VRF name.
device String
A device name from the provider configuration.
adminState string
Administrative state.
bfd boolean
BFD.
id string
The distinguished name of the object.
name string
VRF name.
device string
A device name from the provider configuration.
admin_state str
Administrative state.
bfd bool
BFD.
id str
The distinguished name of the object.
name str
VRF name.
device str
A device name from the provider configuration.
adminState String
Administrative state.
bfd Boolean
BFD.
id String
The distinguished name of the object.
name 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