fmgr_user_device – Configure devices.¶
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
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- adom - The parameter in requested url type: str required: true
- user_device - no description type: dict
- alias - Device alias. type: str more...
- avatar - Image file for avatar (maximum 4K base64 encoded). type: str more...
- category - Device category. type: str choices: [none, android-device, blackberry-device, fortinet-device, ios-device, windows-device, amazon-device] more...
- comment - Comment. type: str more...
- dynamic_mapping - Dynamic_Mapping. type: array
more...
- _scope - _Scope. type: array more...
- avatar - Image file for avatar (maximum 4K base64 encoded). type: str more...
- category - Family. type: str choices: [none, android-device, blackberry-device, fortinet-device, ios-device, windows-device, amazon-device] more...
- comment - Comment. type: str more...
- mac - Device MAC address. type: str more...
- master-device - Master device (optional). type: str more...
- tags - Tags. type: str more...
- type - Type. type: str choices: [ipad, iphone, gaming-console, blackberry-phone, blackberry-playbook, linux-pc, mac, windows-pc, android-phone, android-tablet, media-streaming, windows-phone, fortinet-device, ip-phone, router-nat-device, other-network-device, windows-tablet, printer, forticam, fortifone, unknown] more...
- user - User name. type: str more...
- family - Family. type: str more...
- hardware-vendor - Hardware-Vendor. type: str more...
- hardware-version - Hardware-Version. type: str more...
- os - Os. type: str more...
- software-version - Software-Version. type: str more...
- mac - Device MAC address(es). type: str more...
- master-device - Master device (optional). type: str more...
- tagging - Tagging. type: array more...
- type - Device type. type: str choices: [ipad, iphone, gaming-console, blackberry-phone, blackberry-playbook, linux-pc, mac, windows-pc, android-phone, android-tablet, media-streaming, windows-phone, fortinet-device, ip-phone, router-nat-device, other-network-device, windows-tablet, printer, forticam, fortifone, unknown] more...
- user - User name. type: str 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: fortimanager00
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configure devices.
fmgr_user_device:
bypass_validation: False
adom: ansible
state: present
user_device:
alias: ansible-test-device
category: android-device #<value in [none, android-device, blackberry-device, ...]>
comment: ansible-comment
mac: '00:11:22:33:44:55'
type: iphone #<value in [ipad, iphone, gaming-console, ...]>
- name: gathering fortimanager facts
hosts: fortimanager00
gather_facts: no
connection: httpapi
collections:
- fortinet.fortimanager
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: retrieve all the devices
fmgr_fact:
facts:
selector: 'user_device'
params:
adom: 'ansible'
device: 'your_value'
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