fortinet.fortios.fortios_system_accprofile – Configure access profiles for system administrators in Fortinet’s FortiOS and FortiGate.

Note

This plugin is part of the fortinet.fortios collection (version 2.1.2).

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.

To use it in a playbook, specify: fortinet.fortios.fortios_system_accprofile.

New in version 2.10: of fortinet.fortios

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

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.9.0

Parameters

Parameter			Choices/Defaults	Comments
access_token string				Token-based authentication. Generated from GUI of Fortigate.
enable_log boolean			Choices: no ← yes	Enable/Disable logging for task.
state string / required			Choices: present absent	Indicates whether to create or remove the object.
system_accprofile dictionary				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 VDOM(s).
	secfabgrp string		Choices: none read read-write	Security Fabric.
	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.
	system_diagnostics string		Choices: enable disable	Enable/disable permission to run system diagnostic commands.
	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.
		emailfilter string	Choices: none read read-write	AntiSpam filter and settings.
		endpoint_control string	Choices: none read read-write	FortiClient Profiles.
		file_filter string	Choices: none read read-write	File-filter profiles and settings.
		icap string	Choices: none read read-write	ICAP profiles and settings.
		ips string	Choices: none read read-write	IPS profiles and settings.
		mmsgtp string	Choices: none read read-write	UTM permission.
		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.
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

Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure access profiles for system administrators.
    fortios_system_accprofile:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      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"
        system_diagnostics: "enable"
        utmgrp: "none"
        utmgrp_permission:
            antivirus: "none"
            application_control: "none"
            data_loss_prevention: "none"
            dnsfilter: "none"
            emailfilter: "none"
            endpoint_control: "none"
            file_filter: "none"
            icap: "none"
            ips: "none"
            mmsgtp: "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

Authors

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Hongbin Lu (@fgtdev-hblu)
Frank Shen (@frankshen01)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_system_accprofile_module.html