fortios_user_peer – Configure peer users in Fortinet’s FortiOS and FortiGate.

New in version 2.0.0.


  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and peer category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0


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

  • ansible>=2.14


Using member operation to add an element to an existing object.

FortiOS Version Compatibility

Supported Version Ranges
fortios_user_peer v6.0.0 -> latest


  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • vdom - 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. type: str default: root
  • member_path - Member attribute path to operate on. type: str
  • member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
  • state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
  • user_peer - Configure peer users. type: dict more...
    • ca - Name of the CA certificate. Source type: str more...
    • cn - Peer certificate common name. type: str more...
    • cn_type - Peer certificate common name type. type: str choices: string, email, FQDN, ipv4, ipv6 more...
    • ldap_mode - Mode for LDAP peer authentication. type: str choices: password, principal-name more...
    • ldap_password - Password for LDAP server bind. type: str more...
    • ldap_server - Name of an LDAP server defined under the user ldap command. Performs client access rights check. Source type: str more...
    • ldap_username - Username for LDAP server bind. type: str more...
    • mandatory_ca_verify - Determine what happens to the peer if the CA certificate is not installed. Disable to automatically consider the peer certificate as valid. type: str choices: enable, disable more...
    • mfa_mode - MFA mode for remote peer authentication/authorization. type: str choices: none, password, subject-identity more...
    • mfa_password - Unified password for remote authentication. This field may be left empty when RADIUS authentication is used, in which case the FortiGate will use the RADIUS username as a password. type: str more...
    • mfa_server - Name of a remote authenticator. Performs client access right check. Source type: str more...
    • mfa_username - Unified username for remote authentication. type: str more...
    • name - Peer name. type: str required: true more...
    • ocsp_override_server - Online Certificate Status Protocol (OCSP) server for certificate retrieval. Source type: str more...
    • passwd - Peer"s password used for two-factor authentication. type: str more...
    • subject - Peer certificate name constraints. type: str more...
    • two_factor - Enable/disable two-factor authentication, applying certificate and password-based authentication. type: str choices: enable, disable more...



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


- name: Configure peer users.
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
          ca: "<your_own_value> (source"
          cn: "<your_own_value>"
          cn_type: "string"
          ldap_mode: "password"
          ldap_password: "<your_own_value>"
          ldap_server: "<your_own_value> (source"
          ldap_username: "<your_own_value>"
          mandatory_ca_verify: "enable"
          mfa_mode: "none"
          mfa_password: "<your_own_value>"
          mfa_server: "<your_own_value> (source"
          mfa_username: "<your_own_value>"
          name: "default_name_15"
          ocsp_override_server: "<your_own_value> (source"
          passwd: "<your_own_value>"
          subject: "<your_own_value>"
          two_factor: "enable"

Return Values

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

  • build - Build number of the fortigate image returned: always type: str sample: 1547
  • http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
  • http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
  • mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
  • name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
  • path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
  • revision - Internal revision number returned: always type: str sample:
  • serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
  • status - Indication of the operation's result returned: always type: str sample: success
  • vdom - Virtual domain used returned: always type: str sample: root
  • version - Version of the FortiGate returned: always type: str sample: v5.6.3


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


  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)


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