faz_cli_system_admin_user – Admin user.

New in version 1.0.0.

Warning

Starting in version 2.0.0, all variables will be named in the underscore naming convention.

  • Possible variable names before 2.0.0: variable-name, variable name, variable.name

  • Corresponding variable names since 2.0.0: variable_name

FortiAnalyzer Ansible v1.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.

Synopsis

  • This module is able to configure a FortiAnalyzer 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.15.0

FortiAnalyzer Version Compatibility


6.2.0 6.2.1 6.2.2 6.2.3 6.2.4 6.2.5 6.2.6 6.2.7 6.2.8 6.2.9 6.2.10 6.2.11 6.2.12
None True True True None True True True True True True True True
6.4.0 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 6.4.6 6.4.7 6.4.8 6.4.9 6.4.10 6.4.11 6.4.12 6.4.13 6.4.14
None True True True True True True True True True True True True True True
7.0.0 7.0.1 7.0.2 7.0.3 7.0.4 7.0.5 7.0.6 7.0.7 7.0.8 7.0.9 7.0.10 7.0.11
True True True True True True True True True True True True
7.2.0 7.2.1 7.2.2 7.2.3 7.2.4
True True True True True
7.4.0 7.4.1 7.4.2
True True True

Parameters

  • access_token -The token to access FortiAnalyzer without using ansible_username and ansible_password. type: str required: false
  • enable_log - Enable/Disable logging for task type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud analyzer API users. type: str required: false
  • log_path - The path to save log. Used if enable_log is true. Please use absolute path instead of relative path. If the log_path setting is incorrect, the log will be saved in /tmp/fortianalyzer.ansible.logtype: str required: false default: "/tmp/fortianalyzer.ansible.log"
  • 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 FortiAnalyzer API structure, module continues to execute without validating parameters type: bool required: false default: False
  • 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
  • cli_system_admin_user - Admin user. type: dict
    • adom - No description for the parameter type: array more...
      • adom_name - Admin domain names. type: str more...
    • adom_exclude - No description for the parameter type: array more...
      • adom_name - Admin domain names. type: str more...
    • avatar - Image file for avatar (maximum 4K base64 encoded). type: str more...
    • ca - PKI user certificate CA (CA name in local). type: str more...
    • change_password - Enable/disable restricted user to change self password. type: str choices: [disable, enable] default: disable more...
    • dashboard - No description for the parameter type: array more...
      • column - Widgets column ID. type: int default: 0 more...
      • diskio_content_type - Disk I/O Monitor widgets chart type. type: str choices: [util, iops, blks] default: util more...
      • diskio_period - Disk I/O Monitor widgets data period. type: str choices: [1hour, 8hour, 24hour] default: 1hour more...
      • log_rate_period - Log receive monitor widgets data period. type: str choices: [2min , 1hour, 6hours] more...
      • log_rate_topn - Log receive monitor widgets number of top items to display. type: str choices: [1, 2, 3, 4, 5] default: 5 more...
      • log_rate_type - Log receive monitor widgets statistics breakdown options. type: str choices: [log, device] default: device more...
      • moduleid - Widget ID. type: int default: 0 more...
      • name - Widget name. type: str more...
      • num_entries - Number of entries. type: int default: 10 more...
      • refresh_interval - Widgets refresh interval. type: int default: 300 more...
      • res_cpu_display - Widgets CPU display type. type: str choices: [average , each] default: average more...
      • res_period - Widgets data period. type: str choices: [10min , hour, day] default: 10min more...
      • res_view_type - Widgets data view type. type: str choices: [real-time , history] default: history more...
      • status - Widgets opened/closed state. type: str choices: [close, open] default: open more...
      • tabid - ID of tab where widget is displayed. type: int default: 0 more...
      • time_period - Log Database Monitor widgets data period. type: str choices: [1hour, 8hour, 24hour] default: 1hour more...
      • widget_type - Widget type. type: str choices: [top-lograte, sysres, sysinfo, licinfo, jsconsole, sysop, alert, statistics, rpteng, raid, logrecv, devsummary, logdb-perf, logdb-lag, disk-io, log-rcvd-fwd] more...
    • dashboard_tabs - No description for the parameter type: array more...
      • name - Tab name. type: str more...
      • tabid - Tab ID. type: int default: 0 more...
    • description - Description. type: str more...
    • dev_group - device group. type: str more...
    • email_address - Email address. type: str more...
    • ext_auth_accprofile_override - Allow to use the access profile provided by the remote authentication server. type: str choices: [disable, enable] default: disable more...
    • ext_auth_adom_override - Allow to use the ADOM provided by the remote authentication server. type: str choices: [disable, enable] default: disable more...
    • ext_auth_group_match - Only administrators belonging to this group can login. type: str more...
    • first_name - First name. type: str more...
    • force_password_change - Enable/disable force password change on next login. type: str choices: [disable, enable] default: disable more...
    • group - Group name. type: str more...
    • hidden - Hidden administrator. type: int default: 0 more...
    • ipv6_trusthost1 - Admin user trusted host IPv6, default ::/0 for all. type: str default: ::/0 more...
    • ipv6_trusthost10 - Admin user trusted host IPv6, default ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 for none. type: str default: ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 more...
    • ipv6_trusthost2 - Admin user trusted host IPv6, default ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 for none. type: str default: ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 more...
    • ipv6_trusthost3 - Admin user trusted host IPv6, default ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 for none. type: str default: ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 more...
    • ipv6_trusthost4 - Admin user trusted host IPv6, default ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 for none. type: str default: ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 more...
    • ipv6_trusthost5 - Admin user trusted host IPv6, default ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 for none. type: str default: ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 more...
    • ipv6_trusthost6 - Admin user trusted host IPv6, default ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 for none. type: str default: ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 more...
    • ipv6_trusthost7 - Admin user trusted host IPv6, default ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 for none. type: str default: ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 more...
    • ipv6_trusthost8 - Admin user trusted host IPv6, default ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 for none. type: str default: ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 more...
    • ipv6_trusthost9 - Admin user trusted host IPv6, default ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 for none. type: str default: ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 more...
    • last_name - Last name. type: str more...
    • ldap_server - LDAP server name. type: str more...
    • meta_data - No description for the parameter type: array more...
      • fieldlength - Field length. type: int default: 0 more...
      • fieldname - Field name. type: str more...
      • fieldvalue - Field value. type: str more...
      • importance - Importance. type: str choices: [optional, required] default: optional more...
      • status - Status. type: str choices: [disabled, enabled] default: enabled more...
    • mobile_number - Mobile number. type: str more...
    • pager_number - Pager number. type: str more...
    • password - No description for the parameter type: str more...
    • password_expire - Password expire time in GMT. type: str more...
    • phone_number - Phone number. type: str more...
    • policy_package - No description for the parameter type: array more...
      • policy_package_name - Policy package names. type: str more...
    • profileid - Profile ID. type: str default: Restricted_User more...
    • radius_server - RADIUS server name. type: str more...
    • restrict_access - Enable/disable restricted access to development VDOM. type: str choices: [disable, enable] default: disable more...
    • restrict_dev_vdom - No description for the parameter type: array more...
      • dev_vdom - Device or device VDOM. type: str more...
    • rpc_permit - set none/read/read-write rpc-permission. type: str choices: [read-write, none, read, from-profile] default: none more...
    • ssh_public_key1 - No description for the parameter type: str more...
    • ssh_public_key2 - No description for the parameter type: str more...
    • ssh_public_key3 - No description for the parameter type: str more...
    • subject - PKI user certificate name constraints. type: str more...
    • tacacs_plus_server - TACACS+ server name. type: str more...
    • trusthost1 - Admin user trusted host IP, default 0. type: str default: 0.0.0.0 0.0.0.0 more...
    • trusthost10 - Admin user trusted host IP, default 255. type: str default: 255.255.255.255 255.255.255.255 more...
    • trusthost2 - Admin user trusted host IP, default 255. type: str default: 255.255.255.255 255.255.255.255 more...
    • trusthost3 - Admin user trusted host IP, default 255. type: str default: 255.255.255.255 255.255.255.255 more...
    • trusthost4 - Admin user trusted host IP, default 255. type: str default: 255.255.255.255 255.255.255.255 more...
    • trusthost5 - Admin user trusted host IP, default 255. type: str default: 255.255.255.255 255.255.255.255 more...
    • trusthost6 - Admin user trusted host IP, default 255. type: str default: 255.255.255.255 255.255.255.255 more...
    • trusthost7 - Admin user trusted host IP, default 255. type: str default: 255.255.255.255 255.255.255.255 more...
    • trusthost8 - Admin user trusted host IP, default 255. type: str default: 255.255.255.255 255.255.255.255 more...
    • trusthost9 - Admin user trusted host IP, default 255. type: str default: 255.255.255.255 255.255.255.255 more...
    • two_factor_auth - Enable 2-factor authentication (certificate + password). type: str choices: [disable, enable, password, ftc-ftm, ftc-email, ftc-sms] default: disable more...
    • user_type - User type. type: str choices: [local, radius, ldap, tacacs-plus, pki-auth, group, sso, api] default: local more...
    • userid - User name. type: str more...
    • wildcard - Enable/disable wildcard remote authentication. type: str choices: [disable, enable] default: disable more...
    • login_max - Max login session for this user. type: int default: 32 more...
    • fingerprint - PKI user certificate fingerprint (MD5, SHA1, SHA256) constraints. type: str more...
    • use_global_theme - Enable/disble global theme for administration GUI. type: str choices: [disable, enable] default: enable more...
    • user_theme - Color scheme to use for the admin user GUI. type: str choices: [blue, green, red, melongene, spring, summer, autumn, winter, circuit-board, calla-lily, binary-tunnel, mars, blue-sea, technology, landscape, twilight, canyon, northern-light, astronomy, fish, penguin, mountain, panda, parrot, cave, zebra, contrast-dark, mariner, jade, neutrino, dark-matter, forest, cat, graphite] default: blue more...
    • adom_access - set all/specify/exclude adom access mode. type: str choices: [all, specify, exclude, per-adom-profile] default: specify more...
    • th_from_profile - Internal use only: trusthostX from-profile flag type: int default: 0 more...
    • th6_from_profile - Internal use only: ipv6_trusthostX from-profile flag type: int default: 0 more...
    • cors_allow_origin - Access-Control-Allow-Origin. type: str more...

Notes

Note

  • 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
  connection: httpapi
  hosts: fortianalyzers
  tasks:
    - name: Admin user.
      fortinet.fortianalyzer.faz_cli_system_admin_user:
        cli_system_admin_user:
          change_password: disable
          description: "admin user created via Ansible"
          email_address: "foo@ansible.com"
          ext_auth_accprofile_override: disable
          ext_auth_adom_override: disable
          profileid: 1
          two_factor_auth: disable
          userid: fooadminuser
        state: present
  vars:
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false

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:

  • meta - The result of the request. returned: always type: dict
    • 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_data - The data body of the api response. returned: optional type: list or dict
    • response_message - The descriptive message of the api response. returned: always type: str sample: OK
    • system_information - The information of the target system. returned: always type: dict
  • rc - The status the request. returned: always type: int sample: 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current fortianalyzer version. returned: if params are not supported in the current version type: list

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Xinwei Du (@dux-fortinet)

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.