drmofu / drmofu.fortimanager / 2.2.2 / module / fmgr_user_device Configure devices. | "added in version" 2.0.0 of drmofu.fortimanager" Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu) preview | supported by communitydrmofu.fortimanager.fmgr_user_device (2.2.2) — module
Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2
collections: - name: drmofu.fortimanager version: 2.2.2
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.
- 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'
- 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, ...]>
adom: description: the parameter (adom) in requested url required: true type: str state: choices: - present - absent description: The directive to create, update or delete an object. required: true type: str rc_failed: description: The rc codes list with which the conditions to fail will be overriden. elements: int required: false type: list enable_log: default: false description: Enable/Disable logging for task. required: false type: bool user_device: description: the top level parameters set required: false suboptions: alias: description: Device alias. type: str avatar: description: Image file for avatar type: str category: choices: - none - android-device - blackberry-device - fortinet-device - ios-device - windows-device - amazon-device description: Device category. type: str comment: description: Comment. type: str dynamic_mapping: description: Dynamic_Mapping. elements: dict suboptions: _scope: description: _Scope. elements: dict suboptions: name: description: Name. type: str vdom: description: Vdom. type: str type: list avatar: description: Image file for avatar type: str category: choices: - none - android-device - blackberry-device - fortinet-device - ios-device - windows-device - amazon-device description: Family. type: str comment: description: Comment. type: str family: description: Family. type: str hardware-vendor: description: Hardware-Vendor. type: str hardware-version: description: Hardware-Version. type: str mac: description: Device MAC address. type: str master-device: description: Master device type: str os: description: Os. type: str software-version: description: Software-Version. type: str tags: description: Tags. type: str type: 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 description: Type. type: str user: description: User name. type: str type: list mac: description: Device MAC address type: str master-device: description: Master device type: str tagging: description: Tagging. elements: dict suboptions: category: description: Tag category. type: str name: description: Tagging entry name. type: str tags: description: Tags. type: str type: list tags: description: Applied object tags. type: str type: 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 description: Device type. type: str user: description: User name. type: str type: dict access_token: description: The token to access FortiManager without using username and password. required: false type: str rc_succeeded: description: The rc codes list with which the conditions to succeed will be overriden. elements: int required: false type: list proposed_method: choices: - update - set - add description: The overridden method for the underlying Json RPC request. required: false type: str bypass_validation: default: false description: Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. required: false type: bool workspace_locking_adom: description: The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. required: false type: str forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. required: false type: str workspace_locking_timeout: default: 300 description: The maximum time in seconds to wait for other user to release the workspace lock. required: false type: int
meta: contains: request_url: description: The full url requested. returned: always sample: /sys/login/user type: str response_code: description: The status of api request. returned: always sample: 0 type: int response_data: description: The api response. returned: always type: list response_message: description: The descriptive message of the api response. returned: always sample: OK. type: str system_information: description: The information of the target system. returned: always type: dict description: The result of the request. returned: always type: dict rc: description: The status the request. returned: always sample: 0 type: int version_check_warning: description: Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: complex type: list