1. Packages
  2. Cisco IOS XE Resource Provider
  3. API Docs
  4. getInterfacePim
Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs

iosxe.getInterfacePim

Explore with Pulumi AI

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

    This data source can read the Interface PIM configuration.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Iosxe = Pulumi.Iosxe;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Iosxe.GetInterfacePim.Invoke(new()
        {
            Name = "100",
            Type = "Loopback",
        });
    
    });
    
    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.LookupInterfacePim(ctx, &iosxe.LookupInterfacePimArgs{
    			Name: "100",
    			Type: "Loopback",
    		}, 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.GetInterfacePimArgs;
    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.getInterfacePim(GetInterfacePimArgs.builder()
                .name("100")
                .type("Loopback")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_iosxe as iosxe
    
    example = iosxe.get_interface_pim(name="100",
        type="Loopback")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as iosxe from "@pulumi/iosxe";
    
    const example = iosxe.getInterfacePim({
        name: "100",
        type: "Loopback",
    });
    
    variables:
      example:
        fn::invoke:
          Function: iosxe:getInterfacePim
          Arguments:
            name: '100'
            type: Loopback
    

    Using getInterfacePim

    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 getInterfacePim(args: GetInterfacePimArgs, opts?: InvokeOptions): Promise<GetInterfacePimResult>
    function getInterfacePimOutput(args: GetInterfacePimOutputArgs, opts?: InvokeOptions): Output<GetInterfacePimResult>
    def get_interface_pim(device: Optional[str] = None,
                          name: Optional[str] = None,
                          type: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetInterfacePimResult
    def get_interface_pim_output(device: Optional[pulumi.Input[str]] = None,
                          name: Optional[pulumi.Input[str]] = None,
                          type: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetInterfacePimResult]
    func LookupInterfacePim(ctx *Context, args *LookupInterfacePimArgs, opts ...InvokeOption) (*LookupInterfacePimResult, error)
    func LookupInterfacePimOutput(ctx *Context, args *LookupInterfacePimOutputArgs, opts ...InvokeOption) LookupInterfacePimResultOutput

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

    public static class GetInterfacePim 
    {
        public static Task<GetInterfacePimResult> InvokeAsync(GetInterfacePimArgs args, InvokeOptions? opts = null)
        public static Output<GetInterfacePimResult> Invoke(GetInterfacePimInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetInterfacePimResult> getInterfacePim(GetInterfacePimArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: iosxe:index/getInterfacePim:getInterfacePim
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    Type string
    Interface type
    Device string
    A device name from the provider configuration.
    Name string
    Type string
    Interface type
    Device string
    A device name from the provider configuration.
    name String
    type String
    Interface type
    device String
    A device name from the provider configuration.
    name string
    type string
    Interface type
    device string
    A device name from the provider configuration.
    name str
    type str
    Interface type
    device str
    A device name from the provider configuration.
    name String
    type String
    Interface type
    device String
    A device name from the provider configuration.

    getInterfacePim Result

    The following output properties are available:

    Bfd bool
    Configure BFD
    Border bool
    Border of PIM domain
    BsrBorder bool
    Border of PIM domain
    DenseMode bool
    Enable PIM dense-mode operation
    DrPriority int
    PIM router DR priority
    Id string
    The path of the retrieved object.
    Name string
    Passive bool
    Enable PIM passive interface operation
    SparseDenseMode bool
    Enable PIM sparse-dense-mode operation
    SparseMode bool
    Enable PIM sparse-mode operation
    Type string
    Interface type
    Device string
    A device name from the provider configuration.
    Bfd bool
    Configure BFD
    Border bool
    Border of PIM domain
    BsrBorder bool
    Border of PIM domain
    DenseMode bool
    Enable PIM dense-mode operation
    DrPriority int
    PIM router DR priority
    Id string
    The path of the retrieved object.
    Name string
    Passive bool
    Enable PIM passive interface operation
    SparseDenseMode bool
    Enable PIM sparse-dense-mode operation
    SparseMode bool
    Enable PIM sparse-mode operation
    Type string
    Interface type
    Device string
    A device name from the provider configuration.
    bfd Boolean
    Configure BFD
    border Boolean
    Border of PIM domain
    bsrBorder Boolean
    Border of PIM domain
    denseMode Boolean
    Enable PIM dense-mode operation
    drPriority Integer
    PIM router DR priority
    id String
    The path of the retrieved object.
    name String
    passive Boolean
    Enable PIM passive interface operation
    sparseDenseMode Boolean
    Enable PIM sparse-dense-mode operation
    sparseMode Boolean
    Enable PIM sparse-mode operation
    type String
    Interface type
    device String
    A device name from the provider configuration.
    bfd boolean
    Configure BFD
    border boolean
    Border of PIM domain
    bsrBorder boolean
    Border of PIM domain
    denseMode boolean
    Enable PIM dense-mode operation
    drPriority number
    PIM router DR priority
    id string
    The path of the retrieved object.
    name string
    passive boolean
    Enable PIM passive interface operation
    sparseDenseMode boolean
    Enable PIM sparse-dense-mode operation
    sparseMode boolean
    Enable PIM sparse-mode operation
    type string
    Interface type
    device string
    A device name from the provider configuration.
    bfd bool
    Configure BFD
    border bool
    Border of PIM domain
    bsr_border bool
    Border of PIM domain
    dense_mode bool
    Enable PIM dense-mode operation
    dr_priority int
    PIM router DR priority
    id str
    The path of the retrieved object.
    name str
    passive bool
    Enable PIM passive interface operation
    sparse_dense_mode bool
    Enable PIM sparse-dense-mode operation
    sparse_mode bool
    Enable PIM sparse-mode operation
    type str
    Interface type
    device str
    A device name from the provider configuration.
    bfd Boolean
    Configure BFD
    border Boolean
    Border of PIM domain
    bsrBorder Boolean
    Border of PIM domain
    denseMode Boolean
    Enable PIM dense-mode operation
    drPriority Number
    PIM router DR priority
    id String
    The path of the retrieved object.
    name String
    passive Boolean
    Enable PIM passive interface operation
    sparseDenseMode Boolean
    Enable PIM sparse-dense-mode operation
    sparseMode Boolean
    Enable PIM sparse-mode operation
    type String
    Interface type
    device String
    A device name from the provider configuration.

    Package Details

    Repository
    iosxe lbrlabs/pulumi-iosxe
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the iosxe Terraform Provider.
    iosxe logo
    Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs