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

nxos.getPimInstance

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 instance configuration.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Nxos = Pulumi.Nxos;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Nxos.GetPimInstance.Invoke();
    
    });
    
    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.LookupPimInstance(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.nxos.NxosFunctions;
    import com.pulumi.nxos.inputs.GetPimInstanceArgs;
    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.getPimInstance();
    
        }
    }
    
    import pulumi
    import pulumi_nxos as nxos
    
    example = nxos.get_pim_instance()
    
    import * as pulumi from "@pulumi/pulumi";
    import * as nxos from "@pulumi/nxos";
    
    const example = nxos.getPimInstance({});
    
    variables:
      example:
        fn::invoke:
          Function: nxos:getPimInstance
          Arguments: {}
    

    Using getPimInstance

    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 getPimInstance(args: GetPimInstanceArgs, opts?: InvokeOptions): Promise<GetPimInstanceResult>
    function getPimInstanceOutput(args: GetPimInstanceOutputArgs, opts?: InvokeOptions): Output<GetPimInstanceResult>
    def get_pim_instance(device: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetPimInstanceResult
    def get_pim_instance_output(device: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetPimInstanceResult]
    func LookupPimInstance(ctx *Context, args *LookupPimInstanceArgs, opts ...InvokeOption) (*LookupPimInstanceResult, error)
    func LookupPimInstanceOutput(ctx *Context, args *LookupPimInstanceOutputArgs, opts ...InvokeOption) LookupPimInstanceResultOutput

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

    public static class GetPimInstance 
    {
        public static Task<GetPimInstanceResult> InvokeAsync(GetPimInstanceArgs args, InvokeOptions? opts = null)
        public static Output<GetPimInstanceResult> Invoke(GetPimInstanceInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPimInstanceResult> getPimInstance(GetPimInstanceArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: nxos:index/getPimInstance:getPimInstance
      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.

    getPimInstance Result

    The following output properties are available:

    AdminState string
    Administrative state.
    Id string
    The distinguished name of the object.
    Device string
    A device name from the provider configuration.
    AdminState string
    Administrative state.
    Id string
    The distinguished name of the object.
    Device string
    A device name from the provider configuration.
    adminState String
    Administrative state.
    id String
    The distinguished name of the object.
    device String
    A device name from the provider configuration.
    adminState string
    Administrative state.
    id string
    The distinguished name of the object.
    device string
    A device name from the provider configuration.
    admin_state str
    Administrative state.
    id str
    The distinguished name of the object.
    device str
    A device name from the provider configuration.
    adminState String
    Administrative state.
    id String
    The distinguished name of the object.
    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