Docs4dev
Docs
ansible / latest / collections / fortinet / fortios / fortios_system_central_management_module.html

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.2).

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 Choices/Defaults Comments
access_token
string
Token-based authentication. Generated from GUI of Fortigate.
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task.
system_central_management
dictionary
Configure central management.
allow_monitor
string
    Choices:
  • enable
  • disable
Enable/disable allowing the central management server to remotely monitor this FortiGate
allow_push_configuration
string
    Choices:
  • enable
  • disable
Enable/disable allowing the central management server to push configuration changes to this FortiGate.
allow_push_firmware
string
    Choices:
  • enable
  • disable
Enable/disable allowing the central management server to push firmware updates to this FortiGate.
allow_remote_firmware_upgrade
string
    Choices:
  • enable
  • disable
Enable/disable remotely upgrading the firmware on this FortiGate from the central management server.
ca_cert
string
CA certificate to be used by FGFM protocol.
enc_algorithm
string
    Choices:
  • default
  • high
  • low
Encryption strength for communications between the FortiGate and central management.
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
    Choices:
  • 8890
  • 443
Port used to communicate with FortiManager that is acting as a FortiGuard update server.
include_default_servers
string
    Choices:
  • enable
  • disable
Enable/disable inclusion of public FortiGuard servers in the override server list.
interface
string
Specify outgoing interface to reach server. Source system.interface.name.
interface_select_method
string
    Choices:
  • auto
  • sdwan
  • specify
Specify how to select outgoing interface to reach server.
local_cert
string
Certificate to be used by FGFM protocol.
mode
string
    Choices:
  • normal
  • backup
Central management mode.
schedule_config_restore
string
    Choices:
  • enable
  • disable
Enable/disable allowing the central management server to restore the configuration of this FortiGate.
schedule_script_restore
string
    Choices:
  • enable
  • disable
Enable/disable allowing the central management server to restore the scripts stored on this FortiGate.
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
    Choices:
  • ipv4
  • ipv6
  • fqdn
Indicate whether the FortiGate communicates with the override server using an IPv4 address, an IPv6 address or a 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
    Choices:
  • update
  • rating
FortiGuard service type.
type
string
    Choices:
  • fortimanager
  • fortiguard
  • none
Central management type.
vdom
string
Virtual domain (VDOM) name to use when communicating with FortiManager. Source system.vdom.name.
vdom
string
Default:
"root"
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.

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 central management.
    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"
        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:  "24"
            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 here, the following are the fields unique to this module:

Key Returned Description
build
string
always
Build number of the fortigate image

Sample:
1547
http_method
string
always
Last method used to provision the content into FortiGate

Sample:
PUT
http_status
string
always
Last result given by FortiGate on last operation applied

Sample:
200
mkey
string
success
Master key (id) used in the last call to FortiGate

Sample:
id
name
string
always
Name of the table used to fulfill the request

Sample:
urlfilter
path
string
always
Path of the table used to fulfill the request

Sample:
webfilter
revision
string
always
Internal revision number

Sample:
17.0.2.10658
serial
string
always
Serial number of the unit

Sample:
FGVMEVYYQT3AB5352
status
string
always
Indication of the operation's result

Sample:
success
vdom
string
always
Virtual domain used

Sample:
root
version
string
always
Version of the FortiGate

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)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_system_central_management_module.html