fortinet.fortios.fortios_user_device 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置设备。

注意

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

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

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

要在 playbook 中使用它，请指定：fortinet.fortios.fortios_user_device。

fortinet.fortios 2.0.0 中的新增功能

概要

  • 此模块能够通过允许用户设置和修改用户功能和设备类别来配置 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"

user_device

字典

配置设备。

alias

字符串 / 必填

设备别名。

avatar

字符串

头像的图像文件（最大 4K base64 编码）。

category

字符串

家族。

选项

  • "none"

  • "amazon-device"

  • "android-device"

  • "blackberry-device"

  • "fortinet-device"

  • "ios-device"

  • "windows-device"

comment

字符串

注释。

mac

字符串

设备 MAC 地址。

master_device

字符串

主设备（可选）。源 user.device.alias。

tagging

列表 / elements=字典

配置对象标记。

category

字符串

标记类别。源 system.object-tagging.category。

name

字符串 / 必填

标记条目名称。

tags

列表 / elements=字典

标记。

name

字符串 / 必填

标记名称。源 system.object-tagging.tags.name。

type

字符串

类型。

选项

  • "unknown"

  • "android-phone"

  • "android-tablet"

  • "blackberry-phone"

  • "blackberry-playbook"

  • "forticam"

  • "fortifone"

  • "fortinet-device"

  • "gaming-console"

  • "ip-phone"

  • "ipad"

  • "iphone"

  • "linux-pc"

  • "mac"

  • "media-streaming"

  • "printer"

  • "router-nat-device"

  • "windows-pc"

  • "windows-phone"

  • "windows-tablet"

  • "other-network-device"

user

字符串

用户名。

vdom

字符串

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

默认: "root"

注释

注意

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

  • 该模块支持 check_mode。

示例

- name: Configure devices.
  fortinet.fortios.fortios_user_device:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      user_device:
          alias: "<your_own_value>"
          avatar: "<your_own_value>"
          category: "none"
          comment: "Comment."
          mac: "<your_own_value>"
          master_device: "<your_own_value> (source user.device.alias)"
          tagging:
              -
                  category: "<your_own_value> (source system.object-tagging.category)"
                  name: "default_name_11"
                  tags:
                      -
                          name: "default_name_13 (source system.object-tagging.tags.name)"
          type: "unknown"
          user: "<your_own_value>"

返回值

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

键

描述

build

字符串

FortiGate 映像的版本号

返回: 始终

示例: "1547"

http_method

字符串

最后用于将内容配置到 FortiGate 中的方法

返回: 始终

示例: "PUT"

http_status

字符串

FortiGate 在上次应用操作时给出的最后一个结果

返回: 始终

示例: "200"

mkey

字符串

上次调用 FortiGate 时使用的主密钥 (id)

返回: success

示例: "id"

name

字符串

用于满足请求的表名

返回: 始终

示例: "urlfilter"

path

字符串

用于满足请求的表的路径

返回: 始终

示例: "webfilter"

revision

字符串

内部修订号

返回: 始终

示例: "17.0.2.10658"

serial

字符串

设备的序列号

返回: 始终

示例: "FGVMEVYYQT3AB5352"

status

字符串

操作结果的指示

返回: 始终

示例: "success"

vdom

字符串

使用的虚拟域

返回: 始终

示例: "root"

version

字符串

FortiGate 的版本

返回: 始终

示例: "v5.6.3"

作者

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)