fortinet.fortios.fortios_wireless_controller_ble_profile 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置蓝牙低功耗 (BLE) 配置文件。

注意

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

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

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

要在剧本中使用它,请指定: fortinet.fortios.fortios_wireless_controller_ble_profile

fortinet.fortios 2.0.0 中的新增功能

概要

  • 此模块能够配置 FortiGate 或 FortiOS (FOS) 设备,允许用户设置和修改 wireless_controller 功能和 ble_profile 类别。示例包括所有参数,使用前需要将值调整为数据源。已在 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"

vdom

字符串

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

默认值: "root"

wireless_controller_ble_profile

字典

配置蓝牙低功耗配置文件。

advertising

列表 / 元素=字符串

广告类型。

选项

  • "ibeacon"

  • "eddystone-uid"

  • "eddystone-url"

beacon_interval

整数

信标间隔。

ble_scanning

字符串

启用/禁用蓝牙低功耗 (BLE) 扫描。

选项

  • "enable"

  • "disable"

comment

字符串

注释。

eddystone_instance

字符串

Eddystone 实例 ID。

eddystone_namespace

字符串

Eddystone 命名空间 ID。

eddystone_url

字符串

Eddystone URL。

eddystone_url_encode_hex

字符串

Eddystone 编码的 URL 十六进制字符串

ibeacon_uuid

字符串

通用唯一标识符 (UUID;自动分配,但可以手动重置)。

major_id

整数

主要 ID。

minor_id

整数

次要 ID。

name

字符串 / 必需

蓝牙低功耗配置文件名称。

scan_interval

整数

扫描间隔。

scan_period

整数

扫描周期。

scan_threshold

字符串

AP 报告检测到的 BLE 设备所需的最小信号级别/阈值(dBm)(-95 到 -20)。

scan_time

整数

扫描时间。

scan_type

字符串

扫描类型。

选项

  • "active"

  • "passive"

scan_window

整数

扫描窗口。

txpower

字符串

发射功率级别。

选项

  • "0"

  • "1"

  • "2"

  • "3"

  • "4"

  • "5"

  • "6"

  • "7"

  • "8"

  • "9"

  • "10"

  • "11"

  • "12"

备注

注意

  • 旧版 fortiosapi 已弃用,httpapi 是运行剧本的首选方法。

  • 该模块支持 check_mode。

示例

- name: Configure Bluetooth Low Energy profile.
  fortinet.fortios.fortios_wireless_controller_ble_profile:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      wireless_controller_ble_profile:
          advertising: "ibeacon"
          beacon_interval: "100"
          ble_scanning: "enable"
          comment: "Comment."
          eddystone_instance: "<your_own_value>"
          eddystone_namespace: "<your_own_value>"
          eddystone_url: "<your_own_value>"
          eddystone_url_encode_hex: "<your_own_value>"
          ibeacon_uuid: "<your_own_value>"
          major_id: "1000"
          minor_id: "2000"
          name: "default_name_14"
          scan_interval: "50"
          scan_period: "4000"
          scan_threshold: "<your_own_value>"
          scan_time: "1000"
          scan_type: "active"
          scan_window: "50"
          txpower: "0"

返回值

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

描述

build

字符串

FortiGate 映像的版本号

返回: 始终

示例: "1547"

http_method

字符串

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

返回: 始终

示例: "PUT"

http_status

字符串

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

返回: 始终

示例: "200"

mkey

字符串

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

返回: 成功

示例: "id"

name

字符串

用于完成请求的表的名称

返回: 始终

示例: "urlfilter"

path

字符串

用于完成请求的表的路径

返回: 始终

示例: "webfilter"

revision

字符串

内部版本号

返回: 始终

示例: "17.0.2.10658"

serial

字符串

设备序列号

返回: 始终

示例: "FGVMEVYYQT3AB5352"

状态

字符串

操作结果指示

返回: 始终

示例: "success"

vdom

字符串

使用的虚拟域

返回: 始终

示例: "root"

版本

字符串

FortiGate 版本

返回: 始终

示例: "v5.6.3"

作者

  • 郑链 (@chillancezen)

  • 薛杰 (@JieX19)

  • 陆宏斌 (@fgtdev-hblu)

  • 沈峰 (@frankshen01)

  • 米格尔·安吉尔·穆诺兹 (@mamunozgonzalez)

  • 尼古拉斯·托马斯 (@thomnico)