1. Packages
  2. Fortimanager Provider
  3. API Docs
  4. WanTemplate
fortimanager 1.14.0 published on Tuesday, Apr 15, 2025 by fortinetdev

fortimanager.WanTemplate

Explore with Pulumi AI

Wan Template

Example Usage

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

const trname = new fortimanager.WanTemplate("trname", {
    adom: "root",
    type: "wanprof",
});
Copy
import pulumi
import pulumi_fortimanager as fortimanager

trname = fortimanager.WanTemplate("trname",
    adom="root",
    type="wanprof")
Copy
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.NewWanTemplate(ctx, "trname", &fortimanager.WanTemplateArgs{
			Adom: pulumi.String("root"),
			Type: pulumi.String("wanprof"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fortimanager = Pulumi.Fortimanager;

return await Deployment.RunAsync(() => 
{
    var trname = new Fortimanager.WanTemplate("trname", new()
    {
        Adom = "root",
        Type = "wanprof",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortimanager.WanTemplate;
import com.pulumi.fortimanager.WanTemplateArgs;
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 WanTemplate("trname", WanTemplateArgs.builder()
            .adom("root")
            .type("wanprof")
            .build());

    }
}
Copy
resources:
  trname:
    type: fortimanager:WanTemplate
    properties:
      adom: root
      type: wanprof
Copy

Create WanTemplate Resource

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

Constructor syntax

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

@overload
def WanTemplate(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                adom: Optional[str] = None,
                description: Optional[str] = None,
                dynamic_sort_subtable: Optional[str] = None,
                name: Optional[str] = None,
                oid: Optional[float] = None,
                scopemembers: Optional[Sequence[WanTemplateScopememberArgs]] = None,
                scopetype: Optional[str] = None,
                type: Optional[str] = None,
                wan_template_id: Optional[str] = None)
func NewWanTemplate(ctx *Context, name string, args *WanTemplateArgs, opts ...ResourceOption) (*WanTemplate, error)
public WanTemplate(string name, WanTemplateArgs? args = null, CustomResourceOptions? opts = null)
public WanTemplate(String name, WanTemplateArgs args)
public WanTemplate(String name, WanTemplateArgs args, CustomResourceOptions options)
type: fortimanager:WanTemplate
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 WanTemplateArgs
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 WanTemplateArgs
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 WanTemplateArgs
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 WanTemplateArgs
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. WanTemplateArgs
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 wanTemplateResource = new Fortimanager.WanTemplate("wanTemplateResource", new()
{
    Adom = "string",
    Description = "string",
    DynamicSortSubtable = "string",
    Name = "string",
    Oid = 0,
    Scopemembers = new[]
    {
        new Fortimanager.Inputs.WanTemplateScopememberArgs
        {
            Name = "string",
            Vdom = "string",
        },
    },
    Scopetype = "string",
    Type = "string",
    WanTemplateId = "string",
});
Copy
example, err := fortimanager.NewWanTemplate(ctx, "wanTemplateResource", &fortimanager.WanTemplateArgs{
Adom: pulumi.String("string"),
Description: pulumi.String("string"),
DynamicSortSubtable: pulumi.String("string"),
Name: pulumi.String("string"),
Oid: pulumi.Float64(0),
Scopemembers: .WanTemplateScopememberArray{
&.WanTemplateScopememberArgs{
Name: pulumi.String("string"),
Vdom: pulumi.String("string"),
},
},
Scopetype: pulumi.String("string"),
Type: pulumi.String("string"),
WanTemplateId: pulumi.String("string"),
})
Copy
var wanTemplateResource = new WanTemplate("wanTemplateResource", WanTemplateArgs.builder()
    .adom("string")
    .description("string")
    .dynamicSortSubtable("string")
    .name("string")
    .oid(0)
    .scopemembers(WanTemplateScopememberArgs.builder()
        .name("string")
        .vdom("string")
        .build())
    .scopetype("string")
    .type("string")
    .wanTemplateId("string")
    .build());
Copy
wan_template_resource = fortimanager.WanTemplate("wanTemplateResource",
    adom="string",
    description="string",
    dynamic_sort_subtable="string",
    name="string",
    oid=0,
    scopemembers=[{
        "name": "string",
        "vdom": "string",
    }],
    scopetype="string",
    type="string",
    wan_template_id="string")
Copy
const wanTemplateResource = new fortimanager.WanTemplate("wanTemplateResource", {
    adom: "string",
    description: "string",
    dynamicSortSubtable: "string",
    name: "string",
    oid: 0,
    scopemembers: [{
        name: "string",
        vdom: "string",
    }],
    scopetype: "string",
    type: "string",
    wanTemplateId: "string",
});
Copy
type: fortimanager:WanTemplate
properties:
    adom: string
    description: string
    dynamicSortSubtable: string
    name: string
    oid: 0
    scopemembers:
        - name: string
          vdom: string
    scopetype: string
    type: string
    wanTemplateId: string
Copy

WanTemplate 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 WanTemplate 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.
Name string
Name.
Oid double
Oid.
Scopemembers List<WanTemplateScopemember>
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.
Type string
Type. Valid values: wanprof.
WanTemplateId 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.
Name string
Name.
Oid float64
Oid.
Scopemembers []WanTemplateScopememberArgs
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.
Type string
Type. Valid values: wanprof.
WanTemplateId 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.
name String
Name.
oid Double
Oid.
scopemembers List<WanTemplateScopemember>
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.
type String
Type. Valid values: wanprof.
wanTemplateId 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.
name string
Name.
oid number
Oid.
scopemembers WanTemplateScopemember[]
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.
type string
Type. Valid values: wanprof.
wanTemplateId 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.
name str
Name.
oid float
Oid.
scopemembers Sequence[WanTemplateScopememberArgs]
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.
type str
Type. Valid values: wanprof.
wan_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.
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.
type String
Type. Valid values: wanprof.
wanTemplateId String
an identifier for the resource with format {{name}}.

Outputs

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

Get an existing WanTemplate 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?: WanTemplateState, opts?: CustomResourceOptions): WanTemplate
@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,
        name: Optional[str] = None,
        oid: Optional[float] = None,
        scopemembers: Optional[Sequence[WanTemplateScopememberArgs]] = None,
        scopetype: Optional[str] = None,
        type: Optional[str] = None,
        wan_template_id: Optional[str] = None) -> WanTemplate
func GetWanTemplate(ctx *Context, name string, id IDInput, state *WanTemplateState, opts ...ResourceOption) (*WanTemplate, error)
public static WanTemplate Get(string name, Input<string> id, WanTemplateState? state, CustomResourceOptions? opts = null)
public static WanTemplate get(String name, Output<String> id, WanTemplateState state, CustomResourceOptions options)
resources:  _:    type: fortimanager:WanTemplate    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.
Name string
Name.
Oid double
Oid.
Scopemembers List<WanTemplateScopemember>
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.
Type string
Type. Valid values: wanprof.
WanTemplateId 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.
Name string
Name.
Oid float64
Oid.
Scopemembers []WanTemplateScopememberArgs
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.
Type string
Type. Valid values: wanprof.
WanTemplateId 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.
name String
Name.
oid Double
Oid.
scopemembers List<WanTemplateScopemember>
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.
type String
Type. Valid values: wanprof.
wanTemplateId 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.
name string
Name.
oid number
Oid.
scopemembers WanTemplateScopemember[]
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.
type string
Type. Valid values: wanprof.
wanTemplateId 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.
name str
Name.
oid float
Oid.
scopemembers Sequence[WanTemplateScopememberArgs]
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.
type str
Type. Valid values: wanprof.
wan_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.
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.
type String
Type. Valid values: wanprof.
wanTemplateId String
an identifier for the resource with format {{name}}.

Supporting Types

WanTemplateScopemember
, WanTemplateScopememberArgs

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

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

$ export “FORTIMANAGER_IMPORT_TABLE”=“true”

$ pulumi import fortimanager:index/wanTemplate:WanTemplate 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.