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

nxos.getPimStaticRpGroupList

Explore with Pulumi AI

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

    This data source can read the PIM Static RP group list configuration.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Nxos = Pulumi.Nxos;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Nxos.GetPimStaticRpGroupList.Invoke(new()
        {
            Address = "224.0.0.0/4",
            RpAddress = "1.2.3.4",
            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.LookupPimStaticRpGroupList(ctx, &nxos.LookupPimStaticRpGroupListArgs{
    			Address:   "224.0.0.0/4",
    			RpAddress: "1.2.3.4",
    			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.GetPimStaticRpGroupListArgs;
    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.getPimStaticRpGroupList(GetPimStaticRpGroupListArgs.builder()
                .address("224.0.0.0/4")
                .rpAddress("1.2.3.4")
                .vrfName("default")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_nxos as nxos
    
    example = nxos.get_pim_static_rp_group_list(address="224.0.0.0/4",
        rp_address="1.2.3.4",
        vrf_name="default")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as nxos from "@pulumi/nxos";
    
    const example = nxos.getPimStaticRpGroupList({
        address: "224.0.0.0/4",
        rpAddress: "1.2.3.4",
        vrfName: "default",
    });
    
    variables:
      example:
        fn::invoke:
          Function: nxos:getPimStaticRpGroupList
          Arguments:
            address: 224.0.0.0/4
            rpAddress: 1.2.3.4
            vrfName: default
    

    Using getPimStaticRpGroupList

    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 getPimStaticRpGroupList(args: GetPimStaticRpGroupListArgs, opts?: InvokeOptions): Promise<GetPimStaticRpGroupListResult>
    function getPimStaticRpGroupListOutput(args: GetPimStaticRpGroupListOutputArgs, opts?: InvokeOptions): Output<GetPimStaticRpGroupListResult>
    def get_pim_static_rp_group_list(address: Optional[str] = None,
                                     device: Optional[str] = None,
                                     rp_address: Optional[str] = None,
                                     vrf_name: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetPimStaticRpGroupListResult
    def get_pim_static_rp_group_list_output(address: Optional[pulumi.Input[str]] = None,
                                     device: Optional[pulumi.Input[str]] = None,
                                     rp_address: Optional[pulumi.Input[str]] = None,
                                     vrf_name: Optional[pulumi.Input[str]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[GetPimStaticRpGroupListResult]
    func LookupPimStaticRpGroupList(ctx *Context, args *LookupPimStaticRpGroupListArgs, opts ...InvokeOption) (*LookupPimStaticRpGroupListResult, error)
    func LookupPimStaticRpGroupListOutput(ctx *Context, args *LookupPimStaticRpGroupListOutputArgs, opts ...InvokeOption) LookupPimStaticRpGroupListResultOutput

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

    public static class GetPimStaticRpGroupList 
    {
        public static Task<GetPimStaticRpGroupListResult> InvokeAsync(GetPimStaticRpGroupListArgs args, InvokeOptions? opts = null)
        public static Output<GetPimStaticRpGroupListResult> Invoke(GetPimStaticRpGroupListInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPimStaticRpGroupListResult> getPimStaticRpGroupList(GetPimStaticRpGroupListArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: nxos:index/getPimStaticRpGroupList:getPimStaticRpGroupList
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Address string
    Group list address information.
    RpAddress string
    RP address.
    VrfName string
    VRF name.
    Device string
    A device name from the provider configuration.
    Address string
    Group list address information.
    RpAddress string
    RP address.
    VrfName string
    VRF name.
    Device string
    A device name from the provider configuration.
    address String
    Group list address information.
    rpAddress String
    RP address.
    vrfName String
    VRF name.
    device String
    A device name from the provider configuration.
    address string
    Group list address information.
    rpAddress string
    RP address.
    vrfName string
    VRF name.
    device string
    A device name from the provider configuration.
    address str
    Group list address information.
    rp_address str
    RP address.
    vrf_name str
    VRF name.
    device str
    A device name from the provider configuration.
    address String
    Group list address information.
    rpAddress String
    RP address.
    vrfName String
    VRF name.
    device String
    A device name from the provider configuration.

    getPimStaticRpGroupList Result

    The following output properties are available:

    Address string
    Group list address information.
    Bidir bool
    Flag to treat Group Ranges as BiDir.
    Id string
    The distinguished name of the object.
    Override bool
    Flag to override RP preference to use Static over Dynamic RP.
    RpAddress string
    RP address.
    VrfName string
    VRF name.
    Device string
    A device name from the provider configuration.
    Address string
    Group list address information.
    Bidir bool
    Flag to treat Group Ranges as BiDir.
    Id string
    The distinguished name of the object.
    Override bool
    Flag to override RP preference to use Static over Dynamic RP.
    RpAddress string
    RP address.
    VrfName string
    VRF name.
    Device string
    A device name from the provider configuration.
    address String
    Group list address information.
    bidir Boolean
    Flag to treat Group Ranges as BiDir.
    id String
    The distinguished name of the object.
    override Boolean
    Flag to override RP preference to use Static over Dynamic RP.
    rpAddress String
    RP address.
    vrfName String
    VRF name.
    device String
    A device name from the provider configuration.
    address string
    Group list address information.
    bidir boolean
    Flag to treat Group Ranges as BiDir.
    id string
    The distinguished name of the object.
    override boolean
    Flag to override RP preference to use Static over Dynamic RP.
    rpAddress string
    RP address.
    vrfName string
    VRF name.
    device string
    A device name from the provider configuration.
    address str
    Group list address information.
    bidir bool
    Flag to treat Group Ranges as BiDir.
    id str
    The distinguished name of the object.
    override bool
    Flag to override RP preference to use Static over Dynamic RP.
    rp_address str
    RP address.
    vrf_name str
    VRF name.
    device str
    A device name from the provider configuration.
    address String
    Group list address information.
    bidir Boolean
    Flag to treat Group Ranges as BiDir.
    id String
    The distinguished name of the object.
    override Boolean
    Flag to override RP preference to use Static over Dynamic RP.
    rpAddress String
    RP address.
    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.
    nxos logo
    Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs