fortinet / fortinet.fortimanager / 2.4.0 / module / fmgr_system_ha HA configuration. | "added in version" 1.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_system_ha (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 (generated based on argument schema) hosts: fortimanagers connection: httpapi vars: ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false ansible_httpapi_port: 443 tasks: - name: HA configuration. fortinet.fortimanager.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: <integer> file_quota: <integer> hb_interval: <integer> hb_lost_threshold: <integer> mode: <value in [standalone, master, slave, ...]> password: <list or string> peer: - id: <integer> ip: <string> ip6: <string> serial_number: <string> status: <value in [disable, enable]> local_cert: <string> failover_mode: <value in [manual, vrrp]> monitored_interfaces: - interface_name: <string> monitored_ips: - id: <integer> interface: <string> ip: <string> priority: <integer> unicast: <value in [disable, enable]> vip: <string> vrrp_adv_interval: <integer> vrrp_interface: <string> vip_interface: <string>
rc_failed: description: The rc codes list with which the conditions to fail will be overriden. elements: int type: list system_ha: description: The top level parameters set. required: false suboptions: clusterid: description: Cluster ID range type: int failover-mode: choices: - manual - vrrp description: - Deprecated, please rename it to failover_mode. - HA failover mode. - manual - Manual Failove - vrrp - Use VRRP type: str file-quota: description: Deprecated, please rename it to file_quota. File quota in MB type: int hb-interval: description: Deprecated, please rename it to hb_interval. Heartbeat interval type: int hb-lost-threshold: description: Deprecated, please rename it to hb_lost_threshold. Heartbeat lost threshold type: int local-cert: description: Deprecated, please rename it to local_cert. Set the ha local certificate. type: str mode: choices: - standalone - master - slave - primary - secondary description: - Mode. - standalone - Standalone. - master - Master. - slave - Slave. type: str monitored-interfaces: description: Deprecated, please rename it to monitored_interfaces. elements: dict suboptions: interface-name: description: Deprecated, please rename it to interface_name. Interface name. type: str type: list monitored-ips: description: Deprecated, please rename it to monitored_ips. elements: dict suboptions: id: description: Id. type: int interface: description: Interface name. type: str ip: description: IP address. type: str type: list password: description: (list) Group password. type: raw peer: description: Peer. elements: dict suboptions: id: description: Id. type: int ip: description: IP address of peer. type: str ip6: description: IP address type: str serial-number: description: Deprecated, please rename it to serial_number. Serial number of peer. type: str status: choices: - disable - enable description: - Peer admin status. - disable - Disable. - enable - Enable. type: str type: list priority: description: Runtime priority [1 type: int unicast: choices: - disable - enable description: - Use unitcast for VRRP message. - disable - Disable. - enable - Enable. type: str vip: description: Virtual IP. type: str vip-interface: description: Deprecated, please rename it to vip_interface. Vip interface. type: str vrrp-adv-interval: description: Deprecated, please rename it to vrrp_adv_interval. VRRP advert interval [1 - 30 seconnds] type: int vrrp-interface: description: Deprecated, please rename it to vrrp_interface. VRRP and vip interface. 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