fortinet.fortios.fortios_user_peer module – Configure peer users in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.7).
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.fortios
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_user_peer
.
New in fortinet.fortios 2.0.0
Synopsis
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
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15
Parameters
Parameter |
Comments |
---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
Configure peer users. |
|
Name of the CA certificate. Source vpn.certificate.ca.name. |
|
Peer certificate common name. |
|
Peer certificate common name type. Choices:
|
|
Mode for LDAP peer authentication. Choices:
|
|
Password for LDAP server bind. |
|
Name of an LDAP server defined under the user ldap command. Performs client access rights check. Source user.ldap.name. |
|
Username for LDAP server bind. |
|
Determine what happens to the peer if the CA certificate is not installed. Disable to automatically consider the peer certificate as valid. Choices:
|
|
MFA mode for remote peer authentication/authorization. Choices:
|
|
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. |
|
Name of a remote authenticator. Performs client access right check. Source user.radius.name user.ldap.name. |
|
Unified username for remote authentication. |
|
Peer name. |
|
Online Certificate Status Protocol (OCSP) server for certificate retrieval. Source vpn.certificate.ocsp-server.name. |
|
Peer”s password used for two-factor authentication. |
|
Peer certificate name constraints. |
|
Enable/disable two-factor authentication, applying certificate and password-based authentication. Choices:
|
|
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. Default: |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
The module supports check_mode.
Examples
- name: Configure peer users.
fortinet.fortios.fortios_user_peer:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
user_peer:
ca: "<your_own_value> (source vpn.certificate.ca.name)"
cn: "<your_own_value>"
cn_type: "string"
ldap_mode: "password"
ldap_password: "<your_own_value>"
ldap_server: "<your_own_value> (source user.ldap.name)"
ldap_username: "<your_own_value>"
mandatory_ca_verify: "enable"
mfa_mode: "none"
mfa_password: "<your_own_value>"
mfa_server: "<your_own_value> (source user.radius.name user.ldap.name)"
mfa_username: "<your_own_value>"
name: "default_name_15"
ocsp_override_server: "<your_own_value> (source vpn.certificate.ocsp-server.name)"
passwd: "<your_own_value>"
subject: "<your_own_value>"
two_factor: "enable"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |