fmgd_system_admin – Configure admin users.

Added in version 1.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 v7.x.

Requirements

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

  • ansible-core>=2.16.0

FortiManager Version Compatibility

Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest

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
  • device - The parameter in requested url type: str required: true
  • system_admin - Configure admin users. type: dict
    • accprofile Access profile for this administrator. type: list more...
    • accprofile_override (Alias name: accprofile-override) Enable to use the name of an access profile provided by the remote authentication server to control the fortigate features that this administrator can access. type: str choices: [disable, enable] more...
    • allow_remove_admin_session (Alias name: allow-remove-admin-session) Enable/disable allow admin session to be removed by privileged admin users. type: str choices: [disable, enable] more...
    • comments Comment. type: str more...
    • email_to (Alias name: email-to) This administrators email address. type: str more...
    • force_password_change (Alias name: force-password-change) Enable/disable force password change on next login. type: str choices: [disable, enable] more...
    • fortitoken This administrators fortitoken serial number. type: list more...
    • guest_auth (Alias name: guest-auth) Enable/disable guest authentication. type: str choices: [disable, enable] more...
    • guest_lang (Alias name: guest-lang) Guest management portal language. type: list more...
    • guest_usergroups (Alias name: guest-usergroups) Select guest user groups. type: list more...
    • gui_default_dashboard_template (Alias name: gui-default-dashboard-template) The default dashboard template. type: str more...
    • gui_ignore_invalid_signature_version (Alias name: gui-ignore-invalid-signature-version) Fortios image build version to ignore invalid signature warning for. type: str more...
    • gui_ignore_release_overview_version (Alias name: gui-ignore-release-overview-version) Fortios version to ignore release overview prompt for. type: str more...
    • history0 History0. type: list more...
    • history1 History1. type: list more...
    • ip6_trusthost1 (Alias name: ip6-trusthost1) Any ipv6 address from which the administrator can connect to the fortigate unit. type: str more...
    • ip6_trusthost10 (Alias name: ip6-trusthost10) Any ipv6 address from which the administrator can connect to the fortigate unit. type: str more...
    • ip6_trusthost2 (Alias name: ip6-trusthost2) Any ipv6 address from which the administrator can connect to the fortigate unit. type: str more...
    • ip6_trusthost3 (Alias name: ip6-trusthost3) Any ipv6 address from which the administrator can connect to the fortigate unit. type: str more...
    • ip6_trusthost4 (Alias name: ip6-trusthost4) Any ipv6 address from which the administrator can connect to the fortigate unit. type: str more...
    • ip6_trusthost5 (Alias name: ip6-trusthost5) Any ipv6 address from which the administrator can connect to the fortigate unit. type: str more...
    • ip6_trusthost6 (Alias name: ip6-trusthost6) Any ipv6 address from which the administrator can connect to the fortigate unit. type: str more...
    • ip6_trusthost7 (Alias name: ip6-trusthost7) Any ipv6 address from which the administrator can connect to the fortigate unit. type: str more...
    • ip6_trusthost8 (Alias name: ip6-trusthost8) Any ipv6 address from which the administrator can connect to the fortigate unit. type: str more...
    • ip6_trusthost9 (Alias name: ip6-trusthost9) Any ipv6 address from which the administrator can connect to the fortigate unit. type: str more...
    • name User name. type: str more...
    • password Admin user password. type: list more...
    • password_expire (Alias name: password-expire) Password expire time. type: list more...
    • peer_auth (Alias name: peer-auth) Set to enable peer certificate authentication (for https admin access). type: str choices: [disable, enable] more...
    • peer_group (Alias name: peer-group) Name of peer group defined under config user group which has pki members. type: list more...
    • remote_auth (Alias name: remote-auth) Enable/disable authentication using a remote radius, ldap, or tacacs+ server. type: str choices: [disable, enable] more...
    • remote_group (Alias name: remote-group) User group name used for remote auth. type: list more...
    • schedule Firewall schedule used to restrict when the administrator can log in. type: str more...
    • sms_custom_server (Alias name: sms-custom-server) Custom sms server to send sms messages to. type: list more...
    • sms_phone (Alias name: sms-phone) Phone number on which the administrator receives sms messages. type: str more...
    • sms_server (Alias name: sms-server) Send sms messages using the fortiguard sms server or a custom server. type: str choices: [fortiguard, custom] more...
    • ssh_certificate (Alias name: ssh-certificate) Select the certificate to be used by the fortigate for authentication with an ssh client. type: list more...
    • ssh_public_key1 (Alias name: ssh-public-key1) Public key of an ssh client. type: str more...
    • ssh_public_key2 (Alias name: ssh-public-key2) Public key of an ssh client. type: str more...
    • ssh_public_key3 (Alias name: ssh-public-key3) Public key of an ssh client. type: str more...
    • trusthost1 Any ipv4 address or subnet address and netmask from which the administrator can connect to the fortigate unit. type: list more...
    • trusthost10 Any ipv4 address or subnet address and netmask from which the administrator can connect to the fortigate unit. type: list more...
    • trusthost2 Any ipv4 address or subnet address and netmask from which the administrator can connect to the fortigate unit. type: list more...
    • trusthost3 Any ipv4 address or subnet address and netmask from which the administrator can connect to the fortigate unit. type: list more...
    • trusthost4 Any ipv4 address or subnet address and netmask from which the administrator can connect to the fortigate unit. type: list more...
    • trusthost5 Any ipv4 address or subnet address and netmask from which the administrator can connect to the fortigate unit. type: list more...
    • trusthost6 Any ipv4 address or subnet address and netmask from which the administrator can connect to the fortigate unit. type: list more...
    • trusthost7 Any ipv4 address or subnet address and netmask from which the administrator can connect to the fortigate unit. type: list more...
    • trusthost8 Any ipv4 address or subnet address and netmask from which the administrator can connect to the fortigate unit. type: list more...
    • trusthost9 Any ipv4 address or subnet address and netmask from which the administrator can connect to the fortigate unit. type: list more...
    • two_factor (Alias name: two-factor) Enable/disable two-factor authentication. type: str choices: [disable, fortitoken, email, sms, fortitoken-cloud] more...
    • two_factor_authentication (Alias name: two-factor-authentication) Authentication method by fortitoken cloud. type: str choices: [fortitoken, email, sms] more...
    • two_factor_notification (Alias name: two-factor-notification) Notification method for user activation by fortitoken cloud. type: str choices: [email, sms] more...
    • vdom Virtual domain(s) that the administrator can access. type: list more...
    • vdom_override (Alias name: vdom-override) Enable to use the names of vdoms provided by the remote authentication server to control the vdoms that this administrator can access. type: str choices: [disable, enable] more...
    • wildcard Enable/disable wildcard radius authentication. type: str choices: [disable, enable] more...
    • radius_vdom_override (Alias name: radius-vdom-override) Enable to use the names of vdoms provided by the remote authentication server to control the vdoms that this administrator can access. type: str choices: [disable, enable] more...
    • hidden Hidden. type: int more...
    • old_password (Alias name: old-password) Admin user old password. type: list more...
    • history10 History10. type: list more...
    • history11 History11. type: list more...
    • history12 History12. type: list more...
    • history13 History13. type: list more...
    • history14 History14. type: list more...
    • history15 History15. type: list more...
    • history16 History16. type: list more...
    • history17 History17. type: list more...
    • history18 History18. type: list more...
    • history19 History19. type: list more...
    • history2 History2. type: list more...
    • history3 History3. type: list more...
    • history4 History4. type: list more...
    • history5 History5. type: list more...
    • history6 History6. type: list more...
    • history7 History7. type: list more...
    • history8 History8. type: list more...
    • history9 History9. type: list more...
    • trusthosts Trusthosts. type: list more...
      • id Id. type: int more...
      • ipv4 Ipv4. type: list more...
      • ipv6 Ipv6. type: str more...
      • type Type. type: str choices: [ipv4, ipv6] more...
    • ssh_tmp_file (Alias name: ssh-tmp-file) Temporary file for ssh keys. type: str 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: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure admin users.
      fortinet.fmgdevice.fmgd_system_admin:
        # bypass_validation: false
        # workspace_locking_adom: <global or your adom name>
        # workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        device: <your own value>
        state: present # <value in [present, absent]>
        system_admin:
          name: "your value" # Required variable, string
          # accprofile: <list or string>
          # accprofile_override: <value in [disable, enable]>
          # allow_remove_admin_session: <value in [disable, enable]>
          # comments: <string>
          # email_to: <string>
          # force_password_change: <value in [disable, enable]>
          # fortitoken: <list or string>
          # guest_auth: <value in [disable, enable]>
          # guest_lang: <list or string>
          # guest_usergroups: <list or string>
          # gui_default_dashboard_template: <string>
          # gui_ignore_invalid_signature_version: <string>
          # gui_ignore_release_overview_version: <string>
          # history0: <list or string>
          # history1: <list or string>
          # ip6_trusthost1: <string>
          # ip6_trusthost10: <string>
          # ip6_trusthost2: <string>
          # ip6_trusthost3: <string>
          # ip6_trusthost4: <string>
          # ip6_trusthost5: <string>
          # ip6_trusthost6: <string>
          # ip6_trusthost7: <string>
          # ip6_trusthost8: <string>
          # ip6_trusthost9: <string>
          # password: <list or string>
          # password_expire: <list or string>
          # peer_auth: <value in [disable, enable]>
          # peer_group: <list or string>
          # remote_auth: <value in [disable, enable]>
          # remote_group: <list or string>
          # schedule: <string>
          # sms_custom_server: <list or string>
          # sms_phone: <string>
          # sms_server: <value in [fortiguard, custom]>
          # ssh_certificate: <list or string>
          # ssh_public_key1: <string>
          # ssh_public_key2: <string>
          # ssh_public_key3: <string>
          # trusthost1: <list or string>
          # trusthost10: <list or string>
          # trusthost2: <list or string>
          # trusthost3: <list or string>
          # trusthost4: <list or string>
          # trusthost5: <list or string>
          # trusthost6: <list or string>
          # trusthost7: <list or string>
          # trusthost8: <list or string>
          # trusthost9: <list or string>
          # two_factor: <value in [disable, fortitoken, email, ...]>
          # two_factor_authentication: <value in [fortitoken, email, sms]>
          # two_factor_notification: <value in [email, sms]>
          # vdom: <list or string>
          # vdom_override: <value in [disable, enable]>
          # wildcard: <value in [disable, enable]>
          # radius_vdom_override: <value in [disable, enable]>
          # hidden: <integer>
          # old_password: <list or string>
          # history10: <list or string>
          # history11: <list or string>
          # history12: <list or string>
          # history13: <list or string>
          # history14: <list or string>
          # history15: <list or string>
          # history16: <list or string>
          # history17: <list or string>
          # history18: <list or string>
          # history19: <list or string>
          # history2: <list or string>
          # history3: <list or string>
          # history4: <list or string>
          # history5: <list or string>
          # history6: <list or string>
          # history7: <list or string>
          # history8: <list or string>
          # history9: <list or string>
          # trusthosts:
          #   - id: <integer>
          #     ipv4: <list or string>
          #     ipv6: <string>
          #     type: <value in [ipv4, ipv6]>
          # ssh_tmp_file: <string>

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 sample: 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list

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)