faz_cli_system_admin_user – Admin user.¶

New in version 2.10.

Synopsis
Requirements
FortiAnalyzer Version Compatibility
Parameters
Notes
Examples
Return Values
Status
Authors

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

FortiAnalyzer Version Compatibility ¶

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

cli_system_admin_user yes yes yes yes yes yes yes yes yes yes yes yes

Parameters ¶

enable_log - Enable/Disable logging for task type: bool required: false default: False
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...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

adom True True True True True True True True True True True True
- adom-name - Admin domain names. type: str more...
  
  6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
  
  adom-name True True True True True True True True True True True True
adom-exclude - No description for the parameter type: array more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

adom-exclude True True True True True True True True True True True False
- adom-name - Admin domain names. type: str more...
  
  6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
  
  adom-name True True True True True True True True True True True False
avatar - Image file for avatar (maximum 4K base64 encoded). type: str more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

avatar True True True True True True True True True True True True
ca - PKI user certificate CA (CA name in local). type: str more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

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

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

change-password True True True True True True True True True True True True
dashboard - No description for the parameter type: array more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

dashboard True True True True True True True True True True True True
- column - Widgets column ID. type: int default: 0 more...
  
  6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
  
  column True True True True True True True True True True True True
- diskio-content-type - Disk I/O Monitor widgets chart type. type: str choices: [util, iops, blks] default: util more...
  
  6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
  
  diskio-content-type True True True True True True True True True True True True
- diskio-period - Disk I/O Monitor widgets data period. type: str choices: [1hour, 8hour, 24hour] default: 1hour more...
  
  6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
  
  diskio-period True True True True True True True True True True True True
- log-rate-period - Log receive monitor widgets data period. type: str choices: [2min , 1hour, 6hours] more...
  
  6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
  
  log-rate-period True True True True True True True True True True True True
- log-rate-topn - Log receive monitor widgets number of top items to display. type: str choices: [1, 2, 3, 4, 5] default: 5 more...
  
  6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
  
  log-rate-topn True True True True True True True True True True True True
- log-rate-type - Log receive monitor widgets statistics breakdown options. type: str choices: [log, device] default: device more...
  
  6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
  
  log-rate-type True True True True True True True True True True True True
- moduleid - Widget ID. type: int default: 0 more...
  
  6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
  
  moduleid True True True True True True True True True True True True
- name - Widget name. type: str more...
  
  6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
  
  name True True True True True True True True True True True True
- num-entries - Number of entries. type: int default: 10 more...
  
  6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
  
  num-entries True True True True True True True True True True True True
- refresh-interval - Widgets refresh interval. type: int default: 300 more...
  
  6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
  
  refresh-interval True True True True True True True True True True True True
- res-cpu-display - Widgets CPU display type. type: str choices: [average , each] default: average more...
  
  6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
  
  res-cpu-display True True True True True True True True True True True True
- res-period - Widgets data period. type: str choices: [10min , hour, day] default: 10min more...
  
  6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
  
  res-period True True True True True True True True True True True True
- res-view-type - Widgets data view type. type: str choices: [real-time , history] default: history more...
  
  6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
  
  res-view-type True True True True True True True True True True True True
- status - Widgets opened/closed state. type: str choices: [close, open] default: open more...
  
  6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
  
  status True True True True True True True True True True True True
- tabid - ID of tab where widget is displayed. type: int default: 0 more...
  
  6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
  
  tabid True True True True True True True True True True True True
- time-period - Log Database Monitor widgets data period. type: str choices: [1hour, 8hour, 24hour] default: 1hour more...
  
  6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
  
  time-period True True True True True True True True True True True True
- 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...
  
  6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
  
  widget-type True True True True True True True True True True True True
dashboard-tabs - No description for the parameter type: array more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

dashboard-tabs True True True True True True True True True True True True
- name - Tab name. type: str more...
  
  6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
  
  name True True True True True True True True True True True True
- tabid - Tab ID. type: int default: 0 more...
  
  6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
  
  tabid True True True True True True True True True True True True
description - Description. type: str more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

description True True True True True True True True True True True True
dev-group - device group. type: str more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

dev-group True True True True True True True True True True True True
email-address - Email address. type: str more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

email-address True True True True True True True True True True True True
ext-auth-accprofile-override - Allow to use the access profile provided by the remote authentication server. type: str choices: [disable, enable] default: disable more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

ext-auth-accprofile-override True True True True True True True True True True True True
ext-auth-adom-override - Allow to use the ADOM provided by the remote authentication server. type: str choices: [disable, enable] default: disable more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

ext-auth-adom-override True True True True True True True True True True True True
ext-auth-group-match - Only administrators belonging to this group can login. type: str more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

ext-auth-group-match True True True True True True True True True True True True
first-name - First name. type: str more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

first-name True True True True True True True True True True True True
force-password-change - Enable/disable force password change on next login. type: str choices: [disable, enable] default: disable more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

force-password-change True True True True True True True True True True True True
group - Group name. type: str more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

group True True True True True True True True True True True True
hidden - Hidden administrator. type: int default: 0 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

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

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

ipv6_trusthost1 True True True True True True True True True True True True
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...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

ipv6_trusthost10 True True True True True True True True True True True True
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...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

ipv6_trusthost2 True True True True True True True True True True True True
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...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

ipv6_trusthost3 True True True True True True True True True True True True
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...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

ipv6_trusthost4 True True True True True True True True True True True True
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...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

ipv6_trusthost5 True True True True True True True True True True True True
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...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

ipv6_trusthost6 True True True True True True True True True True True True
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...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

ipv6_trusthost7 True True True True True True True True True True True True
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...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

ipv6_trusthost8 True True True True True True True True True True True True
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...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

ipv6_trusthost9 True True True True True True True True True True True True
last-name - Last name. type: str more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

last-name True True True True True True True True True True True True
ldap-server - LDAP server name. type: str more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

ldap-server True True True True True True True True True True True True
meta-data - No description for the parameter type: array more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

meta-data True True True True True True True True True True True True
- fieldlength - Field length. type: int default: 0 more...
  
  6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
  
  fieldlength True True True True True True True True True True True True
- fieldname - Field name. type: str more...
  
  6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
  
  fieldname True True True True True True True True True True True True
- fieldvalue - Field value. type: str more...
  
  6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
  
  fieldvalue True True True True True True True True True True True True
- importance - Importance. type: str choices: [optional, required] default: optional more...
  
  6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
  
  importance True True True True True True True True True True True True
- status - Status. type: str choices: [disabled, enabled] default: enabled more...
  
  6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
  
  status True True True True True True True True True True True True
mobile-number - Mobile number. type: str more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

mobile-number True True True True True True True True True True True True
pager-number - Pager number. type: str more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

pager-number True True True True True True True True True True True True
password - No description for the parameter type: str more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

password True True True True True True True True True True True True
password-expire - Password expire time in GMT. type: str more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

password-expire True True True True True True True True True True True True
phone-number - Phone number. type: str more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

phone-number True True True True True True True True True True True True
policy-package - No description for the parameter type: array more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

policy-package True True True True True True True True True True True True
- policy-package-name - Policy package names. type: str more...
  
  6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
  
  policy-package-name True True True True True True True True True True True True
profileid - Profile ID. type: str default: Restricted_User more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

profileid True True True True True True True True True True True True
radius_server - RADIUS server name. type: str more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

radius_server True True True True True True True True True True True True
restrict-access - Enable/disable restricted access to development VDOM. type: str choices: [disable, enable] default: disable more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

restrict-access True True True False False False False False False False False False
restrict-dev-vdom - No description for the parameter type: array more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

restrict-dev-vdom True True True False False False False False False False False False
- dev-vdom - Device or device VDOM. type: str more...
  
  6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
  
  dev-vdom True True True False False False False False False False False False
rpc-permit - set none/read/read-write rpc-permission. type: str choices: [read-write, none, read, from-profile] default: none more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

rpc-permit True True True True True True True True True True True True
ssh-public-key1 - No description for the parameter type: str more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

ssh-public-key1 True True True True True True True True True True True True
ssh-public-key2 - No description for the parameter type: str more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

ssh-public-key2 True True True True True True True True True True True True
ssh-public-key3 - No description for the parameter type: str more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

ssh-public-key3 True True True True True True True True True True True True
subject - PKI user certificate name constraints. type: str more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

subject True True True True True True True True True True True True
tacacs-plus-server - TACACS+ server name. type: str more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

tacacs-plus-server True True True True True True True True True True True True
trusthost1 - Admin user trusted host IP, default 0. type: str default: 0.0.0.0 0.0.0.0 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

trusthost1 True True True True True True True True True True True True
trusthost10 - Admin user trusted host IP, default 255. type: str default: 255.255.255.255 255.255.255.255 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

trusthost10 True True True True True True True True True True True True
trusthost2 - Admin user trusted host IP, default 255. type: str default: 255.255.255.255 255.255.255.255 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

trusthost2 True True True True True True True True True True True True
trusthost3 - Admin user trusted host IP, default 255. type: str default: 255.255.255.255 255.255.255.255 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

trusthost3 True True True True True True True True True True True True
trusthost4 - Admin user trusted host IP, default 255. type: str default: 255.255.255.255 255.255.255.255 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

trusthost4 True True True True True True True True True True True True
trusthost5 - Admin user trusted host IP, default 255. type: str default: 255.255.255.255 255.255.255.255 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

trusthost5 True True True True True True True True True True True True
trusthost6 - Admin user trusted host IP, default 255. type: str default: 255.255.255.255 255.255.255.255 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

trusthost6 True True True True True True True True True True True True
trusthost7 - Admin user trusted host IP, default 255. type: str default: 255.255.255.255 255.255.255.255 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

trusthost7 True True True True True True True True True True True True
trusthost8 - Admin user trusted host IP, default 255. type: str default: 255.255.255.255 255.255.255.255 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

trusthost8 True True True True True True True True True True True True
trusthost9 - Admin user trusted host IP, default 255. type: str default: 255.255.255.255 255.255.255.255 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

trusthost9 True True True True True True True True True True True True
two-factor-auth - Enable 2-factor authentication (certificate + password). type: str choices: [disable, enable] default: disable more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

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

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

user_type True True True True True True True True True True True True
userid - User name. type: str more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

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

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

wildcard True True True True True True True True True True True True
login-max - Max login session for this user. type: int default: 32 more...

7.0.0 7.2.0

login-max True True
use-global-theme - Enable/disble global theme for administration GUI. type: str choices: [disable, enable] default: enable more...

7.0.0 7.2.0

use-global-theme True True
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] default: blue more...

7.0.0 7.2.0

user-theme True True
adom-access - set all/specify/exclude adom access mode. type: str choices: [all, specify, exclude] default: specify more...

7.2.0

adom-access True
fingerprint - PKI user certificate fingerprint (MD5, SHA1, SHA256) constraints. type: str more...

7.2.0

fingerprint True
th-from-profile - Internal use only: trusthostX from-profile flag type: int default: 0 more...

7.2.0

th-from-profile True
th6-from-profile - Internal use only: ipv6_trusthostX from-profile flag type: int default: 0 more...

7.2.0

th6-from-profile True

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 ¶

- collections:
  - fortinet.fortianalyzer
  connection: httpapi
  hosts: fortianalyzer-inventory
  tasks:
  - 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
    name: Admin user.
  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:

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_message - The descriptive message of the api response returned: always type: str sample: OK
response_data - The data body of the api response returned: optional type: list or dict

Status ¶

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

Authors ¶

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.