fortinet.fortimanager.fmgr_system_dm 模块 – 配置 dm。

注意

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

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

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

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

fortinet.fortimanager 2.0.0 中的新增功能

概要

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

  • 示例包括所有参数和值，这些参数和值需要在使用前调整为数据源。

参数

参数

注释

access_token

字符串

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

bypass_validation

布尔值

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

选项

  • false ← (默认)

  • true

enable_log

布尔值

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

选项

  • false ← (默认)

  • true

forticloud_access_token

字符串

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

proposed_method

字符串

底层 Json RPC 请求的覆盖方法。

选项

  • "update"

  • "set"

  • "add"

rc_failed

列表 / elements=integer

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

rc_succeeded

列表 / elements=integer

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

system_dm

字典

设置的顶级参数。

concurrent_install_image_limit

别名：concurrent-install-image-limit

整数

并发安装镜像的最大数量

concurrent_install_limit

别名：concurrent-install-limit

整数

最大并发安装数

concurrent_install_script_limit

别名：concurrent-install-script-limit

整数

最大并发安装脚本数

conf_merge_after_script

别名：conf-merge-after-script

字符串

在远程设备上运行脚本后合并配置，而不是完全检索。

disable - 禁用。

enable - 启用。

选项

  • "disable"

  • "enable"

discover_timeout

别名：discover-timeout

整数

发现设备时检查连接超时

dpm_logsize

别名：dpm-logsize

整数

每个设备的最大 dpm 日志大小

fgfm_auto_retrieve_timeout

别名：fgfm-auto-retrieve-timeout

整数

自动检索的最大等待时间

fgfm_install_refresh_count

别名：fgfm-install-refresh-count

整数

最大 FGFM 安装刷新尝试次数。

fgfm_keepalive_itvl

整数

FGFM 协议保持活动间隔

fgfm_sock_timeout

别名：fgfm-sock-timeout

整数

最大 FGFM 套接字空闲时间

force_remote_diff

别名：force-remote-diff

字符串

安装时始终使用远程差异。

disable - 禁用。

enable - 启用。

选项

  • "disable"

  • "enable"

fortiap_refresh_cnt

别名：fortiap-refresh-cnt

整数

每次自动刷新 FortiAP 的最大数量

fortiap_refresh_itvl

别名：fortiap-refresh-itvl

整数

自动刷新 FortiAP 状态间隔

fortiext_refresh_cnt

别名：fortiext-refresh-cnt

整数

FortiExtender 自动刷新的最大设备数量

install_fds_timeout

别名：install-fds-timeout

整数

安装期间等待 fgt 更新的最大时间

install_image_timeout

别名：install-image-timeout

整数

映像传输和设备升级的最大等待时间

install_tunnel_retry_itvl

别名：install-tunnel-retry-itvl

整数

安装期间重新建立隧道的时间

log_autoupdate

别名：log-autoupdate

字符串

启用/禁用自动更新调试日志记录。

disable - 禁用。

enable - 启用。

选项

  • "disable"

  • "enable"

max_revs

别名：max-revs

整数

保存的最大修订版本数

nr_retry

别名: nr-retry

整数

重试次数。

retry

字符串

启用/禁用配置安装重试。

disable - 禁用。

enable - 启用。

选项

  • "disable"

  • "enable"

retry_intvl

别名: retry-intvl

整数

重试间隔。

rollback_allow_reboot

别名: rollback-allow-reboot

字符串

启用/禁用在安装脚本/配置时，FortiGate重启以回滚。

disable - 禁用。

enable - 启用。

选项

  • "disable"

  • "enable"

script_logsize

别名: script-logsize

整数

每个设备的最大脚本日志大小

skip_scep_check

别名: skip-scep-check

字符串

启用/禁用即使配置了scep url，也安装scep相关对象。

disable - 禁用。

enable - 启用。

选项

  • "disable"

  • "enable"

skip_tunnel_fcp_req

别名: skip-tunnel-fcp-req

字符串

启用/禁用跳过从fgfm隧道发送的fcp请求

disable - 禁用。

enable - 启用。

选项

  • "disable"

  • "enable"

verify_install

别名: verify-install

字符串

针对远程配置验证安装。

disable - 禁用。

optimal - 验证命令错误的安装。

enable - 始终验证安装。

选项

  • "disable"

  • "optimal"

  • "enable"

workspace_locking_adom

字符串

在工作区模式下运行的FortiManager要锁定的ADOM，该值可以是 global 和其他包括 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 dm.
      fortinet.fortimanager.fmgr_system_dm:
        # 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, ...]
        system_dm:
          concurrent_install_image_limit: <integer>
          concurrent_install_limit: <integer>
          concurrent_install_script_limit: <integer>
          discover_timeout: <integer>
          dpm_logsize: <integer>
          fgfm_sock_timeout: <integer>
          fgfm_keepalive_itvl: <integer>
          force_remote_diff: <value in [disable, enable]>
          fortiap_refresh_cnt: <integer>
          fortiap_refresh_itvl: <integer>
          fortiext_refresh_cnt: <integer>
          install_image_timeout: <integer>
          install_tunnel_retry_itvl: <integer>
          max_revs: <integer>
          nr_retry: <integer>
          retry: <value in [disable, enable]>
          retry_intvl: <integer>
          rollback_allow_reboot: <value in [disable, enable]>
          script_logsize: <integer>
          skip_scep_check: <value in [disable, enable]>
          skip_tunnel_fcp_req: <value in [disable, enable]>
          verify_install: <value in [disable, optimal, enable]>
          fgfm_install_refresh_count: <integer>
          conf_merge_after_script: <value in [disable, enable]>
          log_autoupdate: <value in [disable, enable]>
          fgfm_auto_retrieve_timeout: <integer>
          install_fds_timeout: <integer>

返回值

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

键

描述

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

列表 / 元素=字符串

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

返回: 复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)