1. Packages
  2. Cisco Catalyst SD-WAN
  3. API Docs
  4. CliDeviceTemplate
Cisco Catalyst SD-WAN v0.1.1 published on Friday, May 31, 2024 by Pulumi

sdwan.CliDeviceTemplate

Explore with Pulumi AI

sdwan logo
Cisco Catalyst SD-WAN v0.1.1 published on Friday, May 31, 2024 by Pulumi

    This resource can manage a CLI Device Template .

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as sdwan from "@pulumi/sdwan";
    
    const example = new sdwan.CliDeviceTemplate("example", {
        name: "Example",
        description: "My description",
        deviceType: "vedge-ISR-4331",
        cliType: "device",
        cliConfiguration: ` system
     host-name             R1-ISR4331-1200-1`,
    });
    
    import pulumi
    import pulumi_sdwan as sdwan
    
    example = sdwan.CliDeviceTemplate("example",
        name="Example",
        description="My description",
        device_type="vedge-ISR-4331",
        cli_type="device",
        cli_configuration=""" system
     host-name             R1-ISR4331-1200-1""")
    
    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.NewCliDeviceTemplate(ctx, "example", &sdwan.CliDeviceTemplateArgs{
    			Name:             pulumi.String("Example"),
    			Description:      pulumi.String("My description"),
    			DeviceType:       pulumi.String("vedge-ISR-4331"),
    			CliType:          pulumi.String("device"),
    			CliConfiguration: pulumi.String(" system\n host-name             R1-ISR4331-1200-1"),
    		})
    		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.CliDeviceTemplate("example", new()
        {
            Name = "Example",
            Description = "My description",
            DeviceType = "vedge-ISR-4331",
            CliType = "device",
            CliConfiguration = @" system
     host-name             R1-ISR4331-1200-1",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.sdwan.CliDeviceTemplate;
    import com.pulumi.sdwan.CliDeviceTemplateArgs;
    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 CliDeviceTemplate("example", CliDeviceTemplateArgs.builder()        
                .name("Example")
                .description("My description")
                .deviceType("vedge-ISR-4331")
                .cliType("device")
                .cliConfiguration("""
     system
     host-name             R1-ISR4331-1200-1            """)
                .build());
    
        }
    }
    
    resources:
      example:
        type: sdwan:CliDeviceTemplate
        properties:
          name: Example
          description: My description
          deviceType: vedge-ISR-4331
          cliType: device
          cliConfiguration: |2-
             system
             host-name             R1-ISR4331-1200-1
    

    Create CliDeviceTemplate Resource

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

    Constructor syntax

    new CliDeviceTemplate(name: string, args: CliDeviceTemplateArgs, opts?: CustomResourceOptions);
    @overload
    def CliDeviceTemplate(resource_name: str,
                          args: CliDeviceTemplateArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def CliDeviceTemplate(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          cli_configuration: Optional[str] = None,
                          cli_type: Optional[str] = None,
                          description: Optional[str] = None,
                          device_type: Optional[str] = None,
                          name: Optional[str] = None)
    func NewCliDeviceTemplate(ctx *Context, name string, args CliDeviceTemplateArgs, opts ...ResourceOption) (*CliDeviceTemplate, error)
    public CliDeviceTemplate(string name, CliDeviceTemplateArgs args, CustomResourceOptions? opts = null)
    public CliDeviceTemplate(String name, CliDeviceTemplateArgs args)
    public CliDeviceTemplate(String name, CliDeviceTemplateArgs args, CustomResourceOptions options)
    
    type: sdwan:CliDeviceTemplate
    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 CliDeviceTemplateArgs
    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 CliDeviceTemplateArgs
    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 CliDeviceTemplateArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CliDeviceTemplateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CliDeviceTemplateArgs
    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 cliDeviceTemplateResource = new Sdwan.CliDeviceTemplate("cliDeviceTemplateResource", new()
    {
        CliConfiguration = "string",
        CliType = "string",
        Description = "string",
        DeviceType = "string",
        Name = "string",
    });
    
    example, err := sdwan.NewCliDeviceTemplate(ctx, "cliDeviceTemplateResource", &sdwan.CliDeviceTemplateArgs{
    	CliConfiguration: pulumi.String("string"),
    	CliType:          pulumi.String("string"),
    	Description:      pulumi.String("string"),
    	DeviceType:       pulumi.String("string"),
    	Name:             pulumi.String("string"),
    })
    
    var cliDeviceTemplateResource = new CliDeviceTemplate("cliDeviceTemplateResource", CliDeviceTemplateArgs.builder()
        .cliConfiguration("string")
        .cliType("string")
        .description("string")
        .deviceType("string")
        .name("string")
        .build());
    
    cli_device_template_resource = sdwan.CliDeviceTemplate("cliDeviceTemplateResource",
        cli_configuration="string",
        cli_type="string",
        description="string",
        device_type="string",
        name="string")
    
    const cliDeviceTemplateResource = new sdwan.CliDeviceTemplate("cliDeviceTemplateResource", {
        cliConfiguration: "string",
        cliType: "string",
        description: "string",
        deviceType: "string",
        name: "string",
    });
    
    type: sdwan:CliDeviceTemplate
    properties:
        cliConfiguration: string
        cliType: string
        description: string
        deviceType: string
        name: string
    

    CliDeviceTemplate 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 CliDeviceTemplate resource accepts the following input properties:

    CliConfiguration string
    CLI configuration
    CliType string
    CLI type - Choices: device, intend
    Description string
    The description of the device template
    DeviceType string
    The device type (e.g., vedge-ISR-4331)
    Name string
    The name of the device template
    CliConfiguration string
    CLI configuration
    CliType string
    CLI type - Choices: device, intend
    Description string
    The description of the device template
    DeviceType string
    The device type (e.g., vedge-ISR-4331)
    Name string
    The name of the device template
    cliConfiguration String
    CLI configuration
    cliType String
    CLI type - Choices: device, intend
    description String
    The description of the device template
    deviceType String
    The device type (e.g., vedge-ISR-4331)
    name String
    The name of the device template
    cliConfiguration string
    CLI configuration
    cliType string
    CLI type - Choices: device, intend
    description string
    The description of the device template
    deviceType string
    The device type (e.g., vedge-ISR-4331)
    name string
    The name of the device template
    cli_configuration str
    CLI configuration
    cli_type str
    CLI type - Choices: device, intend
    description str
    The description of the device template
    device_type str
    The device type (e.g., vedge-ISR-4331)
    name str
    The name of the device template
    cliConfiguration String
    CLI configuration
    cliType String
    CLI type - Choices: device, intend
    description String
    The description of the device template
    deviceType String
    The device type (e.g., vedge-ISR-4331)
    name String
    The name of the device template

    Outputs

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

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

    Look up Existing CliDeviceTemplate Resource

    Get an existing CliDeviceTemplate 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?: CliDeviceTemplateState, opts?: CustomResourceOptions): CliDeviceTemplate
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            cli_configuration: Optional[str] = None,
            cli_type: Optional[str] = None,
            description: Optional[str] = None,
            device_type: Optional[str] = None,
            name: Optional[str] = None,
            version: Optional[int] = None) -> CliDeviceTemplate
    func GetCliDeviceTemplate(ctx *Context, name string, id IDInput, state *CliDeviceTemplateState, opts ...ResourceOption) (*CliDeviceTemplate, error)
    public static CliDeviceTemplate Get(string name, Input<string> id, CliDeviceTemplateState? state, CustomResourceOptions? opts = null)
    public static CliDeviceTemplate get(String name, Output<String> id, CliDeviceTemplateState 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:
    CliConfiguration string
    CLI configuration
    CliType string
    CLI type - Choices: device, intend
    Description string
    The description of the device template
    DeviceType string
    The device type (e.g., vedge-ISR-4331)
    Name string
    The name of the device template
    Version int
    The version of the object
    CliConfiguration string
    CLI configuration
    CliType string
    CLI type - Choices: device, intend
    Description string
    The description of the device template
    DeviceType string
    The device type (e.g., vedge-ISR-4331)
    Name string
    The name of the device template
    Version int
    The version of the object
    cliConfiguration String
    CLI configuration
    cliType String
    CLI type - Choices: device, intend
    description String
    The description of the device template
    deviceType String
    The device type (e.g., vedge-ISR-4331)
    name String
    The name of the device template
    version Integer
    The version of the object
    cliConfiguration string
    CLI configuration
    cliType string
    CLI type - Choices: device, intend
    description string
    The description of the device template
    deviceType string
    The device type (e.g., vedge-ISR-4331)
    name string
    The name of the device template
    version number
    The version of the object
    cli_configuration str
    CLI configuration
    cli_type str
    CLI type - Choices: device, intend
    description str
    The description of the device template
    device_type str
    The device type (e.g., vedge-ISR-4331)
    name str
    The name of the device template
    version int
    The version of the object
    cliConfiguration String
    CLI configuration
    cliType String
    CLI type - Choices: device, intend
    description String
    The description of the device template
    deviceType String
    The device type (e.g., vedge-ISR-4331)
    name String
    The name of the device template
    version Number
    The version of the object

    Import

    $ pulumi import sdwan:index/cliDeviceTemplate:CliDeviceTemplate example "f6b2c44c-693c-4763-b010-895aa3d236bd"
    

    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.1.1 published on Friday, May 31, 2024 by Pulumi