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

iosxe.getBanner

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

    Example Usage

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

    Using getBanner

    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 getBanner(args: GetBannerArgs, opts?: InvokeOptions): Promise<GetBannerResult>
    function getBannerOutput(args: GetBannerOutputArgs, opts?: InvokeOptions): Output<GetBannerResult>
    def get_banner(device: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetBannerResult
    def get_banner_output(device: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetBannerResult]
    func LookupBanner(ctx *Context, args *LookupBannerArgs, opts ...InvokeOption) (*LookupBannerResult, error)
    func LookupBannerOutput(ctx *Context, args *LookupBannerOutputArgs, opts ...InvokeOption) LookupBannerResultOutput

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

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

    getBanner Result

    The following output properties are available:

    ExecBanner string
    Banner message
    Id string
    The path of the retrieved object.
    LoginBanner string
    Banner message
    MotdBanner string
    Banner message
    PromptTimeoutBanner string
    Banner message
    Device string
    A device name from the provider configuration.
    ExecBanner string
    Banner message
    Id string
    The path of the retrieved object.
    LoginBanner string
    Banner message
    MotdBanner string
    Banner message
    PromptTimeoutBanner string
    Banner message
    Device string
    A device name from the provider configuration.
    execBanner String
    Banner message
    id String
    The path of the retrieved object.
    loginBanner String
    Banner message
    motdBanner String
    Banner message
    promptTimeoutBanner String
    Banner message
    device String
    A device name from the provider configuration.
    execBanner string
    Banner message
    id string
    The path of the retrieved object.
    loginBanner string
    Banner message
    motdBanner string
    Banner message
    promptTimeoutBanner string
    Banner message
    device string
    A device name from the provider configuration.
    exec_banner str
    Banner message
    id str
    The path of the retrieved object.
    login_banner str
    Banner message
    motd_banner str
    Banner message
    prompt_timeout_banner str
    Banner message
    device str
    A device name from the provider configuration.
    execBanner String
    Banner message
    id String
    The path of the retrieved object.
    loginBanner String
    Banner message
    motdBanner String
    Banner message
    promptTimeoutBanner String
    Banner message
    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