Skip to content

Latest commit

 

History

History
492 lines (448 loc) · 21 KB

fortios_wireless_controller_ble_profile.rst

File metadata and controls

492 lines (448 loc) · 21 KB
Raw
source:fortios_wireless_controller_ble_profile.py
orphan:

fortios_wireless_controller_ble_profile -- Configure Bluetooth Low Energy profile in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless_controller feature and ble_profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.14

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility


Supported Version Ranges
fortios_wireless_controller_ble_profile v6.0.0 -> latest

Parameters

  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • vdom - Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. type: str default: root
  • member_path - Member attribute path to operate on. type: str
  • member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
  • state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
  • wireless_controller_ble_profile - Configure Bluetooth Low Energy profile. type: dict more...
    Supported Version Ranges
    wireless_controller_ble_profile v6.0.0 -> latest
    • advertising - Advertising type. type: list choices: ibeacon, eddystone-uid, eddystone-url more...
      Supported Version Ranges
      advertising v6.0.0 -> latest
      [ibeacon] v6.0.0 -> latest
      [eddystone-uid] v6.0.0 -> latest
      [eddystone-url] v6.0.0 -> latest
    • beacon_interval - Beacon interval . type: int more...
      Supported Version Ranges
      beacon_interval v6.0.0 -> latest
    • ble_scanning - Enable/disable Bluetooth Low Energy (BLE) scanning. type: str choices: enable, disable more...
      Supported Version Ranges
      ble_scanning v6.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • comment - Comment. type: str more...
      Supported Version Ranges
      comment v6.0.0 -> latest
    • eddystone_instance - Eddystone instance ID. type: str more...
      Supported Version Ranges
      eddystone_instance v6.0.0 -> latest
    • eddystone_namespace - Eddystone namespace ID. type: str more...
      Supported Version Ranges
      eddystone_namespace v6.0.0 -> latest
    • eddystone_url - Eddystone URL. type: str more...
      Supported Version Ranges
      eddystone_url v6.0.0 -> latest
    • eddystone_url_encode_hex - Eddystone encoded URL hexadecimal string type: str more...
      Supported Version Ranges
      eddystone_url_encode_hex v6.0.0 -> v6.0.11 v6.2.3 -> v6.2.3
    • ibeacon_uuid - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). type: str more...
      Supported Version Ranges
      ibeacon_uuid v6.0.0 -> latest
    • major_id - Major ID. type: int more...
      Supported Version Ranges
      major_id v6.0.0 -> latest
    • minor_id - Minor ID. type: int more...
      Supported Version Ranges
      minor_id v6.0.0 -> latest
    • name - Bluetooth Low Energy profile name. type: str required: true more...
      Supported Version Ranges
      name v6.0.0 -> latest
    • scan_interval - Scan Interval . type: int more...
      Supported Version Ranges
      scan_interval v7.4.1 -> latest
    • scan_period - Scan Period . type: int more...
      Supported Version Ranges
      scan_period v7.4.1 -> latest
    • scan_threshold - Minimum signal level/threshold in dBm required for the AP to report detected BLE device (-95 to -20). type: str more...
      Supported Version Ranges
      scan_threshold v7.4.1 -> latest
    • scan_time - Scan Time . type: int more...
      Supported Version Ranges
      scan_time v7.4.1 -> latest
    • scan_type - Scan Type . type: str choices: active, passive more...
      Supported Version Ranges
      scan_type v7.4.1 -> latest
      [active] v6.0.0 -> latest
      [passive] v6.0.0 -> latest
    • scan_window - Scan Windows . type: int more...
      Supported Version Ranges
      scan_window v7.4.1 -> latest
    • txpower - Transmit power level . type: str choices: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 more...
      Supported Version Ranges
      txpower v6.0.0 -> latest
      [0] v6.0.0 -> latest
      [1] v6.0.0 -> latest
      [2] v6.0.0 -> latest
      [3] v6.0.0 -> latest
      [4] v6.0.0 -> latest
      [5] v6.0.0 -> latest
      [6] v6.0.0 -> latest
      [7] v6.0.0 -> latest
      [8] v6.0.0 -> latest
      [9] v6.0.0 -> latest
      [10] v6.0.0 -> latest
      [11] v6.0.0 -> latest
      [12] v6.0.0 -> latest

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- 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"

Return Values

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

  • build - Build number of the fortigate image returned: always type: str sample: 1547
  • http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
  • http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
  • mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
  • name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
  • path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
  • revision - Internal revision number returned: always type: str sample: 17.0.2.10658
  • serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
  • status - Indication of the operation's result returned: always type: str sample: success
  • vdom - Virtual domain used returned: always type: str sample: root
  • version - Version of the FortiGate returned: always type: str sample: v5.6.3

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.