fortios_switch_controller_initial_config_template.rst

source:	fortios_switch_controller_initial_config_template.py
orphan:

fortios_switch_controller_initial_config_template -- Configure template for auto-generated VLANs in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

• Synopsis
• Requirements
• Tips
• FortiOS Version Compatibility
• Parameters
• Notes
• Examples
• Return Values
• Status
• Authors

Synopsis

• This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch_controller_initial_config feature and template category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

The below requirements are needed on the host that executes this module.

• ansible>=2.9

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility

v6.4.0

v6.4.1

v6.4.4

v7.0.0

v7.0.1

v7.0.2

v7.0.3

v7.0.4

v7.0.5

v7.0.6

v7.0.7

v7.0.8

v7.0.12

v7.2.0

v7.2.1

v7.2.2

v7.2.4

v7.4.0

fortios_switch_controller_initial_config_template

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

Parameters

• access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
• enable_log - Enable/Disable logging for task. type: bool required: false default: False
• vdom - Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. type: str default: root
• member_path - Member attribute path to operate on. type: str
• member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
• state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
• switch_controller_initial_config_template - Configure template for auto-generated VLANs. type: dict more...

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  v7.2.1

  v7.2.2

  v7.2.4

  v7.4.0

  switch_controller_initial_config_template

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• allowaccess - Permitted types of management access to this interface. type: list choices: ping, https, ssh, snmp, http, telnet, fgfm, radius-acct, probe-response, fabric, ftm more...

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  v7.2.1

  v7.2.2

  v7.2.4

  v7.4.0

  allowaccess

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [ping]

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [https]

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [ssh]

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [snmp]

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [http]

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [telnet]

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [fgfm]

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [radius-acct]

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [probe-response]

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [fabric]

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [ftm]

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• auto_ip - Automatically allocate interface address and subnet block. type: str choices: enable, disable more...

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  v7.2.1

  v7.2.2

  v7.2.4

  v7.4.0

  auto_ip

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [enable]

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [disable]

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• dhcp_server - Enable/disable a DHCP server on this interface. type: str choices: enable, disable more...

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  v7.2.1

  v7.2.2

  v7.2.4

  v7.4.0

  dhcp_server

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [enable]

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [disable]

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• ip - Interface IPv4 address and subnet mask. type: str more...

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  v7.2.1

  v7.2.2

  v7.2.4

  v7.4.0

  ip

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• name - Initial config template name. type: str required: true more...

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  v7.2.1

  v7.2.2

  v7.2.4

  v7.4.0

  name

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• vlanid - Unique VLAN ID. type: int more...

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  v7.2.1

  v7.2.2

  v7.2.4

  v7.4.0

  vlanid

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

Notes

Note

• Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure template for auto-generated VLANs.
    fortios_switch_controller_initial_config_template:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      switch_controller_initial_config_template:
        allowaccess: "ping"
        auto_ip: "enable"
        dhcp_server: "enable"
        ip: "<your_own_value>"
        name: "default_name_7"
        vlanid: "0"

Return Values

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

• build - Build number of the fortigate image returned: always type: str sample: 1547
• http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
• http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
• mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
• name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
• path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
• revision - Internal revision number returned: always type: str sample: 17.0.2.10658
• serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
• status - Indication of the operation's result returned: always type: str sample: success
• vdom - Virtual domain used returned: always type: str sample: root
• version - Version of the FortiGate returned: always type: str sample: v5.6.3

Status

• This module is not guaranteed to have a backwards compatible interface.

Authors

• Link Zheng (@chillancezen)
• Jie Xue (@JieX19)
• Hongbin Lu (@fgtdev-hblu)
• Frank Shen (@frankshen01)
• Miguel Angel Munoz (@mamunozgonzalez)
• Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.