fmgr_system_admin_user – Admin user.
Added in version 2.0.0.
Warning
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
Argument name before 3.0.0:
var-name
,var name
,var.name
New argument name starting in 3.0.0:
var_name
FortiManager Ansible v2.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 FortiManager device.
Examples include all parameters and values need to be adjusted to data sources before usage.
Tested with FortiManager v7.x.
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15.0
FortiManager Version Compatibility
Supported Version Ranges: v6.0.0 -> latest
Parameters
- access_token -The token to access FortiManager without using username and password. type: str required: false
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- 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
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
- system_admin_user - Admin user. type: dict
- adom Adom. type: list
more...
- adom_name (Alias name: adom-name) Admin domain names. type: str more...
- adom_exclude (Alias name: adom-exclude) Adom exclude. type: list
more...
- adom_name (Alias name: adom-name) Admin domain names. type: str more...
- app_filter (Alias name: app-filter) App filter. type: list
more...
- app_filter_name (Alias name: app-filter-name) App filter name. 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 (Alias name: change-password) Enable/disable restricted user to change self password. type: str choices: [disable, enable] default: disable more...
- dashboard Dashboard. type: list
more...
- column Widgets column id. type: int default: 0 more...
- diskio_content_type (Alias name: diskio-content-type) Disk i/o monitor widgets chart type. type: str choices: [util, iops, blks] default: util more...
- diskio_period (Alias name: diskio-period) Disk i/o monitor widgets data period. type: str choices: [1hour, 8hour, 24hour] default: 1hour more...
- log_rate_period (Alias name: log-rate-period) Log receive monitor widgets data period. type: str choices: [2min, 1hour, 6hours] more...
- log_rate_topn (Alias name: 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 (Alias name: 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 (Alias name: num-entries) Number of entries. type: int default: 10 more...
- refresh_interval (Alias name: refresh-interval) Widgets refresh interval. type: int default: 300 more...
- res_cpu_display (Alias name: res-cpu-display) Widgets cpu display type. type: str choices: [average, each] default: average more...
- res_period (Alias name: res-period) Widgets data period. type: str choices: [10min, hour, day] default: 10min more...
- res_view_type (Alias name: 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 (Alias name: time-period) Log database monitor widgets data period. type: str choices: [1hour, 8hour, 24hour] default: 1hour more...
- widget_type (Alias name: 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 (Alias name: dashboard-tabs) Dashboard tabs. type: list more...
- description Description. type: str more...
- dev_group (Alias name: dev-group) Device group. type: str more...
- email_address (Alias name: email-address) Email address. type: str more...
- ext_auth_accprofile_override (Alias name: 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 (Alias name: 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 (Alias name: ext-auth-group-match) Only administrators belonging to this group can login. type: str more...
- first_name (Alias name: first-name) First name. type: str more...
- force_password_change (Alias name: 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...
- ips_filter (Alias name: ips-filter) Ips filter. type: list
more...
- ips_filter_name (Alias name: ips-filter-name) Ips filter name. type: str 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 (Alias name: last-name) Last name. type: str more...
- ldap_server (Alias name: ldap-server) Ldap server name. type: str more...
- meta_data (Alias name: meta-data) Meta data. type: list
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 (Alias name: mobile-number) Mobile number. type: str more...
- pager_number (Alias name: pager-number) Pager number. type: str more...
- password Password. type: list more...
- password_expire (Alias name: password-expire) Password expire time in gmt. type: list or str more...
- phone_number (Alias name: phone-number) Phone number. type: str more...
- policy_package (Alias name: policy-package) Policy package. type: list
more...
- policy_package_name (Alias name: 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 (Alias name: restrict-access) Enable/disable restricted access to development vdom. type: str choices: [disable, enable] default: disable more...
- restrict_dev_vdom (Alias name: restrict-dev-vdom) Restrict dev vdom. type: list
more...
- dev_vdom (Alias name: dev-vdom) Device or device vdom. type: str more...
- rpc_permit (Alias name: rpc-permit) Set none/read/read-write rpc-permission. type: str choices: [read-write, none, read, from-profile] default: none more...
- ssh_public_key1 (Alias name: ssh-public-key1) Ssh public key 1. type: list more...
- ssh_public_key2 (Alias name: ssh-public-key2) Ssh public key 2. type: list more...
- ssh_public_key3 (Alias name: ssh-public-key3) Ssh public key 3. type: list more...
- subject Pki user certificate name constraints. type: str more...
- tacacs_plus_server (Alias name: 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 (Alias name: 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...
- web_filter (Alias name: web-filter) Web filter. type: list
more...
- web_filter_name (Alias name: web-filter-name) Web filter name. type: str more...
- wildcard Enable/disable wildcard remote authentication. type: str choices: [disable, enable] default: disable more...
- login_max (Alias name: login-max) Max login session for this user. type: int default: 32 more...
- use_global_theme (Alias name: use-global-theme) Enable/disble global theme for administration gui. type: str choices: [disable, enable] default: enable more...
- user_theme (Alias name: 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 (Alias name: adom-access) Set all/specify/exclude adom access mode. type: str choices: [all, specify, exclude, per-adom-profile] default: specify more...
- fingerprint Pki user certificate fingerprint (md5, sha1, sha256) constraints. type: str more...
- th_from_profile (Alias name: th-from-profile) Internal use only: trusthostx from-profile flag type: int default: 0 more...
- th6_from_profile (Alias name: th6-from-profile) Internal use only: ipv6_trusthostx from-profile flag type: int default: 0 more...
- cors_allow_origin (Alias name: cors-allow-origin) Access-control-allow-origin. type: str more...
- fortiai Enable/disble fortiai. type: str choices: [disable, enable] default: disable more...
- policy_block (Alias name: policy-block) Policy block. type: list
more...
- policy_block_name (Alias name: policy-block-name) Policy block names. type: str more...
Notes
Note
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: Admin User
fortinet.fortimanager.fmgr_system_admin_user:
state: present
system_admin_user:
adom:
- adom-name: ansible
userid: "ansible-test"
- name: Admin domain.
fortinet.fortimanager.fmgr_system_admin_user_adom:
bypass_validation: false
user: ansible-test # userid
state: present
system_admin_user_adom:
adom-name: "ALL ADOMS"
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 FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status
This module is not guaranteed to have a backwards compatible interface.