W3cubDocs

/Ansible 2.11

fortinet.fortimanager.fmgr_bleprofile – Configure Bluetooth Low Energy profile.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.0.1).

To install it use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_bleprofile.

New in version 2.10: of fortinet.fortimanager

Synopsis

  • This module is able to configure a FortiManager device.
  • Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter Choices/Defaults Comments
adom
string / required
the parameter (adom) in requested url
bleprofile
dictionary
the top level parameters set
advertising
list / elements=string
    Choices:
  • ibeacon
  • eddystone-uid
  • eddystone-url
no description
beacon-interval
integer
Beacon interval (default = 100 msec).
ble-scanning
string
    Choices:
  • disable
  • enable
Enable/disable Bluetooth Low Energy (BLE) scanning.
comment
string
Comment.
eddystone-instance
string
Eddystone instance ID.
eddystone-namespace
string
Eddystone namespace ID.
eddystone-url
string
Eddystone URL.
eddystone-url-encode-hex
string
Eddystone encoded URL hexadecimal string
ibeacon-uuid
string
Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
major-id
integer
Major ID.
minor-id
integer
Minor ID.
name
string
Bluetooth Low Energy profile name.
txpower
string
    Choices:
  • 0
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
Transmit power level (default = 0).
bypass_validation
boolean
    Choices:
  • no ←
  • yes
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
rc_failed
list / elements=string
the rc codes list with which the conditions to fail will be overriden
rc_succeeded
list / elements=string
the rc codes list with which the conditions to succeed will be overriden
state
string / required
    Choices:
  • present
  • absent
the directive to create, update or delete an object
workspace_locking_adom
string
the adom to lock for FortiManager running in workspace mode, the value can be global and others including root
workspace_locking_timeout
integer
Default:
300
the maximum time in seconds to wait for other user to release the workspace lock

Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
  • To create or update an object, use state present directive.
  • To delete an object, use state absent directive.
  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure Bluetooth Low Energy profile.
     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: <value in [present, absent]>
        bleprofile:
           advertising:
             - ibeacon
             - eddystone-uid
             - eddystone-url
           beacon-interval: <value of integer>
           ble-scanning: <value in [disable, enable]>
           comment: <value of string>
           eddystone-instance: <value of string>
           eddystone-namespace: <value of string>
           eddystone-url: <value of string>
           eddystone-url-encode-hex: <value of string>
           ibeacon-uuid: <value of string>
           major-id: <value of integer>
           minor-id: <value of integer>
           name: <value of string>
           txpower: <value in [0, 1, 2, ...]>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
request_url
string
always
The full url requested

Sample:
/sys/login/user
response_code
integer
always
The status of api request
response_message
string
always
The descriptive message of the api response

Sample:
OK.


Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_bleprofile_module.html