fortinet.fortios.fortios_wireless_controller_ble_profile (2.3.6) — module

Install collection

Install with ansible-galaxy collection install fortinet.fortios:==2.3.6

Add to requirements.yml

  collections:
    - name: fortinet.fortios
      version: 2.3.6

Description

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

• ansible>=2.15

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

    
vdom:
    default: root
    description:
    - 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

state:
    choices:
    - present
    - absent
    description:
    - Indicates whether to create or remove the object.
    required: true
    type: str

enable_log:
    default: false
    description:
    - Enable/Disable logging for task.
    required: false
    type: bool

member_path:
    description:
    - Member attribute path to operate on.
    - Delimited by a slash character if there are more than one attribute.
    - Parameter marked with member_path is legitimate for doing member operation.
    type: str

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

member_state:
    choices:
    - present
    - absent
    description:
    - Add or delete a member under specified attribute path.
    - When member_state is specified, the state option is ignored.
    type: str

wireless_controller_ble_profile:
    default: null
    description:
    - Configure Bluetooth Low Energy profile.
    suboptions:
      advertising:
        choices:
        - ibeacon
        - eddystone-uid
        - eddystone-url
        description:
        - Advertising type.
        elements: str
        type: list
      beacon_interval:
        description:
        - Beacon interval .
        type: int
      ble_scanning:
        choices:
        - enable
        - disable
        description:
        - Enable/disable Bluetooth Low Energy (BLE) scanning.
        type: str
      comment:
        description:
        - Comment.
        type: str
      eddystone_instance:
        description:
        - Eddystone instance ID.
        type: str
      eddystone_namespace:
        description:
        - Eddystone namespace ID.
        type: str
      eddystone_url:
        description:
        - Eddystone URL.
        type: str
      eddystone_url_encode_hex:
        description:
        - Eddystone encoded URL hexadecimal string
        type: str
      ibeacon_uuid:
        description:
        - Universally Unique Identifier (UUID; automatically assigned but can be manually
          reset).
        type: str
      major_id:
        description:
        - Major ID.
        type: int
      minor_id:
        description:
        - Minor ID.
        type: int
      name:
        description:
        - Bluetooth Low Energy profile name.
        required: true
        type: str
      scan_interval:
        description:
        - Scan Interval .
        type: int
      scan_period:
        description:
        - Scan Period .
        type: int
      scan_threshold:
        description:
        - Minimum signal level/threshold in dBm required for the AP to report detected
          BLE device (-95 to -20).
        type: str
      scan_time:
        description:
        - Scan Time .
        type: int
      scan_type:
        choices:
        - active
        - passive
        description:
        - Scan Type .
        type: str
      scan_window:
        description:
        - Scan Windows .
        type: int
      txpower:
        choices:
        - '0'
        - '1'
        - '2'
        - '3'
        - '4'
        - '5'
        - '6'
        - '7'
        - '8'
        - '9'
        - '10'
        - '11'
        - '12'
        description:
        - Transmit power level .
        type: str
    type: dict

Outputs

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