fmgr_user_peer – Configure peer users.¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
- Tested with FortiManager v6.0.0.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- adom - The parameter in requested url type: str required: true
- user_peer - Configure peer users. type: dict
- ca - Name of the CA certificate as returned by the execute vpn certificate ca list command. 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 - No description for the parameter type: str
- ldap-server - Name of an LDAP server defined under the user ldap command. 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. type: str choices: [disable, enable]
- name - Peer name. type: str
- ocsp-override-server - Online Certificate Status Protocol (OCSP) server for certificate retrieval. type: str
- passwd - No description for the parameter 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: [disable, enable]
Notes¶
Note
- Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
- To create or update an object, use state: present directive.
- To delete an object, use state: absent directive
- Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded
Examples¶
- 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]>
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:
- request_url - The full url requested returned: always type: str sample: /sys/login/user
- response_code - The status of api request returned: always type: int sample: 0
- response_message - The descriptive message of the api response returned: always type: str sample: OK
- response_data - The data body of the api response returned: optional type: list or dict