:source: fmgd_system_sdwan.py :orphan: .. _fmgd_system_sdwan: fmgd_system_sdwan -- Configure redundant Internet connections with multiple outbound links and health-check profiles. +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. 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 redundant Internet connections with multiple outbound links and health-check profiles. fortinet.fmgdevice.fmgd_system_sdwan: # bypass_validation: false # workspace_locking_adom: # workspace_locking_timeout: 300 # rc_succeeded: [0, -2, -3, ...] # rc_failed: [-2, -3, ...] device: vdom: system_sdwan: # app_perf_log_period: # duplication: # - dstaddr: # dstaddr6: # dstintf: # id: # packet_de_duplication: # packet_duplication: # service: # service_id: # sla_match_service: # srcaddr: # srcaddr6: # srcintf: # duplication_max_num: # fail_alert_interfaces: # fail_detect: # health_check: # - addr_mode: # class_id: # detect_mode: # diffservcode: # dns_match_ip: # dns_request_domain: # embed_measured_health: # failtime: # ftp_file: # ftp_mode: # ha_priority: # http_agent: # http_get: # http_match: # interval: # members: # mos_codec: # name: # packet_size: # password: # port: # probe_count: # probe_packets: # probe_timeout: # protocol: # quality_measured_method: # recoverytime: # security_mode: # server: # sla: # - id: # jitter_threshold: # latency_threshold: # link_cost_factor: # - "latency" # - "jitter" # - "packet-loss" # - "mos" # - "remote" # - "custom-profile-1" # mos_threshold: # packetloss_threshold: # priority_in_sla: # priority_out_sla: # custom_profile_threshold: # sla_fail_log_period: # sla_id_redistribute: # sla_pass_log_period: # source: # source6: # system_dns: # threshold_alert_jitter: # threshold_alert_latency: # threshold_alert_packetloss: # threshold_warning_jitter: # threshold_warning_latency: # threshold_warning_packetloss: # update_cascade_interface: # update_static_route: # user: # vrf: # fortiguard: # fortiguard_name: # agent_probe_timeout: # remote_probe_timeout: # bandwidth_weight: # jitter_weight: # latency_weight: # packet_loss_weight: # update_bgp_route: # load_balance_mode: # members: # - comment: # cost: # gateway: # gateway6: # ingress_spillover_threshold: # interface: # preferred_source: # priority: # priority6: # seq_num: # source: # source6: # spillover_threshold: # status: # transport_group: # volume_ratio: # weight: # zone: # priority_in_sla: # priority_out_sla: # neighbor: # - health_check: # ip: # member: # minimum_sla_meet_members: # mode: # role: # service_id: # sla_id: # route_metric: # neighbor_hold_boot_time: # neighbor_hold_down: # neighbor_hold_down_time: # service: # - addr_mode: # agent_exclusive: # bandwidth_weight: # default: # dscp_forward: # dscp_forward_tag: # dscp_reverse: # dscp_reverse_tag: # dst: # dst_negate: # dst6: # end_port: # end_src_port: # gateway: # groups: # hash_mode: # health_check: # hold_down_time: # id: # input_device: # input_device_negate: # input_zone: # internet_service: # internet_service_app_ctrl: # internet_service_app_ctrl_category: # internet_service_app_ctrl_group: # internet_service_custom: # internet_service_custom_group: # internet_service_group: # internet_service_name: # jitter_weight: # latency_weight: # link_cost_factor: # link_cost_threshold: # load_balance: # minimum_sla_meet_members: # mode: # name: # packet_loss_weight: # passive_measurement: # priority_members: # priority_zone: # protocol: # quality_link: # role: # shortcut: # shortcut_priority: # sla: # - health_check: # id: # sla_compare_method: # sla_stickiness: # src: # src_negate: # src6: # standalone_action: # start_port: # start_src_port: # status: # tie_break: # tos: # tos_mask: # use_shortcut_sla: # users: # zone_mode: # route_tag: # comment: # fib_best_match_force: # internet_service_fortiguard: # speedtest_bypass_routing: # status: # zone: # - advpn_health_check: # advpn_select: # minimum_sla_meet_members: # name: # service_sla_tie_break: # health_check_fortiguard: # - addr_mode: # class_id: # detect_mode: # diffservcode: # dns_match_ip: # dns_request_domain: # embed_measured_health: # failtime: # ftp_file: # ftp_mode: # ha_priority: # http_agent: # http_get: # http_match: # interval: # members: # mos_codec: # packet_size: # password: # port: # probe_count: # probe_packets: # probe_timeout: # protocol: # quality_measured_method: # recoverytime: # security_mode: # server: # sla: # - id: # jitter_threshold: # latency_threshold: # link_cost_factor: # - "latency" # - "jitter" # - "packet-loss" # - "mos" # - "remote" # mos_threshold: # packetloss_threshold: # priority_in_sla: # priority_out_sla: # sla_fail_log_period: # sla_id_redistribute: # sla_pass_log_period: # source: # source6: # system_dns: # target_name: # threshold_alert_jitter: # threshold_alert_latency: # threshold_alert_packetloss: # threshold_warning_jitter: # threshold_warning_latency: # threshold_warning_packetloss: # update_cascade_interface: # update_static_route: # user: # vrf: # option: # - "sdwan-overlay" # - "sdwan-manager" # duplication_max_discrepancy: 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)