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

fortimanager.SystemTemplate

Explore with Pulumi AI

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

System Template

Create SystemTemplate Resource

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

Constructor syntax

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

@overload
def SystemTemplate(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   adom: Optional[str] = None,
                   description: Optional[str] = None,
                   dynamic_sort_subtable: Optional[str] = None,
                   enabledoptions: Optional[Sequence[str]] = None,
                   name: Optional[str] = None,
                   oid: Optional[float] = None,
                   scopemembers: Optional[Sequence[SystemTemplateScopememberArgs]] = None,
                   scopetype: Optional[str] = None,
                   system_template_id: Optional[str] = None)
func NewSystemTemplate(ctx *Context, name string, args *SystemTemplateArgs, opts ...ResourceOption) (*SystemTemplate, error)
public SystemTemplate(string name, SystemTemplateArgs? args = null, CustomResourceOptions? opts = null)
public SystemTemplate(String name, SystemTemplateArgs args)
public SystemTemplate(String name, SystemTemplateArgs args, CustomResourceOptions options)

type: fortimanager:SystemTemplate
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args SystemTemplateArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args SystemTemplateArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args SystemTemplateArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args SystemTemplateArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SystemTemplateArgs
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 systemTemplateResource = new Fortimanager.SystemTemplate("systemTemplateResource", new()
{
    Adom = "string",
    Description = "string",
    DynamicSortSubtable = "string",
    Enabledoptions = new[]
    {
        "string",
    },
    Name = "string",
    Oid = 0,
    Scopemembers = new[]
    {
        new Fortimanager.Inputs.SystemTemplateScopememberArgs
        {
            Name = "string",
            Vdom = "string",
        },
    },
    Scopetype = "string",
    SystemTemplateId = "string",
});
Copy
example, err := fortimanager.NewSystemTemplate(ctx, "systemTemplateResource", &fortimanager.SystemTemplateArgs{
Adom: pulumi.String("string"),
Description: pulumi.String("string"),
DynamicSortSubtable: pulumi.String("string"),
Enabledoptions: pulumi.StringArray{
pulumi.String("string"),
},
Name: pulumi.String("string"),
Oid: pulumi.Float64(0),
Scopemembers: .SystemTemplateScopememberArray{
&.SystemTemplateScopememberArgs{
Name: pulumi.String("string"),
Vdom: pulumi.String("string"),
},
},
Scopetype: pulumi.String("string"),
SystemTemplateId: pulumi.String("string"),
})
Copy
var systemTemplateResource = new SystemTemplate("systemTemplateResource", SystemTemplateArgs.builder()
    .adom("string")
    .description("string")
    .dynamicSortSubtable("string")
    .enabledoptions("string")
    .name("string")
    .oid(0)
    .scopemembers(SystemTemplateScopememberArgs.builder()
        .name("string")
        .vdom("string")
        .build())
    .scopetype("string")
    .systemTemplateId("string")
    .build());
Copy
system_template_resource = fortimanager.SystemTemplate("systemTemplateResource",
    adom="string",
    description="string",
    dynamic_sort_subtable="string",
    enabledoptions=["string"],
    name="string",
    oid=0,
    scopemembers=[{
        "name": "string",
        "vdom": "string",
    }],
    scopetype="string",
    system_template_id="string")
Copy
const systemTemplateResource = new fortimanager.SystemTemplate("systemTemplateResource", {
    adom: "string",
    description: "string",
    dynamicSortSubtable: "string",
    enabledoptions: ["string"],
    name: "string",
    oid: 0,
    scopemembers: [{
        name: "string",
        vdom: "string",
    }],
    scopetype: "string",
    systemTemplateId: "string",
});
Copy
type: fortimanager:SystemTemplate
properties:
    adom: string
    description: string
    dynamicSortSubtable: string
    enabledoptions:
        - string
    name: string
    oid: 0
    scopemembers:
        - name: string
          vdom: string
    scopetype: string
    systemTemplateId: string
Copy

SystemTemplate 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 SystemTemplate 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.
DynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
Enabledoptions List<string>
Enabled Options. Valid values: none, dns, ntp, email, admin, snmp, repmsg, ftgd, log.
Name string
Name.
Oid double
Oid.
Scopemembers List<SystemTemplateScopemember>
Scope Member. The structure of scopemember block is documented below.
Scopetype string
The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
SystemTemplateId string
an identifier for the resource with format {{name}}.
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.
DynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
Enabledoptions []string
Enabled Options. Valid values: none, dns, ntp, email, admin, snmp, repmsg, ftgd, log.
Name string
Name.
Oid float64
Oid.
Scopemembers []SystemTemplateScopememberArgs
Scope Member. The structure of scopemember block is documented below.
Scopetype string
The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
SystemTemplateId string
an identifier for the resource with format {{name}}.
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.
dynamicSortSubtable String
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
enabledoptions List<String>
Enabled Options. Valid values: none, dns, ntp, email, admin, snmp, repmsg, ftgd, log.
name String
Name.
oid Double
Oid.
scopemembers List<SystemTemplateScopemember>
Scope Member. The structure of scopemember block is documented below.
scopetype String
The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
systemTemplateId String
an identifier for the resource with format {{name}}.
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.
dynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
enabledoptions string[]
Enabled Options. Valid values: none, dns, ntp, email, admin, snmp, repmsg, ftgd, log.
name string
Name.
oid number
Oid.
scopemembers SystemTemplateScopemember[]
Scope Member. The structure of scopemember block is documented below.
scopetype string
The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
systemTemplateId string
an identifier for the resource with format {{name}}.
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.
dynamic_sort_subtable str
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
enabledoptions Sequence[str]
Enabled Options. Valid values: none, dns, ntp, email, admin, snmp, repmsg, ftgd, log.
name str
Name.
oid float
Oid.
scopemembers Sequence[SystemTemplateScopememberArgs]
Scope Member. The structure of scopemember block is documented below.
scopetype str
The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
system_template_id str
an identifier for the resource with format {{name}}.
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.
dynamicSortSubtable String
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
enabledoptions List<String>
Enabled Options. Valid values: none, dns, ntp, email, admin, snmp, repmsg, ftgd, log.
name String
Name.
oid Number
Oid.
scopemembers List<Property Map>
Scope Member. The structure of scopemember block is documented below.
scopetype String
The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
systemTemplateId String
an identifier for the resource with format {{name}}.

Outputs

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

Get an existing SystemTemplate 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?: SystemTemplateState, opts?: CustomResourceOptions): SystemTemplate
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        adom: Optional[str] = None,
        description: Optional[str] = None,
        dynamic_sort_subtable: Optional[str] = None,
        enabledoptions: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        oid: Optional[float] = None,
        scopemembers: Optional[Sequence[SystemTemplateScopememberArgs]] = None,
        scopetype: Optional[str] = None,
        system_template_id: Optional[str] = None) -> SystemTemplate
func GetSystemTemplate(ctx *Context, name string, id IDInput, state *SystemTemplateState, opts ...ResourceOption) (*SystemTemplate, error)
public static SystemTemplate Get(string name, Input<string> id, SystemTemplateState? state, CustomResourceOptions? opts = null)
public static SystemTemplate get(String name, Output<String> id, SystemTemplateState state, CustomResourceOptions options)
resources:  _:    type: fortimanager:SystemTemplate    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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.
DynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
Enabledoptions List<string>
Enabled Options. Valid values: none, dns, ntp, email, admin, snmp, repmsg, ftgd, log.
Name string
Name.
Oid double
Oid.
Scopemembers List<SystemTemplateScopemember>
Scope Member. The structure of scopemember block is documented below.
Scopetype string
The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
SystemTemplateId string
an identifier for the resource with format {{name}}.
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.
DynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
Enabledoptions []string
Enabled Options. Valid values: none, dns, ntp, email, admin, snmp, repmsg, ftgd, log.
Name string
Name.
Oid float64
Oid.
Scopemembers []SystemTemplateScopememberArgs
Scope Member. The structure of scopemember block is documented below.
Scopetype string
The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
SystemTemplateId string
an identifier for the resource with format {{name}}.
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.
dynamicSortSubtable String
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
enabledoptions List<String>
Enabled Options. Valid values: none, dns, ntp, email, admin, snmp, repmsg, ftgd, log.
name String
Name.
oid Double
Oid.
scopemembers List<SystemTemplateScopemember>
Scope Member. The structure of scopemember block is documented below.
scopetype String
The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
systemTemplateId String
an identifier for the resource with format {{name}}.
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.
dynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
enabledoptions string[]
Enabled Options. Valid values: none, dns, ntp, email, admin, snmp, repmsg, ftgd, log.
name string
Name.
oid number
Oid.
scopemembers SystemTemplateScopemember[]
Scope Member. The structure of scopemember block is documented below.
scopetype string
The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
systemTemplateId string
an identifier for the resource with format {{name}}.
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.
dynamic_sort_subtable str
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
enabledoptions Sequence[str]
Enabled Options. Valid values: none, dns, ntp, email, admin, snmp, repmsg, ftgd, log.
name str
Name.
oid float
Oid.
scopemembers Sequence[SystemTemplateScopememberArgs]
Scope Member. The structure of scopemember block is documented below.
scopetype str
The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
system_template_id str
an identifier for the resource with format {{name}}.
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.
dynamicSortSubtable String
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
enabledoptions List<String>
Enabled Options. Valid values: none, dns, ntp, email, admin, snmp, repmsg, ftgd, log.
name String
Name.
oid Number
Oid.
scopemembers List<Property Map>
Scope Member. The structure of scopemember block is documented below.
scopetype String
The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
systemTemplateId String
an identifier for the resource with format {{name}}.

Supporting Types

SystemTemplateScopemember
, SystemTemplateScopememberArgs

Name string
Name.
Vdom string
Vdom.
Name string
Name.
Vdom string
Vdom.
name String
Name.
vdom String
Vdom.
name string
Name.
vdom string
Vdom.
name str
Name.
vdom str
Vdom.
name String
Name.
vdom String
Vdom.

Import

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

$ export “FORTIMANAGER_IMPORT_TABLE”=“true”

$ pulumi import fortimanager:index/systemTemplate:SystemTemplate labelname {{name}}
Copy

$ 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 1.13.0 published on Thursday, Mar 13, 2025 by fortinetdev
fortinetdev/terraform-provider-fortimanager