lix_fortinet.fortios.fortios_system_central_management (102.2.120) — module

Configure central management in Fortinet's FortiOS and FortiGate.

| "added in version" 2.0.0 of lix_fortinet.fortios"

Authors: Link Zheng (@chillancezen), Jie Xue (@JieX19), Hongbin Lu (@fgtdev-hblu), Frank Shen (@frankshen01), Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)

preview | supported by community

Install collection

Install with ansible-galaxy collection install lix_fortinet.fortios:==102.2.120


Add to requirements.yml

  collections:
    - name: lix_fortinet.fortios
      version: 102.2.120

Description

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

Usage examples

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

Inputs

    
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.
    type: str

enable_log:
    default: false
    description:
    - Enable/Disable logging for task.
    required: false
    type: bool

member_path:
    description:
    - 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.
    type: str

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

member_state:
    choices:
    - present
    - absent
    description:
    - Add or delete a member under specified attribute path.
    - When member_state is specified, the state option is ignored.
    type: str

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 unit.
        type: str
      allow_push_configuration:
        choices:
        - enable
        - disable
        description:
        - Enable/disable allowing the central management server to push configuration
          changes to this FortiGate.
        type: str
      allow_push_firmware:
        choices:
        - enable
        - disable
        description:
        - Enable/disable allowing the central management server to push firmware updates
          to this FortiGate.
        type: str
      allow_remote_firmware_upgrade:
        choices:
        - enable
        - disable
        description:
        - Enable/disable remotely upgrading the firmware on this FortiGate from the central
          management server.
        type: str
      ca_cert:
        description:
        - CA certificate to be used by FGFM protocol.
        type: str
      enc_algorithm:
        choices:
        - default
        - high
        - low
        description:
        - Encryption strength for communications between the FortiGate and central management.
        type: str
      fmg:
        description:
        - IP address or FQDN of the FortiManager.
        type: str
      fmg_source_ip:
        description:
        - IPv4 source address that this FortiGate uses when communicating with FortiManager.
        type: str
      fmg_source_ip6:
        description:
        - IPv6 source address that this FortiGate uses when communicating with FortiManager.
        type: str
      fmg_update_port:
        choices:
        - '8890'
        - '443'
        description:
        - Port used to communicate with FortiManager that is acting as a FortiGuard update
          server.
        type: str
      include_default_servers:
        choices:
        - enable
        - disable
        description:
        - Enable/disable inclusion of public FortiGuard servers in the override server
          list.
        type: str
      interface:
        description:
        - Specify outgoing interface to reach server. Source system.interface.name.
        type: str
      interface_select_method:
        choices:
        - auto
        - sdwan
        - specify
        description:
        - Specify how to select outgoing interface to reach server.
        type: str
      local_cert:
        description:
        - Certificate to be used by FGFM protocol.
        type: str
      mode:
        choices:
        - normal
        - backup
        description:
        - Central management mode.
        type: str
      schedule_config_restore:
        choices:
        - enable
        - disable
        description:
        - Enable/disable allowing the central management server to restore the configuration
          of this FortiGate.
        type: str
      schedule_script_restore:
        choices:
        - enable
        - disable
        description:
        - Enable/disable allowing the central management server to restore the scripts
          stored on this FortiGate.
        type: str
      serial_number:
        description:
        - Serial number.
        type: str
      server_list:
        description:
        - Additional severs that the FortiGate can use for updates (for AV, IPS, updates)
          and ratings (for web filter and antispam ratings) servers.
        elements: dict
        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.
            type: str
          fqdn:
            description:
            - FQDN address of override server.
            type: str
          id:
            description:
            - ID.
            type: int
          server_address:
            description:
            - IPv4 address of override server.
            type: str
          server_address6:
            description:
            - IPv6 address of override server.
            type: str
          server_type:
            choices:
            - update
            - rating
            - iot-query
            - iot-collect
            description:
            - FortiGuard service type.
            elements: str
            type: list
        type: list
      type:
        choices:
        - fortimanager
        - fortiguard
        - none
        description:
        - Central management type.
        type: str
      vdom:
        description:
        - Virtual domain (VDOM) name to use when communicating with FortiManager. Source
          system.vdom.name.
        type: str
    type: dict

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: id
  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