fortinet.fortimanager.fmgr_system_admin_user_metadata 模块 – 配置元数据。

注意

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

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

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

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

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代码列表。

state

字符串 / 必需

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

选项

  • "present"

  • "absent"

system_admin_user_metadata

字典

设置的顶级参数。

fieldlength

整数

字段长度。

fieldname

字符串 / 必需

字段名称。

fieldvalue

字符串

字段值。

importance

字符串

重要性。

可选 - 此字段是可选的。

必需 - 此字段是必需的。

选项

  • "optional"

  • "required"

status

字符串

状态。

disabled - 此字段已禁用。

enabled - 此字段已启用。

选项

  • "disabled"

  • "enabled"

user

字符串 / 必需

请求URL中的参数 (user)。

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有助于完成这项工作。

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

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

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

示例

- name: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure meta data.
      fortinet.fortimanager.fmgr_system_admin_user_metadata:
        bypass_validation: true
        user: ansible-test # userid
        state: present
        system_admin_user_metadata:
          fieldlength: 50
          fieldname: Contact Address
          fieldvalue: "[email protected]"
          importance: optional # <value in [optional, required]>
          status: enabled # <value in [disabled, enabled]>

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the meta data of user
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "system_admin_user_metadata"
          params:
            user: "ansible-test" # userid
            meta-data: "your_value"

返回值

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

键

描述

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版本支持，则会发出警告。

返回： complex

作者

  • 杜欣伟 (@dux-fortinet)

  • 李星 (@lix-fortinet)

  • 薛杰 (@JieX19)

  • 郑凌 (@chillancezen)

  • 沈方 (@fshen01)

  • 卢洪斌 (@fgtdev-hblu)