drmofu / drmofu.fortimanager / 2.2.2 / module / fmgr_user_peer Configure peer users. | "added in version" 2.0.0 of drmofu.fortimanager" Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu) preview | supported by communitydrmofu.fortimanager.fmgr_user_peer (2.2.2) — module
Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2
collections: - name: drmofu.fortimanager version: 2.2.2
This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- hosts: fortimanager00 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 adom: ansible state: present user_peer: cn-type: email #<value in [string, email, FQDN, ...]> name: ansible-test-peer passwd: fortinet
- name: gathering fortimanager facts hosts: fortimanager00 gather_facts: no connection: httpapi collections: - fortinet.fortimanager vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: retrieve all the peer users fmgr_fact: facts: selector: 'user_peer' params: adom: 'ansible' peer: 'your_value'
adom: description: the parameter (adom) in requested url required: true type: str state: choices: - present - absent description: The directive to create, update or delete an object. required: true type: str rc_failed: description: The rc codes list with which the conditions to fail will be overriden. elements: int required: false type: list user_peer: description: the top level parameters set required: false suboptions: ca: description: Name of the CA certificate as returned by the execute vpn certificate ca list command. 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. type: str ldap-username: description: Username for LDAP server bind. type: str mandatory-ca-verify: choices: - disable - enable description: Determine what happens to the peer if the CA certificate is not installed. type: str name: description: Peer name. type: str ocsp-override-server: description: Online Certificate Status Protocol type: str passwd: description: Peers password used for two-factor authentication. type: str subject: description: Peer certificate name constraints. type: str two-factor: choices: - disable - enable description: Enable/disable two-factor authentication, applying certificate and password-based authentication. type: str type: dict enable_log: default: false description: Enable/Disable logging for task. required: false type: bool access_token: description: The token to access FortiManager without using username and password. required: false type: str rc_succeeded: description: The rc codes list with which the conditions to succeed will be overriden. elements: int required: false type: list proposed_method: choices: - update - set - add description: The overridden method for the underlying Json RPC request. required: false type: str bypass_validation: default: false description: Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. required: false type: bool workspace_locking_adom: description: The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. required: false type: str forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. required: false type: str workspace_locking_timeout: default: 300 description: The maximum time in seconds to wait for other user to release the workspace lock. required: false type: int
meta: contains: request_url: description: The full url requested. returned: always sample: /sys/login/user type: str response_code: description: The status of api request. returned: always sample: 0 type: int response_data: description: The api response. returned: always type: list response_message: description: The descriptive message of the api response. returned: always sample: OK. type: str system_information: description: The information of the target system. returned: always type: dict description: The result of the request. returned: always type: dict rc: description: The status the request. returned: always sample: 0 type: int version_check_warning: description: Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: complex type: list