fmgr_system_admin_profile – Admin profile.

New in version 2.0.0.

Synopsis

  • This module is able to configure a FortiManager device.
  • Examples include all parameters and values need to be adjusted to data sources before usage.
  • Tested with FortiManager v6.x and v7.x.

Requirements

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

  • ansible>=2.9.0

FortiManager Version Compatibility


6.0.0
True
6.2.0 6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.2.7 6.2.8 6.2.9 6.2.10 6.2.11
True True True True True True True True True True True
6.4.0 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 6.4.6 6.4.7 6.4.8 6.4.9 6.4.10 6.4.11 6.4.12
True True True True True True True True True True True True True
7.0.0 7.0.1 7.0.2 7.0.3 7.0.4 7.0.5 7.0.6 7.0.7 7.0.8
True True True True True True True True True
7.2.0 7.2.1 7.2.2 7.2.3
True True True True
7.4.0
True

Parameters

  • access_token -The token to access FortiManager without using username and password. type: str required: false
  • bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
  • proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
  • state - The directive to create, update or delete an object type: str required: true choices: present, absent
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
  • system_admin_profile - Admin profile. type: dict
    • adom-lock - ADOM locking type: str choices: [none, read, read-write] default: none more...
    • adom-policy-packages - ADOM policy packages. type: str choices: [none, read, read-write] default: none more...
    • adom-switch - Administrator domain. type: str choices: [none, read, read-write] default: none more...
    • app-filter - App filter. type: str choices: [disable, enable] default: disable more...
    • assignment - Assignment permission. type: str choices: [none, read, read-write] default: none more...
    • change-password - Enable/disable restricted user to change self password. type: str choices: [disable, enable] default: disable more...
    • config-retrieve - Configuration retrieve. type: str choices: [none, read, read-write] default: none more...
    • config-revert - Revert Configuration from Revision History type: str choices: [none, read, read-write] default: none more...
    • consistency-check - Consistency check. type: str choices: [none, read, read-write] default: none more...
    • datamask - Enable/disable data masking. type: str choices: [disable, enable] default: disable more...
    • datamask-custom-fields - Datamask-Custom-Fields. type: array more...
      • field-category - Field categories. type: array choices: [log, fortiview, alert, ueba, all] more...
      • field-name - Field name. type: str more...
      • field-status - Field status. type: str choices: [disable, enable] default: enable more...
      • field-type - Field type. type: str choices: [string, ip, mac, email, unknown] default: string more...
    • datamask-custom-priority - Prioritize custom fields. type: str choices: [disable, enable] default: disable more...
    • datamask-fields - Data masking fields. type: array choices: [user, srcip, srcname, srcmac, dstip, dstname, email, message, domain] more...
    • datamask-key - Data masking encryption key. type: str more...
    • deploy-management - Install to devices. type: str choices: [none, read, read-write] default: none more...
    • description - Description. type: str more...
    • device-ap - Manage AP. type: str choices: [none, read, read-write] default: none more...
    • device-config - Manage device configurations. type: str choices: [none, read, read-write] default: none more...
    • device-forticlient - Manage FortiClient. type: str choices: [none, read, read-write] default: none more...
    • device-fortiswitch - Manage FortiSwitch. type: str choices: [none, read, read-write] default: none more...
    • device-manager - Device manager. type: str choices: [none, read, read-write] default: none more...
    • device-op - Device add/delete/edit. type: str choices: [none, read, read-write] default: none more...
    • device-policy-package-lock - Device/Policy Package locking type: str choices: [none, read, read-write] default: none more...
    • device-profile - Device profile permission. type: str choices: [none, read, read-write] default: none more...
    • device-revision-deletion - Delete device revision. type: str choices: [none, read, read-write] default: none more...
    • device-wan-link-load-balance - Manage WAN link load balance. type: str choices: [none, read, read-write] default: none more...
    • event-management - Event management. type: str choices: [none, read, read-write] default: none more...
    • fgd-center-advanced - FortiGuard Center Advanced. type: str choices: [none, read, read-write] default: none more...
    • fgd-center-fmw-mgmt - FortiGuard Center Firmware Management. type: str choices: [none, read, read-write] default: none more...
    • fgd-center-licensing - FortiGuard Center Licensing. type: str choices: [none, read, read-write] default: none more...
    • fgd_center - FortiGuard Center. type: str choices: [none, read, read-write] default: none more...
    • global-policy-packages - Global policy packages. type: str choices: [none, read, read-write] default: none more...
    • import-policy-packages - Import Policy Package. type: str choices: [none, read, read-write] default: none more...
    • intf-mapping - Interface Mapping type: str choices: [none, read, read-write] default: none more...
    • ips-filter - IPS filter. type: str choices: [disable, enable] default: disable more...
    • log-viewer - Log viewer. type: str choices: [none, read, read-write] default: none more...
    • policy-objects - Policy objects permission. type: str choices: [none, read, read-write] default: none more...
    • profileid - Profile ID. type: str more...
    • read-passwd - View password in clear text. type: str choices: [none, read, read-write] default: none more...
    • realtime-monitor - Realtime monitor. type: str choices: [none, read, read-write] default: none more...
    • report-viewer - Report viewer. type: str choices: [none, read, read-write] default: none more...
    • scope - Scope. type: str choices: [global, adom] default: global more...
    • set-install-targets - Edit installation targets. type: str choices: [none, read, read-write] default: none more...
    • system-setting - System setting. type: str choices: [none, read, read-write] default: none more...
    • term-access - Terminal access. type: str choices: [none, read, read-write] default: none more...
    • type - profile type. type: str choices: [system, restricted] default: system more...
    • vpn-manager - VPN manager. type: str choices: [none, read, read-write] default: none more...
    • web-filter - Web filter. type: str choices: [disable, enable] default: disable more...
    • datamask-unmasked-time - Time in days without data masking. type: int default: 0 more...
    • super-user-profile - Enable/disable super user profile type: str choices: [disable, enable] default: disable more...
    • allow-to-install - Enable/disable the restricted user to install objects to the devices. type: str choices: [disable, enable] default: enable more...
    • extension-access - Manage extension access. type: str choices: [none, read, read-write] default: none more...
    • fabric-viewer - Fabric viewer. type: str choices: [none, read, read-write] default: none more...
    • run-report - Run reports. type: str choices: [none, read, read-write] default: none more...
    • script-access - Script access. type: str choices: [none, read, read-write] default: none more...
    • triage-events - Triage events. type: str choices: [none, read, read-write] default: none more...
    • update-incidents - Create/update incidents. type: str choices: [none, read, read-write] default: none more...
    • ips-objects - Ips objects configuration. type: str choices: [none, read, read-write] default: none more...
    • ipv6_trusthost1 - Admin user trusted host IPv6, default ::/0 for all. type: str default: ::/0 more...
    • ipv6_trusthost10 - Admin user trusted host IPv6, default ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 for none. type: str default: ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 more...
    • ipv6_trusthost2 - Admin user trusted host IPv6, default ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 for none. type: str default: ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 more...
    • ipv6_trusthost3 - Admin user trusted host IPv6, default ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 for none. type: str default: ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 more...
    • ipv6_trusthost4 - Admin user trusted host IPv6, default ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 for none. type: str default: ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 more...
    • ipv6_trusthost5 - Admin user trusted host IPv6, default ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 for none. type: str default: ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 more...
    • ipv6_trusthost6 - Admin user trusted host IPv6, default ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 for none. type: str default: ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 more...
    • ipv6_trusthost7 - Admin user trusted host IPv6, default ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 for none. type: str default: ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 more...
    • ipv6_trusthost8 - Admin user trusted host IPv6, default ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 for none. type: str default: ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 more...
    • ipv6_trusthost9 - Admin user trusted host IPv6, default ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 for none. type: str default: ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff/128 more...
    • rpc-permit - Set none/read/read-write rpc-permission type: str choices: [read-write, none, read] default: none more...
    • trusthost1 - Admin user trusted host IP, default 0. type: str default: 0.0.0.0 0.0.0.0 more...
    • trusthost10 - Admin user trusted host IP, default 255. type: str default: 255.255.255.255 255.255.255.255 more...
    • trusthost2 - Admin user trusted host IP, default 255. type: str default: 255.255.255.255 255.255.255.255 more...
    • trusthost3 - Admin user trusted host IP, default 255. type: str default: 255.255.255.255 255.255.255.255 more...
    • trusthost4 - Admin user trusted host IP, default 255. type: str default: 255.255.255.255 255.255.255.255 more...
    • trusthost5 - Admin user trusted host IP, default 255. type: str default: 255.255.255.255 255.255.255.255 more...
    • trusthost6 - Admin user trusted host IP, default 255. type: str default: 255.255.255.255 255.255.255.255 more...
    • trusthost7 - Admin user trusted host IP, default 255. type: str default: 255.255.255.255 255.255.255.255 more...
    • trusthost8 - Admin user trusted host IP, default 255. type: str default: 255.255.255.255 255.255.255.255 more...
    • trusthost9 - Admin user trusted host IP, default 255. type: str default: 255.255.255.255 255.255.255.255 more...
    • ips-baseline-cfg - Ips baseline sensor configration. type: str choices: [none, read, read-write] default: none more...
    • ips-baseline-ovrd - Enable/disable override baseline ips sensor. type: str choices: [disable, enable] default: disable more...
    • device-fortiextender - Manage FortiExtender. type: str choices: [none, read, read-write] default: none more...
    • ips-lock - IPS locking type: str choices: [none, read, read-write] default: none more...

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

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

Return Values

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

  • meta - The result of the request.returned: always type: dict
    • request_url - The full url requested. returned: always type: str sample: /sys/login/user
    • response_code - The status of api request. returned: always type: int sample: 0
    • response_data - The data body of the api response. returned: optional type: list or dict
    • response_message - The descriptive message of the api response. returned: always type: str sample: OK
    • system_information - The information of the target system. returned: always type: dict
  • rc - The status the request. returned: always type: int 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least on parameter mpt supported by the current FortiManager version type: list 0

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Xinwei Du (@dux-fortinet)
  • Xing Li (@lix-fortinet)
  • Jie Xue (@JieX19)
  • Link Zheng (@chillancezen)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.