fortios.switchcontroller/initialconfig.Template
Explore with Pulumi AI
Configure template for auto-generated VLANs. Applies to FortiOS Version >= 6.4.0
.
Create Template Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Template(name: string, args?: TemplateArgs, opts?: CustomResourceOptions);
@overload
def Template(resource_name: str,
args: Optional[TemplateArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def Template(resource_name: str,
opts: Optional[ResourceOptions] = None,
allowaccess: Optional[str] = None,
auto_ip: Optional[str] = None,
dhcp_server: Optional[str] = None,
ip: Optional[str] = None,
name: Optional[str] = None,
vdomparam: Optional[str] = None,
vlanid: Optional[int] = None)
func NewTemplate(ctx *Context, name string, args *TemplateArgs, opts ...ResourceOption) (*Template, error)
public Template(string name, TemplateArgs? args = null, CustomResourceOptions? opts = null)
public Template(String name, TemplateArgs args)
public Template(String name, TemplateArgs args, CustomResourceOptions options)
type: fortios:switchcontroller/initialconfig/template:Template
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 TemplateArgs
- 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 TemplateArgs
- 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 TemplateArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args TemplateArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args TemplateArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Template 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 Template resource accepts the following input properties:
- Allowaccess string
- Permitted types of management access to this interface. Valid values:
ping
,https
,ssh
,snmp
,http
,telnet
,fgfm
,radius-acct
,probe-response
,fabric
,ftm
. - Auto
Ip string - Automatically allocate interface address and subnet block. Valid values:
enable
,disable
. - Dhcp
Server string - Enable/disable a DHCP server on this interface. Valid values:
enable
,disable
. - Ip string
- Interface IPv4 address and subnet mask.
- Name string
- Initial config template name
- Vdomparam string
- Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
- Vlanid int
- Unique VLAN ID.
- Allowaccess string
- Permitted types of management access to this interface. Valid values:
ping
,https
,ssh
,snmp
,http
,telnet
,fgfm
,radius-acct
,probe-response
,fabric
,ftm
. - Auto
Ip string - Automatically allocate interface address and subnet block. Valid values:
enable
,disable
. - Dhcp
Server string - Enable/disable a DHCP server on this interface. Valid values:
enable
,disable
. - Ip string
- Interface IPv4 address and subnet mask.
- Name string
- Initial config template name
- Vdomparam string
- Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
- Vlanid int
- Unique VLAN ID.
- allowaccess String
- Permitted types of management access to this interface. Valid values:
ping
,https
,ssh
,snmp
,http
,telnet
,fgfm
,radius-acct
,probe-response
,fabric
,ftm
. - auto
Ip String - Automatically allocate interface address and subnet block. Valid values:
enable
,disable
. - dhcp
Server String - Enable/disable a DHCP server on this interface. Valid values:
enable
,disable
. - ip String
- Interface IPv4 address and subnet mask.
- name String
- Initial config template name
- vdomparam String
- Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
- vlanid Integer
- Unique VLAN ID.
- allowaccess string
- Permitted types of management access to this interface. Valid values:
ping
,https
,ssh
,snmp
,http
,telnet
,fgfm
,radius-acct
,probe-response
,fabric
,ftm
. - auto
Ip string - Automatically allocate interface address and subnet block. Valid values:
enable
,disable
. - dhcp
Server string - Enable/disable a DHCP server on this interface. Valid values:
enable
,disable
. - ip string
- Interface IPv4 address and subnet mask.
- name string
- Initial config template name
- vdomparam string
- Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
- vlanid number
- Unique VLAN ID.
- allowaccess str
- Permitted types of management access to this interface. Valid values:
ping
,https
,ssh
,snmp
,http
,telnet
,fgfm
,radius-acct
,probe-response
,fabric
,ftm
. - auto_
ip str - Automatically allocate interface address and subnet block. Valid values:
enable
,disable
. - dhcp_
server str - Enable/disable a DHCP server on this interface. Valid values:
enable
,disable
. - ip str
- Interface IPv4 address and subnet mask.
- name str
- Initial config template name
- vdomparam str
- Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
- vlanid int
- Unique VLAN ID.
- allowaccess String
- Permitted types of management access to this interface. Valid values:
ping
,https
,ssh
,snmp
,http
,telnet
,fgfm
,radius-acct
,probe-response
,fabric
,ftm
. - auto
Ip String - Automatically allocate interface address and subnet block. Valid values:
enable
,disable
. - dhcp
Server String - Enable/disable a DHCP server on this interface. Valid values:
enable
,disable
. - ip String
- Interface IPv4 address and subnet mask.
- name String
- Initial config template name
- vdomparam String
- Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
- vlanid Number
- Unique VLAN ID.
Outputs
All input properties are implicitly available as output properties. Additionally, the Template 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 Template Resource
Get an existing Template 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?: TemplateState, opts?: CustomResourceOptions): Template
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
allowaccess: Optional[str] = None,
auto_ip: Optional[str] = None,
dhcp_server: Optional[str] = None,
ip: Optional[str] = None,
name: Optional[str] = None,
vdomparam: Optional[str] = None,
vlanid: Optional[int] = None) -> Template
func GetTemplate(ctx *Context, name string, id IDInput, state *TemplateState, opts ...ResourceOption) (*Template, error)
public static Template Get(string name, Input<string> id, TemplateState? state, CustomResourceOptions? opts = null)
public static Template get(String name, Output<String> id, TemplateState 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.
- Allowaccess string
- Permitted types of management access to this interface. Valid values:
ping
,https
,ssh
,snmp
,http
,telnet
,fgfm
,radius-acct
,probe-response
,fabric
,ftm
. - Auto
Ip string - Automatically allocate interface address and subnet block. Valid values:
enable
,disable
. - Dhcp
Server string - Enable/disable a DHCP server on this interface. Valid values:
enable
,disable
. - Ip string
- Interface IPv4 address and subnet mask.
- Name string
- Initial config template name
- Vdomparam string
- Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
- Vlanid int
- Unique VLAN ID.
- Allowaccess string
- Permitted types of management access to this interface. Valid values:
ping
,https
,ssh
,snmp
,http
,telnet
,fgfm
,radius-acct
,probe-response
,fabric
,ftm
. - Auto
Ip string - Automatically allocate interface address and subnet block. Valid values:
enable
,disable
. - Dhcp
Server string - Enable/disable a DHCP server on this interface. Valid values:
enable
,disable
. - Ip string
- Interface IPv4 address and subnet mask.
- Name string
- Initial config template name
- Vdomparam string
- Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
- Vlanid int
- Unique VLAN ID.
- allowaccess String
- Permitted types of management access to this interface. Valid values:
ping
,https
,ssh
,snmp
,http
,telnet
,fgfm
,radius-acct
,probe-response
,fabric
,ftm
. - auto
Ip String - Automatically allocate interface address and subnet block. Valid values:
enable
,disable
. - dhcp
Server String - Enable/disable a DHCP server on this interface. Valid values:
enable
,disable
. - ip String
- Interface IPv4 address and subnet mask.
- name String
- Initial config template name
- vdomparam String
- Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
- vlanid Integer
- Unique VLAN ID.
- allowaccess string
- Permitted types of management access to this interface. Valid values:
ping
,https
,ssh
,snmp
,http
,telnet
,fgfm
,radius-acct
,probe-response
,fabric
,ftm
. - auto
Ip string - Automatically allocate interface address and subnet block. Valid values:
enable
,disable
. - dhcp
Server string - Enable/disable a DHCP server on this interface. Valid values:
enable
,disable
. - ip string
- Interface IPv4 address and subnet mask.
- name string
- Initial config template name
- vdomparam string
- Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
- vlanid number
- Unique VLAN ID.
- allowaccess str
- Permitted types of management access to this interface. Valid values:
ping
,https
,ssh
,snmp
,http
,telnet
,fgfm
,radius-acct
,probe-response
,fabric
,ftm
. - auto_
ip str - Automatically allocate interface address and subnet block. Valid values:
enable
,disable
. - dhcp_
server str - Enable/disable a DHCP server on this interface. Valid values:
enable
,disable
. - ip str
- Interface IPv4 address and subnet mask.
- name str
- Initial config template name
- vdomparam str
- Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
- vlanid int
- Unique VLAN ID.
- allowaccess String
- Permitted types of management access to this interface. Valid values:
ping
,https
,ssh
,snmp
,http
,telnet
,fgfm
,radius-acct
,probe-response
,fabric
,ftm
. - auto
Ip String - Automatically allocate interface address and subnet block. Valid values:
enable
,disable
. - dhcp
Server String - Enable/disable a DHCP server on this interface. Valid values:
enable
,disable
. - ip String
- Interface IPv4 address and subnet mask.
- name String
- Initial config template name
- vdomparam String
- Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
- vlanid Number
- Unique VLAN ID.
Import
SwitchControllerInitialConfig Template can be imported using any of these accepted formats:
$ pulumi import fortios:switchcontroller/initialconfig/template:Template labelname {{name}}
If you do not want to import arguments of block:
$ export “FORTIOS_IMPORT_TABLE”=“false”
$ pulumi import fortios:switchcontroller/initialconfig/template:Template labelname {{name}}
$ unset “FORTIOS_IMPORT_TABLE”
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- fortios pulumiverse/pulumi-fortios
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
fortios
Terraform Provider.