fmgr_system_ha – HA configuration.¶
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.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
FortiManager Version Compatibility¶
6.0.0 |
6.2.1 |
6.2.3 |
6.2.5 |
6.4.0 |
6.4.2 |
6.4.5 |
7.0.0 |
7.2.0 |
|
| system_ha | yes | yes | yes | yes | yes | yes | yes | yes | yes |
Parameters¶
- enable_log - Enable/Disable logging for task type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0 type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
- 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
- system_ha - no description type: dict
- clusterid - Cluster ID range (1 - 64). type: int default: 1 more...
- file-quota - File quota in MB (2048 - 20480). type: int default: 4096 more...
- hb-interval - Heartbeat interval (1 - 255). type: int default: 5 more...
- hb-lost-threshold - Heartbeat lost threshold (1 - 255). type: int default: 3 more...
- mode - Mode. type: str choices: [standalone, master, slave, primary, secondary] default: standalone more...
- password - Group password. type: str more...
- peer - Peer. type: array
more...
- id - Id. type: int default: 0 more...
- ip - IP address of peer. type: str default: 0.0.0.0 more...
- ip6 - IP address (V6) of peer. type: str default: :: more...
- serial-number - Serial number of peer. type: str more...
- status - Peer admin status. type: str choices: [disable, enable] default: enable more...
- local-cert - set the ha local certificate. type: str more...
- failover-mode - HA failover mode. type: str choices: [manual, vrrp] default: manual more...
- monitored-interfaces - No description for the parameter type: array
more...
- interface-name - Interface name. type: str more...
- monitored-ips - No description for the parameter type: array more...
- priority - Runtime priority [1 (lowest) - 253 (highest)] type: int default: 1 more...
- unicast - Use unitcast for VRRP message. type: str choices: [disable, enable] default: disable more...
- vip - Virtual IP. type: str more...
- vrrp-adv-interval - VRRP advert interval [1 - 30 seconnds] type: int default: 3 more...
- vrrp-interface - VRRP and vip interface. type: str more...
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: no description
fmgr_system_ha:
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, ...]
system_ha:
clusterid: <value of integer>
file-quota: <value of integer>
hb-interval: <value of integer>
hb-lost-threshold: <value of integer>
mode: <value in [standalone, master, slave, ...]>
password: <value of string>
peer:
-
id: <value of integer>
ip: <value of string>
ip6: <value of string>
serial-number: <value of string>
status: <value in [disable, enable]>
local-cert: <value of string>
failover-mode: <value in [manual, vrrp]>
monitored-interfaces:
-
interface-name: <value of string>
monitored-ips:
-
id: <value of integer>
interface: <value of string>
ip: <value of string>
priority: <value of integer>
unicast: <value in [disable, enable]>
vip: <value of string>
vrrp-adv-interval: <value of integer>
vrrp-interface: <value of string>
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