Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Fortimanager Provider
  3. API Docs
  4. ObjectCliTemplate
fortimanager 1.13.0 published on Thursday, Mar 13, 2025 by fortinetdev
fortinetdev/terraform-provider-fortimanager

fortimanager.ObjectCliTemplate

Explore with Pulumi AI

fortimanager logo
fortimanager 1.13.0 published on Thursday, Mar 13, 2025 by fortinetdev
fortinetdev/terraform-provider-fortimanager

    ObjectCli Template

    Example Usage

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

const trname = new fortimanager.ObjectCliTemplate("trname", {
    description: "This is a Terraform example",
    script: "terr-script",
});

    import pulumi
import pulumi_fortimanager as fortimanager

trname = fortimanager.ObjectCliTemplate("trname",
    description="This is a Terraform example",
    script="terr-script")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/fortimanager/fortimanager"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := fortimanager.NewObjectCliTemplate(ctx, "trname", &fortimanager.ObjectCliTemplateArgs{
			Description: pulumi.String("This is a Terraform example"),
			Script:      pulumi.String("terr-script"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var trname = new Fortimanager.ObjectCliTemplate("trname", new()
    {
        Description = "This is a Terraform example",
        Script = "terr-script",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortimanager.ObjectCliTemplate;
import com.pulumi.fortimanager.ObjectCliTemplateArgs;
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 trname = new ObjectCliTemplate("trname", ObjectCliTemplateArgs.builder()
            .description("This is a Terraform example")
            .script("terr-script")
            .build());

    }
}

    resources:
  trname:
    type: fortimanager:ObjectCliTemplate
    properties:
      description: This is a Terraform example
      script: terr-script

    Create ObjectCliTemplate Resource

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

    Constructor syntax

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

@overload
def ObjectCliTemplate(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      adom: Optional[str] = None,
                      description: Optional[str] = None,
                      modification_time: Optional[str] = None,
                      name: Optional[str] = None,
                      object_cli_template_id: Optional[str] = None,
                      options: Optional[Sequence[str]] = None,
                      position: Optional[str] = None,
                      provision: Optional[str] = None,
                      scopetype: Optional[str] = None,
                      script: Optional[str] = None,
                      type: Optional[str] = None,
                      variables: Optional[Sequence[str]] = None)
    func NewObjectCliTemplate(ctx *Context, name string, args *ObjectCliTemplateArgs, opts ...ResourceOption) (*ObjectCliTemplate, error)
    public ObjectCliTemplate(string name, ObjectCliTemplateArgs? args = null, CustomResourceOptions? opts = null)
    public ObjectCliTemplate(String name, ObjectCliTemplateArgs args)
public ObjectCliTemplate(String name, ObjectCliTemplateArgs args, CustomResourceOptions options)

    type: fortimanager:ObjectCliTemplate
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 ObjectCliTemplateArgs
    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 ObjectCliTemplateArgs
    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 ObjectCliTemplateArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ObjectCliTemplateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ObjectCliTemplateArgs
    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 objectCliTemplateResource = new Fortimanager.ObjectCliTemplate("objectCliTemplateResource", new()
{
    Adom = "string",
    Description = "string",
    ModificationTime = "string",
    Name = "string",
    ObjectCliTemplateId = "string",
    Options = new[]
    {
        "string",
    },
    Position = "string",
    Provision = "string",
    Scopetype = "string",
    Script = "string",
    Type = "string",
    Variables = new[]
    {
        "string",
    },
});

    example, err := fortimanager.NewObjectCliTemplate(ctx, "objectCliTemplateResource", &fortimanager.ObjectCliTemplateArgs{
Adom: pulumi.String("string"),
Description: pulumi.String("string"),
ModificationTime: pulumi.String("string"),
Name: pulumi.String("string"),
ObjectCliTemplateId: pulumi.String("string"),
Options: pulumi.StringArray{
pulumi.String("string"),
},
Position: pulumi.String("string"),
Provision: pulumi.String("string"),
Scopetype: pulumi.String("string"),
Script: pulumi.String("string"),
Type: pulumi.String("string"),
Variables: pulumi.StringArray{
pulumi.String("string"),
},
})

    var objectCliTemplateResource = new ObjectCliTemplate("objectCliTemplateResource", ObjectCliTemplateArgs.builder()
    .adom("string")
    .description("string")
    .modificationTime("string")
    .name("string")
    .objectCliTemplateId("string")
    .options("string")
    .position("string")
    .provision("string")
    .scopetype("string")
    .script("string")
    .type("string")
    .variables("string")
    .build());

    object_cli_template_resource = fortimanager.ObjectCliTemplate("objectCliTemplateResource",
    adom="string",
    description="string",
    modification_time="string",
    name="string",
    object_cli_template_id="string",
    options=["string"],
    position="string",
    provision="string",
    scopetype="string",
    script="string",
    type="string",
    variables=["string"])

    const objectCliTemplateResource = new fortimanager.ObjectCliTemplate("objectCliTemplateResource", {
    adom: "string",
    description: "string",
    modificationTime: "string",
    name: "string",
    objectCliTemplateId: "string",
    options: ["string"],
    position: "string",
    provision: "string",
    scopetype: "string",
    script: "string",
    type: "string",
    variables: ["string"],
});

    type: fortimanager:ObjectCliTemplate
properties:
    adom: string
    description: string
    modificationTime: string
    name: string
    objectCliTemplateId: string
    options:
        - string
    position: string
    provision: string
    scopetype: string
    script: string
    type: string
    variables:
        - string

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

    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    Description string
    Description.
    ModificationTime string
    Modification-Time.
    Name string
    Name.
    ObjectCliTemplateId string
    an identifier for the resource with format {{name}}.
    Options List<string>
    Option. Valid values: sdwan-overlay, sdwan-manager.
    Position string
    Position. Valid values: post-vdom-copy, prep-vdom-copy.
    Provision string
    Provision. Valid values: disable, enable.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    Script string
    Script.
    Type string
    Type. Valid values: cli, jinja.
    Variables List<string>
    Variables.
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    Description string
    Description.
    ModificationTime string
    Modification-Time.
    Name string
    Name.
    ObjectCliTemplateId string
    an identifier for the resource with format {{name}}.
    Options []string
    Option. Valid values: sdwan-overlay, sdwan-manager.
    Position string
    Position. Valid values: post-vdom-copy, prep-vdom-copy.
    Provision string
    Provision. Valid values: disable, enable.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    Script string
    Script.
    Type string
    Type. Valid values: cli, jinja.
    Variables []string
    Variables.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    description String
    Description.
    modificationTime String
    Modification-Time.
    name String
    Name.
    objectCliTemplateId String
    an identifier for the resource with format {{name}}.
    options List<String>
    Option. Valid values: sdwan-overlay, sdwan-manager.
    position String
    Position. Valid values: post-vdom-copy, prep-vdom-copy.
    provision String
    Provision. Valid values: disable, enable.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    script String
    Script.
    type String
    Type. Valid values: cli, jinja.
    variables List<String>
    Variables.
    adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    description string
    Description.
    modificationTime string
    Modification-Time.
    name string
    Name.
    objectCliTemplateId string
    an identifier for the resource with format {{name}}.
    options string[]
    Option. Valid values: sdwan-overlay, sdwan-manager.
    position string
    Position. Valid values: post-vdom-copy, prep-vdom-copy.
    provision string
    Provision. Valid values: disable, enable.
    scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    script string
    Script.
    type string
    Type. Valid values: cli, jinja.
    variables string[]
    Variables.
    adom str
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    description str
    Description.
    modification_time str
    Modification-Time.
    name str
    Name.
    object_cli_template_id str
    an identifier for the resource with format {{name}}.
    options Sequence[str]
    Option. Valid values: sdwan-overlay, sdwan-manager.
    position str
    Position. Valid values: post-vdom-copy, prep-vdom-copy.
    provision str
    Provision. Valid values: disable, enable.
    scopetype str
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    script str
    Script.
    type str
    Type. Valid values: cli, jinja.
    variables Sequence[str]
    Variables.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    description String
    Description.
    modificationTime String
    Modification-Time.
    name String
    Name.
    objectCliTemplateId String
    an identifier for the resource with format {{name}}.
    options List<String>
    Option. Valid values: sdwan-overlay, sdwan-manager.
    position String
    Position. Valid values: post-vdom-copy, prep-vdom-copy.
    provision String
    Provision. Valid values: disable, enable.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    script String
    Script.
    type String
    Type. Valid values: cli, jinja.
    variables List<String>
    Variables.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ObjectCliTemplate 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 ObjectCliTemplate Resource

    Get an existing ObjectCliTemplate 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?: ObjectCliTemplateState, opts?: CustomResourceOptions): ObjectCliTemplate
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        adom: Optional[str] = None,
        description: Optional[str] = None,
        modification_time: Optional[str] = None,
        name: Optional[str] = None,
        object_cli_template_id: Optional[str] = None,
        options: Optional[Sequence[str]] = None,
        position: Optional[str] = None,
        provision: Optional[str] = None,
        scopetype: Optional[str] = None,
        script: Optional[str] = None,
        type: Optional[str] = None,
        variables: Optional[Sequence[str]] = None) -> ObjectCliTemplate
    func GetObjectCliTemplate(ctx *Context, name string, id IDInput, state *ObjectCliTemplateState, opts ...ResourceOption) (*ObjectCliTemplate, error)
    public static ObjectCliTemplate Get(string name, Input<string> id, ObjectCliTemplateState? state, CustomResourceOptions? opts = null)
    public static ObjectCliTemplate get(String name, Output<String> id, ObjectCliTemplateState state, CustomResourceOptions options)
    resources:  _:    type: fortimanager:ObjectCliTemplate    get:      id: ${id}
    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:
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    Description string
    Description.
    ModificationTime string
    Modification-Time.
    Name string
    Name.
    ObjectCliTemplateId string
    an identifier for the resource with format {{name}}.
    Options List<string>
    Option. Valid values: sdwan-overlay, sdwan-manager.
    Position string
    Position. Valid values: post-vdom-copy, prep-vdom-copy.
    Provision string
    Provision. Valid values: disable, enable.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    Script string
    Script.
    Type string
    Type. Valid values: cli, jinja.
    Variables List<string>
    Variables.
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    Description string
    Description.
    ModificationTime string
    Modification-Time.
    Name string
    Name.
    ObjectCliTemplateId string
    an identifier for the resource with format {{name}}.
    Options []string
    Option. Valid values: sdwan-overlay, sdwan-manager.
    Position string
    Position. Valid values: post-vdom-copy, prep-vdom-copy.
    Provision string
    Provision. Valid values: disable, enable.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    Script string
    Script.
    Type string
    Type. Valid values: cli, jinja.
    Variables []string
    Variables.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    description String
    Description.
    modificationTime String
    Modification-Time.
    name String
    Name.
    objectCliTemplateId String
    an identifier for the resource with format {{name}}.
    options List<String>
    Option. Valid values: sdwan-overlay, sdwan-manager.
    position String
    Position. Valid values: post-vdom-copy, prep-vdom-copy.
    provision String
    Provision. Valid values: disable, enable.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    script String
    Script.
    type String
    Type. Valid values: cli, jinja.
    variables List<String>
    Variables.
    adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    description string
    Description.
    modificationTime string
    Modification-Time.
    name string
    Name.
    objectCliTemplateId string
    an identifier for the resource with format {{name}}.
    options string[]
    Option. Valid values: sdwan-overlay, sdwan-manager.
    position string
    Position. Valid values: post-vdom-copy, prep-vdom-copy.
    provision string
    Provision. Valid values: disable, enable.
    scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    script string
    Script.
    type string
    Type. Valid values: cli, jinja.
    variables string[]
    Variables.
    adom str
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    description str
    Description.
    modification_time str
    Modification-Time.
    name str
    Name.
    object_cli_template_id str
    an identifier for the resource with format {{name}}.
    options Sequence[str]
    Option. Valid values: sdwan-overlay, sdwan-manager.
    position str
    Position. Valid values: post-vdom-copy, prep-vdom-copy.
    provision str
    Provision. Valid values: disable, enable.
    scopetype str
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    script str
    Script.
    type str
    Type. Valid values: cli, jinja.
    variables Sequence[str]
    Variables.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    description String
    Description.
    modificationTime String
    Modification-Time.
    name String
    Name.
    objectCliTemplateId String
    an identifier for the resource with format {{name}}.
    options List<String>
    Option. Valid values: sdwan-overlay, sdwan-manager.
    position String
    Position. Valid values: post-vdom-copy, prep-vdom-copy.
    provision String
    Provision. Valid values: disable, enable.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    script String
    Script.
    type String
    Type. Valid values: cli, jinja.
    variables List<String>
    Variables.

    Import

    ObjectCli Template can be imported using any of these accepted formats:

    $ export “FORTIMANAGER_IMPORT_TABLE”=“true”

    $ pulumi import fortimanager:index/objectCliTemplate:ObjectCliTemplate labelname {{name}}

    $ unset “FORTIMANAGER_IMPORT_TABLE”

    -> Hint: The scopetype and adom for import will directly inherit the scopetype and adom configuration of the provider.

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

    Package Details

    Repository
    fortimanager fortinetdev/terraform-provider-fortimanager
    License
    Notes
    This Pulumi package is based on the fortimanager Terraform Provider.
    fortimanager logo
    fortimanager 1.13.0 published on Thursday, Mar 13, 2025 by fortinetdev
    fortinetdev/terraform-provider-fortimanager