fmgr_wtpprofile_eslsesdongle – ESL SES-imagotag dongle configuration.¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- enable_log - Enable/Disable logging for task type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0 type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
- adom - The parameter in requested url type: str required: true
- wtp-profile - The parameter in requested url type: str required: true
- wtpprofile_eslsesdongle - no description type: dict
- apc-addr-type - ESL SES-imagotag APC address type (default = fqdn). type: str choices: [fqdn, ip] more...
- apc-fqdn - FQDN of ESL SES-imagotag Access Point Controller (APC). type: str more...
- apc-ip - IP address of ESL SES-imagotag Access Point Controller (APC). type: str more...
- apc-port - Port of ESL SES-imagotag Access Point Controller (APC). type: int more...
- coex-level - ESL SES-imagotag dongle coexistence level (default = none). type: str choices: [none] more...
- compliance-level - Compliance levels for the ESL solution integration (default = compliance-level-2). type: str choices: [compliance-level-2] more...
- esl-channel - ESL SES-imagotag dongle channel (default = 127). type: str choices: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 127, -1] more...
- output-power - ESL SES-imagotag dongle output power (default = A). type: str choices: [a, b, c, d, e, f, g, h] more...
- scd-enable - Enable/disable ESL SES-imagotag Serial Communication Daemon (SCD) (default = disable). type: str choices: [disable, enable] more...
- tls-cert-verification - Enable/disable TLS certificate verification (default = enable). type: str choices: [disable, enable] more...
- tls-fqdn-verification - Enable/disable TLS certificate verification (default = disable). type: str choices: [disable, enable] more...
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: no description
fmgr_wtpprofile_eslsesdongle:
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>
wtp-profile: <your own value>
wtpprofile_eslsesdongle:
apc-addr-type: <value in [fqdn, ip]>
apc-fqdn: <value of string>
apc-ip: <value of string>
apc-port: <value of integer>
coex-level: <value in [none]>
compliance-level: <value in [compliance-level-2]>
esl-channel: <value in [0, 1, 2, ...]>
output-power: <value in [a, b, c, ...]>
scd-enable: <value in [disable, enable]>
tls-cert-verification: <value in [disable, enable]>
tls-fqdn-verification: <value in [disable, enable]>
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:
- request_url - The full url requested returned: always type: str sample: /sys/login/user
- response_code - The status of api request returned: always type: int sample: 0
- response_message - The descriptive message of the api response returned: always type: str sample: OK
- response_data - The data body of the api response returned: optional type: list or dict