Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cisco Catalyst SD-WAN
  3. API Docs
  4. SystemBannerFeature
Cisco Catalyst SD-WAN v0.2.0 published on Friday, Nov 1, 2024 by Pulumi
pulumi/pulumi-sdwan

sdwan.SystemBannerFeature

Explore with Pulumi AI

sdwan logo
Cisco Catalyst SD-WAN v0.2.0 published on Friday, Nov 1, 2024 by Pulumi
pulumi/pulumi-sdwan

    This resource can manage a System Banner Feature.

    • Minimum SD-WAN Manager version: 20.12.0

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as sdwan from "@pulumi/sdwan";

const example = new sdwan.SystemBannerFeature("example", {
    name: "Example",
    description: "My Example",
    featureProfileId: "f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac",
    login: "My login banner",
    motd: "My motd banner",
});

    import pulumi
import pulumi_sdwan as sdwan

example = sdwan.SystemBannerFeature("example",
    name="Example",
    description="My Example",
    feature_profile_id="f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac",
    login="My login banner",
    motd="My motd banner")

    package main

import (
	"github.com/pulumi/pulumi-sdwan/sdk/go/sdwan"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sdwan.NewSystemBannerFeature(ctx, "example", &sdwan.SystemBannerFeatureArgs{
			Name:             pulumi.String("Example"),
			Description:      pulumi.String("My Example"),
			FeatureProfileId: pulumi.String("f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac"),
			Login:            pulumi.String("My login banner"),
			Motd:             pulumi.String("My motd banner"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Sdwan = Pulumi.Sdwan;

return await Deployment.RunAsync(() => 
{
    var example = new Sdwan.SystemBannerFeature("example", new()
    {
        Name = "Example",
        Description = "My Example",
        FeatureProfileId = "f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac",
        Login = "My login banner",
        Motd = "My motd banner",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.sdwan.SystemBannerFeature;
import com.pulumi.sdwan.SystemBannerFeatureArgs;
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 SystemBannerFeature("example", SystemBannerFeatureArgs.builder()
            .name("Example")
            .description("My Example")
            .featureProfileId("f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac")
            .login("My login banner")
            .motd("My motd banner")
            .build());

    }
}

    resources:
  example:
    type: sdwan:SystemBannerFeature
    properties:
      name: Example
      description: My Example
      featureProfileId: f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac
      login: My login banner
      motd: My motd banner

    Create SystemBannerFeature Resource

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

    Constructor syntax

    new SystemBannerFeature(name: string, args: SystemBannerFeatureArgs, opts?: CustomResourceOptions);
    @overload
def SystemBannerFeature(resource_name: str,
                        args: SystemBannerFeatureArgs,
                        opts: Optional[ResourceOptions] = None)

@overload
def SystemBannerFeature(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        feature_profile_id: Optional[str] = None,
                        description: Optional[str] = None,
                        login: Optional[str] = None,
                        login_variable: Optional[str] = None,
                        motd: Optional[str] = None,
                        motd_variable: Optional[str] = None,
                        name: Optional[str] = None)
    func NewSystemBannerFeature(ctx *Context, name string, args SystemBannerFeatureArgs, opts ...ResourceOption) (*SystemBannerFeature, error)
    public SystemBannerFeature(string name, SystemBannerFeatureArgs args, CustomResourceOptions? opts = null)
    public SystemBannerFeature(String name, SystemBannerFeatureArgs args)
public SystemBannerFeature(String name, SystemBannerFeatureArgs args, CustomResourceOptions options)

    type: sdwan:SystemBannerFeature
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 SystemBannerFeatureArgs
    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 SystemBannerFeatureArgs
    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 SystemBannerFeatureArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SystemBannerFeatureArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SystemBannerFeatureArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var systemBannerFeatureResource = new Sdwan.SystemBannerFeature("systemBannerFeatureResource", new()
{
    FeatureProfileId = "string",
    Description = "string",
    Login = "string",
    LoginVariable = "string",
    Motd = "string",
    MotdVariable = "string",
    Name = "string",
});

    example, err := sdwan.NewSystemBannerFeature(ctx, "systemBannerFeatureResource", &sdwan.SystemBannerFeatureArgs{
	FeatureProfileId: pulumi.String("string"),
	Description:      pulumi.String("string"),
	Login:            pulumi.String("string"),
	LoginVariable:    pulumi.String("string"),
	Motd:             pulumi.String("string"),
	MotdVariable:     pulumi.String("string"),
	Name:             pulumi.String("string"),
})

    var systemBannerFeatureResource = new SystemBannerFeature("systemBannerFeatureResource", SystemBannerFeatureArgs.builder()
    .featureProfileId("string")
    .description("string")
    .login("string")
    .loginVariable("string")
    .motd("string")
    .motdVariable("string")
    .name("string")
    .build());

    system_banner_feature_resource = sdwan.SystemBannerFeature("systemBannerFeatureResource",
    feature_profile_id="string",
    description="string",
    login="string",
    login_variable="string",
    motd="string",
    motd_variable="string",
    name="string")

    const systemBannerFeatureResource = new sdwan.SystemBannerFeature("systemBannerFeatureResource", {
    featureProfileId: "string",
    description: "string",
    login: "string",
    loginVariable: "string",
    motd: "string",
    motdVariable: "string",
    name: "string",
});

    type: sdwan:SystemBannerFeature
properties:
    description: string
    featureProfileId: string
    login: string
    loginVariable: string
    motd: string
    motdVariable: string
    name: string

    SystemBannerFeature Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The SystemBannerFeature resource accepts the following input properties:

    FeatureProfileId string
    Feature Profile ID
    Description string
    The description of the Feature
    Login string
    LoginVariable string
    Variable name
    Motd string
    MotdVariable string
    Variable name
    Name string
    The name of the Feature
    FeatureProfileId string
    Feature Profile ID
    Description string
    The description of the Feature
    Login string
    LoginVariable string
    Variable name
    Motd string
    MotdVariable string
    Variable name
    Name string
    The name of the Feature
    featureProfileId String
    Feature Profile ID
    description String
    The description of the Feature
    login String
    loginVariable String
    Variable name
    motd String
    motdVariable String
    Variable name
    name String
    The name of the Feature
    featureProfileId string
    Feature Profile ID
    description string
    The description of the Feature
    login string
    loginVariable string
    Variable name
    motd string
    motdVariable string
    Variable name
    name string
    The name of the Feature
    feature_profile_id str
    Feature Profile ID
    description str
    The description of the Feature
    login str
    login_variable str
    Variable name
    motd str
    motd_variable str
    Variable name
    name str
    The name of the Feature
    featureProfileId String
    Feature Profile ID
    description String
    The description of the Feature
    login String
    loginVariable String
    Variable name
    motd String
    motdVariable String
    Variable name
    name String
    The name of the Feature

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Version int
    The version of the Feature
    Id string
    The provider-assigned unique ID for this managed resource.
    Version int
    The version of the Feature
    id String
    The provider-assigned unique ID for this managed resource.
    version Integer
    The version of the Feature
    id string
    The provider-assigned unique ID for this managed resource.
    version number
    The version of the Feature
    id str
    The provider-assigned unique ID for this managed resource.
    version int
    The version of the Feature
    id String
    The provider-assigned unique ID for this managed resource.
    version Number
    The version of the Feature

    Look up Existing SystemBannerFeature Resource

    Get an existing SystemBannerFeature 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?: SystemBannerFeatureState, opts?: CustomResourceOptions): SystemBannerFeature
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        feature_profile_id: Optional[str] = None,
        login: Optional[str] = None,
        login_variable: Optional[str] = None,
        motd: Optional[str] = None,
        motd_variable: Optional[str] = None,
        name: Optional[str] = None,
        version: Optional[int] = None) -> SystemBannerFeature
    func GetSystemBannerFeature(ctx *Context, name string, id IDInput, state *SystemBannerFeatureState, opts ...ResourceOption) (*SystemBannerFeature, error)
    public static SystemBannerFeature Get(string name, Input<string> id, SystemBannerFeatureState? state, CustomResourceOptions? opts = null)
    public static SystemBannerFeature get(String name, Output<String> id, SystemBannerFeatureState 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:
    Description string
    The description of the Feature
    FeatureProfileId string
    Feature Profile ID
    Login string
    LoginVariable string
    Variable name
    Motd string
    MotdVariable string
    Variable name
    Name string
    The name of the Feature
    Version int
    The version of the Feature
    Description string
    The description of the Feature
    FeatureProfileId string
    Feature Profile ID
    Login string
    LoginVariable string
    Variable name
    Motd string
    MotdVariable string
    Variable name
    Name string
    The name of the Feature
    Version int
    The version of the Feature
    description String
    The description of the Feature
    featureProfileId String
    Feature Profile ID
    login String
    loginVariable String
    Variable name
    motd String
    motdVariable String
    Variable name
    name String
    The name of the Feature
    version Integer
    The version of the Feature
    description string
    The description of the Feature
    featureProfileId string
    Feature Profile ID
    login string
    loginVariable string
    Variable name
    motd string
    motdVariable string
    Variable name
    name string
    The name of the Feature
    version number
    The version of the Feature
    description str
    The description of the Feature
    feature_profile_id str
    Feature Profile ID
    login str
    login_variable str
    Variable name
    motd str
    motd_variable str
    Variable name
    name str
    The name of the Feature
    version int
    The version of the Feature
    description String
    The description of the Feature
    featureProfileId String
    Feature Profile ID
    login String
    loginVariable String
    Variable name
    motd String
    motdVariable String
    Variable name
    name String
    The name of the Feature
    version Number
    The version of the Feature

    Import

    Expected import identifier with the format: “system_banner_feature_id,feature_profile_id”

    $ pulumi import sdwan:index/systemBannerFeature:SystemBannerFeature example "f6b2c44c-693c-4763-b010-895aa3d236bd,f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac"

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

    Package Details

    Repository
    sdwan pulumi/pulumi-sdwan
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the sdwan Terraform Provider.
    sdwan logo
    Cisco Catalyst SD-WAN v0.2.0 published on Friday, Nov 1, 2024 by Pulumi
    pulumi/pulumi-sdwan