fortinet.fortimanager.fmgr_system_admin_profile module – Admin profile.

Note

This module is part of the fortinet.fortimanager collection (version 2.7.0).

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 fortinet.fortimanager 2.0.0

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

access_token

string

The token to access FortiManager without using username and password.

bypass_validation

boolean

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

Choices:

  • false ← (default)

  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

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

rc_succeeded

list / elements=integer

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

string

Deprecated, please rename it to adom_admin.

Enable Adom Admin.

disable - Disable setting.

enable - Enable setting.

Choices:

  • "disable"

  • "enable"

adom-lock

string

Deprecated, please rename it to adom_lock.

ADOM locking

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • "none"

  • "read"

  • "read-write"

adom-policy-packages

string

Deprecated, please rename it to adom_policy_packages.

ADOM policy packages.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • "none"

  • "read"

  • "read-write"

adom-switch

string

Deprecated, please rename it to adom_switch.

Administrator domain.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • "none"

  • "read"

  • "read-write"

allow-to-install

string

Deprecated, please rename it to allow_to_install.

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

disable - Disable setting.

enable - Enable setting.

Choices:

  • "disable"

  • "enable"

app-filter

string

Deprecated, please rename it to app_filter.

App filter.

disable - Disable setting.

enable - Enable setting.

Choices:

  • "disable"

  • "enable"

assignment

string

Assignment permission.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • "none"

  • "read"

  • "read-write"

change-password

string

Deprecated, please rename it to change_password.

Enable/disable restricted user to change self password.

disable - Disable setting.

enable - Enable setting.

Choices:

  • "disable"

  • "enable"

config-retrieve

string

Deprecated, please rename it to config_retrieve.

Configuration retrieve.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • "none"

  • "read"

  • "read-write"

config-revert

string

Deprecated, please rename it to config_revert.

Revert Configuration from Revision History

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • "none"

  • "read"

  • "read-write"

consistency-check

string

Deprecated, please rename it to consistency_check.

Consistency check.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • "none"

  • "read"

  • "read-write"

datamask

string

Enable/disable data masking.

disable - Disable data masking.

enable - Enable data masking.

Choices:

  • "disable"

  • "enable"

datamask-custom-fields

list / elements=dictionary

Deprecated, please rename it to datamask_custom_fields. Datamask custom fields.

field-category

list / elements=string

Deprecated, please rename it to field_category.

Field categories.

log - Log.

fortiview - FortiView.

alert - Event management.

ueba - UEBA.

all - All.

Choices:

  • "log"

  • "fortiview"

  • "alert"

  • "ueba"

  • "all"

field-name

string

Deprecated, please rename it to field_name. Field name.

field-status

string

Deprecated, please rename it to field_status.

Field status.

disable - Disable field.

enable - Enable field.

Choices:

  • "disable"

  • "enable"

field-type

string

Deprecated, please rename it to field_type.

Field type.

string - String.

ip - IP.

mac - MAC address.

email - Email address.

unknown - Unknown.

Choices:

  • "string"

  • "ip"

  • "mac"

  • "email"

  • "unknown"

datamask-custom-priority

string

Deprecated, please rename it to datamask_custom_priority.

Prioritize custom fields.

disable - Disable custom field search priority.

enable - Enable custom field search priority.

Choices:

  • "disable"

  • "enable"

datamask-fields

list / elements=string

Deprecated, please rename it to datamask_fields.

Data masking fields.

user - User name.

srcip - Source IP.

srcname - Source name.

srcmac - Source MAC.

dstip - Destination IP.

dstname - Dst name.

email - Email.

message - Message.

domain - Domain.

Choices:

  • "user"

  • "srcip"

  • "srcname"

  • "srcmac"

  • "dstip"

  • "dstname"

  • "email"

  • "message"

  • "domain"

datamask-key

any

(list) Deprecated, please rename it to datamask_key. Data masking encryption key.

datamask-unmasked-time

integer

Deprecated, please rename it to datamask_unmasked_time. Time in days without data masking.

deploy-management

string

Deprecated, please rename it to deploy_management.

Install to devices.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • "none"

  • "read"

  • "read-write"

description

string

Description.

device-ap

string

Deprecated, please rename it to device_ap.

Manage AP.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • "none"

  • "read"

  • "read-write"

device-config

string

Deprecated, please rename it to device_config.

Manage device configurations.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • "none"

  • "read"

  • "read-write"

device-forticlient

string

Deprecated, please rename it to device_forticlient.

Manage FortiClient.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • "none"

  • "read"

  • "read-write"

device-fortiextender

string

Deprecated, please rename it to device_fortiextender.

Manage FortiExtender.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • "none"

  • "read"

  • "read-write"

device-fortiswitch

string

Deprecated, please rename it to device_fortiswitch.

Manage FortiSwitch.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • "none"

  • "read"

  • "read-write"

device-manager

string

Deprecated, please rename it to device_manager.

Device manager.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • "none"

  • "read"

  • "read-write"

device-op

string

Deprecated, please rename it to device_op.

Device add/delete/edit.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • "none"

  • "read"

  • "read-write"

device-policy-package-lock

string

Deprecated, please rename it to device_policy_package_lock.

Device/Policy Package locking

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • "none"

  • "read"

  • "read-write"

device-profile

string

Deprecated, please rename it to device_profile.

Device profile permission.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • "none"

  • "read"

  • "read-write"

device-revision-deletion

string

Deprecated, please rename it to device_revision_deletion.

Delete device revision.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • "none"

  • "read"

  • "read-write"

string

Deprecated, please rename it to device_wan_link_load_balance.

Manage WAN link load balance.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • "none"

  • "read"

  • "read-write"

event-management

string

Deprecated, please rename it to event_management.

Event management.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • "none"

  • "read"

  • "read-write"

extension-access

string

Deprecated, please rename it to extension_access.

Manage extension access.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • "none"

  • "read"

  • "read-write"

fabric-viewer

string

Deprecated, please rename it to fabric_viewer.

Fabric viewer.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • "none"

  • "read"

  • "read-write"

fgd-center-advanced

string

Deprecated, please rename it to fgd_center_advanced.

FortiGuard Center Advanced.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • "none"

  • "read"

  • "read-write"

fgd-center-fmw-mgmt

string

Deprecated, please rename it to fgd_center_fmw_mgmt.

FortiGuard Center Firmware Management.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • "none"

  • "read"

  • "read-write"

fgd-center-licensing

string

Deprecated, please rename it to fgd_center_licensing.

FortiGuard Center Licensing.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • "none"

  • "read"

  • "read-write"

fgd_center

string

FortiGuard Center.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • "none"

  • "read"

  • "read-write"

fgt-gui-proxy

string

Deprecated, please rename it to fgt_gui_proxy.

FortiGate GUI proxy.

disable - No permission.

enable - With permission.

Choices:

  • "disable"

  • "enable"

global-policy-packages

string

Deprecated, please rename it to global_policy_packages.

Global policy packages.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • "none"

  • "read"

  • "read-write"

import-policy-packages

string

Deprecated, please rename it to import_policy_packages.

Import Policy Package.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • "none"

  • "read"

  • "read-write"

intf-mapping

string

Deprecated, please rename it to intf_mapping.

Interface Mapping

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • "none"

  • "read"

  • "read-write"

ips-baseline-cfg

string

Deprecated, please rename it to ips_baseline_cfg.

Ips baseline sensor configration.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • "none"

  • "read"

  • "read-write"

ips-baseline-ovrd

string

Deprecated, please rename it to ips_baseline_ovrd.

Enable/disable override baseline ips sensor.

disable - Disable setting.

enable - Enable setting.

Choices:

  • "disable"

  • "enable"

ips-filter

string

Deprecated, please rename it to ips_filter.

IPS filter.

disable - Disable setting.

enable - Enable setting.

Choices:

  • "disable"

  • "enable"

ips-lock

string

Deprecated, please rename it to ips_lock.

IPS locking

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • "none"

  • "read"

  • "read-write"

ips-objects

string

Deprecated, please rename it to ips_objects.

Ips objects configuration.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • "none"

  • "read"

  • "read-write"

ipv6_trusthost1

string

Admin user trusted host IPv6, default

ipv6_trusthost10

string

Admin user trusted host IPv6, default ffff

ipv6_trusthost2

string

Admin user trusted host IPv6, default ffff

ipv6_trusthost3

string

Admin user trusted host IPv6, default ffff

ipv6_trusthost4

string

Admin user trusted host IPv6, default ffff

ipv6_trusthost5

string

Admin user trusted host IPv6, default ffff

ipv6_trusthost6

string

Admin user trusted host IPv6, default ffff

ipv6_trusthost7

string

Admin user trusted host IPv6, default ffff

ipv6_trusthost8

string

Admin user trusted host IPv6, default ffff

ipv6_trusthost9

string

Admin user trusted host IPv6, default ffff

log-viewer

string

Deprecated, please rename it to log_viewer.

Log viewer.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • "none"

  • "read"

  • "read-write"

policy-ips-attrs

string

Deprecated, please rename it to policy_ips_attrs.

Policy ips attributes configuration.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • "none"

  • "read"

  • "read-write"

policy-objects

string

Deprecated, please rename it to policy_objects.

Policy objects permission.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • "none"

  • "read"

  • "read-write"

profileid

string / required

Profile ID.

read-passwd

string

Deprecated, please rename it to read_passwd.

View password in clear text.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • "none"

  • "read"

  • "read-write"

realtime-monitor

string

Deprecated, please rename it to realtime_monitor.

Realtime monitor.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • "none"

  • "read"

  • "read-write"

report-viewer

string

Deprecated, please rename it to report_viewer.

Report viewer.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • "none"

  • "read"

  • "read-write"

rpc-permit

string

Deprecated, please rename it to rpc_permit.

Set none/read/read-write rpc-permission

read-write - Read-write permission.

none - No permission.

read - Read-only permission.

Choices:

  • "read-write"

  • "none"

  • "read"

run-report

string

Deprecated, please rename it to run_report.

Run reports.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • "none"

  • "read"

  • "read-write"

scope

string

Scope.

global - Global scope.

adom - ADOM scope.

Choices:

  • "global"

  • "adom"

script-access

string

Deprecated, please rename it to script_access.

Script access.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • "none"

  • "read"

  • "read-write"

set-install-targets

string

Deprecated, please rename it to set_install_targets.

Edit installation targets.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • "none"

  • "read"

  • "read-write"

super-user-profile

string

Deprecated, please rename it to super_user_profile.

Enable/disable super user profile

disable - Disable super user profile

enable - Enable super user profile

Choices:

  • "disable"

  • "enable"

system-setting

string

Deprecated, please rename it to system_setting.

System setting.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • "none"

  • "read"

  • "read-write"

term-access

string

Deprecated, please rename it to term_access.

Terminal access.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • "none"

  • "read"

  • "read-write"

triage-events

string

Deprecated, please rename it to triage_events.

Triage events.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • "none"

  • "read"

  • "read-write"

trusthost1

string

Admin user trusted host IP, default 0.

trusthost10

string

Admin user trusted host IP, default 255.

trusthost2

string

Admin user trusted host IP, default 255.

trusthost3

string

Admin user trusted host IP, default 255.

trusthost4

string

Admin user trusted host IP, default 255.

trusthost5

string

Admin user trusted host IP, default 255.

trusthost6

string

Admin user trusted host IP, default 255.

trusthost7

string

Admin user trusted host IP, default 255.

trusthost8

string

Admin user trusted host IP, default 255.

trusthost9

string

Admin user trusted host IP, default 255.

type

string

profile type.

system - System admin.

restricted - Restricted admin.

Choices:

  • "system"

  • "restricted"

update-incidents

string

Deprecated, please rename it to update_incidents.

Create/update incidents.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • "none"

  • "read"

  • "read-write"

vpn-manager

string

Deprecated, please rename it to vpn_manager.

VPN manager.

none - No permission.

read - Read permission.

read-write - Read-write permission.

Choices:

  • "none"

  • "read"

  • "read-write"

web-filter

string

Deprecated, please rename it to web_filter.

Web filter.

disable - Disable setting.

enable - Enable setting.

Choices:

  • "disable"

  • "enable"

write-passwd-access

string

Deprecated, please rename it to write_passwd_access.

set all/specify-by-user/specify-by-profile write password access mode.

all - All except super users.

specify-by-user - Specify by user.

specify-by-profile - Specify by profile.

Choices:

  • "all"

  • "specify-by-user"

  • "specify-by-profile"

write-passwd-profiles

list / elements=dictionary

Deprecated, please rename it to write_passwd_profiles. Write passwd profiles.

profileid

string

Profile ID.

write-passwd-user-list

list / elements=dictionary

Deprecated, please rename it to write_passwd_user_list. Write passwd user list.

userid

string

User ID.

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

  • Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

  • 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

- name: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Admin profile.
      fortinet.fortimanager.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: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the admin profiles
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "system_admin_profile"
          params:
            profile: "your_value"

Return Values

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

Key

Description

meta

dictionary

The result of the request.

Returned: always

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_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)