fortios_system_central_management – Configure central management in Fortinet’s FortiOS and FortiGate.
New in version 2.0.0.
Synopsis
This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and central_management 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.15
Tips
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
Supported Version Ranges: v6.0.0 -> 7.4.3
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
- system_central_management - Configure central management. type: dict more...
- allow_monitor - Enable/disable allowing the central management server to remotely monitor this FortiGate unit. type: str choices: enable, disable more...
- allow_push_configuration - Enable/disable allowing the central management server to push configuration changes to this FortiGate. type: str choices: enable, disable more...
- allow_push_firmware - Enable/disable allowing the central management server to push firmware updates to this FortiGate. type: str choices: enable, disable more...
- allow_remote_firmware_upgrade - Enable/disable remotely upgrading the firmware on this FortiGate from the central management server. type: str choices: enable, disable more...
- ca_cert - CA certificate to be used by FGFM protocol. type: str more...
- enc_algorithm - Encryption strength for communications between the FortiGate and central management. type: str choices: default, high, low more...
- fmg - IP address or FQDN of the FortiManager. type: str more...
- fmg_source_ip - IPv4 source address that this FortiGate uses when communicating with FortiManager. type: str more...
- fmg_source_ip6 - IPv6 source address that this FortiGate uses when communicating with FortiManager. type: str more...
- fmg_update_port - Port used to communicate with FortiManager that is acting as a FortiGuard update server. type: str choices: 8890, 443 more...
- fortigate_cloud_sso_default_profile - Override access profile. Source system.accprofile.name. type: str more...
- include_default_servers - Enable/disable inclusion of public FortiGuard servers in the override server list. type: str choices: enable, disable more...
- interface - Specify outgoing interface to reach server. Source system.interface.name. type: str more...
- interface_select_method - Specify how to select outgoing interface to reach server. type: str choices: auto, sdwan, specify more...
- local_cert - Certificate to be used by FGFM protocol. type: str more...
- mode - Central management mode. type: str choices: normal, backup more...
- schedule_config_restore - Enable/disable allowing the central management server to restore the configuration of this FortiGate. type: str choices: enable, disable more...
- schedule_script_restore - Enable/disable allowing the central management server to restore the scripts stored on this FortiGate. type: str choices: enable, disable more...
- serial_number - Serial number. type: str more...
- server_list - Additional severs that the FortiGate can use for updates (for AV, IPS, updates) and ratings (for web filter and antispam ratings) servers. type: list member_path: server_list:id more...
- addr_type - Indicate whether the FortiGate communicates with the override server using an IPv4 address, an IPv6 address or a FQDN. type: str choices: ipv4, ipv6, fqdn more...
- fqdn - FQDN address of override server. type: str more...
- id - ID. see Notes. type: int required: true more...
- server_address - IPv4 address of override server. type: str more...
- server_address6 - IPv6 address of override server. type: str more...
- server_type - FortiGuard service type. type: list choices: update, rating, iot-query, iot-collect more...
- type - Central management type. type: str choices: fortimanager, fortiguard, none more...
- vdom - Virtual domain (VDOM) name to use when communicating with FortiManager. Source system.vdom.name. type: str more...
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- name: Configure central management.
fortinet.fortios.fortios_system_central_management:
vdom: "{{ vdom }}"
system_central_management:
allow_monitor: "enable"
allow_push_configuration: "enable"
allow_push_firmware: "enable"
allow_remote_firmware_upgrade: "enable"
ca_cert: "<your_own_value>"
enc_algorithm: "default"
fmg: "<your_own_value>"
fmg_source_ip: "<your_own_value>"
fmg_source_ip6: "<your_own_value>"
fmg_update_port: "8890"
fortigate_cloud_sso_default_profile: "<your_own_value> (source system.accprofile.name)"
include_default_servers: "enable"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
local_cert: "<your_own_value>"
mode: "normal"
schedule_config_restore: "enable"
schedule_script_restore: "enable"
serial_number: "<your_own_value>"
server_list:
-
addr_type: "ipv4"
fqdn: "<your_own_value>"
id: "25"
server_address: "<your_own_value>"
server_address6: "<your_own_value>"
server_type: "update"
type: "fortimanager"
vdom: "<your_own_value> (source system.vdom.name)"
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.