nxos.getPimInterface

Explore with Pulumi AI

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

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var example = Nxos.GetPimInterface.Invoke(new()
    {
        InterfaceId = "eth1/10",
        VrfName = "default",
    });

});

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.LookupPimInterface(ctx, &nxos.LookupPimInterfaceArgs{
			InterfaceId: "eth1/10",
			VrfName:     "default",
		}, nil)
		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.NxosFunctions;
import com.pulumi.nxos.inputs.GetPimInterfaceArgs;
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.getPimInterface(GetPimInterfaceArgs.builder()
            .interfaceId("eth1/10")
            .vrfName("default")
            .build());

    }
}

import pulumi
import pulumi_nxos as nxos

example = nxos.get_pim_interface(interface_id="eth1/10",
    vrf_name="default")

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

const example = nxos.getPimInterface({
    interfaceId: "eth1/10",
    vrfName: "default",
});

variables:
  example:
    fn::invoke:
      Function: nxos:getPimInterface
      Arguments:
        interfaceId: eth1/10
        vrfName: default

Using getPimInterface

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 getPimInterface(args: GetPimInterfaceArgs, opts?: InvokeOptions): Promise<GetPimInterfaceResult>
function getPimInterfaceOutput(args: GetPimInterfaceOutputArgs, opts?: InvokeOptions): Output<GetPimInterfaceResult>

def get_pim_interface(device: Optional[str] = None,
                      interface_id: Optional[str] = None,
                      vrf_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetPimInterfaceResult
def get_pim_interface_output(device: Optional[pulumi.Input[str]] = None,
                      interface_id: Optional[pulumi.Input[str]] = None,
                      vrf_name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetPimInterfaceResult]

func LookupPimInterface(ctx *Context, args *LookupPimInterfaceArgs, opts ...InvokeOption) (*LookupPimInterfaceResult, error)
func LookupPimInterfaceOutput(ctx *Context, args *LookupPimInterfaceOutputArgs, opts ...InvokeOption) LookupPimInterfaceResultOutput

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

public static class GetPimInterface 
{
    public static Task<GetPimInterfaceResult> InvokeAsync(GetPimInterfaceArgs args, InvokeOptions? opts = null)
    public static Output<GetPimInterfaceResult> Invoke(GetPimInterfaceInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPimInterfaceResult> getPimInterface(GetPimInterfaceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: nxos:index/getPimInterface:getPimInterface
  arguments:
    # arguments dictionary

The following arguments are supported:

InterfaceId string: Must match first field in the output of show intf brief. Example: eth1/1.
VrfName string: VRF name.
Device string: A device name from the provider configuration.

InterfaceId string: Must match first field in the output of show intf brief. Example: eth1/1.
VrfName string: VRF name.
Device string: A device name from the provider configuration.

interfaceId String: Must match first field in the output of show intf brief. Example: eth1/1.
vrfName String: VRF name.
device String: A device name from the provider configuration.

interfaceId string: Must match first field in the output of show intf brief. Example: eth1/1.
vrfName string: VRF name.
device string: A device name from the provider configuration.

interface_id str: Must match first field in the output of show intf brief. Example: eth1/1.
vrf_name str: VRF name.
device str: A device name from the provider configuration.

interfaceId String: Must match first field in the output of show intf brief. Example: eth1/1.
vrfName String: VRF name.
device String: A device name from the provider configuration.

getPimInterface Result

The following output properties are available:

AdminState string: Administrative state.
Bfd string: BFD.
DrPriority int: Designated Router priority level.
Id string: The distinguished name of the object.
InterfaceId string: Must match first field in the output of show intf brief. Example: eth1/1.
Passive bool: Passive interface.
SparseMode bool: Sparse mode.
VrfName string: VRF name.
Device string: A device name from the provider configuration.

AdminState string: Administrative state.
Bfd string: BFD.
DrPriority int: Designated Router priority level.
Id string: The distinguished name of the object.
InterfaceId string: Must match first field in the output of show intf brief. Example: eth1/1.
Passive bool: Passive interface.
SparseMode bool: Sparse mode.
VrfName string: VRF name.
Device string: A device name from the provider configuration.

adminState String: Administrative state.
bfd String: BFD.
drPriority Integer: Designated Router priority level.
id String: The distinguished name of the object.
interfaceId String: Must match first field in the output of show intf brief. Example: eth1/1.
passive Boolean: Passive interface.
sparseMode Boolean: Sparse mode.
vrfName String: VRF name.
device String: A device name from the provider configuration.

adminState string: Administrative state.
bfd string: BFD.
drPriority number: Designated Router priority level.
id string: The distinguished name of the object.
interfaceId string: Must match first field in the output of show intf brief. Example: eth1/1.
passive boolean: Passive interface.
sparseMode boolean: Sparse mode.
vrfName string: VRF name.
device string: A device name from the provider configuration.

admin_state str: Administrative state.
bfd str: BFD.
dr_priority int: Designated Router priority level.
id str: The distinguished name of the object.
interface_id str: Must match first field in the output of show intf brief. Example: eth1/1.
passive bool: Passive interface.
sparse_mode bool: Sparse mode.
vrf_name str: VRF name.
device str: A device name from the provider configuration.

adminState String: Administrative state.
bfd String: BFD.
drPriority Number: Designated Router priority level.
id String: The distinguished name of the object.
interfaceId String: Must match first field in the output of show intf brief. Example: eth1/1.
passive Boolean: Passive interface.
sparseMode Boolean: Sparse mode.
vrfName 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

lbrlabs/pulumi-nxos

nxos.getPimInterface

On this page

On this page

Example Usage

Using getPimInterface

getPimInterface Result

Package Details

On this page

On this page