1. Packages
  2. Cisco IOS XE Resource Provider
  3. API Docs
  4. getPim
Viewing docs for Cisco IOS XE v0.0.1
published on Friday, Sep 22, 2023 by lbrlabs
Schema (JSON)
lbrlabs/pulumi-iosxe

iosxe.getPim

iosxe logo
Viewing docs for Cisco IOS XE v0.0.1
published on Friday, Sep 22, 2023 by lbrlabs
Schema (JSON)
lbrlabs/pulumi-iosxe

    This data source can read the PIM configuration.

    Example Usage

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

return await Deployment.RunAsync(() => 
{
    var example = Iosxe.GetPim.Invoke();

});

    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.LookupPim(ctx, nil, 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.GetPimArgs;
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.getPim();

    }
}

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

const example = iosxe.getPim({});

    import pulumi
import pulumi_iosxe as iosxe

example = iosxe.get_pim()

    variables:
  example:
    fn::invoke:
      Function: iosxe:getPim
      Arguments: {}

    Using getPim

    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 getPim(args: GetPimArgs, opts?: InvokeOptions): Promise<GetPimResult>
function getPimOutput(args: GetPimOutputArgs, opts?: InvokeOptions): Output<GetPimResult>
    def get_pim(device: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetPimResult
def get_pim_output(device: Optional[pulumi.Input[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetPimResult]
    func LookupPim(ctx *Context, args *LookupPimArgs, opts ...InvokeOption) (*LookupPimResult, error)
func LookupPimOutput(ctx *Context, args *LookupPimOutputArgs, opts ...InvokeOption) LookupPimResultOutput

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

    public static class GetPim 
{
    public static Task<GetPimResult> InvokeAsync(GetPimArgs args, InvokeOptions? opts = null)
    public static Output<GetPimResult> Invoke(GetPimInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPimResult> getPim(GetPimArgs args, InvokeOptions options)
public static Output<GetPimResult> getPim(GetPimArgs args, InvokeOptions options)

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

    The following arguments are supported:

    Device string
    A device name from the provider configuration.
    Device string
    A device name from the provider configuration.
    device String
    A device name from the provider configuration.
    device string
    A device name from the provider configuration.
    device str
    A device name from the provider configuration.
    device String
    A device name from the provider configuration.

    getPim 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
    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.GetPimRpAddress>
    PIM RP-address (Rendezvous Point)
    RpCandidates List<Lbrlabs.PulumiPackage.Iosxe.Outputs.GetPimRpCandidate>
    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
    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
    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 []GetPimRpAddress
    PIM RP-address (Rendezvous Point)
    RpCandidates []GetPimRpCandidate
    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
    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
    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<GetPimRpAddress>
    PIM RP-address (Rendezvous Point)
    rpCandidates List<GetPimRpCandidate>
    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
    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
    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 GetPimRpAddress[]
    PIM RP-address (Rendezvous Point)
    rpCandidates GetPimRpCandidate[]
    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
    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
    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[GetPimRpAddress]
    PIM RP-address (Rendezvous Point)
    rp_candidates Sequence[GetPimRpCandidate]
    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
    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
    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
    device String
    A device name from the provider configuration.

    Supporting Types

    GetPimRpAddress

    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

    GetPimRpCandidate

    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.
    iosxe logo
    Viewing docs for Cisco IOS XE v0.0.1
    published on Friday, Sep 22, 2023 by lbrlabs
    Schema (JSON)
    lbrlabs/pulumi-iosxe
      Try Pulumi Cloud free. Your team will thank you.