:source: fmgd_system_ha.py :orphan: .. _fmgd_system_ha: fmgd_system_ha -- Configure HA. +++++++++++++++++++++++++++++++ .. versionadded:: 1.0.0 .. contents:: :local: :depth: 1 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. - Tested with FortiManager v7.x. Requirements ------------ The below requirements are needed on the host that executes this module. - ansible-core>=2.16.0 FortiManager Version Compatibility ---------------------------------- .. raw:: html

Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest

Parameters ---------- .. raw:: html 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 -------- .. code-block:: yaml+jinja - name: Example playbook (generated based on argument schema) hosts: fortimanagers connection: httpapi gather_facts: false vars: ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false ansible_httpapi_port: 443 tasks: - name: Configure HA. fortinet.fmgdevice.fmgd_system_ha: # bypass_validation: false # workspace_locking_adom: # workspace_locking_timeout: 300 # rc_succeeded: [0, -2, -3, ...] # rc_failed: [-2, -3, ...] device: system_ha: # arps: # arps_interval: # authentication: # board_failover_tolerance: # chassis_id: # cpu_threshold: # encryption: # evpn_ttl: # failover_hold_time: # ftp_proxy_threshold: # gratuitous_arps: # group_id: # group_name: # ha_direct: # ha_eth_type: # ha_mgmt_interfaces: # - dst: # gateway: # gateway6: # id: # interface: # dst6: # ha_mgmt_status: # ha_port_dtag_mode: # ha_port_outer_tpid: # ha_uptime_diff_margin: # hb_interval: # hb_interval_in_milliseconds: # hb_lost_threshold: # hbdev: # hbdev_second_vlan_id: # hbdev_vlan_id: # hc_eth_type: # hello_holddown: # http_proxy_threshold: # hw_session_hold_time: # hw_session_sync_delay: # hw_session_sync_dev: # imap_proxy_threshold: # ipsec_phase2_proposal: # - "aes128-sha1" # - "aes128-sha256" # - "aes128-sha384" # - "aes128-sha512" # - "aes192-sha1" # - "aes192-sha256" # - "aes192-sha384" # - "aes192-sha512" # - "aes256-sha1" # - "aes256-sha256" # - "aes256-sha384" # - "aes256-sha512" # - "aes128gcm" # - "aes256gcm" # - "chacha20poly1305" # key: # l2ep_eth_type: # link_failed_signal: # load_balance_all: # logical_sn: # memory_based_failover: # memory_compatible_mode: # memory_failover_flip_timeout: # memory_failover_monitor_period: # memory_failover_sample_rate: # memory_failover_threshold: # memory_threshold: # mode: # monitor: # multicast_ttl: # nntp_proxy_threshold: # override: # override_wait_time: # password: # pingserver_failover_threshold: # pingserver_flip_timeout: # pingserver_monitor_interface: # pingserver_secondary_force_reset: # pop3_proxy_threshold: # priority: # route_hold: # route_ttl: # route_wait: # schedule: # session_pickup: # session_pickup_connectionless: # session_pickup_delay: # session_pickup_expectation: # session_pickup_nat: # session_sync_dev: # smtp_proxy_threshold: # ssd_failover: # standalone_config_sync: # standalone_mgmt_vdom: # sync_config: # sync_packet_balance: # unicast_gateway: # unicast_hb: # unicast_hb_netmask: # unicast_hb_peerip: # unicast_peers: # - id: # peer_ip: # unicast_status: # uninterruptible_primary_wait: # upgrade_mode: # vcluster: # - monitor: # override: # override_wait_time: # pingserver_failover_threshold: # pingserver_flip_timeout: # pingserver_monitor_interface: # pingserver_secondary_force_reset: # priority: # vcluster_id: # vdom: # pingserver_slave_force_reset: # vcluster_status: # weight: # pingserver_slave_force_reset: # uninterruptible_upgrade: # vdom: # minimum_worker_threshold: # vcluster2: # secondary_vcluster: # monitor: # override: # override_wait_time: # pingserver_failover_threshold: # pingserver_monitor_interface: # pingserver_secondary_force_reset: # priority: # vcluster_id: # vdom: # pingserver_slave_force_reset: # secondary_switch_standby: # vcluster_id: # slave_switch_standby: # frup: # frup_settings: # active_interface: # active_switch_port: # backup_interface: # inter_cluster_session_sync: # auto_virtual_mac_interface: # backup_hbdev: # check_secondary_dev_health: # primary_hold_before_reboot: # sequential_upgrade: # bounce_intf_upon_failover: 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: .. raw:: html
  • meta - The result of the request.returned: always type: dict
    • 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_data - The data body of the api response. returned: optional type: list or dict
    • response_message - The descriptive message of the api response. returned: always type: str sample: OK
    • system_information - The information of the target system. returned: always type: dict
  • rc - The status the request. returned: always type: int sample: 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status ------ - This module is not guaranteed to have a backwards compatible interface. Authors ------- - Xinwei Du (@dux-fortinet) - Xing Li (@lix-fortinet) - Jie Xue (@JieX19) - Link Zheng (@chillancezen) - Frank Shen (@fshen01) - Hongbin Lu (@fgtdev-hblu)