ansible / ansible.builtin / v2.9.17 / module / fortios_user_device Configure devices in Fortinet's FortiOS and FortiGate. | "added in version" 2.9 of ansible.builtin" Authors: Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico) preview | supported by communityansible.builtin.fortios_user_device (v2.9.17) — module
pip
Install with pip install ansible==2.9.17
This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and device category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5
- hosts: localhost vars: host: "192.168.122.40" username: "admin" password: "" vdom: "root" ssl_verify: "False" tasks: - name: Configure devices. fortios_user_device: host: "{{ host }}" username: "{{ username }}" password: "{{ password }}" vdom: "{{ vdom }}" https: "False" state: "present" user_device: alias: "<your_own_value>" avatar: "<your_own_value>" category: "none" comment: "Comment." mac: "<your_own_value>" master_device: "<your_own_value> (source user.device.alias)" tagging: - category: "<your_own_value> (source system.object-tagging.category)" name: "default_name_11" tags: - name: "default_name_13 (source system.object-tagging.tags.name)" type: "unknown" user: "<your_own_value>"
host: description: - FortiOS or FortiGate IP address. required: false type: str vdom: default: root description: - Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. type: str https: default: true description: - Indicates if the requests towards FortiGate must use HTTPS protocol. type: bool state: choices: - present - absent description: - Indicates whether to create or remove the object. required: true type: str password: default: '' description: - FortiOS or FortiGate password. type: str username: description: - FortiOS or FortiGate username. required: false type: str ssl_verify: default: true description: - Ensures FortiGate certificate must be verified by a proper CA. type: bool user_device: default: null description: - Configure devices. suboptions: alias: description: - Device alias. required: true type: str avatar: description: - Image file for avatar (maximum 4K base64 encoded). type: str category: choices: - none - amazon-device - android-device - blackberry-device - fortinet-device - ios-device - windows-device description: - Device category. type: str comment: description: - Comment. type: str mac: description: - Device MAC address. type: str master_device: description: - Master device (optional). Source user.device.alias. type: str tagging: description: - Config object tagging. suboptions: category: description: - Tag category. Source system.object-tagging.category. type: str name: description: - Tagging entry name. required: true type: str tags: description: - Tags. suboptions: name: description: - Tag name. Source system.object-tagging.tags.name. required: true type: str type: list type: list type: choices: - unknown - android-phone - android-tablet - blackberry-phone - blackberry-playbook - forticam - fortifone - fortinet-device - gaming-console - ip-phone - ipad - iphone - linux-pc - mac - media-streaming - printer - router-nat-device - windows-pc - windows-phone - windows-tablet - other-network-device description: - Device type. type: str user: description: - User name. type: str type: dict
build: description: Build number of the fortigate image returned: always sample: '1547' type: str http_method: description: Last method used to provision the content into FortiGate returned: always sample: PUT type: str http_status: description: Last result given by FortiGate on last operation applied returned: always sample: '200' type: str mkey: description: Master key (id) used in the last call to FortiGate returned: success sample: id type: str name: description: Name of the table used to fulfill the request returned: always sample: urlfilter type: str path: description: Path of the table used to fulfill the request returned: always sample: webfilter type: str revision: description: Internal revision number returned: always sample: 17.0.2.10658 type: str serial: description: Serial number of the unit returned: always sample: FGVMEVYYQT3AB5352 type: str status: description: Indication of the operation's result returned: always sample: success type: str vdom: description: Virtual domain used returned: always sample: root type: str version: description: Version of the FortiGate returned: always sample: v5.6.3 type: str