faz_cli_system_admin_user.rst

source

faz_cli_system_admin_user.py

orphan

faz_cli_system_admin_user -- Admin user.

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

Supported Version Ranges: v6.2.1 -> latest

Parameters

• access_token The token to access FortiAnalyzer without using ansible_username and ansible_password. type: str
• bypass_validation Only set to True when module schema diffs with FortiAnalyzer API structure, module continues to execute without validating parameters type: bool default: False
• enable_log Enable/Disable logging for task type: bool default: False
• forticloud_access_token Access token of forticloud analyzer API users. type: str
• 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 default: "/tmp/fortianalyzer.ansible.log"
• proposed_method The overridden method for the underlying Json RPC request type: str choices: set, update, add
• version_check If set to True, it will check whether the parameters used are supported by the corresponding version of FortiAnazlyer locally based on FNDN data. A warning will be returned in version_check_warning if there is a mismatch. This warning is only a suggestion and may not be accurate. type: bool default: False
• rc_succeeded The rc codes list with which the conditions to succeed will be overriden type: list
• rc_failed The rc codes list with which the conditions to fail will be overriden type: list
• 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 type: list of dict more...

  Supported Version Ranges: v6.2.1 -> latest

  • adom_name Admin domain names. type: str more...

    Supported Version Ranges: v6.2.1 -> latest

• adom_exclude type: list of dict more...

  Supported Version Ranges: v6.2.1 -> v7.0.2

  • adom_name Admin domain names. type: str more...

    Supported Version Ranges: v6.2.1 -> v7.0.2

• avatar Image file for avatar (maximum 4K base64 encoded). type: str more...

  Supported Version Ranges: v6.2.1 -> latest

• ca PKI user certificate CA (CA name in local). type: str more...

  Supported Version Ranges: v6.2.1 -> latest

• change_password Enable/disable restricted user to change self password. type: str choices: [disable, enable] default: disable more...

  Supported Version Ranges: v6.2.1 -> latest

• dashboard type: list of dict more...

  Supported Version Ranges: v6.2.1 -> latest

  • column Widgets column ID. type: int default: 0 more...

    Supported Version Ranges: v6.2.1 -> latest

  • diskio_content_type Disk I/O Monitor widgets chart type. type: str choices: [util, iops, blks] default: util more...

    Supported Version Ranges: v6.2.1 -> latest

  • diskio_period Disk I/O Monitor widgets data period. type: str choices: [1hour, 8hour, 24hour] default: 1hour more...

    Supported Version Ranges: v6.2.1 -> latest

  • log_rate_period Log receive monitor widgets data period. type: str choices: [2min , 1hour, 6hours] more...

    Supported Version Ranges: v6.2.1 -> latest

  • log_rate_topn Log receive monitor widgets number of top items to display. type: str choices: [1, 2, 3, 4, 5] default: 5 more...

    Supported Version Ranges: v6.2.1 -> latest

  • log_rate_type Log receive monitor widgets statistics breakdown options. type: str choices: [log, device] default: device more...

    Supported Version Ranges: v6.2.1 -> latest

  • moduleid Widget ID. type: int default: 0 more...

    Supported Version Ranges: v6.2.1 -> latest

  • name Widget name. type: str more...

    Supported Version Ranges: v6.2.1 -> latest

  • num_entries Number of entries. type: int default: 10 more...

    Supported Version Ranges: v6.2.1 -> latest

  • refresh_interval Widgets refresh interval. type: int default: 300 more...

    Supported Version Ranges: v6.2.1 -> latest

  • res_cpu_display Widgets CPU display type. type: str choices: [average , each] default: average more...

    Supported Version Ranges: v6.2.1 -> latest

  • res_period Widgets data period. type: str choices: [10min , hour, day] default: 10min more...

    Supported Version Ranges: v6.2.1 -> latest

  • res_view_type Widgets data view type. type: str choices: [real-time , history] default: history more...

    Supported Version Ranges: v6.2.1 -> latest

  • status Widgets opened/closed state. type: str choices: [close, open] default: open more...

    Supported Version Ranges: v6.2.1 -> latest

  • tabid ID of tab where widget is displayed. type: int default: 0 more...

    Supported Version Ranges: v6.2.1 -> latest

  • time_period Log Database Monitor widgets data period. type: str choices: [1hour, 8hour, 24hour] default: 1hour more...

    Supported Version Ranges: v6.2.1 -> latest

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

    Supported Version Ranges: v6.2.1 -> latest

• dashboard_tabs type: list of dict more...

  Supported Version Ranges: v6.2.1 -> latest

  • name Tab name. type: str more...

    Supported Version Ranges: v6.2.1 -> latest

  • tabid Tab ID. type: int default: 0 more...

    Supported Version Ranges: v6.2.1 -> latest

• description Description. type: str more...

  Supported Version Ranges: v6.2.1 -> latest

• dev_group device group. type: str more...

  Supported Version Ranges: v6.2.1 -> latest

• email_address Email address. type: str more...

  Supported Version Ranges: v6.2.1 -> latest

• ext_auth_accprofile_override Allow to use the access profile provided by the remote authentication server. type: str choices: [disable, enable] default: disable more...

  Supported Version Ranges: v6.2.1 -> latest

• ext_auth_adom_override Allow to use the ADOM provided by the remote authentication server. type: str choices: [disable, enable] default: disable more...

  Supported Version Ranges: v6.2.1 -> latest

• ext_auth_group_match Only administrators belonging to this group can login. type: str more...

  Supported Version Ranges: v6.2.1 -> latest

• first_name First name. type: str more...

  Supported Version Ranges: v6.2.1 -> latest

• force_password_change Enable/disable force password change on next login. type: str choices: [disable, enable] default: disable more...

  Supported Version Ranges: v6.2.1 -> latest

• group Group name. type: str more...

  Supported Version Ranges: v6.2.1 -> latest

• hidden Hidden administrator. type: int default: 0 more...

  Supported Version Ranges: v6.2.1 -> latest

• ipv6_trusthost1 Admin user trusted host IPv6, default ::/0 for all. type: str default: ::/0 more...

  Supported Version Ranges: v6.2.1 -> latest

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

  Supported Version Ranges: v6.2.1 -> latest

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

  Supported Version Ranges: v6.2.1 -> latest

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

  Supported Version Ranges: v6.2.1 -> latest

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

  Supported Version Ranges: v6.2.1 -> latest

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

  Supported Version Ranges: v6.2.1 -> latest

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

  Supported Version Ranges: v6.2.1 -> latest

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

  Supported Version Ranges: v6.2.1 -> latest

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

  Supported Version Ranges: v6.2.1 -> latest

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

  Supported Version Ranges: v6.2.1 -> latest

• last_name Last name. type: str more...

  Supported Version Ranges: v6.2.1 -> latest

• ldap_server LDAP server name. type: str more...

  Supported Version Ranges: v6.2.1 -> latest

• meta_data type: list of dict more...

  Supported Version Ranges: v6.2.1 -> latest

  • fieldlength Field length. type: int default: 0 more...

    Supported Version Ranges: v6.2.1 -> latest

  • fieldname Field name. type: str more...

    Supported Version Ranges: v6.2.1 -> latest

  • fieldvalue Field value. type: str more...

    Supported Version Ranges: v6.2.1 -> latest

  • importance Importance. type: str choices: [optional, required] default: optional more...

    Supported Version Ranges: v6.2.1 -> latest

  • status Status. type: str choices: [disabled, enabled] default: enabled more...

    Supported Version Ranges: v6.2.1 -> latest

• mobile_number Mobile number. type: str more...

  Supported Version Ranges: v6.2.1 -> latest

• pager_number Pager number. type: str more...

  Supported Version Ranges: v6.2.1 -> latest

• password Password. type: str elements: str more...

  Supported Version Ranges: v6.2.1 -> latest

• password_expire Password expire time in GMT. type: str more...

  Supported Version Ranges: v6.2.1 -> latest

• phone_number Phone number. type: str more...

  Supported Version Ranges: v6.2.1 -> latest

• policy_package type: list of dict more...

  Supported Version Ranges: v6.2.1 -> latest

  • policy_package_name Policy package names. type: str more...

    Supported Version Ranges: v6.2.1 -> latest

• profileid Profile ID. type: str default: Restricted_User more...

  Supported Version Ranges: v6.2.1 -> latest

• radius_server RADIUS server name. type: str more...

  Supported Version Ranges: v6.2.1 -> latest

• restrict_access Enable/disable restricted access to development VDOM. type: str choices: [disable, enable] default: disable more...

  Supported Version Ranges: v6.2.1 -> v6.2.3

• restrict_dev_vdom type: list of dict more...

  Supported Version Ranges: v6.2.1 -> v6.2.3

  • dev_vdom Device or device VDOM. type: str more...

    Supported Version Ranges: v6.2.1 -> v6.2.3

• rpc_permit set none/read/read-write rpc-permission. type: str choices: [read-write, none, read, from-profile] default: none more...

  Supported Version Ranges: v6.2.1 -> latest

• ssh_public_key1 SSH public key 1. type: str elements: str more...

  Supported Version Ranges: v6.2.1 -> latest

• ssh_public_key2 SSH public key 2. type: str elements: str more...

  Supported Version Ranges: v6.2.1 -> latest

• ssh_public_key3 SSH public key 3. type: str elements: str more...

  Supported Version Ranges: v6.2.1 -> latest

• subject PKI user certificate name constraints. type: str more...

  Supported Version Ranges: v6.2.1 -> latest

• tacacs_plus_server TACACS+ server name. type: str more...

  Supported Version Ranges: v6.2.1 -> latest

• trusthost1 Admin user trusted host IP, default 0.0.0.0 0.0.0.0 for all. type: str default: 0.0.0.0 0.0.0.0 more...

  Supported Version Ranges: v6.2.1 -> latest

• trusthost10 Admin user trusted host IP, default 255.255.255.255 255.255.255.255 for none. type: str default: 255.255.255.255 255.255.255.255 more...

  Supported Version Ranges: v6.2.1 -> latest

• trusthost2 Admin user trusted host IP, default 255.255.255.255 255.255.255.255 for none. type: str default: 255.255.255.255 255.255.255.255 more...

  Supported Version Ranges: v6.2.1 -> latest

• trusthost3 Admin user trusted host IP, default 255.255.255.255 255.255.255.255 for none. type: str default: 255.255.255.255 255.255.255.255 more...

  Supported Version Ranges: v6.2.1 -> latest

• trusthost4 Admin user trusted host IP, default 255.255.255.255 255.255.255.255 for none. type: str default: 255.255.255.255 255.255.255.255 more...

  Supported Version Ranges: v6.2.1 -> latest

• trusthost5 Admin user trusted host IP, default 255.255.255.255 255.255.255.255 for none. type: str default: 255.255.255.255 255.255.255.255 more...

  Supported Version Ranges: v6.2.1 -> latest

• trusthost6 Admin user trusted host IP, default 255.255.255.255 255.255.255.255 for none. type: str default: 255.255.255.255 255.255.255.255 more...

  Supported Version Ranges: v6.2.1 -> latest

• trusthost7 Admin user trusted host IP, default 255.255.255.255 255.255.255.255 for none. type: str default: 255.255.255.255 255.255.255.255 more...

  Supported Version Ranges: v6.2.1 -> latest

• trusthost8 Admin user trusted host IP, default 255.255.255.255 255.255.255.255 for none. type: str default: 255.255.255.255 255.255.255.255 more...

  Supported Version Ranges: v6.2.1 -> latest

• trusthost9 Admin user trusted host IP, default 255.255.255.255 255.255.255.255 for none. type: str default: 255.255.255.255 255.255.255.255 more...

  Supported Version Ranges: v6.2.1 -> latest

• two_factor_auth Enable 2-factor authentication (certificate + password). type: str choices: [disable, enable, password, ftc-ftm, ftc-email, ftc-sms] default: disable more...

  Supported Version Ranges: v6.2.1 -> latest

• user_type User type. type: str choices: [local, radius, ldap, tacacs-plus, pki-auth, group, sso, api] default: local more...

  Supported Version Ranges: v6.2.1 -> latest

• userid User name. type: str more...

  Supported Version Ranges: v6.2.1 -> latest

• wildcard Enable/disable wildcard remote authentication. type: str choices: [disable, enable] default: disable more...

  Supported Version Ranges: v6.2.1 -> latest

• login_max Max login session for this user. type: int default: 32 more...

  Supported Version Ranges: v6.4.6 -> latest

• fingerprint PKI user certificate fingerprint (MD5, SHA1, SHA256) constraints. type: str more...

  Supported Version Ranges: v6.4.8 -> v6.4.14, v7.0.4 -> latest

• use_global_theme Enable/disble global theme for administration GUI. type: str choices: [disable, enable] default: enable more...

  Supported Version Ranges: v7.0.0 -> latest

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

  Supported Version Ranges: v7.0.0 -> latest

• adom_access set all/specify/exclude adom access mode. type: str choices: [all, specify, exclude, per-adom-profile] default: specify more...

  Supported Version Ranges: v7.0.3 -> latest

• th_from_profile Internal use only: trusthostX from-profile flag type: int default: 0 more...

  Supported Version Ranges: v7.0.3 -> latest

• th6_from_profile Internal use only: ipv6_trusthostX from-profile flag type: int default: 0 more...

  Supported Version Ranges: v7.0.3 -> latest

• cors_allow_origin Access-Control-Allow-Origin. type: str more...

  Supported Version Ranges: v7.2.2 -> latest

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)
• Maxx Liu (@MaxxLiu22)
• Link Zheng (@chillancezen)
• Jie Xue (@JieX19)
• Frank Shen (@fshen01)
• Hongbin Lu (@fgtdev-hblu)