fmgr_system_ha_peer – Peer.

New in version 2.10.

Synopsis

• This module is able to configure a FortiManager device by allowing the user to [add, get, set, update] the following FortiManager json-rpc urls.
• /cli/global/system/ha/peer
• 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.10.0

Parameters

• loose_validation - Do parameter validation in a loose way 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 dom
• workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
• parameters for method: [add, set, update] - Peer.
• data - No description for the parameter type: array
  • id - Id. type: int default: 0
  • ip - IP address of peer. type: str default: 0.0.0.0
  • ip6 - IP address (V6) of peer. type: str default: ::
  • serial-number - Serial number of peer. type: str
  • status - Peer admin status. type: str choices: [disable, enable] default: enable
• parameters for method: [get] - Peer.
• fields - No description for the parameter type: array
  • {no-name} - No description for the parameter type: array
    • {no-name} - No description for the parameter type: str choices: [id, ip, ip6, serial-number, status]
• filter - No description for the parameter type: array
  • {no-name} - No description for the parameter type: str
• loadsub - Enable or disable the return of any sub-objects. type: int
• option - Set fetch option for the request. type: str choices: [count, syntax]

Notes

Note

• The module may supports multiple method, every method has different parameters definition
• One method may also have more than one parameter definition collection, each collection is dedicated to one API endpoint
• The module may include domain dependent urls, the domain can be specified in url_params as adom
• To run in workspace mode, the paremeter workspace_locking_adom must be included in the task

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: REQUESTING /CLI/SYSTEM/HA/PEER
     fmgr_system_ha_peer:
        loose_validation: False
        workspace_locking_adom: <value in [global, custom adom]>
        workspace_locking_timeout: 300
        method: <value in [add, set, update]>
        params:
           -
              data:
                -
                    id: <value of integer>
                    ip: <value of string>
                    ip6: <value of string>
                    serial-number: <value of string>
                    status: <value in [disable, enable]>

   - name: REQUESTING /CLI/SYSTEM/HA/PEER
     fmgr_system_ha_peer:
        loose_validation: False
        workspace_locking_adom: <value in [global, custom adom]>
        workspace_locking_timeout: 300
        method: <value in [get]>
        params:
           -
              fields:
                -
                   - <value in [id, ip, ip6, ...]>
              filter:
                - <value of string>
              loadsub: <value of integer>
              option: <value in [count, syntax]>

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:

• return values for method: [add, set, update]
• status - No description for the parameter type: dict
  • code - No description for the parameter type: int
  • message - No description for the parameter type: str
• url - No description for the parameter type: str example: /cli/global/system/ha/peer
• return values for method: [get]
• data - No description for the parameter type: array
  • id - Id. type: int example: 0
  • ip - IP address of peer. type: str example: 0.0.0.0
  • ip6 - IP address (V6) of peer. type: str example: ::
  • serial-number - Serial number of peer. type: str
  • status - Peer admin status. type: str example: enable
• status - No description for the parameter type: dict
  • code - No description for the parameter type: int
  • message - No description for the parameter type: str
• url - No description for the parameter type: str example: /cli/global/system/ha/peer

Status

• This module is not guaranteed to have a backwards compatible interface.

Authors

• Frank Shen (@fshen01)
• Link Zheng (@zhengl)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.