fortinet / fortinet.fortimanager / 2.4.0 / module / fmgr_user_peer Configure peer users. | "added in version" 2.0.0 of fortinet.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 communityfortinet.fortimanager.fmgr_user_peer (2.4.0) — module
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections: - name: fortinet.fortimanager version: 2.4.0
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.
- name: Example playbook hosts: fortimanagers connection: httpapi vars: ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false ansible_httpapi_port: 443 tasks: - name: Configure peer users. fortinet.fortimanager.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: fortimanagers gather_facts: false connection: httpapi vars: ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false ansible_httpapi_port: 443 tasks: - name: Retrieve all the peer users fortinet.fortimanager.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 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: Deprecated, please rename it to cn_type. Peer certificate common name type. type: str ldap-mode: choices: - password - principal-name description: Deprecated, please rename it to ldap_mode. Mode for LDAP peer authentication. type: str ldap-password: description: (list) Deprecated, please rename it to ldap_password. Password for LDAP server bind. type: raw ldap-server: description: Deprecated, please rename it to ldap_server. Name of an LDAP server defined under the user ldap command. type: str ldap-username: description: Deprecated, please rename it to ldap_username. Username for LDAP server bind. type: str mandatory-ca-verify: choices: - disable - enable description: Deprecated, please rename it to mandatory_ca_verify. Determine what happens to the peer if the CA certificate is not insta... type: str mfa-mode: choices: - none - password - subject-identity description: Deprecated, please rename it to mfa_mode. MFA mode for remote peer authentication/authorization. type: str mfa-password: description: (list) Deprecated, please rename it to mfa_password. type: raw mfa-server: description: Deprecated, please rename it to mfa_server. Name of a remote authenticator. type: str mfa-username: description: Deprecated, please rename it to mfa_username. Unified username for remote authentication. type: str name: description: Peer name. required: true type: str ocsp-override-server: description: Deprecated, please rename it to ocsp_override_server. Online Certificate Status Protocol type: str passwd: description: (list) Peers password used for two-factor authentication. type: raw subject: description: Peer certificate name constraints. type: str two-factor: choices: - disable - enable description: Deprecated, please rename it to two_factor. Enable/disable two-factor authentication, applying certificate and password-ba... type: str type: dict enable_log: default: false description: Enable/Disable logging for task. type: bool access_token: description: The token to access FortiManager without using username and password. type: str rc_succeeded: description: The rc codes list with which the conditions to succeed will be overriden. elements: int type: list proposed_method: choices: - update - set - add description: The overridden method for the underlying Json RPC request. 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. 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. type: str forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. type: str workspace_locking_timeout: default: 300 description: The maximum time in seconds to wait for other user to release the workspace lock. 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