fortios_user_peer – Configure peer users in Fortinet’s FortiOS and FortiGate.¶
New in version 2.9.
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.9.0
Parameters¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: 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
- state - Indicates whether to create or remove the object. type: str required: True choices: present, absent
- user_peer - Configure peer users. type: dict
- ca - Name of the CA certificate as returned by the execute vpn certificate ca list command. Source vpn.certificate.ca.name. type: str
- cn - Peer certificate common name. type: str
- cn_type - Peer certificate common name type. type: str choices: string, email, FQDN, ipv4, ipv6
- ldap_mode - Mode for LDAP peer authentication. type: str choices: password, principal-name
- ldap_password - Password for LDAP server bind. type: str
- ldap_server - Name of an LDAP server defined under the user ldap command. Performs client access rights check. Source user.ldap.name. type: str
- ldap_username - Username for LDAP server bind. type: str
- 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
- name - Peer name. type: str required: True
- ocsp_override_server - Online Certificate Status Protocol (OCSP) server for certificate retrieval. Source vpn.certificate.ocsp-server.name. type: str
- passwd - Peer"s password used for two-factor authentication. type: str
- subject - Peer certificate name constraints. type: str
- two_factor - Enable/disable two-factor authentication, applying certificate and password-based authentication. type: str choices: enable, disable
Examples¶
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure peer users.
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"
name: "default_name_11"
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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, 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: 17.0.2.10658
- 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