ansible / ansible.builtin / v2.9.24 / module / fortios_user_peer Configure peer users in Fortinet's FortiOS and FortiGate. | "added in version" 2.9 of ansible.builtin" Authors: Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico) preview | supported by communityansible.builtin.fortios_user_peer (v2.9.24) — module
pip
Install with pip install ansible==2.9.24
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.5
- hosts: localhost vars: host: "192.168.122.40" username: "admin" password: "" vdom: "root" ssl_verify: "False" tasks: - name: Configure peer users. fortios_user_peer: host: "{{ host }}" username: "{{ username }}" password: "{{ password }}" vdom: "{{ vdom }}" https: "False" state: "present" 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"
host: description: - FortiOS or FortiGate IP address. required: false type: str vdom: default: root description: - 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 https: default: true description: - Indicates if the requests towards FortiGate must use HTTPS protocol. type: bool state: choices: - present - absent description: - Indicates whether to create or remove the object. required: true type: str password: default: '' description: - FortiOS or FortiGate password. type: str username: description: - FortiOS or FortiGate username. required: false type: str user_peer: default: null description: - Configure peer users. suboptions: ca: description: - Name of the CA certificate as returned by the execute vpn certificate ca list command. Source vpn.certificate.ca.name. type: str cn: description: - Peer certificate common name. type: str cn_type: choices: - string - email - FQDN - ipv4 - ipv6 description: - Peer certificate common name type. type: str ldap_mode: choices: - password - principal-name description: - Mode for LDAP peer authentication. type: str ldap_password: description: - Password for LDAP server bind. type: str ldap_server: description: - Name of an LDAP server defined under the user ldap command. Performs client access rights check. Source user.ldap.name. type: str ldap_username: description: - Username for LDAP server bind. type: str mandatory_ca_verify: choices: - enable - disable description: - Determine what happens to the peer if the CA certificate is not installed. Disable to automatically consider the peer certificate as valid. type: str name: description: - Peer name. required: true type: str ocsp_override_server: description: - Online Certificate Status Protocol (OCSP) server for certificate retrieval. Source vpn.certificate.ocsp-server.name. type: str passwd: description: - Peer's password used for two-factor authentication. type: str subject: description: - Peer certificate name constraints. type: str two_factor: choices: - enable - disable description: - Enable/disable two-factor authentication, applying certificate and password-based authentication. type: str type: dict ssl_verify: default: true description: - Ensures FortiGate certificate must be verified by a proper CA. type: bool
build: description: Build number of the fortigate image returned: always sample: '1547' type: str http_method: description: Last method used to provision the content into FortiGate returned: always sample: PUT type: str http_status: description: Last result given by FortiGate on last operation applied returned: always sample: '200' type: str mkey: description: Master key (id) used in the last call to FortiGate returned: success sample: id type: str name: description: Name of the table used to fulfill the request returned: always sample: urlfilter type: str path: description: Path of the table used to fulfill the request returned: always sample: webfilter type: str revision: description: Internal revision number returned: always sample: 17.0.2.10658 type: str serial: description: Serial number of the unit returned: always sample: FGVMEVYYQT3AB5352 type: str status: description: Indication of the operation's result returned: always sample: success type: str vdom: description: Virtual domain used returned: always sample: root type: str version: description: Version of the FortiGate returned: always sample: v5.6.3 type: str