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

iosxe.Banner

Explore with Pulumi AI

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

    This resource can manage the Banner configuration.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Iosxe = Lbrlabs.PulumiPackage.Iosxe;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Iosxe.Banner("example", new()
        {
            ExecBanner = "My Exec Banner",
            LoginBanner = "My Login Banner",
            MotdBanner = "My MOTD Banner",
            PromptTimeoutBanner = "My Prompt-Timeout Banner",
        });
    
    });
    
    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.NewBanner(ctx, "example", &iosxe.BannerArgs{
    			ExecBanner:          pulumi.String("My Exec Banner"),
    			LoginBanner:         pulumi.String("My Login Banner"),
    			MotdBanner:          pulumi.String("My MOTD Banner"),
    			PromptTimeoutBanner: pulumi.String("My Prompt-Timeout Banner"),
    		})
    		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.Banner;
    import com.pulumi.iosxe.BannerArgs;
    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) {
            var example = new Banner("example", BannerArgs.builder()        
                .execBanner("My Exec Banner")
                .loginBanner("My Login Banner")
                .motdBanner("My MOTD Banner")
                .promptTimeoutBanner("My Prompt-Timeout Banner")
                .build());
    
        }
    }
    
    import pulumi
    import lbrlabs_pulumi_iosxe as iosxe
    
    example = iosxe.Banner("example",
        exec_banner="My Exec Banner",
        login_banner="My Login Banner",
        motd_banner="My MOTD Banner",
        prompt_timeout_banner="My Prompt-Timeout Banner")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as iosxe from "@lbrlabs/pulumi-iosxe";
    
    const example = new iosxe.Banner("example", {
        execBanner: "My Exec Banner",
        loginBanner: "My Login Banner",
        motdBanner: "My MOTD Banner",
        promptTimeoutBanner: "My Prompt-Timeout Banner",
    });
    
    resources:
      example:
        type: iosxe:Banner
        properties:
          execBanner: My Exec Banner
          loginBanner: My Login Banner
          motdBanner: My MOTD Banner
          promptTimeoutBanner: My Prompt-Timeout Banner
    

    Create Banner Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Banner(name: string, args?: BannerArgs, opts?: CustomResourceOptions);
    @overload
    def Banner(resource_name: str,
               args: Optional[BannerArgs] = None,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def Banner(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               delete_mode: Optional[str] = None,
               device: Optional[str] = None,
               exec_banner: Optional[str] = None,
               login_banner: Optional[str] = None,
               motd_banner: Optional[str] = None,
               prompt_timeout_banner: Optional[str] = None)
    func NewBanner(ctx *Context, name string, args *BannerArgs, opts ...ResourceOption) (*Banner, error)
    public Banner(string name, BannerArgs? args = null, CustomResourceOptions? opts = null)
    public Banner(String name, BannerArgs args)
    public Banner(String name, BannerArgs args, CustomResourceOptions options)
    
    type: iosxe:Banner
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args BannerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args BannerArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args BannerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BannerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BannerArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var bannerResource = new Iosxe.Banner("bannerResource", new()
    {
        DeleteMode = "string",
        Device = "string",
        ExecBanner = "string",
        LoginBanner = "string",
        MotdBanner = "string",
        PromptTimeoutBanner = "string",
    });
    
    example, err := iosxe.NewBanner(ctx, "bannerResource", &iosxe.BannerArgs{
    	DeleteMode:          pulumi.String("string"),
    	Device:              pulumi.String("string"),
    	ExecBanner:          pulumi.String("string"),
    	LoginBanner:         pulumi.String("string"),
    	MotdBanner:          pulumi.String("string"),
    	PromptTimeoutBanner: pulumi.String("string"),
    })
    
    var bannerResource = new Banner("bannerResource", BannerArgs.builder()        
        .deleteMode("string")
        .device("string")
        .execBanner("string")
        .loginBanner("string")
        .motdBanner("string")
        .promptTimeoutBanner("string")
        .build());
    
    banner_resource = iosxe.Banner("bannerResource",
        delete_mode="string",
        device="string",
        exec_banner="string",
        login_banner="string",
        motd_banner="string",
        prompt_timeout_banner="string")
    
    const bannerResource = new iosxe.Banner("bannerResource", {
        deleteMode: "string",
        device: "string",
        execBanner: "string",
        loginBanner: "string",
        motdBanner: "string",
        promptTimeoutBanner: "string",
    });
    
    type: iosxe:Banner
    properties:
        deleteMode: string
        device: string
        execBanner: string
        loginBanner: string
        motdBanner: string
        promptTimeoutBanner: string
    

    Banner Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Banner resource accepts the following input properties:

    DeleteMode string
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    Device string
    A device name from the provider configuration.
    ExecBanner string
    Banner message
    LoginBanner string
    Banner message
    MotdBanner string
    Banner message
    PromptTimeoutBanner string
    Banner message
    DeleteMode string
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    Device string
    A device name from the provider configuration.
    ExecBanner string
    Banner message
    LoginBanner string
    Banner message
    MotdBanner string
    Banner message
    PromptTimeoutBanner string
    Banner message
    deleteMode String
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    device String
    A device name from the provider configuration.
    execBanner String
    Banner message
    loginBanner String
    Banner message
    motdBanner String
    Banner message
    promptTimeoutBanner String
    Banner message
    deleteMode string
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    device string
    A device name from the provider configuration.
    execBanner string
    Banner message
    loginBanner string
    Banner message
    motdBanner string
    Banner message
    promptTimeoutBanner string
    Banner message
    delete_mode str
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    device str
    A device name from the provider configuration.
    exec_banner str
    Banner message
    login_banner str
    Banner message
    motd_banner str
    Banner message
    prompt_timeout_banner str
    Banner message
    deleteMode String
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    device String
    A device name from the provider configuration.
    execBanner String
    Banner message
    loginBanner String
    Banner message
    motdBanner String
    Banner message
    promptTimeoutBanner String
    Banner message

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Banner resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Banner Resource

    Get an existing Banner resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: BannerState, opts?: CustomResourceOptions): Banner
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            delete_mode: Optional[str] = None,
            device: Optional[str] = None,
            exec_banner: Optional[str] = None,
            login_banner: Optional[str] = None,
            motd_banner: Optional[str] = None,
            prompt_timeout_banner: Optional[str] = None) -> Banner
    func GetBanner(ctx *Context, name string, id IDInput, state *BannerState, opts ...ResourceOption) (*Banner, error)
    public static Banner Get(string name, Input<string> id, BannerState? state, CustomResourceOptions? opts = null)
    public static Banner get(String name, Output<String> id, BannerState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    DeleteMode string
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    Device string
    A device name from the provider configuration.
    ExecBanner string
    Banner message
    LoginBanner string
    Banner message
    MotdBanner string
    Banner message
    PromptTimeoutBanner string
    Banner message
    DeleteMode string
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    Device string
    A device name from the provider configuration.
    ExecBanner string
    Banner message
    LoginBanner string
    Banner message
    MotdBanner string
    Banner message
    PromptTimeoutBanner string
    Banner message
    deleteMode String
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    device String
    A device name from the provider configuration.
    execBanner String
    Banner message
    loginBanner String
    Banner message
    motdBanner String
    Banner message
    promptTimeoutBanner String
    Banner message
    deleteMode string
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    device string
    A device name from the provider configuration.
    execBanner string
    Banner message
    loginBanner string
    Banner message
    motdBanner string
    Banner message
    promptTimeoutBanner string
    Banner message
    delete_mode str
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    device str
    A device name from the provider configuration.
    exec_banner str
    Banner message
    login_banner str
    Banner message
    motd_banner str
    Banner message
    prompt_timeout_banner str
    Banner message
    deleteMode String
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    device String
    A device name from the provider configuration.
    execBanner String
    Banner message
    loginBanner String
    Banner message
    motdBanner String
    Banner message
    promptTimeoutBanner String
    Banner message

    Import

     $ pulumi import iosxe:index/banner:Banner example "Cisco-IOS-XE-native:native/banner"
    

    To learn more about importing existing cloud resources, see Importing resources.

    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