On this page
fortios_system_central_management – Configure central management in Fortinet’s FortiOS and FortiGate
New in version 2.8.
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.5
Requirements
The below requirements are needed on the host that executes this module.
- fortiosapi>=0.9.8
Parameters
Parameter | Choices/Defaults | Comments | ||
---|---|---|---|---|
host
string
|
FortiOS or FortiGate IP address.
|
|||
https
boolean
|
|
Indicates if the requests towards FortiGate must use HTTPS protocol.
|
||
password
string
|
Default:
""
|
FortiOS or FortiGate password.
|
||
ssl_verify
boolean
added in 2.9
|
|
Ensures FortiGate certificate must be verified by a proper CA.
|
||
system_central_management
dictionary
|
Default:
null
|
Configure central management.
|
||
allow_monitor
string
|
|
Enable/disable allowing the central management server to remotely monitor this FortiGate
|
||
allow_push_configuration
string
|
|
Enable/disable allowing the central management server to push configuration changes to this FortiGate.
|
||
allow_push_firmware
string
|
|
Enable/disable allowing the central management server to push firmware updates to this FortiGate.
|
||
allow_remote_firmware_upgrade
string
|
|
Enable/disable remotely upgrading the firmware on this FortiGate from the central management server.
|
||
enc_algorithm
string
|
|
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.
|
|||
include_default_servers
string
|
|
Enable/disable inclusion of public FortiGuard servers in the override server list.
|
||
mode
string
|
|
Central management mode.
|
||
schedule_config_restore
string
|
|
Enable/disable allowing the central management server to restore the configuration of this FortiGate.
|
||
schedule_script_restore
string
|
|
Enable/disable allowing the central management server to restore the scripts stored on this FortiGate.
|
||
serial_number
string
|
Serial number.
|
|||
server_list
list
|
Additional servers 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.
|
||
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.
|
||
type
string
|
|
Central management type.
|
||
vdom
string
|
Virtual domain (VDOM) name to use when communicating with FortiManager. Source system.vdom.name.
|
|||
username
string
|
FortiOS or FortiGate username.
|
|||
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
- Requires fortiosapi library developed by Fortinet
- Run as a local_action in your playbook
Examples
- hosts: localhost
vars:
host: "192.168.122.40"
username: "admin"
password: ""
vdom: "root"
ssl_verify: "False"
tasks:
- name: Configure central management.
fortios_system_central_management:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
https: "False"
system_central_management:
allow_monitor: "enable"
allow_push_configuration: "enable"
allow_push_firmware: "enable"
allow_remote_firmware_upgrade: "enable"
enc_algorithm: "default"
fmg: "<your_own_value>"
fmg_source_ip: "<your_own_value>"
fmg_source_ip6: "<your_own_value>"
include_default_servers: "enable"
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: "19"
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
|
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/fortios_system_central_management_module.html