ansible.builtin.fortios_system_central_management (v2.8.20) — module

Configure central management.

| "added in version" 2.8 of ansible.builtin"

Authors: Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.8.20

Description

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

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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)"

Inputs

    
host:
    description:
    - FortiOS or FortiGate ip address.
    required: true

vdom:
    default: root
    description:
    - 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.

https:
    default: false
    description:
    - Indicates if the requests towards FortiGate must use HTTPS protocol
    type: bool

password:
    default: ''
    description:
    - FortiOS or FortiGate password.

username:
    description:
    - FortiOS or FortiGate username.
    required: true

system_central_management:
    default: null
    description:
    - Configure central management.
    suboptions:
      allow-monitor:
        choices:
        - enable
        - disable
        description:
        - Enable/disable allowing the central management server to remotely monitor this
          FortiGate
      allow-push-configuration:
        choices:
        - enable
        - disable
        description:
        - Enable/disable allowing the central management server to push configuration
          changes to this FortiGate.
      allow-push-firmware:
        choices:
        - enable
        - disable
        description:
        - Enable/disable allowing the central management server to push firmware updates
          to this FortiGate.
      allow-remote-firmware-upgrade:
        choices:
        - enable
        - disable
        description:
        - Enable/disable remotely upgrading the firmware on this FortiGate from the central
          management server.
      enc-algorithm:
        choices:
        - default
        - high
        - low
        description:
        - Encryption strength for communications between the FortiGate and central management.
      fmg:
        description:
        - IP address or FQDN of the FortiManager.
      fmg-source-ip:
        description:
        - IPv4 source address that this FortiGate uses when communicating with FortiManager.
      fmg-source-ip6:
        description:
        - IPv6 source address that this FortiGate uses when communicating with FortiManager.
      include-default-servers:
        choices:
        - enable
        - disable
        description:
        - Enable/disable inclusion of public FortiGuard servers in the override server
          list.
      mode:
        choices:
        - normal
        - backup
        description:
        - Central management mode.
      schedule-config-restore:
        choices:
        - enable
        - disable
        description:
        - Enable/disable allowing the central management server to restore the configuration
          of this FortiGate.
      schedule-script-restore:
        choices:
        - enable
        - disable
        description:
        - Enable/disable allowing the central management server to restore the scripts
          stored on this FortiGate.
      serial-number:
        description:
        - Serial number.
      server-list:
        description:
        - Additional servers that the FortiGate can use for updates (for AV, IPS, updates)
          and ratings (for web filter and antispam ratings) servers.
        suboptions:
          addr-type:
            choices:
            - ipv4
            - ipv6
            - fqdn
            description:
            - Indicate whether the FortiGate communicates with the override server using
              an IPv4 address, an IPv6 address or a FQDN.
          fqdn:
            description:
            - FQDN address of override server.
          id:
            description:
            - ID.
            required: true
          server-address:
            description:
            - IPv4 address of override server.
          server-address6:
            description:
            - IPv6 address of override server.
          server-type:
            choices:
            - update
            - rating
            description:
            - FortiGuard service type.
      type:
        choices:
        - fortimanager
        - fortiguard
        - none
        description:
        - Central management type.
      vdom:
        description:
        - Virtual domain (VDOM) name to use when communicating with FortiManager. Source
          system.vdom.name.

Outputs

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