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

iosxe.getPrefixList

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 Prefix List configuration.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Iosxe = Pulumi.Iosxe;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Iosxe.GetPrefixList.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.LookupPrefixList(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.GetPrefixListArgs;
    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.getPrefixList();
    
        }
    }
    
    import pulumi
    import pulumi_iosxe as iosxe
    
    example = iosxe.get_prefix_list()
    
    import * as pulumi from "@pulumi/pulumi";
    import * as iosxe from "@pulumi/iosxe";
    
    const example = iosxe.getPrefixList({});
    
    variables:
      example:
        fn::invoke:
          Function: iosxe:getPrefixList
          Arguments: {}
    

    Using getPrefixList

    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 getPrefixList(args: GetPrefixListArgs, opts?: InvokeOptions): Promise<GetPrefixListResult>
    function getPrefixListOutput(args: GetPrefixListOutputArgs, opts?: InvokeOptions): Output<GetPrefixListResult>
    def get_prefix_list(device: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetPrefixListResult
    def get_prefix_list_output(device: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetPrefixListResult]
    func LookupPrefixList(ctx *Context, args *LookupPrefixListArgs, opts ...InvokeOption) (*LookupPrefixListResult, error)
    func LookupPrefixListOutput(ctx *Context, args *LookupPrefixListOutputArgs, opts ...InvokeOption) LookupPrefixListResultOutput

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

    public static class GetPrefixList 
    {
        public static Task<GetPrefixListResult> InvokeAsync(GetPrefixListArgs args, InvokeOptions? opts = null)
        public static Output<GetPrefixListResult> Invoke(GetPrefixListInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPrefixListResult> getPrefixList(GetPrefixListArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: iosxe:index/getPrefixList:getPrefixList
      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.

    getPrefixList Result

    The following output properties are available:

    Id string
    The path of the retrieved object.
    Prefixes List<Lbrlabs.PulumiPackage.Iosxe.Outputs.GetPrefixListPrefix>
    Build prefix-lists with name ans seq.no
    Device string
    A device name from the provider configuration.
    Id string
    The path of the retrieved object.
    Prefixes []GetPrefixListPrefix
    Build prefix-lists with name ans seq.no
    Device string
    A device name from the provider configuration.
    id String
    The path of the retrieved object.
    prefixes List<GetPrefixListPrefix>
    Build prefix-lists with name ans seq.no
    device String
    A device name from the provider configuration.
    id string
    The path of the retrieved object.
    prefixes GetPrefixListPrefix[]
    Build prefix-lists with name ans seq.no
    device string
    A device name from the provider configuration.
    id str
    The path of the retrieved object.
    prefixes Sequence[GetPrefixListPrefix]
    Build prefix-lists with name ans seq.no
    device str
    A device name from the provider configuration.
    id String
    The path of the retrieved object.
    prefixes List<Property Map>
    Build prefix-lists with name ans seq.no
    device String
    A device name from the provider configuration.

    Supporting Types

    GetPrefixListPrefix

    Action string
    Specify deny or permit action
    Ge int
    Minimum prefix length to be matched
    Ip string
    IPv4 Prefix
    Le int
    Maximum prefix length to be matched
    Name string
    Name of the prefix-list
    Seq int
    Seq Number of the prefix-list
    Action string
    Specify deny or permit action
    Ge int
    Minimum prefix length to be matched
    Ip string
    IPv4 Prefix
    Le int
    Maximum prefix length to be matched
    Name string
    Name of the prefix-list
    Seq int
    Seq Number of the prefix-list
    action String
    Specify deny or permit action
    ge Integer
    Minimum prefix length to be matched
    ip String
    IPv4 Prefix
    le Integer
    Maximum prefix length to be matched
    name String
    Name of the prefix-list
    seq Integer
    Seq Number of the prefix-list
    action string
    Specify deny or permit action
    ge number
    Minimum prefix length to be matched
    ip string
    IPv4 Prefix
    le number
    Maximum prefix length to be matched
    name string
    Name of the prefix-list
    seq number
    Seq Number of the prefix-list
    action str
    Specify deny or permit action
    ge int
    Minimum prefix length to be matched
    ip str
    IPv4 Prefix
    le int
    Maximum prefix length to be matched
    name str
    Name of the prefix-list
    seq int
    Seq Number of the prefix-list
    action String
    Specify deny or permit action
    ge Number
    Minimum prefix length to be matched
    ip String
    IPv4 Prefix
    le Number
    Maximum prefix length to be matched
    name String
    Name of the prefix-list
    seq Number
    Seq Number of the prefix-list

    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