# fortios_system_accprofile – Configure access profiles for system administrators in Fortinet’s FortiOS and FortiGate

New in version 2.8.

- Synopsis

- Requirements

- Parameters

- Notes

- Examples

- Return Values

- Status

## 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.5

## Requirements

The below requirements are needed on the host that executes this module.

- fortiosapi>=0.9.8

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
host string |  | FortiOS or FortiGate IP address.

https
boolean

Choices:
- no
- yes ←

Indicates if the requests towards FortiGate must use HTTPS protocol.

password string | Default: "" | FortiOS or FortiGate password.

ssl_verify
boolean
added in 2.9

Choices:
- no
- yes ←

Ensures FortiGate certificate must be verified by a proper CA.

state
string
added in 2.9

Choices:
- present
- absent

Indicates whether to create or remove the object. This attribute was present already in previous version in a deeper level. It has been moved out to this outer level.

system_accprofile dictionary | Default: null | Configure access profiles for system administrators.
| admintimeout integer |  | Administrator timeout for this access profile (0 - 480 min).

admintimeout_override
string

Choices:
- enable
- disable

Enable/disable overriding the global administrator idle timeout.

authgrp
string

Choices:
- none
- read
- read-write

Administrator access to Users and Devices.

| comments string |  | Comment.

ftviewgrp
string

Choices:
- none
- read
- read-write

FortiView.

fwgrp
string

Choices:
- none
- read
- read-write
- custom

Administrator access to the Firewall configuration.

| fwgrp_permission dictionary |  | Custom firewall permission.

address
string

Choices:
- none
- read
- read-write

Address Configuration.

policy
string

Choices:
- none
- read
- read-write

Policy Configuration.

schedule
string

Choices:
- none
- read
- read-write

Schedule Configuration.

service
string

Choices:
- none
- read
- read-write

Service Configuration.

loggrp
string

Choices:
- none
- read
- read-write
- custom

Administrator access to Logging and Reporting including viewing log messages.

| loggrp_permission dictionary |  | Custom Log & Report permission.

config
string

Choices:
- none
- read
- read-write

Log & Report configuration.

data_access
string

Choices:
- none
- read
- read-write

Log & Report Data Access.

report_access
string

Choices:
- none
- read
- read-write

Log & Report Report Access.

threat_weight
string

Choices:
- none
- read
- read-write

Log & Report Threat Weight.

| name string / required |  | Profile name.

netgrp
string

Choices:
- none
- read
- read-write
- custom

Network Configuration.

| netgrp_permission dictionary |  | Custom network permission.

cfg
string

Choices:
- none
- read
- read-write

Network Configuration.

packet_capture
string

Choices:
- none
- read
- read-write

Packet Capture Configuration.

route_cfg
string

Choices:
- none
- read
- read-write

Router Configuration.

scope
string

Choices:
- vdom
- global

Scope of admin access: global or specific VDOs.

secfabgrp
string

Choices:
- none
- read
- read-write

Security Fabric.

state
string

Choices:
- present
- absent

Deprecated
Starting with Ansible 2.9 we recommend using the top-level 'state' parameter.

Indicates whether to create or remove the object.

sysgrp
string

Choices:
- none
- read
- read-write
- custom

System Configuration.

| sysgrp_permission dictionary |  | Custom system permission.

admin
string

Choices:
- none
- read
- read-write

Administrator Users.

cfg
string

Choices:
- none
- read
- read-write

System Configuration.

mnt
string

Choices:
- none
- read
- read-write

Maintenance.

upd
string

Choices:
- none
- read
- read-write

FortiGuard Updates.

utmgrp
string

Choices:
- none
- read
- read-write
- custom

Administrator access to Security Profiles.

| utmgrp_permission dictionary |  | Custom Security Profile permissions.

antivirus
string

Choices:
- none
- read
- read-write

Antivirus profiles and settings.

application_control
string

Choices:
- none
- read
- read-write

Application Control profiles and settings.

data_loss_prevention
string

Choices:
- none
- read
- read-write

DLP profiles and settings.

dnsfilter
string

Choices:
- none
- read
- read-write

DNS Filter profiles and settings.

endpoint_control
string

Choices:
- none
- read
- read-write

FortiClient Profiles.

icap
string

Choices:
- none
- read
- read-write

ICAP profiles and settings.

ips
string

Choices:
- none
- read
- read-write

IPS profiles and settings.

spamfilter
string

Choices:
- none
- read
- read-write

AntiSpam filter and settings.

voip
string

Choices:
- none
- read
- read-write

VoIP profiles and settings.

waf
string

Choices:
- none
- read
- read-write

Web Application Firewall profiles and settings.

webfilter
string

Choices:
- none
- read
- read-write

Web Filter profiles and settings.

vpngrp
string

Choices:
- none
- read
- read-write

Administrator access to IPsec, SSL, PPTP, and L2TP VPN.

wanoptgrp
string

Choices:
- none
- read
- read-write

Administrator access to WAN Opt & Cache.

wifi
string

Choices:
- none
- read
- read-write

Administrator access to the WiFi controller and Switch controller.

username string |  | FortiOS or FortiGate username.
vdom string | Default: "root" | 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.

## Notes

Note

- Requires fortiosapi library developed by Fortinet

- Run as a local_action in your playbook

## Examples

    - hosts: localhost
      vars:
       host: "192.168.122.40"
       username: "admin"
       password: ""
       vdom: "root"
       ssl_verify: "False"
      tasks:
      - name: Configure access profiles for system administrators.
        fortios_system_accprofile:
          host:  "{{ host }}"
          username: "{{ username }}"
          password: "{{ password }}"
          vdom:  "{{ vdom }}"
          https: "False"
          state: "present"
          system_accprofile:
            admintimeout: "3"
            admintimeout_override: "enable"
            authgrp: "none"
            comments: "<your_own_value>"
            ftviewgrp: "none"
            fwgrp: "none"
            fwgrp_permission:
                address: "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_20"
            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"
            utmgrp: "none"
            utmgrp_permission:
                antivirus: "none"
                application_control: "none"
                data_loss_prevention: "none"
                dnsfilter: "none"
                endpoint_control: "none"
                icap: "none"
                ips: "none"
                spamfilter: "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 | Returned | Description
--- | --- | ---
build string | always | Build number of the fortigate image Sample: 1547
http_method string | always | Last method used to provision the content into FortiGate Sample: PUT
http_status string | always | Last result given by FortiGate on last operation applied Sample: 200
mkey string | success | Master key (id) used in the last call to FortiGate Sample: id
name string | always | Name of the table used to fulfill the request Sample: urlfilter
path string | always | Path of the table used to fulfill the request Sample: webfilter
revision string | always | Internal revision number Sample: 17.0.2.10658
serial string | always | Serial number of the unit Sample: FGVMEVYYQT3AB5352
status string | always | Indication of the operation's result Sample: success
vdom string | always | Virtual domain used Sample: root
version string | always | Version of the FortiGate Sample: v5.6.3

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]

- This module is maintained by the Ansible Community. [community]

### Authors

- Miguel Angel Munoz (@mamunozgonzalez)

- Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.