fmgr_devprof_system_centralmanagement – Configure central management.

Added in version 1.0.0.

Warning

Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).

  • Argument name before 3.0.0: var-name, var name, var.name

  • New argument name starting in 3.0.0: var_name

FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values need to be adjusted to data sources before usage.

  • Tested with FortiManager v7.x.

Requirements

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

  • ansible>=2.15.0

FortiManager Version Compatibility

Supported Version Ranges: v6.0.0 -> v6.2.5, v6.2.7 -> v6.4.1, v6.4.3 -> latest

Parameters

  • access_token -The token to access FortiManager without using username and password. type: str required: false
  • bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
  • proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
  • adom - The parameter in requested url type: str required: true
  • devprof - The parameter in requested url type: str required: true
  • devprof_system_centralmanagement - Configure central management. type: dict
    • include_default_servers (Alias name: include-default-servers) Enable/disable inclusion of public fortiguard servers in the override server list. type: str choices: [disable, enable] more...
    • server_list (Alias name: server-list) Server list. type: list more...
      • addr_type (Alias name: addr-type) Indicate whether the fortigate communicates with the override server using an ipv4 address, an ipv6 address or a fqdn. type: str choices: [fqdn, ipv4, ipv6] more...
      • fqdn Fqdn address of override server. type: str more...
      • id Id. type: int more...
      • server_address (Alias name: server-address) Ipv4 address of override server. type: str more...
      • server_address6 (Alias name: server-address6) Ipv6 address of override server. type: str more...
      • server_type (Alias name: server-type) Fortiguard service type. type: list choices: [update, rating, iot-query, iot-collect, vpatch-query] more...
    • ltefw_upgrade_time (Alias name: ltefw-upgrade-time) Schedule next lte firmware upgrade time (local time). type: str more...
    • vdom Virtual domain (vdom) name to use when communicating with fortimanager. type: list more...
    • allow_remote_firmware_upgrade (Alias name: allow-remote-firmware-upgrade) Enable/disable remotely upgrading the firmware on this fortigate from the central management server. type: str choices: [disable, enable] more...
    • local_cert (Alias name: local-cert) Certificate to be used by fgfm protocol. type: str more...
    • allow_push_firmware (Alias name: allow-push-firmware) Enable/disable allowing the central management server to push firmware updates to this fortigate. type: str choices: [disable, enable] more...
    • ltefw_upgrade_frequency (Alias name: ltefw-upgrade-frequency) Set lte firmware auto pushdown frequency. type: str choices: [everyHour, every12hour, everyDay, everyWeek] more...
    • mode Central management mode. type: str choices: [normal, backup] more...
    • serial_number (Alias name: serial-number) Serial number. type: list more...
    • fmg_source_ip6 (Alias name: fmg-source-ip6) Ipv6 source address that this fortigate uses when communicating with fortimanager. type: str more...
    • allow_monitor (Alias name: allow-monitor) Enable/disable allowing the central management server to remotely monitor this fortigate unit. type: str choices: [disable, enable] more...
    • allow_push_configuration (Alias name: allow-push-configuration) Enable/disable allowing the central management server to push configuration changes to this fortigate. type: str choices: [disable, enable] more...
    • ca_cert (Alias name: ca-cert) Ca certificate to be used by fgfm protocol. type: str more...
    • fmg_update_port (Alias name: fmg-update-port) Port used to communicate with fortimanager that is acting as a fortiguard update server. type: str choices: [443, 8890] more...
    • use_elbc_vdom (Alias name: use-elbc-vdom) Enable/disable use of special elbc config sync vdom to connect to fortimanager. type: str choices: [disable, enable] more...
    • allow_remote_lte_firmware_upgrade (Alias name: allow-remote-lte-firmware-upgrade) Enable/disable remotely upgrading the lte firmware on this fortigate from the central management server. type: str choices: [disable, enable] more...
    • interface Specify outgoing interface to reach server. type: list more...
    • schedule_script_restore (Alias name: schedule-script-restore) Enable/disable allowing the central management server to restore the scripts stored on this fortigate. type: str choices: [disable, enable] more...
    • schedule_config_restore (Alias name: schedule-config-restore) Enable/disable allowing the central management server to restore the configuration of this fortigate. type: str choices: [disable, enable] more...
    • interface_select_method (Alias name: interface-select-method) Specify how to select outgoing interface to reach server. type: str choices: [auto, sdwan, specify] more...
    • type Central management type. type: str choices: [fortimanager, fortiguard, none] more...
    • fmg_source_ip (Alias name: fmg-source-ip) Ipv4 source address that this fortigate uses when communicating with fortimanager. type: str more...
    • fortigate_cloud_sso_default_profile (Alias name: fortigate-cloud-sso-default-profile) Override access profile. type: list more...
    • fmg Ip address or fqdn of the fortimanager. type: list more...
    • enc_algorithm (Alias name: enc-algorithm) Encryption strength for communications between the fortigate and central management. type: str choices: [default, high, low] more...
    • allow_remote_modem_firmware_upgrade (Alias name: allow-remote-modem-firmware-upgrade) Enable/disable remotely upgrading the internal cellular modem firmware on this fortigate from the central management server. type: str choices: [disable, enable] more...
    • modem_upgrade_frequency (Alias name: modem-upgrade-frequency) Set internal cellular modem firmware auto pushdown frequency. type: str choices: [everyHour, every12hour, everyDay, everyWeek] more...
    • modem_upgrade_time (Alias name: modem-upgrade-time) Schedule next internal cellular modem firmware upgrade time (local time). type: str more...

Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

  • To create or update an object, use state: present directive.

  • To delete an object, use state: absent directive

  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure central management.
      fortinet.fortimanager.fmgr_devprof_system_centralmanagement:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        devprof: <your own value>
        devprof_system_centralmanagement:
          include_default_servers: <value in [disable, enable]>
          server_list:
            -
              addr_type: <value in [fqdn, ipv4, ipv6]>
              fqdn: <string>
              id: <integer>
              server_address: <string>
              server_address6: <string>
              server_type:
                - "update"
                - "rating"
                - "iot-query"
                - "iot-collect"
                - "vpatch-query"
          ltefw_upgrade_time: <string>
          vdom: <list or string>
          allow_remote_firmware_upgrade: <value in [disable, enable]>
          local_cert: <string>
          allow_push_firmware: <value in [disable, enable]>
          ltefw_upgrade_frequency: <value in [everyHour, every12hour, everyDay, ...]>
          mode: <value in [normal, backup]>
          serial_number: <list or string>
          fmg_source_ip6: <string>
          allow_monitor: <value in [disable, enable]>
          allow_push_configuration: <value in [disable, enable]>
          ca_cert: <string>
          fmg_update_port: <value in [443, 8890]>
          use_elbc_vdom: <value in [disable, enable]>
          allow_remote_lte_firmware_upgrade: <value in [disable, enable]>
          interface: <list or string>
          schedule_script_restore: <value in [disable, enable]>
          schedule_config_restore: <value in [disable, enable]>
          interface_select_method: <value in [auto, sdwan, specify]>
          type: <value in [fortimanager, fortiguard, none]>
          fmg_source_ip: <string>
          fortigate_cloud_sso_default_profile: <list or string>
          fmg: <list or string>
          enc_algorithm: <value in [default, high, low]>
          allow_remote_modem_firmware_upgrade: <value in [disable, enable]>
          modem_upgrade_frequency: <value in [everyHour, every12hour, everyDay, ...]>
          modem_upgrade_time: <string>

Return Values

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

  • meta - The result of the request.returned: always type: dict
    • request_url - The full url requested. returned: always type: str sample: /sys/login/user
    • response_code - The status of api request. returned: always type: int sample: 0
    • response_data - The data body of the api response. returned: optional type: list or dict
    • response_message - The descriptive message of the api response. returned: always type: str sample: OK
    • system_information - The information of the target system. returned: always type: dict
  • rc - The status the request. returned: always type: int sample: 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)