fortinet.fortimanager.fmgr_user_nsx 模块 – 用户 nsx

注意

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

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

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

要在 Playbook 中使用它，请指定：fortinet.fortimanager.fmgr_user_nsx。

fortinet.fortimanager 2.1.0 中的新增功能

概要

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

  • 示例包括所有参数和值，在使用前需要根据数据源进行调整。

参数

参数

注释

access_token

字符串

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

adom

字符串 / 必需

请求 URL 中的参数 (adom)。

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_succeeded

列表 / 元素=整数

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

state

字符串 / 必需

创建、更新或删除对象的指令。

选择

  • "present"

  • "absent"

user_nsx

字典

设置的顶级参数。

fmgip

字符串

Fmgip。

fmgpasswd

任何类型

（列表）Fmgpasswd。

fmguser

字符串

Fmguser。

if_allgroup

别名：if-allgroup

字符串

如果 allgroup。

选择

  • "disable"

  • "enable"

name

字符串 / 必需

名称。

password

任何类型

（列表）密码。

server

字符串

服务器。

service

列表 / 元素=字典

服务。

id

字符串

Id。

integration

字符串

集成。

选择

  • "east-west"

  • "north-south"

name

字符串

名称。

ref_id

别名：ref-id

字符串

引用 ID。

service_id

别名：service-id

任何类型

（列表）服务 ID。

service_manager_id

别名：service-manager-id

字符串

服务管理器 ID。

service_manager_rev

别名：service-manager-rev

整数

服务管理器修订版。

status

字符串

状态。

选择

  • "disable"

  • "enable"

user

字符串

用户。

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 可帮助完成工作。

  • 要创建或更新对象，请使用 state present 指令。

  • 要删除对象，请使用 state absent 指令。

  • 通常，当返回非零 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: User nsx
      fortinet.fortimanager.fmgr_user_nsx:
        # 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>
        state: present # <value in [present, absent]>
        user_nsx:
          fmgip: <string>
          fmguser: <string>
          name: <string>
          password: <list or string>
          server: <string>
          status: <value in [disable, enable]>
          user: <string>
          fmgpasswd: <list or string>
          service_id: <list or string>
          if_allgroup: <value in [disable, enable]>
          service:
            -
              id: <string>
              integration: <value in [east-west, north-south]>
              name: <string>
              ref_id: <string>
          service_manager_id: <string>
          service_manager_rev: <integer>

返回值

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

键

描述

元数据

字典

请求的结果。

返回：始终

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)