You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

fortinet.fortios.fortios_system_central_management – Configure central management in Fortinet’s FortiOS and FortiGate.

Note

This plugin is part of the fortinet.fortios collection (version 2.1.3).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortios.

To use it in a playbook, specify: fortinet.fortios.fortios_system_central_management.

New in version 2.10: of fortinet.fortios

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.9.0

Parameters

Parameter	Comments
access_token string	Token-based authentication. Generated from GUI of Fortigate.
enable_log boolean	Enable/Disable logging for task. Choices: no ← (default) yes
member_path string	Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation.
member_state string	Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices: present absent
system_central_management dictionary	Configure central management.
allow_monitor string	Enable/disable allowing the central management server to remotely monitor this FortiGate Choices: enable disable
allow_push_configuration string	Enable/disable allowing the central management server to push configuration changes to this FortiGate. Choices: enable disable
allow_push_firmware string	Enable/disable allowing the central management server to push firmware updates to this FortiGate. Choices: enable disable
allow_remote_firmware_upgrade string	Enable/disable remotely upgrading the firmware on this FortiGate from the central management server. Choices: enable disable
ca_cert string	CA certificate to be used by FGFM protocol.
enc_algorithm string	Encryption strength for communications between the FortiGate and central management. Choices: default high low
fmg string	IP address or FQDN of the FortiManager.
fmg_source_ip string	IPv4 source address that this FortiGate uses when communicating with FortiManager.
fmg_source_ip6 string	IPv6 source address that this FortiGate uses when communicating with FortiManager.
fmg_update_port string	Port used to communicate with FortiManager that is acting as a FortiGuard update server. Choices: 8890 443
include_default_servers string	Enable/disable inclusion of public FortiGuard servers in the override server list. Choices: enable disable
interface string	Specify outgoing interface to reach server. Source system.interface.name.
interface_select_method string	Specify how to select outgoing interface to reach server. Choices: auto sdwan specify
local_cert string	Certificate to be used by FGFM protocol.
mode string	Central management mode. Choices: normal backup
schedule_config_restore string	Enable/disable allowing the central management server to restore the configuration of this FortiGate. Choices: enable disable
schedule_script_restore string	Enable/disable allowing the central management server to restore the scripts stored on this FortiGate. Choices: enable disable
serial_number string	Serial number.
server_list list / elements=string	Additional severs that the FortiGate can use for updates (for AV, IPS, updates) and ratings (for web filter and antispam ratings) servers.
addr_type string	Indicate whether the FortiGate communicates with the override server using an IPv4 address, an IPv6 address or a FQDN. Choices: ipv4 ipv6 fqdn
fqdn string	FQDN address of override server.
id integer / required	ID.
server_address string	IPv4 address of override server.
server_address6 string	IPv6 address of override server.
server_type string	FortiGuard service type. Choices: update rating
type string	Central management type. Choices: fortimanager fortiguard none
vdom string	Virtual domain (VDOM) name to use when communicating with FortiManager. Source system.vdom.name.
vdom string	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. Default: “root”

Notes

Note

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

Examples

- collections:
  - fortinet.fortios
  connection: httpapi
  hosts: fortigate01
  vars:
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    vdom: root
  tasks:
  - name: fortios_system_central_management
    fortios_system_central_management:
      vdom: root
      system_central_management:
        allow_monitor: enable
        vdom: root

Return Values

Common return values are documented here, the following are the fields unique to this module:

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

Authors

• Link Zheng (@chillancezen)

• Jie Xue (@JieX19)

• Hongbin Lu (@fgtdev-hblu)

• Frank Shen (@frankshen01)

• Miguel Angel Munoz (@mamunozgonzalez)

• Nicolas Thomas (@thomnico)