fmgr_system_admin_profile – Admin profile.¶
New in version 2.10.
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 v6.0.0.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- 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
- 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
- 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
- system_admin_profile - Admin profile. type: dict
- adom-lock - ADOM locking type: str choices: [none, read, read-write] default: none
- adom-policy-packages - ADOM policy packages. type: str choices: [none, read, read-write] default: none
- adom-switch - Administrator domain. type: str choices: [none, read, read-write] default: none
- app-filter - App filter. type: str choices: [disable, enable] default: disable
- assignment - Assignment permission. type: str choices: [none, read, read-write] default: none
- change-password - Enable/disable restricted user to change self password. type: str choices: [disable, enable] default: disable
- config-retrieve - Configuration retrieve. type: str choices: [none, read, read-write] default: none
- config-revert - Revert Configuration from Revision History type: str choices: [none, read, read-write] default: none
- consistency-check - Consistency check. type: str choices: [none, read, read-write] default: none
- datamask - Enable/disable data masking. type: str choices: [disable, enable] default: disable
- datamask-custom-fields - No description for the parameter type: array
- field-category - No description for the parameter type: array choices: [log, fortiview, alert, ueba, all]
- field-name - Field name. type: str
- field-status - Field status. type: str choices: [disable, enable] default: enable
- field-type - Field type. type: str choices: [string, ip, mac, email, unknown] default: string
- datamask-custom-priority - Prioritize custom fields. type: str choices: [disable, enable] default: disable
- datamask-fields - No description for the parameter type: array choices: [user, srcip, srcname, srcmac, dstip, dstname, email, message, domain]
- datamask-key - No description for the parameter type: str
- deploy-management - Install to devices. type: str choices: [none, read, read-write] default: none
- description - Description. type: str
- device-ap - Manage AP. type: str choices: [none, read, read-write] default: none
- device-config - Manage device configurations. type: str choices: [none, read, read-write] default: none
- device-forticlient - Manage FortiClient. type: str choices: [none, read, read-write] default: none
- device-fortiswitch - Manage FortiSwitch. type: str choices: [none, read, read-write] default: none
- device-manager - Device manager. type: str choices: [none, read, read-write] default: none
- device-op - Device add/delete/edit. type: str choices: [none, read, read-write] default: none
- device-policy-package-lock - Device/Policy Package locking type: str choices: [none, read, read-write] default: none
- device-profile - Device profile permission. type: str choices: [none, read, read-write] default: none
- device-revision-deletion - Delete device revision. type: str choices: [none, read, read-write] default: none
- device-wan-link-load-balance - Manage WAN link load balance. type: str choices: [none, read, read-write] default: none
- event-management - Event management. type: str choices: [none, read, read-write] default: none
- fgd-center-advanced - FortiGuard Center Advanced. type: str choices: [none, read, read-write] default: none
- fgd-center-fmw-mgmt - FortiGuard Center Firmware Management. type: str choices: [none, read, read-write] default: none
- fgd-center-licensing - FortiGuard Center Licensing. type: str choices: [none, read, read-write] default: none
- fgd_center - FortiGuard Center. type: str choices: [none, read, read-write] default: none
- global-policy-packages - Global policy packages. type: str choices: [none, read, read-write] default: none
- import-policy-packages - Import Policy Package. type: str choices: [none, read, read-write] default: none
- intf-mapping - Interface Mapping type: str choices: [none, read, read-write] default: none
- ips-filter - IPS filter. type: str choices: [disable, enable] default: disable
- log-viewer - Log viewer. type: str choices: [none, read, read-write] default: none
- policy-objects - Policy objects permission. type: str choices: [none, read, read-write] default: none
- profileid - Profile ID. type: str
- read-passwd - View password in clear text. type: str choices: [none, read, read-write] default: none
- realtime-monitor - Realtime monitor. type: str choices: [none, read, read-write] default: none
- report-viewer - Report viewer. type: str choices: [none, read, read-write] default: none
- scope - Scope. type: str choices: [global, adom] default: global
- set-install-targets - Edit installation targets. type: str choices: [none, read, read-write] default: none
- system-setting - System setting. type: str choices: [none, read, read-write] default: none
- term-access - Terminal access. type: str choices: [none, read, read-write] default: none
- type - profile type. type: str choices: [system, restricted] default: system
- vpn-manager - VPN manager. type: str choices: [none, read, read-write] default: none
- web-filter - Web filter. type: str choices: [disable, enable] default: disable
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¶
- hosts: fortimanager-inventory
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
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
state: <value in [present, absent]>
system_admin_profile:
adom-lock: <value in [none, read, read-write]>
adom-policy-packages: <value in [none, read, read-write]>
adom-switch: <value in [none, read, read-write]>
app-filter: <value in [disable, enable]>
assignment: <value in [none, read, read-write]>
change-password: <value in [disable, enable]>
config-retrieve: <value in [none, read, read-write]>
config-revert: <value in [none, read, read-write]>
consistency-check: <value in [none, read, read-write]>
datamask: <value in [disable, enable]>
datamask-custom-fields:
-
field-category:
- log
- fortiview
- alert
- ueba
- all
field-name: <value of string>
field-status: <value in [disable, enable]>
field-type: <value in [string, ip, mac, ...]>
datamask-custom-priority: <value in [disable, enable]>
datamask-fields:
- user
- srcip
- srcname
- srcmac
- dstip
- dstname
- email
- message
- domain
datamask-key: <value of string>
deploy-management: <value in [none, read, read-write]>
description: <value of string>
device-ap: <value in [none, read, read-write]>
device-config: <value in [none, read, read-write]>
device-forticlient: <value in [none, read, read-write]>
device-fortiswitch: <value in [none, read, read-write]>
device-manager: <value in [none, read, read-write]>
device-op: <value in [none, read, read-write]>
device-policy-package-lock: <value in [none, read, read-write]>
device-profile: <value in [none, read, read-write]>
device-revision-deletion: <value in [none, read, read-write]>
device-wan-link-load-balance: <value in [none, read, read-write]>
event-management: <value in [none, read, read-write]>
fgd-center-advanced: <value in [none, read, read-write]>
fgd-center-fmw-mgmt: <value in [none, read, read-write]>
fgd-center-licensing: <value in [none, read, read-write]>
fgd_center: <value in [none, read, read-write]>
global-policy-packages: <value in [none, read, read-write]>
import-policy-packages: <value in [none, read, read-write]>
intf-mapping: <value in [none, read, read-write]>
ips-filter: <value in [disable, enable]>
log-viewer: <value in [none, read, read-write]>
policy-objects: <value in [none, read, read-write]>
profileid: <value of string>
read-passwd: <value in [none, read, read-write]>
realtime-monitor: <value in [none, read, read-write]>
report-viewer: <value in [none, read, read-write]>
scope: <value in [global, adom]>
set-install-targets: <value in [none, read, read-write]>
system-setting: <value in [none, read, read-write]>
term-access: <value in [none, read, read-write]>
type: <value in [system, restricted]>
vpn-manager: <value in [none, read, read-write]>
web-filter: <value in [disable, enable]>
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