fortinet.fortimanager.fmgr_system_admin_profile module – Admin profile.
Note
This module is part of the fortinet.fortimanager collection (version 2.7.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install fortinet.fortimanager
.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_system_admin_profile
.
New in fortinet.fortimanager 2.0.0
Synopsis
This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
Parameter |
Comments |
---|---|
The token to access FortiManager without using username and password. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The directive to create, update or delete an object. Choices:
|
|
The top level parameters set. |
|
Deprecated, please rename it to adom_admin. Enable Adom Admin. disable - Disable setting. enable - Enable setting. Choices:
|
|
Deprecated, please rename it to adom_lock. ADOM locking none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Deprecated, please rename it to adom_policy_packages. ADOM policy packages. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Deprecated, please rename it to adom_switch. Administrator domain. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Deprecated, please rename it to allow_to_install. Enable/disable the restricted user to install objects to the devices. disable - Disable setting. enable - Enable setting. Choices:
|
|
Deprecated, please rename it to app_filter. App filter. disable - Disable setting. enable - Enable setting. Choices:
|
|
Assignment permission. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Deprecated, please rename it to change_password. Enable/disable restricted user to change self password. disable - Disable setting. enable - Enable setting. Choices:
|
|
Deprecated, please rename it to config_retrieve. Configuration retrieve. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Deprecated, please rename it to config_revert. Revert Configuration from Revision History none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Deprecated, please rename it to consistency_check. Consistency check. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Enable/disable data masking. disable - Disable data masking. enable - Enable data masking. Choices:
|
|
Deprecated, please rename it to datamask_custom_fields. Datamask custom fields. |
|
Deprecated, please rename it to field_category. Field categories. log - Log. fortiview - FortiView. alert - Event management. ueba - UEBA. all - All. Choices:
|
|
Deprecated, please rename it to field_name. Field name. |
|
Deprecated, please rename it to field_status. Field status. disable - Disable field. enable - Enable field. Choices:
|
|
Deprecated, please rename it to field_type. Field type. string - String. ip - IP. mac - MAC address. email - Email address. unknown - Unknown. Choices:
|
|
Deprecated, please rename it to datamask_custom_priority. Prioritize custom fields. disable - Disable custom field search priority. enable - Enable custom field search priority. Choices:
|
|
Deprecated, please rename it to datamask_fields. Data masking fields. user - User name. srcip - Source IP. srcname - Source name. srcmac - Source MAC. dstip - Destination IP. dstname - Dst name. email - Email. message - Message. domain - Domain. Choices:
|
|
(list) Deprecated, please rename it to datamask_key. Data masking encryption key. |
|
Deprecated, please rename it to datamask_unmasked_time. Time in days without data masking. |
|
Deprecated, please rename it to deploy_management. Install to devices. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Description. |
|
Deprecated, please rename it to device_ap. Manage AP. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Deprecated, please rename it to device_config. Manage device configurations. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Deprecated, please rename it to device_forticlient. Manage FortiClient. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Deprecated, please rename it to device_fortiextender. Manage FortiExtender. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Deprecated, please rename it to device_fortiswitch. Manage FortiSwitch. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Deprecated, please rename it to device_manager. Device manager. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Deprecated, please rename it to device_op. Device add/delete/edit. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Deprecated, please rename it to device_policy_package_lock. Device/Policy Package locking none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Deprecated, please rename it to device_profile. Device profile permission. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Deprecated, please rename it to device_revision_deletion. Delete device revision. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Deprecated, please rename it to device_wan_link_load_balance. Manage WAN link load balance. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Deprecated, please rename it to event_management. Event management. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Deprecated, please rename it to extension_access. Manage extension access. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Deprecated, please rename it to fabric_viewer. Fabric viewer. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Deprecated, please rename it to fgd_center_advanced. FortiGuard Center Advanced. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Deprecated, please rename it to fgd_center_fmw_mgmt. FortiGuard Center Firmware Management. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Deprecated, please rename it to fgd_center_licensing. FortiGuard Center Licensing. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
FortiGuard Center. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Deprecated, please rename it to fgt_gui_proxy. FortiGate GUI proxy. disable - No permission. enable - With permission. Choices:
|
|
Deprecated, please rename it to global_policy_packages. Global policy packages. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Deprecated, please rename it to import_policy_packages. Import Policy Package. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Deprecated, please rename it to intf_mapping. Interface Mapping none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Deprecated, please rename it to ips_baseline_cfg. Ips baseline sensor configration. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Deprecated, please rename it to ips_baseline_ovrd. Enable/disable override baseline ips sensor. disable - Disable setting. enable - Enable setting. Choices:
|
|
Deprecated, please rename it to ips_filter. IPS filter. disable - Disable setting. enable - Enable setting. Choices:
|
|
Deprecated, please rename it to ips_lock. IPS locking none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Deprecated, please rename it to ips_objects. Ips objects configuration. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Admin user trusted host IPv6, default |
|
Admin user trusted host IPv6, default ffff |
|
Admin user trusted host IPv6, default ffff |
|
Admin user trusted host IPv6, default ffff |
|
Admin user trusted host IPv6, default ffff |
|
Admin user trusted host IPv6, default ffff |
|
Admin user trusted host IPv6, default ffff |
|
Admin user trusted host IPv6, default ffff |
|
Admin user trusted host IPv6, default ffff |
|
Admin user trusted host IPv6, default ffff |
|
Deprecated, please rename it to log_viewer. Log viewer. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Deprecated, please rename it to policy_ips_attrs. Policy ips attributes configuration. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Deprecated, please rename it to policy_objects. Policy objects permission. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Profile ID. |
|
Deprecated, please rename it to read_passwd. View password in clear text. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Deprecated, please rename it to realtime_monitor. Realtime monitor. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Deprecated, please rename it to report_viewer. Report viewer. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Deprecated, please rename it to rpc_permit. Set none/read/read-write rpc-permission read-write - Read-write permission. none - No permission. read - Read-only permission. Choices:
|
|
Deprecated, please rename it to run_report. Run reports. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Scope. global - Global scope. adom - ADOM scope. Choices:
|
|
Deprecated, please rename it to script_access. Script access. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Deprecated, please rename it to set_install_targets. Edit installation targets. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Deprecated, please rename it to super_user_profile. Enable/disable super user profile disable - Disable super user profile enable - Enable super user profile Choices:
|
|
Deprecated, please rename it to system_setting. System setting. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Deprecated, please rename it to term_access. Terminal access. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Deprecated, please rename it to triage_events. Triage events. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Admin user trusted host IP, default 0. |
|
Admin user trusted host IP, default 255. |
|
Admin user trusted host IP, default 255. |
|
Admin user trusted host IP, default 255. |
|
Admin user trusted host IP, default 255. |
|
Admin user trusted host IP, default 255. |
|
Admin user trusted host IP, default 255. |
|
Admin user trusted host IP, default 255. |
|
Admin user trusted host IP, default 255. |
|
Admin user trusted host IP, default 255. |
|
profile type. system - System admin. restricted - Restricted admin. Choices:
|
|
Deprecated, please rename it to update_incidents. Create/update incidents. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Deprecated, please rename it to vpn_manager. VPN manager. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Deprecated, please rename it to web_filter. Web filter. disable - Disable setting. enable - Enable setting. Choices:
|
|
Deprecated, please rename it to write_passwd_access. set all/specify-by-user/specify-by-profile write password access mode. all - All except super users. specify-by-user - Specify by user. specify-by-profile - Specify by profile. Choices:
|
|
Deprecated, please rename it to write_passwd_profiles. Write passwd profiles. |
|
Profile ID. |
|
Deprecated, please rename it to write_passwd_user_list. Write passwd user list. |
|
User ID. |
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
Notes
Note
Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
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 profile.
fortinet.fortimanager.fmgr_system_admin_profile:
bypass_validation: false
state: present
system_admin_profile:
description: ansible-test-description
profileid: ansible-test-profile
scope: adom # <value in [global, adom]>
type: system # <value in [system, restricted]>
- name: Gathering fortimanager facts
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Retrieve all the admin profiles
fortinet.fortimanager.fmgr_fact:
facts:
selector: "system_admin_profile"
params:
profile: "your_value"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |