fortios_system_central_management – Configure central management

From Get docs
Ansible/docs/2.8/modules/fortios system central management module


fortios_system_central_management – Configure central management

New in version 2.8.


Synopsis

  • This module is able to configure a FortiGate or FortiOS by allowing the user to configure system feature and central_management category. Examples includes all options and need to be adjusted to datasources before usage. Tested with FOS v6.0.2

Requirements

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

  • fortiosapi>=0.9.8

Parameters

Parameter Choices/Defaults Comments

host

- / required

FortiOS or FortiGate ip address.

https

boolean

  • no

  • yes

Indicates if the requests towards FortiGate must use HTTPS protocol

password

-

Default:

""

FortiOS or FortiGate password.

system_central_management

-

Default:

null

Configure central management.

allow-monitor

-

  • enable
  • disable

Enable/disable allowing the central management server to remotely monitor this FortiGate

allow-push-configuration

-

  • enable
  • disable

Enable/disable allowing the central management server to push configuration changes to this FortiGate.

allow-push-firmware

-

  • enable
  • disable

Enable/disable allowing the central management server to push firmware updates to this FortiGate.

allow-remote-firmware-upgrade

-

  • enable
  • disable

Enable/disable remotely upgrading the firmware on this FortiGate from the central management server.

enc-algorithm

-

  • default
  • high
  • low

Encryption strength for communications between the FortiGate and central management.

fmg

-

IP address or FQDN of the FortiManager.

fmg-source-ip

-

IPv4 source address that this FortiGate uses when communicating with FortiManager.

fmg-source-ip6

-

IPv6 source address that this FortiGate uses when communicating with FortiManager.

include-default-servers

-

  • enable
  • disable

Enable/disable inclusion of public FortiGuard servers in the override server list.

mode

-

  • normal
  • backup

Central management mode.

schedule-config-restore

-

  • enable
  • disable

Enable/disable allowing the central management server to restore the configuration of this FortiGate.

schedule-script-restore

-

  • enable
  • disable

Enable/disable allowing the central management server to restore the scripts stored on this FortiGate.

serial-number

-

Serial number.

server-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

-

  • ipv4
  • ipv6
  • fqdn

Indicate whether the FortiGate communicates with the override server using an IPv4 address, an IPv6 address or a FQDN.

fqdn

-

FQDN address of override server.

id

- / required

ID.

server-address

-

IPv4 address of override server.

server-address6

-

IPv6 address of override server.

server-type

-

  • update
  • rating

FortiGuard service type.

type

-

  • fortimanager
  • fortiguard
  • none

Central management type.

vdom

-

Virtual domain (VDOM) name to use when communicating with FortiManager. Source system.vdom.name.

username

- / required

FortiOS or FortiGate username.

vdom

-

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"
  tasks:
  - name: Configure central management.
    fortios_system_central_management:
      host:  "{{  host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{  vdom }}"
      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:

key1

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

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.8/modules/fortios_system_central_management_module.html