fortinet.fortios.fortios_system_api_user 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 API 用户。

注意

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

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

要安装它，请使用： ansible-galaxy collection install fortinet.fortios。 您需要更多要求才能使用此模块，请参阅 要求 以了解详细信息。

要在 Playbook 中使用它，请指定： fortinet.fortios.fortios_system_api_user。

fortinet.fortios 2.0.0 新增功能

概要

  • 此模块能够通过允许用户设置和修改系统功能和 api_user 类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括所有参数和值都需要在使用前调整为数据源。已使用 FOS v6.0.0 进行测试

要求

执行此模块的主机需要满足以下要求。

  • ansible>=2.15

参数

参数

注释

access_token

字符串

基于令牌的身份验证。从 Fortigate 的 GUI 生成。

enable_log

布尔值

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

选项

  • false ← (默认)

  • true

member_path

字符串

要操作的成员属性路径。

如果有多个属性，则用斜杠字符分隔。

使用 member_path 标记的参数对于执行成员操作是合法的。

member_state

字符串

在指定的属性路径下添加或删除成员。

当指定 member_state 时，将忽略 state 选项。

选项

  • "present"

  • "absent"

state

字符串 / 必需

指示是创建还是删除对象。

选项

  • "present"

  • "absent"

system_api_user

字典

配置 API 用户。

accprofile

字符串

管理员用户访问配置文件。来源 system.accprofile.name。

api_key

字符串

管理员用户密码。

comments

字符串

注释。

cors_allow_origin

字符串

API 响应中 Access-Control-Allow-Origin 的值。如果可能，请避免使用“*”。

name

字符串 / 必需

用户名。

peer_auth

字符串

启用/禁用对等身份验证。

选项

  • "enable"

  • "disable"

peer_group

字符串

对等组名称。

schedule

字符串

计划名称。

trusthost

列表 / 元素=字典

信任主机。

id

整数 / 必需

ID。请参阅 <a href=’#notes’>说明</a>。

ipv4_trusthost

字符串

IPv4 受信任的主机地址。

ipv6_trusthost

字符串

IPv6 受信任的主机地址。

type

字符串

信任主机类型。

选项

  • "ipv4-trusthost"

  • "ipv6-trusthost"

vdom

列表 / 元素=字典

虚拟域。

name

字符串 / 必需

虚拟域名。来源 system.vdom.name。

vdom

字符串

虚拟域，在之前定义的域中。vdom 是 FortiGate 的虚拟实例，可以配置并用作不同的单元。

默认值: "root"

说明

注意

  • 旧的 fortiosapi 已被弃用，httpapi 是运行 Playbook 的首选方式

  • 该模块支持 check_mode。

示例

- name: Configure API users.
  fortinet.fortios.fortios_system_api_user:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_api_user:
          accprofile: "<your_own_value> (source system.accprofile.name)"
          api_key: "<your_own_value>"
          comments: "<your_own_value>"
          cors_allow_origin: "<your_own_value>"
          name: "default_name_7"
          peer_auth: "enable"
          peer_group: "<your_own_value>"
          schedule: "<your_own_value>"
          trusthost:
              -
                  id: "12"
                  ipv4_trusthost: "myhostname"
                  ipv6_trusthost: "myhostname"
                  type: "ipv4-trusthost"
          vdom:
              -
                  name: "default_name_17 (source system.vdom.name)"

返回值

通用返回值记录在这里，以下是此模块特有的字段

键

描述

build

字符串

Fortigate 镜像的版本号

返回: 总是

示例: "1547"

http_method

字符串

上次用于将内容配置到 FortiGate 中的方法

返回: 总是

示例: "PUT"

http_status

字符串

FortiGate 在上次应用的操作中给出的最后结果

返回: 总是

示例: "200"

mkey

字符串

上次调用 FortiGate 时使用的主键（id）

返回: 成功

示例: "id"

name

字符串

用于完成请求的表的名称

返回: 总是

示例: "urlfilter"

path

字符串

用于完成请求的表的路径

返回: 总是

示例: "webfilter"

revision

字符串

内部修订号

返回: 总是

示例: "17.0.2.10658"

序列号

字符串

设备的序列号

返回: 总是

示例: "FGVMEVYYQT3AB5352"

状态

字符串

操作结果的指示

返回: 总是

示例: "success"

vdom

字符串

使用的虚拟域

返回: 总是

示例: "root"

版本

字符串

FortiGate 的版本

返回: 总是

示例: "v5.6.3"

作者

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)