- source
fmgr_wanprof_system_sdwan.py
- orphan
fmgr_wanprof_system_sdwan -- Configure redundant internet connections using SD-WAN (formerly virtual WAN link).
2.1.0
Warning
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
- Argument name before 3.0.0:
var-name,var name,var.name - New argument name starting in 3.0.0:
var_name
FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
- 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 v6.x and v7.x.
The below requirements are needed on the host that executes this module.
- ansible>=2.15.0
Supported Version Ranges: v6.4.1 -> latest
- access_token -The token to access FortiManager without using username and password. type: str required: false
- 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
- 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
- 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
- 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
- adom - The parameter in requested url type: str required: true
- wanprof - The parameter in requested url type: str required: true
- wanprof_system_sdwan - Configure redundant internet connections using SD-WAN type: dict
- duplication type: list
more...
Supported Version Ranges:
v6.4.2 -> latest- dstaddr Destination address or address group names. type: list or str
more...
Supported Version Ranges:
v6.4.2 -> latest - dstaddr6 Destination address6 or address6 group names. type: list or str
more...
Supported Version Ranges:
v6.4.2 -> latest - dstintf Outgoing (egress) interfaces or zones. type: list or str
more...
Supported Version Ranges:
v6.4.2 -> latest - id Duplication rule id (1 - 255). type: int
more...
Supported Version Ranges:
v6.4.2 -> latest - packet_de_duplication (Alias name: packet-de-duplication) Enable/disable discarding of packets that have been duplicated. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.4.2 -> latest - packet_duplication (Alias name: packet-duplication) Configure packet duplication method. type: str choices: [disable, force, on-demand]
more...
Supported Version Ranges:
v6.4.2 -> latest - service Service and service group name. type: list or str
more...
Supported Version Ranges:
v6.4.2 -> latest - srcaddr Source address or address group names. type: list or str
more...
Supported Version Ranges:
v6.4.2 -> latest - srcaddr6 Source address6 or address6 group names. type: list or str
more...
Supported Version Ranges:
v6.4.2 -> latest - srcintf Incoming (ingress) interfaces or zones. type: list or str
more...
Supported Version Ranges:
v6.4.2 -> latest - service_id (Alias name: service-id) Sd-wan service rule id list. type: list or str
more...
Supported Version Ranges:
v6.4.3 -> latest - sla_match_service (Alias name: sla-match-service) Enable/disable packet duplication matching health-check slas in service rule. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.2.0 -> latest
- dstaddr Destination address or address group names. type: list or str
more...
- duplication_max_num (Alias name: duplication-max-num) Maximum number of interface members a packet is duplicated in the sd-wan zone (2 - 4, default = 2; if set to 3, the original packet plus 2 more copies are created). type: int
more...
Supported Version Ranges:
v6.4.2 -> latest - fail_detect (Alias name: fail-detect) Enable/disable sd-wan internet connection status checking (failure detection). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.4.1 -> latest - health_check (Alias name: health-check) type: list
more...
Supported Version Ranges:
v6.4.1 -> latest- _dynamic_server (Alias name: _dynamic-server) type: str
more...
Supported Version Ranges:
v6.4.1 -> v6.4.14 - addr_mode (Alias name: addr-mode) Address mode (ipv4 or ipv6). type: str choices: [ipv4, ipv6]
more...
Supported Version Ranges:
v6.4.1 -> latest - diffservcode Differentiated services code point (dscp) in the ip header of the probe packet. type: str
more...
Supported Version Ranges:
v6.4.1 -> latest - dns_match_ip (Alias name: dns-match-ip) Response ip expected from dns server if the protocol is dns. type: str
more...
Supported Version Ranges:
v6.4.2 -> latest - dns_request_domain (Alias name: dns-request-domain) Fully qualified domain name to resolve for the dns probe. type: str
more...
Supported Version Ranges:
v6.4.1 -> latest - failtime Number of failures before server is considered lost (1 - 3600, default = 5). type: int
more...
Supported Version Ranges:
v6.4.1 -> latest - ftp_file (Alias name: ftp-file) Full path and file name on the ftp server to download for ftp health-check to probe. type: str
more...
Supported Version Ranges:
v6.4.2 -> latest - ftp_mode (Alias name: ftp-mode) Ftp mode. type: str choices: [passive, port]
more...
Supported Version Ranges:
v6.4.2 -> latest - ha_priority (Alias name: ha-priority) Ha election priority (1 - 50). type: int
more...
Supported Version Ranges:
v6.4.1 -> latest - http_agent (Alias name: http-agent) String in the http-agent field in the http header. type: str
more...
Supported Version Ranges:
v6.4.1 -> latest - http_get (Alias name: http-get) Url used to communicate with the server if the protocol if the protocol is http. type: str
more...
Supported Version Ranges:
v6.4.1 -> latest - http_match (Alias name: http-match) Response string expected from the server if the protocol is http. type: str
more...
Supported Version Ranges:
v6.4.1 -> latest - interval Status check interval in milliseconds, or the time between attempting to connect to the server (500 - 3600*1000 msec, default = 500). type: int
more...
Supported Version Ranges:
v6.4.1 -> latest - members Member sequence number list. type: list or str
more...
Supported Version Ranges:
v6.4.1 -> latest - name Status check or health check name. type: str
more...
Supported Version Ranges:
v6.4.1 -> latest - packet_size (Alias name: packet-size) Packet size of a twamp test session, type: int
more...
Supported Version Ranges:
v6.4.1 -> latest - password type: list
more...
Supported Version Ranges:
v6.4.1 -> latest - port Port number used to communicate with the server over the selected protocol (0-65535, default = 0, auto select. type: int
more...
Supported Version Ranges:
v6.4.1 -> latest - probe_count (Alias name: probe-count) Number of most recent probes that should be used to calculate latency and jitter (5 - 30, default = 30). type: int
more...
Supported Version Ranges:
v6.4.1 -> latest - probe_packets (Alias name: probe-packets) Enable/disable transmission of probe packets. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.4.1 -> latest - probe_timeout (Alias name: probe-timeout) Time to wait before a probe packet is considered lost (500 - 3600*1000 msec, default = 500). type: int
more...
Supported Version Ranges:
v6.4.1 -> latest - protocol Protocol used to determine if the fortigate can communicate with the server. type: str choices: [ping, tcp-echo, udp-echo, http, twamp, ping6, dns, tcp-connect, ftp, https]
more...
Supported Version Ranges:
v6.4.1 -> latest - quality_measured_method (Alias name: quality-measured-method) Method to measure the quality of tcp-connect. type: str choices: [half-close, half-open]
more...
Supported Version Ranges:
v6.4.2 -> latest - recoverytime Number of successful responses received before server is considered recovered (1 - 3600, default = 5). type: int
more...
Supported Version Ranges:
v6.4.1 -> latest - security_mode (Alias name: security-mode) Twamp controller security mode. type: str choices: [none, authentication]
more...
Supported Version Ranges:
v6.4.1 -> latest - server type: list
more...
Supported Version Ranges:
v6.4.1 -> latest - sla type: list
more...
Supported Version Ranges:
v6.4.1 -> latest- id Sla id. type: int
more...
Supported Version Ranges:
v6.4.1 -> latest - jitter_threshold (Alias name: jitter-threshold) Jitter for sla to make decision in milliseconds. type: int
more...
Supported Version Ranges:
v6.4.1 -> latest - latency_threshold (Alias name: latency-threshold) Latency for sla to make decision in milliseconds. type: int
more...
Supported Version Ranges:
v6.4.1 -> latest - link_cost_factor (Alias name: link-cost-factor) type: list choices: [latency, jitter, packet-loss, mos]
more...
Supported Version Ranges:
v6.4.1 -> latest - packetloss_threshold (Alias name: packetloss-threshold) Packet loss for sla to make decision in percentage. type: int
more...
Supported Version Ranges:
v6.4.1 -> latest - mos_threshold (Alias name: mos-threshold) Minimum mean opinion score for sla to be marked as pass. type: str
more...
Supported Version Ranges:
v7.2.0 -> latest - priority_in_sla (Alias name: priority-in-sla) Value to be distributed into routing table when in-sla (0 - 65535, default = 0). type: int
more...
Supported Version Ranges:
v7.2.1 -> latest - priority_out_sla (Alias name: priority-out-sla) Value to be distributed into routing table when out-sla (0 - 65535, default = 0). type: int
more...
Supported Version Ranges:
v7.2.1 -> latest
- id Sla id. type: int
more...
- sla_fail_log_period (Alias name: sla-fail-log-period) Time interval in seconds that sla fail log messages will be generated (0 - 3600, default = 0). type: int
more...
Supported Version Ranges:
v6.4.1 -> latest - sla_pass_log_period (Alias name: sla-pass-log-period) Time interval in seconds that sla pass log messages will be generated (0 - 3600, default = 0). type: int
more...
Supported Version Ranges:
v6.4.1 -> latest - system_dns (Alias name: system-dns) Enable/disable system dns as the probe server. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.4.1 -> latest - threshold_alert_jitter (Alias name: threshold-alert-jitter) Alert threshold for jitter (ms, default = 0). type: int
more...
Supported Version Ranges:
v6.4.1 -> latest - threshold_alert_latency (Alias name: threshold-alert-latency) Alert threshold for latency (ms, default = 0). type: int
more...
Supported Version Ranges:
v6.4.1 -> latest - threshold_alert_packetloss (Alias name: threshold-alert-packetloss) Alert threshold for packet loss (percentage, default = 0). type: int
more...
Supported Version Ranges:
v6.4.1 -> latest - threshold_warning_jitter (Alias name: threshold-warning-jitter) Warning threshold for jitter (ms, default = 0). type: int
more...
Supported Version Ranges:
v6.4.1 -> latest - threshold_warning_latency (Alias name: threshold-warning-latency) Warning threshold for latency (ms, default = 0). type: int
more...
Supported Version Ranges:
v6.4.1 -> latest - threshold_warning_packetloss (Alias name: threshold-warning-packetloss) Warning threshold for packet loss (percentage, default = 0). type: int
more...
Supported Version Ranges:
v6.4.1 -> latest - update_cascade_interface (Alias name: update-cascade-interface) Enable/disable update cascade interface. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.4.1 -> latest - update_static_route (Alias name: update-static-route) Enable/disable updating the static route. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.4.1 -> latest - user The user name to access probe server. type: str
more...
Supported Version Ranges:
v6.4.2 -> latest - detect_mode (Alias name: detect-mode) The mode determining how to detect the server. type: str choices: [active, passive, prefer-passive, remote, agent-based]
more...
Supported Version Ranges:
v7.0.0 -> latest - mos_codec (Alias name: mos-codec) Codec to use for mos calculation (default = g711). type: str choices: [g711, g722, g729]
more...
Supported Version Ranges:
v7.2.0 -> latest - source Source ip address used in the health-check packet to the server. type: str
more...
Supported Version Ranges:
v7.2.0 -> latest - vrf Virtual routing forwarding id. type: int
more...
Supported Version Ranges:
v7.2.0 -> latest - embed_measured_health (Alias name: embed-measured-health) Enable/disable embedding measured health information. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.2.1 -> latest - sla_id_redistribute (Alias name: sla-id-redistribute) Select the id from the sla sub-table. type: int
more...
Supported Version Ranges:
v7.2.1 -> latest - class_id (Alias name: class-id) Traffic class id. type: str
more...
Supported Version Ranges:
v7.4.0 -> latest - source6 Source ipv6 addressused in the health-check packet to server. type: str
more...
Supported Version Ranges:
v7.4.0 -> latest
- _dynamic_server (Alias name: _dynamic-server) type: str
more...
- load_balance_mode (Alias name: load-balance-mode) Algorithm or mode to use for load balancing internet traffic to sd-wan members. type: str choices: [source-ip-based, weight-based, usage-based, source-dest-ip-based, measured-volume-based]
more...
Supported Version Ranges:
v6.4.1 -> latest - members type: list
more...
Supported Version Ranges:
v6.4.1 -> latest- _dynamic_member (Alias name: _dynamic-member) type: str
more...
Supported Version Ranges:
v6.4.1 -> v6.4.14 - comment Comments. type: str
more...
Supported Version Ranges:
v6.4.1 -> latest - cost Cost of this interface for services in sla mode (0 - 4294967295, default = 0). type: int
more...
Supported Version Ranges:
v6.4.1 -> latest - gateway The default gateway for this interface. type: str
more...
Supported Version Ranges:
v6.4.1 -> latest - gateway6 Ipv6 gateway. type: str
more...
Supported Version Ranges:
v6.4.1 -> latest - ingress_spillover_threshold (Alias name: ingress-spillover-threshold) Ingress spillover threshold for this interface (0 - 16776000 kbit/s). type: int
more...
Supported Version Ranges:
v6.4.1 -> latest - interface Interface name. type: str
more...
Supported Version Ranges:
v6.4.1 -> latest - priority Priority of the interface (0 - 65535). type: int
more...
Supported Version Ranges:
v6.4.1 -> latest - seq_num (Alias name: seq-num) Sequence number(1-512). type: int
more...
Supported Version Ranges:
v6.4.1 -> latest - source Source ip address used in the health-check packet to the server. type: str
more...
Supported Version Ranges:
v6.4.1 -> latest - source6 Source ipv6 address used in the health-check packet to the server. type: str
more...
Supported Version Ranges:
v6.4.1 -> latest - spillover_threshold (Alias name: spillover-threshold) Egress spillover threshold for this interface (0 - 16776000 kbit/s). type: int
more...
Supported Version Ranges:
v6.4.1 -> latest - status Enable/disable this interface in the sd-wan. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.4.1 -> latest - volume_ratio (Alias name: volume-ratio) Measured volume ratio (this value / sum of all values = percentage of link volume, 1 - 255). type: int
more...
Supported Version Ranges:
v6.4.1 -> latest - weight Weight of this interface for weighted load balancing. type: int
more...
Supported Version Ranges:
v6.4.1 -> latest - zone Zone name. type: str
more...
Supported Version Ranges:
v6.4.1 -> latest - priority6 Priority of the interface for ipv6 (1 - 65535, default = 1024). type: int
more...
Supported Version Ranges:
v7.0.0 -> latest - preferred_source (Alias name: preferred-source) Preferred source of route for this member. type: str
more...
Supported Version Ranges:
v7.4.0 -> latest - transport_group (Alias name: transport-group) Measured transport group (0 - 255). type: int
more...
Supported Version Ranges:
v7.4.2 -> latest
- _dynamic_member (Alias name: _dynamic-member) type: str
more...
- neighbor type: list
more...
Supported Version Ranges:
v6.4.1 -> latest- health_check (Alias name: health-check) Sd-wan health-check name. type: str
more...
Supported Version Ranges:
v6.4.1 -> latest - ip Ip/ipv6 address of neighbor. type: str
more...
Supported Version Ranges:
v6.4.1 -> latest - member Member sequence number. type: list or str
more...
Supported Version Ranges:
v6.4.1 -> latest - role Role of neighbor. type: str choices: [primary, secondary, standalone]
more...
Supported Version Ranges:
v6.4.1 -> latest - sla_id (Alias name: sla-id) Sla id. type: int
more...
Supported Version Ranges:
v6.4.1 -> latest - minimum_sla_meet_members (Alias name: minimum-sla-meet-members) Minimum number of members which meet sla when the neighbor is preferred. type: int
more...
Supported Version Ranges:
v7.2.0 -> latest - mode What metric to select the neighbor. type: str choices: [sla, speedtest]
more...
Supported Version Ranges:
v7.0.1 -> latest - service_id (Alias name: service-id) Sd-wan service id to work with the neighbor. type: str
more...
Supported Version Ranges:
v7.4.1 -> latest
- health_check (Alias name: health-check) Sd-wan health-check name. type: str
more...
- neighbor_hold_boot_time (Alias name: neighbor-hold-boot-time) Waiting period in seconds when switching from the primary neighbor to the secondary neighbor from the neighbor start. type: int
more...
Supported Version Ranges:
v6.4.1 -> latest - neighbor_hold_down (Alias name: neighbor-hold-down) Enable/disable hold switching from the secondary neighbor to the primary neighbor. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.4.1 -> latest - neighbor_hold_down_time (Alias name: neighbor-hold-down-time) Waiting period in seconds when switching from the secondary neighbor to the primary neighbor when hold-down is disabled. type: int
more...
Supported Version Ranges:
v6.4.1 -> latest - service type: list
more...
Supported Version Ranges:
v6.4.1 -> latest- addr_mode (Alias name: addr-mode) Address mode (ipv4 or ipv6). type: str choices: [ipv4, ipv6]
more...
Supported Version Ranges:
v6.4.1 -> latest - bandwidth_weight (Alias name: bandwidth-weight) Coefficient of reciprocal of available bidirectional bandwidth in the formula of custom-profile-1. type: int
more...
Supported Version Ranges:
v6.4.1 -> latest - default Enable/disable use of sd-wan as default service. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.4.1 -> latest - dscp_forward (Alias name: dscp-forward) Enable/disable forward traffic dscp tag. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.4.1 -> latest - dscp_forward_tag (Alias name: dscp-forward-tag) Forward traffic dscp tag. type: str
more...
Supported Version Ranges:
v6.4.1 -> latest - dscp_reverse (Alias name: dscp-reverse) Enable/disable reverse traffic dscp tag. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.4.1 -> latest - dscp_reverse_tag (Alias name: dscp-reverse-tag) Reverse traffic dscp tag. type: str
more...
Supported Version Ranges:
v6.4.1 -> latest - dst Destination address name. type: list or str
more...
Supported Version Ranges:
v6.4.1 -> latest - dst_negate (Alias name: dst-negate) Enable/disable negation of destination address match. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.4.1 -> latest - dst6 Destination address6 name. type: list or str
more...
Supported Version Ranges:
v6.4.1 -> latest - end_port (Alias name: end-port) End destination port number. type: int
more...
Supported Version Ranges:
v6.4.1 -> latest - gateway Enable/disable sd-wan service gateway. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.4.1 -> latest - groups User groups. type: list or str
more...
Supported Version Ranges:
v6.4.1 -> latest - hash_mode (Alias name: hash-mode) Hash algorithm for selected priority members for load balance mode. type: str choices: [round-robin, source-ip-based, source-dest-ip-based, inbandwidth, outbandwidth, bibandwidth]
more...
Supported Version Ranges:
v6.4.2 -> latest - health_check (Alias name: health-check) Health check list. type: list or str
more...
Supported Version Ranges:
v6.4.1 -> latest - hold_down_time (Alias name: hold-down-time) Waiting period in seconds when switching from the back-up member to the primary member (0 - 10000000, default = 0). type: int
more...
Supported Version Ranges:
v6.4.1 -> latest - id Sd-wan rule id (1 - 4000). type: int
more...
Supported Version Ranges:
v6.4.1 -> latest - input_device (Alias name: input-device) Source interface name. type: list or str
more...
Supported Version Ranges:
v6.4.1 -> latest - input_device_negate (Alias name: input-device-negate) Enable/disable negation of input device match. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.4.1 -> latest - internet_service (Alias name: internet-service) Enable/disable use of internet service for application-based load balancing. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.4.1 -> latest - internet_service_app_ctrl (Alias name: internet-service-app-ctrl) type: list
more...
Supported Version Ranges:
v6.4.1 -> latest - internet_service_app_ctrl_group (Alias name: internet-service-app-ctrl-group) Application control based internet service group list. type: list or str
more...
Supported Version Ranges:
v6.4.1 -> latest - internet_service_custom (Alias name: internet-service-custom) Custom internet service name list. type: list or str
more...
Supported Version Ranges:
v6.4.1 -> latest - internet_service_custom_group (Alias name: internet-service-custom-group) Custom internet service group list. type: list or str
more...
Supported Version Ranges:
v6.4.1 -> latest - internet_service_group (Alias name: internet-service-group) Internet service group list. type: list or str
more...
Supported Version Ranges:
v6.4.1 -> latest - internet_service_name (Alias name: internet-service-name) Internet service name list. type: list or str
more...
Supported Version Ranges:
v6.4.1 -> latest - jitter_weight (Alias name: jitter-weight) Coefficient of jitter in the formula of custom-profile-1. type: int
more...
Supported Version Ranges:
v6.4.1 -> latest - latency_weight (Alias name: latency-weight) Coefficient of latency in the formula of custom-profile-1. type: int
more...
Supported Version Ranges:
v6.4.1 -> latest - link_cost_factor (Alias name: link-cost-factor) Link cost factor. type: str choices: [latency, jitter, packet-loss, inbandwidth, outbandwidth, bibandwidth, custom-profile-1]
more...
Supported Version Ranges:
v6.4.1 -> latest - link_cost_threshold (Alias name: link-cost-threshold) Percentage threshold change of link cost values that will result in policy route regeneration (0 - 10000000, default = 10). type: int
more...
Supported Version Ranges:
v6.4.1 -> latest - minimum_sla_meet_members (Alias name: minimum-sla-meet-members) Minimum number of members which meet sla. type: int
more...
Supported Version Ranges:
v6.4.2 -> latest - mode Control how the sd-wan rule sets the priority of interfaces in the sd-wan. type: str choices: [auto, manual, priority, sla, load-balance]
more...
Supported Version Ranges:
v6.4.1 -> latest - name Sd-wan rule name. type: str
more...
Supported Version Ranges:
v6.4.1 -> latest - packet_loss_weight (Alias name: packet-loss-weight) Coefficient of packet-loss in the formula of custom-profile-1. type: int
more...
Supported Version Ranges:
v6.4.1 -> latest - priority_members (Alias name: priority-members) Member sequence number list. type: list or str
more...
Supported Version Ranges:
v6.4.1 -> latest - protocol Protocol number. type: int
more...
Supported Version Ranges:
v6.4.1 -> latest - quality_link (Alias name: quality-link) Quality grade. type: int
more...
Supported Version Ranges:
v6.4.1 -> latest - role Service role to work with neighbor. type: str choices: [primary, secondary, standalone]
more...
Supported Version Ranges:
v6.4.1 -> latest - route_tag (Alias name: route-tag) Ipv4 route map route-tag. type: int
more...
Supported Version Ranges:
v6.4.1 -> latest - sla type: list
more...
Supported Version Ranges:
v6.4.1 -> latest - sla_compare_method (Alias name: sla-compare-method) Method to compare sla value for sla mode. type: str choices: [order, number]
more...
Supported Version Ranges:
v6.4.1 -> latest - src Source address name. type: list or str
more...
Supported Version Ranges:
v6.4.1 -> latest - src_negate (Alias name: src-negate) Enable/disable negation of source address match. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.4.1 -> latest - src6 Source address6 name. type: list or str
more...
Supported Version Ranges:
v6.4.1 -> latest - standalone_action (Alias name: standalone-action) Enable/disable service when selected neighbor role is standalone while service role is not standalone. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.4.1 -> latest - start_port (Alias name: start-port) Start destination port number. type: int
more...
Supported Version Ranges:
v6.4.1 -> latest - status Enable/disable sd-wan service. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.4.1 -> latest - tos Type of service bit pattern. type: str
more...
Supported Version Ranges:
v6.4.1 -> latest - tos_mask (Alias name: tos-mask) Type of service evaluated bits. type: str
more...
Supported Version Ranges:
v6.4.1 -> latest - users User name. type: list or str
more...
Supported Version Ranges:
v6.4.1 -> latest - tie_break (Alias name: tie-break) Method of selecting member if more than one meets the sla. type: str choices: [zone, cfg-order, fib-best-match, input-device]
more...
Supported Version Ranges:
v6.4.3 -> latest - use_shortcut_sla (Alias name: use-shortcut-sla) Enable/disable use of advpn shortcut for quality comparison. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.4.4 -> latest - input_zone (Alias name: input-zone) type: list
more...
Supported Version Ranges:
v7.2.0 -> latest - internet_service_app_ctrl_category (Alias name: internet-service-app-ctrl-category) type: list
more...
Supported Version Ranges:
v7.2.0 -> latest - passive_measurement (Alias name: passive-measurement) Enable/disable passive measurement based on the service criteria. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.2 -> latest - priority_zone (Alias name: priority-zone) type: list or str
more...
Supported Version Ranges:
v7.0.1 -> latest - agent_exclusive (Alias name: agent-exclusive) Set/unset the service as agent use exclusively. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.2.2 -> latest - shortcut Enable/disable shortcut for this service. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.4.0 -> latest - shortcut_stickiness (Alias name: shortcut-stickiness) Enable/disable shortcut-stickiness of advpn. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.4.0 -> v7.4.1 - end_src_port (Alias name: end-src-port) End source port number. type: int
more...
Supported Version Ranges:
v7.4.1 -> latest - load_balance (Alias name: load-balance) Enable/disable load-balance. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.4.1 -> latest - sla_stickiness (Alias name: sla-stickiness) Enable/disable sla stickiness (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.4.1 -> latest - start_src_port (Alias name: start-src-port) Start source port number. type: int
more...
Supported Version Ranges:
v7.4.1 -> latest - zone_mode (Alias name: zone-mode) Enable/disable zone mode. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.4.1 -> latest - shortcut_priority (Alias name: shortcut-priority) High priority of advpn shortcut for this service. type: str choices: [disable, enable, auto]
more...
Supported Version Ranges:
v7.4.2 -> latest
- addr_mode (Alias name: addr-mode) Address mode (ipv4 or ipv6). type: str choices: [ipv4, ipv6]
more...
- status Enable/disable sd-wan. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.4.1 -> latest - zone type: list
more...
Supported Version Ranges:
v6.4.1 -> latest- name Zone name. type: str
more...
Supported Version Ranges:
v6.4.1 -> latest - service_sla_tie_break (Alias name: service-sla-tie-break) Method of selecting member if more than one meets the sla. type: str choices: [cfg-order, fib-best-match, input-device]
more...
Supported Version Ranges:
v6.4.3 -> latest - minimum_sla_meet_members (Alias name: minimum-sla-meet-members) Minimum number of members which meet sla when the neighbor is preferred. type: int
more...
Supported Version Ranges:
v7.4.1 -> latest - advpn_health_check (Alias name: advpn-health-check) Health check for advpn local overlay link quality. type: str
more...
Supported Version Ranges:
v7.4.2 -> latest - advpn_select (Alias name: advpn-select) Enable/disable selection of advpn based on sdwan information. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.4.2 -> latest
- name Zone name. type: str
more...
- speedtest_bypass_routing (Alias name: speedtest-bypass-routing) Enable/disable bypass routing when speedtest on a sd-wan member. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.1 -> latest - fail_alert_interfaces (Alias name: fail-alert-interfaces) type: list
more...
Supported Version Ranges:
v7.2.3 -> latest - app_perf_log_period (Alias name: app-perf-log-period) Time interval in seconds that applicationperformance logs are generated (0 - 3600, default = 0). type: int
more...
Supported Version Ranges:
v7.4.0 -> latest
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
- 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: Configure redundant internet connections using SD-WAN
fortinet.fortimanager.fmgr_wanprof_system_sdwan:
# 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, ...]
adom: <your own value>
wanprof: <your own value>
wanprof_system_sdwan:
duplication:
-
dstaddr: <list or string>
dstaddr6: <list or string>
dstintf: <list or string>
id: <integer>
packet_de_duplication: <value in [disable, enable]>
packet_duplication: <value in [disable, force, on-demand]>
service: <list or string>
srcaddr: <list or string>
srcaddr6: <list or string>
srcintf: <list or string>
service_id: <list or string>
sla_match_service: <value in [disable, enable]>
duplication_max_num: <integer>
fail_detect: <value in [disable, enable]>
health_check:
-
_dynamic_server: <string>
addr_mode: <value in [ipv4, ipv6]>
diffservcode: <string>
dns_match_ip: <string>
dns_request_domain: <string>
failtime: <integer>
ftp_file: <string>
ftp_mode: <value in [passive, port]>
ha_priority: <integer>
http_agent: <string>
http_get: <string>
http_match: <string>
interval: <integer>
members: <list or string>
name: <string>
packet_size: <integer>
password: <list or string>
port: <integer>
probe_count: <integer>
probe_packets: <value in [disable, enable]>
probe_timeout: <integer>
protocol: <value in [ping, tcp-echo, udp-echo, ...]>
quality_measured_method: <value in [half-close, half-open]>
recoverytime: <integer>
security_mode: <value in [none, authentication]>
server: <list or string>
sla:
-
id: <integer>
jitter_threshold: <integer>
latency_threshold: <integer>
link_cost_factor:
- latency
- jitter
- packet-loss
- mos
packetloss_threshold: <integer>
mos_threshold: <string>
priority_in_sla: <integer>
priority_out_sla: <integer>
sla_fail_log_period: <integer>
sla_pass_log_period: <integer>
system_dns: <value in [disable, enable]>
threshold_alert_jitter: <integer>
threshold_alert_latency: <integer>
threshold_alert_packetloss: <integer>
threshold_warning_jitter: <integer>
threshold_warning_latency: <integer>
threshold_warning_packetloss: <integer>
update_cascade_interface: <value in [disable, enable]>
update_static_route: <value in [disable, enable]>
user: <string>
detect_mode: <value in [active, passive, prefer-passive, ...]>
mos_codec: <value in [g711, g722, g729]>
source: <string>
vrf: <integer>
embed_measured_health: <value in [disable, enable]>
sla_id_redistribute: <integer>
class_id: <string>
source6: <string>
load_balance_mode: <value in [source-ip-based, weight-based, usage-based, ...]>
members:
-
_dynamic_member: <string>
comment: <string>
cost: <integer>
gateway: <string>
gateway6: <string>
ingress_spillover_threshold: <integer>
interface: <string>
priority: <integer>
seq_num: <integer>
source: <string>
source6: <string>
spillover_threshold: <integer>
status: <value in [disable, enable]>
volume_ratio: <integer>
weight: <integer>
zone: <string>
priority6: <integer>
preferred_source: <string>
transport_group: <integer>
neighbor:
-
health_check: <string>
ip: <string>
member: <list or string>
role: <value in [primary, secondary, standalone]>
sla_id: <integer>
minimum_sla_meet_members: <integer>
mode: <value in [sla, speedtest]>
service_id: <string>
neighbor_hold_boot_time: <integer>
neighbor_hold_down: <value in [disable, enable]>
neighbor_hold_down_time: <integer>
service:
-
addr_mode: <value in [ipv4, ipv6]>
bandwidth_weight: <integer>
default: <value in [disable, enable]>
dscp_forward: <value in [disable, enable]>
dscp_forward_tag: <string>
dscp_reverse: <value in [disable, enable]>
dscp_reverse_tag: <string>
dst: <list or string>
dst_negate: <value in [disable, enable]>
dst6: <list or string>
end_port: <integer>
gateway: <value in [disable, enable]>
groups: <list or string>
hash_mode: <value in [round-robin, source-ip-based, source-dest-ip-based, ...]>
health_check: <list or string>
hold_down_time: <integer>
id: <integer>
input_device: <list or string>
input_device_negate: <value in [disable, enable]>
internet_service: <value in [disable, enable]>
internet_service_app_ctrl: <list or integer>
internet_service_app_ctrl_group: <list or string>
internet_service_custom: <list or string>
internet_service_custom_group: <list or string>
internet_service_group: <list or string>
internet_service_name: <list or string>
jitter_weight: <integer>
latency_weight: <integer>
link_cost_factor: <value in [latency, jitter, packet-loss, ...]>
link_cost_threshold: <integer>
minimum_sla_meet_members: <integer>
mode: <value in [auto, manual, priority, ...]>
name: <string>
packet_loss_weight: <integer>
priority_members: <list or string>
protocol: <integer>
quality_link: <integer>
role: <value in [primary, secondary, standalone]>
route_tag: <integer>
sla:
-
health_check: <string>
id: <integer>
sla_compare_method: <value in [order, number]>
src: <list or string>
src_negate: <value in [disable, enable]>
src6: <list or string>
standalone_action: <value in [disable, enable]>
start_port: <integer>
status: <value in [disable, enable]>
tos: <string>
tos_mask: <string>
users: <list or string>
tie_break: <value in [zone, cfg-order, fib-best-match, ...]>
use_shortcut_sla: <value in [disable, enable]>
input_zone: <list or string>
internet_service_app_ctrl_category: <list or integer>
passive_measurement: <value in [disable, enable]>
priority_zone: <list or string>
agent_exclusive: <value in [disable, enable]>
shortcut: <value in [disable, enable]>
shortcut_stickiness: <value in [disable, enable]>
end_src_port: <integer>
load_balance: <value in [disable, enable]>
sla_stickiness: <value in [disable, enable]>
start_src_port: <integer>
zone_mode: <value in [disable, enable]>
shortcut_priority: <value in [disable, enable, auto]>
status: <value in [disable, enable]>
zone:
-
name: <string>
service_sla_tie_break: <value in [cfg-order, fib-best-match, input-device]>
minimum_sla_meet_members: <integer>
advpn_health_check: <string>
advpn_select: <value in [disable, enable]>
speedtest_bypass_routing: <value in [disable, enable]>
fail_alert_interfaces: <list or string>
app_perf_log_period: <integer>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:
- 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
- This module is not guaranteed to have a backwards compatible interface.
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)