Note
This plugin is part of the fortinet.fortimanager collection (version 2.0.1).
To install it use: ansible-galaxy collection install fortinet.fortimanager.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_user_peer.
New in version 2.10: of fortinet.fortimanager
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| adom string / required | the parameter (adom) in requested url | ||
| bypass_validation boolean |
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters | |
| rc_failed list / elements=string | the rc codes list with which the conditions to fail will be overriden | ||
| rc_succeeded list / elements=string | the rc codes list with which the conditions to succeed will be overriden | ||
| state string / required |
| the directive to create, update or delete an object | |
| user_peer dictionary | the top level parameters set | ||
| ca string | Name of the CA certificate as returned by the execute vpn certificate ca list command. | ||
| cn string | Peer certificate common name. | ||
| cn-type string |
| Peer certificate common name type. | |
| ldap-mode string |
| Mode for LDAP peer authentication. | |
| ldap-password string | no description | ||
| ldap-server string | Name of an LDAP server defined under the user ldap command. Performs client access rights check. | ||
| ldap-username string | Username for LDAP server bind. | ||
| mandatory-ca-verify string |
| Determine what happens to the peer if the CA certificate is not installed. Disable to automatically consider the peer certific... | |
| name string | Peer name. | ||
| ocsp-override-server string | Online Certificate Status Protocol (OCSP) server for certificate retrieval. | ||
| passwd string | no description | ||
| subject string | Peer certificate name constraints. | ||
| two-factor string |
| Enable/disable two-factor authentication, applying certificate and password-based authentication. | |
| workspace_locking_adom string | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root | ||
| workspace_locking_timeout integer | Default: 300 | the maximum time in seconds to wait for other user to release the workspace lock | |
Note
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configure peer users.
fmgr_user_peer:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
state: <value in [present, absent]>
user_peer:
ca: <value of string>
cn: <value of string>
cn-type: <value in [string, email, FQDN, ...]>
ldap-mode: <value in [password, principal-name]>
ldap-password: <value of string>
ldap-server: <value of string>
ldap-username: <value of string>
mandatory-ca-verify: <value in [disable, enable]>
name: <value of string>
ocsp-override-server: <value of string>
passwd: <value of string>
subject: <value of string>
two-factor: <value in [disable, enable]>
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| request_url string | always | The full url requested Sample: /sys/login/user |
| response_code integer | always | The status of api request |
| response_message string | always | The descriptive message of the api response Sample: OK. |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_user_peer_module.html