fortinet.fortimanager.fmgr_system_guiact 模块 – 通过 GUI 进行系统设置。

注意

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

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

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

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

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

列表 / 元素=整数

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

rc_succeeded

列表 / 元素=整数

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

system_guiact

字典

设置的顶层参数。

backup_all

字符串

备份所有设置。

backup_conf

字符串

备份配置文件。

eventlog_msg

字符串

写入事件日志。

eventlog_path

字符串

事件日志路径。

reboot

整数

重启系统。

reset2default

整数

恢复出厂默认设置。

restore_all

字符串

恢复所有设置。

restore_conf

字符串

恢复配置文件。

time

字符串

时间。

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: System settings through GUI.
      fortinet.fortimanager.fmgr_system_guiact:
        # 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_guiact:
          backup_all: <string>
          backup_conf: <string>
          eventlog_msg: <string>
          eventlog_path: <string>
          reboot: <integer>
          reset2default: <integer>
          restore_all: <string>
          restore_conf: <string>
          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

列表 / 元素=字符串

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

返回值: 复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)