fortinet.fortimanager.fmgr_system_admin_profile module – Admin profile.
Note
This module is part of the fortinet.fortimanager collection (version 2.1.5).
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 version 2.10: of fortinet.fortimanager
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 |
|---|---|
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:
|
|
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 |
|
ADOM locking none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
ADOM policy packages. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Administrator domain. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Enable/disable the restricted user to install objects to the devices. disable - Disable setting. enable - Enable setting. Choices:
|
|
App filter. disable - Disable setting. enable - Enable setting. Choices:
|
|
Assignment permission. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Enable/disable restricted user to change self password. disable - Disable setting. enable - Enable setting. Choices:
|
|
Configuration retrieve. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Revert Configuration from Revision History none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
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:
|
|
Datamask-Custom-Fields. |
|
Field categories. Choices:
|
|
Field name. |
|
Field status. disable - Disable field. enable - Enable field. Choices:
|
|
Field type. string - String. ip - IP. mac - MAC address. email - Email address. unknown - Unknown. Choices:
|
|
Prioritize custom fields. disable - Disable custom field search priority. enable - Enable custom field search priority. Choices:
|
|
Data masking fields. Choices:
|
|
Data masking encryption key. |
|
Time in days without data masking. Default: 0 |
|
Install to devices. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Description. |
|
Manage AP. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Manage device configurations. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Manage FortiClient. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Manage FortiSwitch. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Device manager. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Device add/delete/edit. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Device/Policy Package locking none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Device profile permission. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Delete device revision. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Manage WAN link load balance. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Event management. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Manage extension access. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Fabric viewer. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
FortiGuard Center Advanced. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
FortiGuard Center Firmware Management. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
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:
|
|
Global policy packages. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Import Policy Package. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Interface Mapping none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
IPS filter. disable - Disable setting. enable - Enable setting. Choices:
|
|
Log viewer. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Policy objects permission. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Profile ID. |
|
View password in clear text. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Realtime monitor. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Report viewer. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Run reports. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Scope. global - Global scope. adom - ADOM scope. Choices:
|
|
Script access. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Edit installation targets. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Enable/disable super user profile disable - Disable super user profile enable - Enable super user profile Choices:
|
|
System setting. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Terminal access. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Triage events. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
profile type. system - System admin. restricted - Restricted admin. Choices:
|
|
Create/update incidents. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
VPN manager. none - No permission. read - Read permission. read-write - Read-write permission. Choices:
|
|
Web filter. disable - Disable setting. enable - Enable setting. Choices:
|
|
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: 300 |
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: gathering fortimanager facts
hosts: fortimanager00
gather_facts: no
connection: httpapi
collections:
- fortinet.fortimanager
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: retrieve all the admin profiles
fmgr_fact:
facts:
selector: 'system_admin_profile'
params:
profile: ''
- hosts: fortimanager00
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Admin profile.
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]>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The full url requested Returned: always Sample: “/sys/login/user” |
|
The status of api request Returned: always Sample: 0 |
|
The descriptive message of the api response Returned: always Sample: “OK.” |
Authors
Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)