fortinet.fortimanager.fmgr_user_peer module – Configure peer users.

Note

This module is part of the fortinet.fortimanager collection (version 2.1.5).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

Synopsis

  • 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.

Parameters

Parameter

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

Choices:

  • no ← (default)

  • yes

enable_log

boolean

Enable/Disable logging for task

Choices:

  • no ← (default)

  • yes

proposed_method

string

The overridden method for the underlying Json RPC request

Choices:

  • update

  • set

  • add

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

Choices:

  • present

  • absent

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.

Choices:

  • string

  • email

  • FQDN

  • ipv4

  • ipv6

ldap-mode

string

Mode for LDAP peer authentication.

Choices:

  • password

  • principal-name

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.

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…

Choices:

  • disable

  • enable

name

string

Peer name.

ocsp-override-server

string

Online Certificate Status Protocol (OCSP) server for certificate retrieval.

passwd

string

Peers password used for two-factor authentication.

subject

string

Peer certificate name constraints.

two-factor

string

Enable/disable two-factor authentication, applying certificate and password-based authentication.

Choices:

  • disable

  • enable

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

the maximum time in seconds to wait for other user to release the workspace lock

Default: 300

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

- 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: ''

- 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

Return Values

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

Key

Description

request_url

string

The full url requested

Returned: always

Sample: “/sys/login/user”

response_code

integer

The status of api request

Returned: always

Sample: 0

response_message

string

The descriptive message of the api response

Returned: always

Sample: “OK.”

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)