faz_cli_system_admin_profile – Admin profile.
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_profile - Admin profile. type: dict
- adom_lock - ADOM locking type: str choices: [none, read, read-write] default: none more...
- adom_switch - Administrator domain. type: str choices: [none, read, read-write] default: none more...
- allow_to_install - Enable/disable the restricted user to install objects to the devices. type: str choices: [disable, enable] default: enable more...
- change_password - Enable/disable the user to change self password. type: str choices: [disable, enable] default: disable more...
- datamask - Enable/disable data masking. type: str choices: [disable, enable] default: disable more...
- datamask_custom_fields - No description for the parameter type: array
more...
- field_category - No description for the parameter type: array choices: [log, fortiview, alert, ueba, all] more...
- field_name - Field name. type: str more...
- field_status - Field status. type: str choices: [disable, enable] default: enable more...
- field_type - Field type. type: str choices: [string, ip, mac, email, unknown] default: string more...
- datamask_custom_priority - Prioritize custom fields. type: str choices: [disable, enable] default: disable more...
- datamask_fields - No description for the parameter type: array choices: [user, srcip, srcname, srcmac, dstip, dstname, email, message, domain] more...
- datamask_key - No description for the parameter type: str more...
- datamask_unmasked_time - Time in days without data masking. type: int default: 0 more...
- description - Description. type: str more...
- device_ap - Manage AP. type: str choices: [none, read, read-write] default: none more...
- device_forticlient - Manage FortiClient. type: str choices: [none, read, read-write] default: none more...
- device_fortiswitch - Manage FortiSwitch. type: str choices: [none, read, read-write] default: none more...
- device_manager - Device manager. type: str choices: [none, read, read-write] default: none more...
- device_op - Device add/delete/edit. type: str choices: [none, read, read-write] default: none more...
- device_policy_package_lock - Device/Policy Package locking type: str choices: [none, read, read-write] default: none more...
- device_wan_link_load_balance - Manage WAN link load balance. type: str choices: [none, read, read-write] default: none more...
- event_management - Event management. type: str choices: [none, read, read-write] default: none more...
- fortirecorder_setting - FortiRecorder settings. type: str choices: [none, read, read-write] default: none more...
- log_viewer - Log viewer. type: str choices: [none, read, read-write] default: none more...
- profileid - Profile ID. type: str more...
- realtime_monitor - Realtime monitor. type: str choices: [none, read, read-write] default: none more...
- report_viewer - Report viewer. type: str choices: [none, read, read-write] default: none more...
- scope - Scope. type: str choices: [global, adom] default: global more...
- super_user_profile - Enable/disable super user profile type: str choices: [disable, enable] default: disable more...
- system_setting - System setting. type: str choices: [none, read, read-write] default: none more...
- fabric_viewer - Fabric viewer. type: str choices: [none, read, read-write] default: none more...
- execute_playbook - Execute playbook. type: str choices: [none, read, read-write] default: none more...
- extension_access - Manage extension access. type: str choices: [none, read, read-write] default: none more...
- run_report - Run reports. type: str choices: [none, read, read-write] default: none more...
- script_access - Script access. type: str choices: [none, read, read-write] default: none more...
- triage_events - Triage events. type: str choices: [none, read, read-write] default: none more...
- update_incidents - Create/update incidents. type: str choices: [none, read, read-write] default: none more...
- ips_baseline_ovrd - Enable/disable override baseline ips sensor. type: str choices: [disable, enable] default: disable 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...
- rpc_permit - Set none/read/read-write rpc-permission type: str choices: [read-write, none, read] default: none 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...
- device_fortiextender - Manage FortiExtender. type: str choices: [none, read, read-write] default: none more...
- ips_lock - IPS locking type: str choices: [none, read, read-write] default: none more...
- fgt_gui_proxy - FortiGate GUI proxy. type: str choices: [disable, enable] default: disable more...
- write_passwd_access - set all/specify-by-user/specify-by-profile write password access mode. type: str choices: [all, specify-by-user, specify-by-profile] default: all more...
- write_passwd_profiles - No description for the parameter type: array
more...
- profileid - Profile ID. type: str more...
- write_passwd_user_list - No description for the parameter type: array
more...
- userid - User ID. 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 profile.
fortinet.fortianalyzer.faz_cli_system_admin_profile:
cli_system_admin_profile:
allow_to_install: disable
change_password: disable
datamask: disable
profileid: 1
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.