fortinet.fortimanager.fmgr_devprof_system_centralmanagement 模块 – 配置中央管理。

注意

此模块是 fortinet.fortimanager 集合 (版本 2.8.2) 的一部分。

如果您正在使用 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install fortinet.fortimanager。

要在 playbook 中使用它，请指定： fortinet.fortimanager.fmgr_devprof_system_centralmanagement。

fortinet.fortimanager 1.0.0 中的新增功能

概要

  • 此模块能够配置 FortiManager 设备。

  • 示例包含所有需要在使用前根据数据源调整的参数和值。

参数

参数

注释

access_token

字符串

无需使用用户名和密码即可访问 FortiManager 的令牌。

adom

字符串 / 必需

请求 URL 中的参数 (adom)。

bypass_validation

布尔值

仅当模块模式与 FortiManager API 结构不同时设置为 True，模块将继续执行而无需验证参数。

选项

  • false ← (默认)

  • true

devprof

字符串 / 必需

请求 URL 中的参数 (devprof)。

devprof_system_centralmanagement

字典

设置的顶级参数。

allow_monitor

别名：allow-monitor

字符串

启用/禁用允许中央管理服务器远程监控此 FortiGate 单元。

选项

  • "disable"

  • "enable"

allow_push_configuration

别名：allow-push-configuration

字符串

启用/禁用允许中央管理服务器将配置更改推送到此 FortiGate。

选项

  • "disable"

  • "enable"

allow_push_firmware

别名：allow-push-firmware

字符串

启用/禁用允许中央管理服务器将固件更新推送到此 FortiGate。

选项

  • "disable"

  • "enable"

allow_remote_firmware_upgrade

别名：allow-remote-firmware-upgrade

字符串

启用/禁用从中央管理服务器远程升级此 FortiGate 上的固件。

选项

  • "disable"

  • "enable"

allow_remote_lte_firmware_upgrade

别名：allow-remote-lte-firmware-upgrade

字符串

启用/禁用从中央管理服务器远程升级此 FortiGate 上的 LTE 固件。

选项

  • "disable"

  • "enable"

allow_remote_modem_firmware_upgrade

别名：allow-remote-modem-firmware-upgrade

字符串

启用/禁用从中央管理服务器远程升级此 FortiGate 上的内部蜂窝调制解调器固件。

选项

  • "disable"

  • "enable"

ca_cert

别名：ca-cert

字符串

FGFM 协议要使用的 CA 证书。

enc_algorithm

别名：enc-algorithm

字符串

FortiGate 和中央管理之间通信的加密强度。

选项

  • "default"

  • "high"

  • "low"

fmg

任意

(列表) FortiManager 的 IP 地址或 FQDN。

fmg_source_ip

别名：fmg-source-ip

字符串

此 FortiGate 与 FortiManager 通信时使用的 IPv4 源地址。

fmg_source_ip6

别名：fmg-source-ip6

字符串

此 FortiGate 与 FortiManager 通信时使用的 IPv6 源地址。

fmg_update_port

别名：fmg-update-port

字符串

用于与充当 FortiGuard 更新服务器的 FortiManager 通信的端口。

选项

  • "443"

  • "8890"

fortigate_cloud_sso_default_profile

别名：fortigate-cloud-sso-default-profile

任意

(列表) 覆盖访问配置文件。

include_default_servers

别名：include-default-servers

字符串

启用/禁用在覆盖服务器列表中包含公共 FortiGuard 服务器。

选项

  • "disable"

  • "enable"

interface

任意

(列表) 指定到达服务器的出站接口。

interface_select_method

别名：interface-select-method

字符串

指定如何选择到达服务器的出站接口。

选项

  • "auto"

  • "sdwan"

  • "specify"

local_cert

别名：local-cert

字符串

FGFM 协议要使用的证书。

ltefw_upgrade_frequency

别名：ltefw-upgrade-frequency

字符串

设置 LTE 固件自动下推频率。

选项

  • "everyHour"

  • "every12hour"

  • "everyDay"

  • "everyWeek"

ltefw_upgrade_time

别名：ltefw-upgrade-time

字符串

安排下次 LTE 固件升级时间

mode

字符串

中央管理模式。

选项

  • "normal"

  • "backup"

modem_upgrade_frequency

别名：modem-upgrade-frequency

字符串

设置内部蜂窝调制解调器固件自动下推频率。

选项

  • "everyHour"

  • "every12hour"

  • "everyDay"

  • "everyWeek"

modem_upgrade_time

别名：modem-upgrade-time

字符串

计划下次内部蜂窝调制解调器固件升级时间

schedule_config_restore

别名：schedule-config-restore

字符串

启用/禁用允许中央管理服务器恢复此 FortiGate 的配置。

选项

  • "disable"

  • "enable"

schedule_script_restore

别名：schedule-script-restore

字符串

启用/禁用允许中央管理服务器恢复存储在此 FortiGate 上的脚本。

选项

  • "disable"

  • "enable"

serial_number

别名：serial-number

任意

(列表) 序列号。

server_list

别名：server-list

列表 / 元素=字典

服务器列表。

addr_type

别名：addr-type

字符串

指示 FortiGate 是否使用 IPv4 地址、IPv6 地址或 FQDN 与覆盖服务器通信。

选项

  • "fqdn"

  • "ipv4"

  • "ipv6"

fqdn

字符串

覆盖服务器的 FQDN 地址。

id

整数

ID。

server_address

别名：server-address

字符串

覆盖服务器的 IPv4 地址。

server_address6

别名：server-address6

字符串

覆盖服务器的 IPv6 地址。

server_type

别名：server-type

列表 / 元素=字符串

FortiGuard 服务类型。

选项

  • "update"

  • "rating"

  • "iot-query"

  • "iot-collect"

  • "vpatch-query"

类型

字符串

中央管理类型。

选项

  • "fortimanager"

  • "fortiguard"

  • "none"

use_elbc_vdom

别名：use-elbc-vdom

字符串

启用/禁用使用特殊的 ELBC 配置同步 VDOM 连接到 FortiManager。

选项

  • "disable"

  • "enable"

vdom

任意

(列表) 虚拟域

enable_log

布尔值

启用/禁用任务日志记录。

选项

  • false ← (默认)

  • true

forticloud_access_token

字符串

使用 FortiCloud API 访问令牌验证 Ansible 客户端。

proposed_method

字符串

基础 Json RPC 请求的覆盖方法。

选项

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素=整数

将覆盖失败条件的 rc 代码列表。

rc_succeeded

列表 / 元素=整数

将覆盖成功条件的 rc 代码列表。

workspace_locking_adom

字符串

在工作区模式下运行 FortiManager 时要锁定的 ADOM，该值可以是全局值和其他值，包括 root。

workspace_locking_timeout

整数

等待其他用户释放工作区锁的最大时间（秒）。

默认值： 300

注释

注意

  • 从 2.4.0 版本开始，所有输入参数都使用下划线命名约定 (snake_case)。请将诸如“var-name”之类的参数更改为“var_name”。旧的参数名称仍然可用，但您会收到弃用警告。您可以通过在 ansible.cfg 中设置 deprecation_warnings=False 来忽略此警告。

  • 此 FortiManager 模块支持在工作区锁定模式下运行，顶级参数 workspace_locking_adom 和 workspace_locking_timeout 有助于完成此工作。

  • 通常，当返回非零 rc 时，运行一个模块可能会失败。您还可以使用参数 rc_failed 和 rc_succeeded 覆盖失败或成功的条件。

示例

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

返回值

常用返回值已在 此处 记录，以下是此模块特有的字段

键

描述

meta

字典

请求的结果。

返回：始终

request_url

字符串

请求的完整 URL。

返回：始终

示例： "/sys/login/user"

response_code

整数

API 请求的状态。

返回：始终

示例： 0

response_data

列表 / 元素=字符串

API 响应。

返回：始终

response_message

字符串

API 响应的描述性消息。

返回：始终

示例： "OK."

system_information

字典

目标系统的信息。

返回：始终

rc

整数

请求的状态。

返回：始终

示例： 0

version_check_warning

列表 / 元素=字符串

如果剧本中使用的参数不受当前 FortiManager 版本支持，则会发出警告。

返回：复杂

作者

  • 杜欣伟 (@dux-fortinet)

  • 李星 (@lix-fortinet)

  • 薛杰 (@JieX19)

  • 郑麟 (@chillancezen)

  • 沈方 (@fshen01)

  • 卢宏斌 (@fgtdev-hblu)