fortinet.fortios.fortios_system_accprofile module – Configure access profiles for system administrators in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.8).
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.fortios
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_system_accprofile
.
New in fortinet.fortios 2.0.0
Synopsis
This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and accprofile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15
Parameters
Parameter |
Comments |
---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
Configure access profiles for system administrators. |
|
Administrator timeout for this access profile (0 - 480 min). |
|
Enable/disable overriding the global administrator idle timeout. Choices:
|
|
Administrator access to Users and Devices. Choices:
|
|
Enable/disable permission to run config commands. Choices:
|
|
Enable/disable permission to run diagnostic commands. Choices:
|
|
Enable/disable permission to run execute commands. Choices:
|
|
Enable/disable permission to run get commands. Choices:
|
|
Enable/disable permission to run show commands. Choices:
|
|
Comment. |
|
FortiView. Choices:
|
|
Administrator access to the Firewall configuration. Choices:
|
|
Custom firewall permission. |
|
Address Configuration. Choices:
|
|
Other Firewall Configuration. Choices:
|
|
Policy Configuration. Choices:
|
|
Schedule Configuration. Choices:
|
|
Service Configuration. Choices:
|
|
Administrator access to Logging and Reporting including viewing log messages. Choices:
|
|
Custom Log & Report permission. |
|
Log & Report configuration. Choices:
|
|
Log & Report Data Access. Choices:
|
|
Log & Report Report Access. Choices:
|
|
Log & Report Threat Weight. Choices:
|
|
Profile name. |
|
Network Configuration. Choices:
|
|
Custom network permission. |
|
Network Configuration. Choices:
|
|
Packet Capture Configuration. Choices:
|
|
Router Configuration. Choices:
|
|
Scope of admin access: global or specific VDOM(s). Choices:
|
|
Security Fabric. Choices:
|
|
System Configuration. Choices:
|
|
Custom system permission. |
|
Administrator Users. Choices:
|
|
System Configuration. Choices:
|
|
Maintenance. Choices:
|
|
FortiGuard Updates. Choices:
|
|
Enable/disable permission to run system diagnostic commands. Choices:
|
|
Enable/disable permission to execute SSH commands. Choices:
|
|
Enable/disable permission to execute TELNET commands. Choices:
|
|
Administrator access to Security Profiles. Choices:
|
|
Custom Security Profile permissions. |
|
Antivirus profiles and settings. Choices:
|
|
Application Control profiles and settings. Choices:
|
|
Inline CASB filter profile and settings Choices:
|
|
DLP profiles and settings. Choices:
|
|
DLP profiles and settings. Choices:
|
|
DLP profiles and settings. Choices:
|
|
DNS Filter profiles and settings. Choices:
|
|
Email Filter and settings. Choices:
|
|
FortiClient Profiles. Choices:
|
|
File-filter profiles and settings. Choices:
|
|
ICAP profiles and settings. Choices:
|
|
IPS profiles and settings. Choices:
|
|
UTM permission. Choices:
|
|
AntiSpam filter and settings. Choices:
|
|
Video filter profiles and settings. Choices:
|
|
Virtual patch profiles and settings. Choices:
|
|
VoIP profiles and settings. Choices:
|
|
Web Application Firewall profiles and settings. Choices:
|
|
Web Filter profiles and settings. Choices:
|
|
Administrator access to IPsec, SSL, PPTP, and L2TP VPN. Choices:
|
|
Administrator access to WAN Opt & Cache. Choices:
|
|
Administrator access to the WiFi controller and Switch controller. Choices:
|
|
Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. Default: |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
The module supports check_mode.
Examples
- name: Configure access profiles for system administrators.
fortinet.fortios.fortios_system_accprofile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_accprofile:
admintimeout: "10"
admintimeout_override: "enable"
authgrp: "none"
cli_config: "enable"
cli_diagnose: "enable"
cli_exec: "enable"
cli_get: "enable"
cli_show: "enable"
comments: "<your_own_value>"
ftviewgrp: "none"
fwgrp: "none"
fwgrp_permission:
address: "none"
others: "none"
policy: "none"
schedule: "none"
service: "none"
loggrp: "none"
loggrp_permission:
config: "none"
data_access: "none"
report_access: "none"
threat_weight: "none"
name: "default_name_26"
netgrp: "none"
netgrp_permission:
cfg: "none"
packet_capture: "none"
route_cfg: "none"
scope: "vdom"
secfabgrp: "none"
sysgrp: "none"
sysgrp_permission:
admin: "none"
cfg: "none"
mnt: "none"
upd: "none"
system_diagnostics: "enable"
system_execute_ssh: "enable"
system_execute_telnet: "enable"
utmgrp: "none"
utmgrp_permission:
antivirus: "none"
application_control: "none"
casb: "none"
data_leak_prevention: "none"
data_loss_prevention: "none"
dlp: "none"
dnsfilter: "none"
emailfilter: "none"
endpoint_control: "none"
file_filter: "none"
icap: "none"
ips: "none"
mmsgtp: "none"
spamfilter: "none"
videofilter: "none"
virtual_patch: "none"
voip: "none"
waf: "none"
webfilter: "none"
vpngrp: "none"
wanoptgrp: "none"
wifi: "none"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |