fortinet.fortimanager.fmgr_bleprofile 模块 – 配置蓝牙低功耗配置文件。

注意

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

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

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

要在剧本中使用它，请指定：fortinet.fortimanager.fmgr_bleprofile。

fortinet.fortimanager 2.0.0 中的新功能

概要

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

  • 示例包括所有参数和值，这些参数和值需要在使用前调整为数据源。

参数

参数

注释

access_token

字符串

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

adom

字符串 / 必需

请求 URL 中的参数 (adom)。

bleprofile

字典

顶层参数集。

advertising

列表 / 元素=字符串

广告类型。

选项

  • "ibeacon"

  • "eddystone-uid"

  • "eddystone-url"

beacon_interval

别名：beacon-interval

整数

信标间隔

ble_scanning

别名：ble-scanning

字符串

启用/禁用蓝牙低功耗

选项

  • "disable"

  • "enable"

comment

字符串

注释。

eddystone_instance

别名：eddystone-instance

字符串

Eddystone 实例 ID。

eddystone_namespace

别名：eddystone-namespace

字符串

Eddystone 命名空间 ID。

eddystone_url

别名：eddystone-url

字符串

Eddystone URL。

eddystone_url_encode_hex

别名：eddystone-url-encode-hex

字符串

Eddystone 编码 URL 十六进制字符串

ibeacon_uuid

别名：ibeacon-uuid

字符串

通用唯一标识符

major_id

别名：major-id

整数

主要 ID。

minor_id

别名：minor-id

整数

次要 ID。

name

字符串 / 必需

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

scan_interval

别名：scan-interval

整数

扫描间隔

scan_period

别名：scan-period

整数

扫描周期

scan_threshold

别名：scan-threshold

字符串

AP 报告检测到的 BLE 设备所需的最小信号级别/阈值（以 dBm 为单位）

scan_time

别名：scan-time

整数

扫描时间

scan_type

别名：scan-type

字符串

扫描类型

选项

  • "active"

  • "passive"

scan_window

别名：scan-window

整数

扫描窗口

txpower

字符串

传输功率级别

选项

  • "0"

  • "1"

  • "2"

  • "3"

  • "4"

  • "5"

  • "6"

  • "7"

  • "8"

  • "9"

  • "10"

  • "11"

  • "12"

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"

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 (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: Configure Bluetooth Low Energy profile.
      fortinet.fortimanager.fmgr_bleprofile:
        # 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]>
        bleprofile:
          advertising:
            - "ibeacon"
            - "eddystone-uid"
            - "eddystone-url"
          beacon_interval: <integer>
          ble_scanning: <value in [disable, enable]>
          comment: <string>
          eddystone_instance: <string>
          eddystone_namespace: <string>
          eddystone_url: <string>
          eddystone_url_encode_hex: <string>
          ibeacon_uuid: <string>
          major_id: <integer>
          minor_id: <integer>
          name: <string>
          txpower: <value in [0, 1, 2, ...]>
          scan_interval: <integer>
          scan_period: <integer>
          scan_threshold: <string>
          scan_time: <integer>
          scan_type: <value in [active, passive]>
          scan_window: <integer>

返回值

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

键

描述

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

返回: 复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)