drmofu / drmofu.fortimanager / 2.2.2 / module / fmgr_user_devicegroup Configure device groups. | "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_devicegroup (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.
- hosts: fortimanager00 collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: Create User Device Group fmgr_user_devicegroup: adom: ansible state: 'present' user_devicegroup: name: ansible-test - name: Configure dynamic mappings of device group fmgr_user_devicegroup_dynamicmapping: bypass_validation: False adom: ansible device-group: ansible-test # name state: present user_devicegroup_dynamicmapping: _if_unmanaged: 10 _scope: - name: FGT_AWS # need a valid device name vdom: root # need a valid vdom name under the device comment: ansible-comment member: ios-device
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 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 user_devicegroup: description: the top level parameters set required: false suboptions: _if_unmanaged: description: no description type: int comment: description: Comment. type: str dynamic_mapping: description: description elements: dict suboptions: _if_unmanaged: description: no description type: int _scope: description: description elements: dict suboptions: name: description: no description type: str vdom: description: no description type: str type: list comment: description: no description type: str member: description: description elements: str type: list type: list member: description: Device group member. elements: str type: list name: description: Device group name. type: str tagging: description: description elements: dict suboptions: category: description: Tag category. type: str name: description: Tagging entry name. type: str tags: description: description type: str type: list type: dict 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