faz_cli_system_admin_profile – Admin profile.¶

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_profile 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_profile - Admin profile. type: dict

adom-lock - ADOM locking type: str choices: [none, read, read-write] 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

adom-lock True True True True True True True True True True True True
adom-switch - Administrator domain. type: str choices: [none, read, read-write] 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

adom-switch True True True True True True True True True True True True
allow-to-install - Enable/disable the restricted user to install objects to the devices. type: str choices: [disable, enable] default: enable 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

allow-to-install True False False False False True True True True True True True
change-password - Enable/disable the 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
datamask - Enable/disable data masking. 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

datamask True True True True True True True True True True True True
datamask-custom-fields - 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

datamask-custom-fields True True True True True True True True True True True True
- field-category - No description for the parameter type: array choices: [log, fortiview, alert, ueba, all] 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
  
  field-category True True True True True True True True True True True True
- field-name - 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
  
  field-name True True True True True True True True True True True True
- field-status - Field status. type: str choices: [disable, enable] default: enable 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
  
  field-status True True True True True True True True True True True True
- field-type - Field type. type: str choices: [string, ip, mac, email, unknown] default: string 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
  
  field-type True True True True True True True True True True True True
datamask-custom-priority - Prioritize custom fields. 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

datamask-custom-priority True True True True True True True True True True True True
datamask-fields - No description for the parameter type: array choices: [user, srcip, srcname, srcmac, dstip, dstname, email, message, domain] 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

datamask-fields True True True True True True True True True True True True
datamask-key - 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

datamask-key True True True True True True True True True True True True
datamask-unmasked-time - Time in days without data masking. 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

datamask-unmasked-time 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
device-ap - Manage AP. type: str choices: [none, read, read-write] 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

device-ap True True True True True True True True True True True True
device-forticlient - Manage FortiClient. type: str choices: [none, read, read-write] 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

device-forticlient True True True True True True True True True True True True
device-fortiswitch - Manage FortiSwitch. type: str choices: [none, read, read-write] 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

device-fortiswitch True True True True True True True True True True True True
device-manager - Device manager. type: str choices: [none, read, read-write] 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

device-manager True True True True True True True True True True True True
device-op - Device add/delete/edit. type: str choices: [none, read, read-write] 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

device-op True True True True True True True True True True True True
device-policy-package-lock - Device/Policy Package locking type: str choices: [none, read, read-write] 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

device-policy-package-lock True True True True True True True True True True True True
device-wan-link-load-balance - Manage WAN link load balance. type: str choices: [none, read, read-write] 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

device-wan-link-load-balance True True True True True True True True True True True True
event-management - Event management. type: str choices: [none, read, read-write] 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

event-management True True True True True True True True True True True True
fortirecorder-setting - FortiRecorder settings. type: str choices: [none, read, read-write] 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

fortirecorder-setting True True True True True True True True True True True True
log-viewer - Log viewer. type: str choices: [none, read, read-write] 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

log-viewer True True True True True True True True True True True True
profileid - Profile ID. 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

profileid True True True True True True True True True True True True
realtime-monitor - Realtime monitor. type: str choices: [none, read, read-write] 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

realtime-monitor True True True True True True True True True True True True
report-viewer - Report viewer. type: str choices: [none, read, read-write] 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

report-viewer True True True True True True True True True True True True
scope - Scope. type: str choices: [global, adom] default: global 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

scope True True True True True True True True True True True True
super-user-profile - Enable/disable super user profile 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

super-user-profile True True True True True True True True True True True True
system-setting - System setting. type: str choices: [none, read, read-write] 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

system-setting True True True True True True True True True True True True
execute-playbook - Execute playbook. type: str choices: [none, read, read-write] default: none more...

7.0.0 7.2.0

execute-playbook True True
extension-access - Manage extension access. type: str choices: [none, read, read-write] default: none more...

7.0.0 7.2.0

extension-access True True
fabric-viewer - Fabric viewer. type: str choices: [none, read, read-write] default: none more...

7.0.0 7.2.0

fabric-viewer True True
run-report - Run reports. type: str choices: [none, read, read-write] default: none more...

7.0.0 7.2.0

run-report True True
script-access - Script access. type: str choices: [none, read, read-write] default: none more...

7.0.0 7.2.0

script-access True True
triage-events - Triage events. type: str choices: [none, read, read-write] default: none more...

7.0.0 7.2.0

triage-events True True
update-incidents - Create/update incidents. type: str choices: [none, read, read-write] default: none more...

7.0.0 7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

ipv6_trusthost9 True
rpc-permit - Set none/read/read-write rpc-permission type: str choices: [read-write, none, read] default: none more...

7.2.0

rpc-permit True
trusthost1 - Admin user trusted host IP, default 0. type: str default: 0.0.0.0 0.0.0.0 more...

7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

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

7.2.0

trusthost9 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_profile:
      cli_system_admin_profile:
        allow-to-install: disable
        change-password: disable
        datamask: disable
        profileid: 1
      state: present
    name: Admin profile.
  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.

	`7.0.0`	`7.2.0`
execute-playbook	True	True

	`7.0.0`	`7.2.0`
extension-access	True	True

	`7.0.0`	`7.2.0`
fabric-viewer	True	True

	`7.0.0`	`7.2.0`
run-report	True	True