fortios_user_peer – Configure peer users in Fortinet’s FortiOS and FortiGate — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

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

New in version 2.9.

- Synopsis
- Requirements
- Parameters
- Notes
- Examples
- Return Values
- Status

## 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.5

## Requirements

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

- fortiosapi>=0.9.8

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
host string |  | FortiOS or FortiGate IP address.
https boolean | Choices: no yes ← | Indicates if the requests towards FortiGate must use HTTPS protocol.
password string | Default: "" | FortiOS or FortiGate password.
ssl_verify boolean | Choices: no yes ← | Ensures FortiGate certificate must be verified by a proper CA.
state string / required | Choices: present absent | Indicates whether to create or remove the object.
user_peer dictionary | Default: null | Configure peer users.
| ca string |  | Name of the CA certificate as returned by the execute vpn certificate ca list command. Source vpn.certificate.ca.name.
| cn string |  | Peer certificate common name.
| cn_type string | Choices: string email FQDN ipv4 ipv6 | Peer certificate common name type.
| ldap_mode string | Choices: password principal-name | Mode for LDAP peer authentication.
| ldap_password string |  | Password for LDAP server bind.
| ldap_server string |  | Name of an LDAP server defined under the user ldap command. Performs client access rights check. Source user.ldap.name.
| ldap_username string |  | Username for LDAP server bind.
| mandatory_ca_verify string | Choices: enable disable | Determine what happens to the peer if the CA certificate is not installed. Disable to automatically consider the peer certificate as valid.
| name string / required |  | Peer name.
| ocsp_override_server string |  | Online Certificate Status Protocol (OCSP) server for certificate retrieval. Source vpn.certificate.ocsp-server.name.
| passwd string |  | Peer's password used for two-factor authentication.
| subject string |  | Peer certificate name constraints.
| two_factor string | Choices: enable disable | Enable/disable two-factor authentication, applying certificate and password-based authentication.
username string |  | FortiOS or FortiGate username.
vdom string | Default: "root" | 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.

## Notes

Note

- Requires fortiosapi library developed by Fortinet
- Run as a local_action in your playbook

## Examples

    - 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"

## Return Values

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

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

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.