Cisco IOS XE v0.0.1, Sep 22 23

Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs

iosxe.getPimVrf

Explore with Pulumi AI

Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

return await Deployment.RunAsync(() => 
{
    var example = Iosxe.GetPimVrf.Invoke(new()
    {
        Vrf = "VRF1",
    });

});

package main

import (
	"github.com/lbrlabs/pulumi-iosxe/sdk/go/iosxe"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := iosxe.LookupPimVrf(ctx, &iosxe.LookupPimVrfArgs{
			Vrf: "VRF1",
		}, 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.iosxe.IosxeFunctions;
import com.pulumi.iosxe.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 = IosxeFunctions.getPimVrf(GetPimVrfArgs.builder()
            .vrf("VRF1")
            .build());

    }
}

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

const example = iosxe.getPimVrf({
    vrf: "VRF1",
});

import pulumi
import pulumi_iosxe as iosxe

example = iosxe.get_pim_vrf(vrf="VRF1")

variables:
  example:
    fn::invoke:
      Function: iosxe:getPimVrf
      Arguments:
        vrf: VRF1

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.

TypeScript
Python
Go
C#
Java
YAML

function getPimVrf(args: GetPimVrfArgs, opts?: InvokeOptions): Promise<GetPimVrfResult>
function getPimVrfOutput(args: GetPimVrfOutputArgs, opts?: InvokeOptions): Output<GetPimVrfResult>

def get_pim_vrf(device: Optional[str] = None,
                vrf: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetPimVrfResult
def get_pim_vrf_output(device: Optional[pulumi.Input[str]] = None,
                vrf: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetPimVrfResult]

func LookupPimVrf(ctx *Context, args *LookupPimVrfArgs, opts ...InvokeOption) (*LookupPimVrfResult, error)
func LookupPimVrfOutput(ctx *Context, args *LookupPimVrfOutputArgs, opts ...InvokeOption) LookupPimVrfResultOutput

> 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)
}

public static CompletableFuture<GetPimVrfResult> getPimVrf(GetPimVrfArgs args, InvokeOptions options)
public static Output<GetPimVrfResult> getPimVrf(GetPimVrfArgs args, InvokeOptions options)

fn::invoke:
  function: iosxe:index/getPimVrf:getPimVrf
  arguments:
    # arguments dictionary

The following arguments are supported:

Vrf string
Device string: A device name from the provider configuration.

Vrf string
Device string: A device name from the provider configuration.

vrf String
device String: A device name from the provider configuration.

vrf string
device string: A device name from the provider configuration.

vrf str
device str: A device name from the provider configuration.

vrf String
device String: A device name from the provider configuration.

getPimVrf Result

The following output properties are available:

Autorp bool: Configure AutoRP global operations
AutorpListener bool: Allow AutoRP packets across sparse mode interface
BsrCandidateAcceptRpCandidate string: BSR RP candidate filter
BsrCandidateLoopback int: Loopback interface
BsrCandidateMask int: Hash Mask length for RP selection
BsrCandidatePriority int: Priority value for candidate bootstrap router
CacheRpfOif bool: Cache outgoing interface RPF info
Id string: The path of the retrieved object.
RpAddress string: IP address of Rendezvous-point for group
RpAddressBidir bool: Group range treated in bidirectional shared-tree mode
RpAddressOverride bool: Overrides dynamically learnt RP mappings
RpAddresses List<Lbrlabs.PulumiPackage.Iosxe.Outputs.GetPimVrfRpAddress>: PIM RP-address (Rendezvous Point)
RpCandidates List<Lbrlabs.PulumiPackage.Iosxe.Outputs.GetPimVrfRpCandidate>: To be a PIM version 2 RP candidate
SsmDefault bool: Use 232/8 group range for SSM
SsmRange string: ACL for group range to be used for SSM
Vrf string
Device string: A device name from the provider configuration.

Autorp bool: Configure AutoRP global operations
AutorpListener bool: Allow AutoRP packets across sparse mode interface
BsrCandidateAcceptRpCandidate string: BSR RP candidate filter
BsrCandidateLoopback int: Loopback interface
BsrCandidateMask int: Hash Mask length for RP selection
BsrCandidatePriority int: Priority value for candidate bootstrap router
CacheRpfOif bool: Cache outgoing interface RPF info
Id string: The path of the retrieved object.
RpAddress string: IP address of Rendezvous-point for group
RpAddressBidir bool: Group range treated in bidirectional shared-tree mode
RpAddressOverride bool: Overrides dynamically learnt RP mappings
RpAddresses []GetPimVrfRpAddress: PIM RP-address (Rendezvous Point)
RpCandidates []GetPimVrfRpCandidate: To be a PIM version 2 RP candidate
SsmDefault bool: Use 232/8 group range for SSM
SsmRange string: ACL for group range to be used for SSM
Vrf string
Device string: A device name from the provider configuration.

autorp Boolean: Configure AutoRP global operations
autorpListener Boolean: Allow AutoRP packets across sparse mode interface
bsrCandidateAcceptRpCandidate String: BSR RP candidate filter
bsrCandidateLoopback Integer: Loopback interface
bsrCandidateMask Integer: Hash Mask length for RP selection
bsrCandidatePriority Integer: Priority value for candidate bootstrap router
cacheRpfOif Boolean: Cache outgoing interface RPF info
id String: The path of the retrieved object.
rpAddress String: IP address of Rendezvous-point for group
rpAddressBidir Boolean: Group range treated in bidirectional shared-tree mode
rpAddressOverride Boolean: Overrides dynamically learnt RP mappings
rpAddresses List<GetPimVrfRpAddress>: PIM RP-address (Rendezvous Point)
rpCandidates List<GetPimVrfRpCandidate>: To be a PIM version 2 RP candidate
ssmDefault Boolean: Use 232/8 group range for SSM
ssmRange String: ACL for group range to be used for SSM
vrf String
device String: A device name from the provider configuration.

autorp boolean: Configure AutoRP global operations
autorpListener boolean: Allow AutoRP packets across sparse mode interface
bsrCandidateAcceptRpCandidate string: BSR RP candidate filter
bsrCandidateLoopback number: Loopback interface
bsrCandidateMask number: Hash Mask length for RP selection
bsrCandidatePriority number: Priority value for candidate bootstrap router
cacheRpfOif boolean: Cache outgoing interface RPF info
id string: The path of the retrieved object.
rpAddress string: IP address of Rendezvous-point for group
rpAddressBidir boolean: Group range treated in bidirectional shared-tree mode
rpAddressOverride boolean: Overrides dynamically learnt RP mappings
rpAddresses GetPimVrfRpAddress[]: PIM RP-address (Rendezvous Point)
rpCandidates GetPimVrfRpCandidate[]: To be a PIM version 2 RP candidate
ssmDefault boolean: Use 232/8 group range for SSM
ssmRange string: ACL for group range to be used for SSM
vrf string
device string: A device name from the provider configuration.

autorp bool: Configure AutoRP global operations
autorp_listener bool: Allow AutoRP packets across sparse mode interface
bsr_candidate_accept_rp_candidate str: BSR RP candidate filter
bsr_candidate_loopback int: Loopback interface
bsr_candidate_mask int: Hash Mask length for RP selection
bsr_candidate_priority int: Priority value for candidate bootstrap router
cache_rpf_oif bool: Cache outgoing interface RPF info
id str: The path of the retrieved object.
rp_address str: IP address of Rendezvous-point for group
rp_address_bidir bool: Group range treated in bidirectional shared-tree mode
rp_address_override bool: Overrides dynamically learnt RP mappings
rp_addresses Sequence[GetPimVrfRpAddress]: PIM RP-address (Rendezvous Point)
rp_candidates Sequence[GetPimVrfRpCandidate]: To be a PIM version 2 RP candidate
ssm_default bool: Use 232/8 group range for SSM
ssm_range str: ACL for group range to be used for SSM
vrf str
device str: A device name from the provider configuration.

autorp Boolean: Configure AutoRP global operations
autorpListener Boolean: Allow AutoRP packets across sparse mode interface
bsrCandidateAcceptRpCandidate String: BSR RP candidate filter
bsrCandidateLoopback Number: Loopback interface
bsrCandidateMask Number: Hash Mask length for RP selection
bsrCandidatePriority Number: Priority value for candidate bootstrap router
cacheRpfOif Boolean: Cache outgoing interface RPF info
id String: The path of the retrieved object.
rpAddress String: IP address of Rendezvous-point for group
rpAddressBidir Boolean: Group range treated in bidirectional shared-tree mode
rpAddressOverride Boolean: Overrides dynamically learnt RP mappings
rpAddresses List<Property Map>: PIM RP-address (Rendezvous Point)
rpCandidates List<Property Map>: To be a PIM version 2 RP candidate
ssmDefault Boolean: Use 232/8 group range for SSM
ssmRange String: ACL for group range to be used for SSM
vrf String
device String: A device name from the provider configuration.

Supporting Types

GetPimVrfRpAddress

AccessList string: IP Access-list
Bidir bool: Group range treated in bidirectional shared-tree mode
Override bool: Overrides dynamically learnt RP mappings
RpAddress string: IP address of Rendezvous-point for group

AccessList string: IP Access-list
Bidir bool: Group range treated in bidirectional shared-tree mode
Override bool: Overrides dynamically learnt RP mappings
RpAddress string: IP address of Rendezvous-point for group

accessList String: IP Access-list
bidir Boolean: Group range treated in bidirectional shared-tree mode
override Boolean: Overrides dynamically learnt RP mappings
rpAddress String: IP address of Rendezvous-point for group

accessList string: IP Access-list
bidir boolean: Group range treated in bidirectional shared-tree mode
override boolean: Overrides dynamically learnt RP mappings
rpAddress string: IP address of Rendezvous-point for group

access_list str: IP Access-list
bidir bool: Group range treated in bidirectional shared-tree mode
override bool: Overrides dynamically learnt RP mappings
rp_address str: IP address of Rendezvous-point for group

accessList String: IP Access-list
bidir Boolean: Group range treated in bidirectional shared-tree mode
override Boolean: Overrides dynamically learnt RP mappings
rpAddress String: IP address of Rendezvous-point for group

GetPimVrfRpCandidate

Bidir bool: Group range treated in bidirectional shared-tree mode
GroupList string: IP Access list
Interface string: Autonomic-Networking virtual interface
Interval int: RP candidate advertisement interval
Priority int: RP candidate priority

Bidir bool: Group range treated in bidirectional shared-tree mode
GroupList string: IP Access list
Interface string: Autonomic-Networking virtual interface
Interval int: RP candidate advertisement interval
Priority int: RP candidate priority

bidir Boolean: Group range treated in bidirectional shared-tree mode
groupList String: IP Access list
interface_ String: Autonomic-Networking virtual interface
interval Integer: RP candidate advertisement interval
priority Integer: RP candidate priority

bidir boolean: Group range treated in bidirectional shared-tree mode
groupList string: IP Access list
interface string: Autonomic-Networking virtual interface
interval number: RP candidate advertisement interval
priority number: RP candidate priority

bidir bool: Group range treated in bidirectional shared-tree mode
group_list str: IP Access list
interface str: Autonomic-Networking virtual interface
interval int: RP candidate advertisement interval
priority int: RP candidate priority

bidir Boolean: Group range treated in bidirectional shared-tree mode
groupList String: IP Access list
interface String: Autonomic-Networking virtual interface
interval Number: RP candidate advertisement interval
priority Number: RP candidate priority

Package Details

Repository: iosxe lbrlabs/pulumi-iosxe
License: Apache-2.0
Notes: This Pulumi package is based on the iosxe Terraform Provider.

Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs

lbrlabs/pulumi-iosxe

iosxe.getPimVrf

On this page

On this page

Example Usage

Using getPimVrf

getPimVrf Result

Supporting Types

GetPimVrfRpAddress

GetPimVrfRpCandidate

Package Details

On this page

On this page