fortinet.fortimanager.fmgr_system_admin_profile – Admin profile.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.1.4).

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

bypass_validation

boolean

only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters

Choices:

  • no ← (default)

  • yes

enable_log

boolean

Enable/Disable logging for task

Choices:

  • no ← (default)

  • yes

proposed_method

string

The overridden method for the underlying Json RPC request

Choices:

  • update

  • set

  • add

rc_failed

list / elements=string

the rc codes list with which the conditions to fail will be overriden

rc_succeeded

list / elements=string

the rc codes list with which the conditions to succeed will be overriden

state

string / required

the directive to create, update or delete an object

Choices:

  • present

  • absent

system_admin_profile

dictionary

the top level parameters set

adom-lock

string

ADOM locking

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • none ← (default)

  • read

  • read-write

adom-policy-packages

string

ADOM policy packages.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • none ← (default)

  • read

  • read-write

adom-switch

string

Administrator domain.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • none ← (default)

  • read

  • read-write

allow-to-install

string

Enable/disable the restricted user to install objects to the devices.

disable - Disable setting.

enable - Enable setting.

Choices:

  • disable

  • enable ← (default)

app-filter

string

App filter.

disable - Disable setting.

enable - Enable setting.

Choices:

  • disable ← (default)

  • enable

assignment

string

Assignment permission.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • none ← (default)

  • read

  • read-write

change-password

string

Enable/disable restricted user to change self password.

disable - Disable setting.

enable - Enable setting.

Choices:

  • disable ← (default)

  • enable

config-retrieve

string

Configuration retrieve.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • none ← (default)

  • read

  • read-write

config-revert

string

Revert Configuration from Revision History

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • none ← (default)

  • read

  • read-write

consistency-check

string

Consistency check.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • none ← (default)

  • read

  • read-write

datamask

string

Enable/disable data masking.

disable - Disable data masking.

enable - Enable data masking.

Choices:

  • disable ← (default)

  • enable

datamask-custom-fields

list / elements=string

Datamask-Custom-Fields.

field-category

list / elements=string

Field categories.

Choices:

  • log

  • fortiview

  • alert

  • ueba

  • all

field-name

string

Field name.

field-status

string

Field status.

disable - Disable field.

enable - Enable field.

Choices:

  • disable

  • enable ← (default)

field-type

string

Field type.

string - String.

ip - IP.

mac - MAC address.

email - Email address.

unknown - Unknown.

Choices:

  • string ← (default)

  • ip

  • mac

  • email

  • unknown

datamask-custom-priority

string

Prioritize custom fields.

disable - Disable custom field search priority.

enable - Enable custom field search priority.

Choices:

  • disable ← (default)

  • enable

datamask-fields

list / elements=string

Data masking fields.

Choices:

  • user

  • srcip

  • srcname

  • srcmac

  • dstip

  • dstname

  • email

  • message

  • domain

datamask-key

string

Data masking encryption key.

datamask-unmasked-time

integer

Time in days without data masking.

Default: 0

deploy-management

string

Install to devices.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • none ← (default)

  • read

  • read-write

description

string

Description.

device-ap

string

Manage AP.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • none ← (default)

  • read

  • read-write

device-config

string

Manage device configurations.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • none ← (default)

  • read

  • read-write

device-forticlient

string

Manage FortiClient.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • none ← (default)

  • read

  • read-write

device-fortiswitch

string

Manage FortiSwitch.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • none ← (default)

  • read

  • read-write

device-manager

string

Device manager.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • none ← (default)

  • read

  • read-write

device-op

string

Device add/delete/edit.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • none ← (default)

  • read

  • read-write

device-policy-package-lock

string

Device/Policy Package locking

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • none ← (default)

  • read

  • read-write

device-profile

string

Device profile permission.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • none ← (default)

  • read

  • read-write

device-revision-deletion

string

Delete device revision.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • none ← (default)

  • read

  • read-write

string

Manage WAN link load balance.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • none ← (default)

  • read

  • read-write

event-management

string

Event management.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • none ← (default)

  • read

  • read-write

extension-access

string

Manage extension access.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • none ← (default)

  • read

  • read-write

fabric-viewer

string

Fabric viewer.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • none ← (default)

  • read

  • read-write

fgd-center-advanced

string

FortiGuard Center Advanced.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • none ← (default)

  • read

  • read-write

fgd-center-fmw-mgmt

string

FortiGuard Center Firmware Management.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • none ← (default)

  • read

  • read-write

fgd-center-licensing

string

FortiGuard Center Licensing.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • none ← (default)

  • read

  • read-write

fgd_center

string

FortiGuard Center.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • none ← (default)

  • read

  • read-write

global-policy-packages

string

Global policy packages.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • none ← (default)

  • read

  • read-write

import-policy-packages

string

Import Policy Package.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • none ← (default)

  • read

  • read-write

intf-mapping

string

Interface Mapping

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • none ← (default)

  • read

  • read-write

ips-filter

string

IPS filter.

disable - Disable setting.

enable - Enable setting.

Choices:

  • disable ← (default)

  • enable

log-viewer

string

Log viewer.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • none ← (default)

  • read

  • read-write

policy-objects

string

Policy objects permission.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • none ← (default)

  • read

  • read-write

profileid

string

Profile ID.

read-passwd

string

View password in clear text.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • none ← (default)

  • read

  • read-write

realtime-monitor

string

Realtime monitor.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • none ← (default)

  • read

  • read-write

report-viewer

string

Report viewer.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • none ← (default)

  • read

  • read-write

run-report

string

Run reports.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • none ← (default)

  • read

  • read-write

scope

string

Scope.

global - Global scope.

adom - ADOM scope.

Choices:

  • global ← (default)

  • adom

script-access

string

Script access.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • none ← (default)

  • read

  • read-write

set-install-targets

string

Edit installation targets.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • none ← (default)

  • read

  • read-write

super-user-profile

string

Enable/disable super user profile

disable - Disable super user profile

enable - Enable super user profile

Choices:

  • disable ← (default)

  • enable

system-setting

string

System setting.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • none ← (default)

  • read

  • read-write

term-access

string

Terminal access.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • none ← (default)

  • read

  • read-write

triage-events

string

Triage events.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • none ← (default)

  • read

  • read-write

type

string

profile type.

system - System admin.

restricted - Restricted admin.

Choices:

  • system ← (default)

  • restricted

update-incidents

string

Create/update incidents.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • none ← (default)

  • read

  • read-write

vpn-manager

string

VPN manager.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • none ← (default)

  • read

  • read-write

web-filter

string

Web filter.

disable - Disable setting.

enable - Enable setting.

Choices:

  • disable ← (default)

  • enable

workspace_locking_adom

string

the adom to lock for FortiManager running in workspace mode, the value can be global and others including root

workspace_locking_timeout

integer

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

- 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]>

- 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: ''

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

request_url

string

The full url requested

Returned: always

Sample: “/sys/login/user”

response_code

integer

The status of api request

Returned: always

Sample: 0

response_message

string

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)