fortinet.fortimanager.fmgr_user_device module – Configure devices.

Note

This module is part of the fortinet.fortimanager collection (version 2.8.2).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_user_device.

New in fortinet.fortimanager 2.0.0

Synopsis

  • 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.

Parameters

Parameter

Comments

access_token

string

The token to access FortiManager without using username and password.

adom

string / required

The parameter (adom) in requested url.

bypass_validation

boolean

Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters.

Choices:

  • false ← (default)

  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

The rc codes list with which the conditions to fail will be overriden.

rc_succeeded

list / elements=integer

The rc codes list with which the conditions to succeed will be overriden.

state

string / required

The directive to create, update or delete an object.

Choices:

  • "present"

  • "absent"

user_device

dictionary

The top level parameters set.

alias

string / required

Device alias.

avatar

string

Image file for avatar

category

string

Device category.

Choices:

  • "none"

  • "android-device"

  • "blackberry-device"

  • "fortinet-device"

  • "ios-device"

  • "windows-device"

  • "amazon-device"

comment

string

Comment.

dynamic_mapping

list / elements=dictionary

Dynamic mapping.

_scope

list / elements=dictionary

Scope.

name

string

Name.

vdom

string

Vdom.

avatar

string

Avatar.

category

string

Category.

Choices:

  • "none"

  • "android-device"

  • "blackberry-device"

  • "fortinet-device"

  • "ios-device"

  • "windows-device"

  • "amazon-device"

comment

string

Comment.

family

string

Family.

hardware_vendor

aliases: hardware-vendor

string

Hardware vendor.

hardware_version

aliases: hardware-version

string

Hardware version.

mac

string

Mac.

master_device

aliases: master-device

string

Master device.

os

string

Os.

software_version

aliases: software-version

string

Software version.

tags

any

(list or str) Tags.

type

string

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"

user

string

User.

mac

string

Device MAC address

master_device

aliases: master-device

string

Master device

tagging

list / elements=dictionary

Tagging.

category

string

Tag category.

name

string

Tagging entry name.

tags

any

(list) Tags.

tags

string

Applied object tags.

type

string

Device 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"

user

string

User name.

workspace_locking_adom

string

The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.

workspace_locking_timeout

integer

The maximum time in seconds to wait for other user to release the workspace lock.

Default: 300

Notes

Note

  • Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

  • 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

- name: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure devices.
      fortinet.fortimanager.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: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the devices
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "user_device"
          params:
            adom: "ansible"
            device: "your_value"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

meta

dictionary

The result of the request.

Returned: always

request_url

string

The full url requested.

Returned: always

Sample: "/sys/login/user"

response_code

integer

The status of api request.

Returned: always

Sample: 0

response_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)