fmgr_wanprof_system_sdwan – Configure redundant internet connections using SD-WAN (formerly virtual WAN link).

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.4.2	6.4.5	7.0.0	7.2.0
wanprof_system_sdwan	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
• adom - The parameter in requested url type: str required: true
• wanprof - The parameter in requested url type: str required: true
• wanprof_system_sdwan - no description type: dict
• duplication - No description for the parameter type: array more...

  	6.4.2	6.4.5	7.0.0	7.2.0
  duplication	True	True	True	True

  • dstaddr - Destination address or address group names. type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    dstaddr	True	True	True	True

  • dstaddr6 - Destination address6 or address6 group names. type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    dstaddr6	True	True	True	True

  • dstintf - Outgoing (egress) interfaces or zones. type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    dstintf	True	True	True	True

  • id - Duplication rule ID (1 - 255). type: int more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    id	True	True	True	True

  • packet-de-duplication - Enable/disable discarding of packets that have been duplicated. type: str choices: [disable, enable] more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    packet-de-duplication	True	True	True	True

  • packet-duplication - Configure packet duplication method. type: str choices: [disable, force, on-demand] more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    packet-duplication	True	True	True	True

  • service - Service and service group name. type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    service	True	True	True	True

  • srcaddr - Source address or address group names. type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    srcaddr	True	True	True	True

  • srcaddr6 - Source address6 or address6 group names. type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    srcaddr6	True	True	True	True

  • srcintf - Incoming (ingress) interfaces or zones. type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    srcintf	True	True	True	True

  • service-id - SD-WAN service rule ID list. type: str more...

    	6.4.5	7.0.0	7.2.0
    service-id	True	True	True

  • sla-match-service - Enable/disable packet duplication matching health-check SLAs in service rule. type: str choices: [disable, enable] more...

    	7.2.0
    sla-match-service	True

• 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...

  	6.4.2	6.4.5	7.0.0	7.2.0
  duplication-max-num	True	True	True	True

• fail-detect - Enable/disable SD-WAN Internet connection status checking (failure detection). type: str choices: [disable, enable] more...

  	6.4.2	6.4.5	7.0.0	7.2.0
  fail-detect	True	True	True	True

• health-check - No description for the parameter type: array more...

  	6.4.2	6.4.5	7.0.0	7.2.0
  health-check	True	True	True	True

  • _dynamic-server - No description for the parameter type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    _dynamic-server	True	True	False	False

  • addr-mode - Address mode (IPv4 or IPv6). type: str choices: [ipv4, ipv6] more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    addr-mode	True	True	True	True

  • diffservcode - Differentiated services code point (DSCP) in the IP header of the probe packet. type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    diffservcode	True	True	True	True

  • dns-match-ip - Response IP expected from DNS server if the protocol is DNS. type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    dns-match-ip	True	True	True	True

  • dns-request-domain - Fully qualified domain name to resolve for the DNS probe. type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    dns-request-domain	True	True	True	True

  • failtime - Number of failures before server is considered lost (1 - 3600, default = 5). type: int more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    failtime	True	True	True	True

  • ftp-file - Full path and file name on the FTP server to download for FTP health-check to probe. type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    ftp-file	True	True	True	True

  • ftp-mode - FTP mode. type: str choices: [passive, port] more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    ftp-mode	True	True	True	True

  • ha-priority - HA election priority (1 - 50). type: int more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    ha-priority	True	True	True	True

  • http-agent - String in the http-agent field in the HTTP header. type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    http-agent	True	True	True	True

  • http-get - URL used to communicate with the server if the protocol if the protocol is HTTP. type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    http-get	True	True	True	True

  • http-match - Response string expected from the server if the protocol is HTTP. type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    http-match	True	True	True	True

  • 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...

    	6.4.2	6.4.5	7.0.0	7.2.0
    interval	True	True	True	True

  • members - Member sequence number list. type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    members	True	True	True	True

  • name - Status check or health check name. type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    name	True	True	True	True

  • packet-size - Packet size of a twamp test session, type: int more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    packet-size	True	True	True	True

  • password - No description for the parameter type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    password	True	True	True	True

  • port - Port number used to communicate with the server over the selected protocol (0-65535, default = 0, auto select. type: int more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    port	True	True	True	True

  • probe-count - Number of most recent probes that should be used to calculate latency and jitter (5 - 30, default = 30). type: int more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    probe-count	True	True	True	True

  • probe-packets - Enable/disable transmission of probe packets. type: str choices: [disable, enable] more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    probe-packets	True	True	True	True

  • probe-timeout - Time to wait before a probe packet is considered lost (500 - 3600*1000 msec, default = 500). type: int more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    probe-timeout	True	True	True	True

  • 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] more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    protocol	True	True	True	True

  • quality-measured-method - Method to measure the quality of tcp-connect. type: str choices: [half-close, half-open] more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    quality-measured-method	True	True	True	True

  • recoverytime - Number of successful responses received before server is considered recovered (1 - 3600, default = 5). type: int more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    recoverytime	True	True	True	True

  • security-mode - Twamp controller security mode. type: str choices: [none, authentication] more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    security-mode	True	True	True	True

  • server - No description for the parameter type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    server	True	True	True	True

  • sla - No description for the parameter type: array more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    sla	True	True	True	True

    • id - SLA ID. type: int more...

      	6.4.2	6.4.5	7.0.0	7.2.0
      id	True	True	True	True

    • jitter-threshold - Jitter for SLA to make decision in milliseconds. type: int more...

      	6.4.2	6.4.5	7.0.0	7.2.0
      jitter-threshold	True	True	True	True

    • latency-threshold - Latency for SLA to make decision in milliseconds. type: int more...

      	6.4.2	6.4.5	7.0.0	7.2.0
      latency-threshold	True	True	True	True

    • link-cost-factor - No description for the parameter type: array choices: [latency, jitter, packet-loss, mos] more...

      	6.4.2	6.4.5	7.0.0	7.2.0
      link-cost-factor	True	True	True	True

    • packetloss-threshold - Packet loss for SLA to make decision in percentage. type: int more...

      	6.4.2	6.4.5	7.0.0	7.2.0
      packetloss-threshold	True	True	True	True

    • mos-threshold - Minimum Mean Opinion Score for SLA to be marked as pass. type: str more...

      	7.2.0
      mos-threshold	True

  • sla-fail-log-period - Time interval in seconds that SLA fail log messages will be generated (0 - 3600, default = 0). type: int more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    sla-fail-log-period	True	True	True	True

  • sla-pass-log-period - Time interval in seconds that SLA pass log messages will be generated (0 - 3600, default = 0). type: int more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    sla-pass-log-period	True	True	True	True

  • system-dns - Enable/disable system DNS as the probe server. type: str choices: [disable, enable] more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    system-dns	True	True	True	True

  • threshold-alert-jitter - Alert threshold for jitter (ms, default = 0). type: int more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    threshold-alert-jitter	True	True	True	True

  • threshold-alert-latency - Alert threshold for latency (ms, default = 0). type: int more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    threshold-alert-latency	True	True	True	True

  • threshold-alert-packetloss - Alert threshold for packet loss (percentage, default = 0). type: int more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    threshold-alert-packetloss	True	True	True	True

  • threshold-warning-jitter - Warning threshold for jitter (ms, default = 0). type: int more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    threshold-warning-jitter	True	True	True	True

  • threshold-warning-latency - Warning threshold for latency (ms, default = 0). type: int more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    threshold-warning-latency	True	True	True	True

  • threshold-warning-packetloss - Warning threshold for packet loss (percentage, default = 0). type: int more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    threshold-warning-packetloss	True	True	True	True

  • update-cascade-interface - Enable/disable update cascade interface. type: str choices: [disable, enable] more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    update-cascade-interface	True	True	True	True

  • update-static-route - Enable/disable updating the static route. type: str choices: [disable, enable] more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    update-static-route	True	True	True	True

  • user - The user name to access probe server. type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    user	True	True	True	True

  • detect-mode - The mode determining how to detect the server. type: str choices: [active, passive, prefer-passive] more...

    	7.0.0	7.2.0
    detect-mode	True	True

  • mos-codec - Codec to use for MOS calculation (default = g711). type: str choices: [g711, g722, g729] more...

    	7.2.0
    mos-codec	True

  • source - Source IP address used in the health-check packet to the server. type: str more...

    	7.2.0
    source	True

  • vrf - Virtual Routing Forwarding ID. type: int more...

    	7.2.0
    vrf	True

• 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...

  	6.4.2	6.4.5	7.0.0	7.2.0
  load-balance-mode	True	True	True	True

• members - No description for the parameter type: array more...

  	6.4.2	6.4.5	7.0.0	7.2.0
  members	True	True	True	True

  • _dynamic-member - No description for the parameter type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    _dynamic-member	True	True	False	False

  • comment - Comments. type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    comment	True	True	True	True

  • cost - Cost of this interface for services in SLA mode (0 - 4294967295, default = 0). type: int more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    cost	True	True	True	True

  • gateway - The default gateway for this interface. type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    gateway	True	True	True	True

  • gateway6 - IPv6 gateway. type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    gateway6	True	True	True	True

  • ingress-spillover-threshold - Ingress spillover threshold for this interface (0 - 16776000 kbit/s). type: int more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    ingress-spillover-threshold	True	True	True	True

  • interface - Interface name. type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    interface	True	True	True	True

  • priority - Priority of the interface (0 - 65535). type: int more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    priority	True	True	True	True

  • seq-num - Sequence number(1-512). type: int more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    seq-num	True	True	True	True

  • source - Source IP address used in the health-check packet to the server. type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    source	True	True	True	True

  • source6 - Source IPv6 address used in the health-check packet to the server. type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    source6	True	True	True	True

  • spillover-threshold - Egress spillover threshold for this interface (0 - 16776000 kbit/s). type: int more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    spillover-threshold	True	True	True	True

  • status - Enable/disable this interface in the SD-WAN. type: str choices: [disable, enable] more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    status	True	True	True	True

  • volume-ratio - Measured volume ratio (this value / sum of all values = percentage of link volume, 1 - 255). type: int more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    volume-ratio	True	True	True	True

  • weight - Weight of this interface for weighted load balancing. type: int more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    weight	True	True	True	True

  • zone - Zone name. type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    zone	True	True	True	True

  • priority6 - Priority of the interface for IPv6 (1 - 65535, default = 1024). type: int more...

    	7.0.0	7.2.0
    priority6	True	True

• neighbor - No description for the parameter type: array more...

  	6.4.2	6.4.5	7.0.0	7.2.0
  neighbor	True	True	True	True

  • health-check - SD-WAN health-check name. type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    health-check	True	True	True	True

  • ip - IP/IPv6 address of neighbor. type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    ip	True	True	True	True

  • member - Member sequence number. type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    member	True	True	True	True

  • role - Role of neighbor. type: str choices: [primary, secondary, standalone] more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    role	True	True	True	True

  • sla-id - SLA ID. type: int more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    sla-id	True	True	True	True

  • minimum-sla-meet-members - Minimum number of members which meet SLA when the neighbor is preferred. type: int more...

    	7.2.0
    minimum-sla-meet-members	True

  • mode - What metric to select the neighbor. type: str choices: [sla, speedtest] more...

    	7.2.0
    mode	True

• 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...

  	6.4.2	6.4.5	7.0.0	7.2.0
  neighbor-hold-boot-time	True	True	True	True

• neighbor-hold-down - Enable/disable hold switching from the secondary neighbor to the primary neighbor. type: str choices: [disable, enable] more...

  	6.4.2	6.4.5	7.0.0	7.2.0
  neighbor-hold-down	True	True	True	True

• 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...

  	6.4.2	6.4.5	7.0.0	7.2.0
  neighbor-hold-down-time	True	True	True	True

• service - No description for the parameter type: array more...

  	6.4.2	6.4.5	7.0.0	7.2.0
  service	True	True	True	True

  • addr-mode - Address mode (IPv4 or IPv6). type: str choices: [ipv4, ipv6] more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    addr-mode	True	True	True	True

  • bandwidth-weight - Coefficient of reciprocal of available bidirectional bandwidth in the formula of custom-profile-1. type: int more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    bandwidth-weight	True	True	True	True

  • default - Enable/disable use of SD-WAN as default service. type: str choices: [disable, enable] more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    default	True	True	True	True

  • dscp-forward - Enable/disable forward traffic DSCP tag. type: str choices: [disable, enable] more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    dscp-forward	True	True	True	True

  • dscp-forward-tag - Forward traffic DSCP tag. type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    dscp-forward-tag	True	True	True	True

  • dscp-reverse - Enable/disable reverse traffic DSCP tag. type: str choices: [disable, enable] more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    dscp-reverse	True	True	True	True

  • dscp-reverse-tag - Reverse traffic DSCP tag. type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    dscp-reverse-tag	True	True	True	True

  • dst - Destination address name. type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    dst	True	True	True	True

  • dst-negate - Enable/disable negation of destination address match. type: str choices: [disable, enable] more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    dst-negate	True	True	True	True

  • dst6 - Destination address6 name. type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    dst6	True	True	True	True

  • end-port - End destination port number. type: int more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    end-port	True	True	True	True

  • gateway - Enable/disable SD-WAN service gateway. type: str choices: [disable, enable] more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    gateway	True	True	True	True

  • groups - User groups. type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    groups	True	True	True	True

  • 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...

    	6.4.2	6.4.5	7.0.0	7.2.0
    hash-mode	True	True	True	True

  • health-check - Health check list. type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    health-check	True	True	True	True

  • 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...

    	6.4.2	6.4.5	7.0.0	7.2.0
    hold-down-time	True	True	True	True

  • id - SD-WAN rule ID (1 - 4000). type: int more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    id	True	True	True	True

  • input-device - Source interface name. type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    input-device	True	True	True	True

  • input-device-negate - Enable/disable negation of input device match. type: str choices: [disable, enable] more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    input-device-negate	True	True	True	True

  • internet-service - Enable/disable use of Internet service for application-based load balancing. type: str choices: [disable, enable] more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    internet-service	True	True	True	True

  • internet-service-app-ctrl - No description for the parameter type: int more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    internet-service-app-ctrl	True	True	True	True

  • internet-service-app-ctrl-group - Application control based Internet Service group list. type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    internet-service-app-ctrl-group	True	True	True	True

  • internet-service-custom - Custom Internet service name list. type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    internet-service-custom	True	True	True	True

  • internet-service-custom-group - Custom Internet Service group list. type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    internet-service-custom-group	True	True	True	True

  • internet-service-group - Internet Service group list. type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    internet-service-group	True	True	True	True

  • internet-service-name - Internet service name list. type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    internet-service-name	True	True	True	True

  • jitter-weight - Coefficient of jitter in the formula of custom-profile-1. type: int more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    jitter-weight	True	True	True	True

  • latency-weight - Coefficient of latency in the formula of custom-profile-1. type: int more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    latency-weight	True	True	True	True

  • link-cost-factor - Link cost factor. type: str choices: [latency, jitter, packet-loss, inbandwidth, outbandwidth, bibandwidth, custom-profile-1] more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    link-cost-factor	True	True	True	True

  • link-cost-threshold - Percentage threshold change of link cost values that will result in policy route regeneration (0 - 10000000, default = 10). type: int more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    link-cost-threshold	True	True	True	True

  • minimum-sla-meet-members - Minimum number of members which meet SLA. type: int more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    minimum-sla-meet-members	True	True	True	True

  • 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...

    	6.4.2	6.4.5	7.0.0	7.2.0
    mode	True	True	True	True

  • name - SD-WAN rule name. type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    name	True	True	True	True

  • packet-loss-weight - Coefficient of packet-loss in the formula of custom-profile-1. type: int more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    packet-loss-weight	True	True	True	True

  • priority-members - Member sequence number list. type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    priority-members	True	True	True	True

  • protocol - Protocol number. type: int more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    protocol	True	True	True	True

  • quality-link - Quality grade. type: int more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    quality-link	True	True	True	True

  • role - Service role to work with neighbor. type: str choices: [primary, secondary, standalone] more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    role	True	True	True	True

  • route-tag - IPv4 route map route-tag. type: int more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    route-tag	True	True	True	True

  • sla - No description for the parameter type: array more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    sla	True	True	True	True

    • health-check - SD-WAN health-check. type: str more...

      	6.4.2	6.4.5	7.0.0	7.2.0
      health-check	True	True	True	True

    • id - SLA ID. type: int more...

      	6.4.2	6.4.5	7.0.0	7.2.0
      id	True	True	True	True

  • sla-compare-method - Method to compare SLA value for SLA mode. type: str choices: [order, number] more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    sla-compare-method	True	True	True	True

  • src - Source address name. type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    src	True	True	True	True

  • src-negate - Enable/disable negation of source address match. type: str choices: [disable, enable] more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    src-negate	True	True	True	True

  • src6 - Source address6 name. type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    src6	True	True	True	True

  • standalone-action - Enable/disable service when selected neighbor role is standalone while service role is not standalone. type: str choices: [disable, enable] more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    standalone-action	True	True	True	True

  • start-port - Start destination port number. type: int more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    start-port	True	True	True	True

  • status - Enable/disable SD-WAN service. type: str choices: [disable, enable] more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    status	True	True	True	True

  • tos - Type of service bit pattern. type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    tos	True	True	True	True

  • tos-mask - Type of service evaluated bits. type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    tos-mask	True	True	True	True

  • users - User name. type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    users	True	True	True	True

  • 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...

    	6.4.5	7.0.0	7.2.0
    tie-break	True	True	True

  • use-shortcut-sla - Enable/disable use of ADVPN shortcut for quality comparison. type: str choices: [disable, enable] more...

    	6.4.5	7.0.0	7.2.0
    use-shortcut-sla	True	True	True

  • input-zone - No description for the parameter type: str more...

    	7.2.0
    input-zone	True

  • internet-service-app-ctrl-category - No description for the parameter type: int more...

    	7.2.0
    internet-service-app-ctrl-category	True

  • passive-measurement - Enable/disable passive measurement based on the service criteria. type: str choices: [disable, enable] more...

    	7.2.0
    passive-measurement	True

  • priority-zone - No description for the parameter type: str more...

    	7.2.0
    priority-zone	True

• status - Enable/disable SD-WAN. type: str choices: [disable, enable] more...

  	6.4.2	6.4.5	7.0.0	7.2.0
  status	True	True	True	True

• zone - No description for the parameter type: array more...

  	6.4.2	6.4.5	7.0.0	7.2.0
  zone	True	True	True	True

  • name - Zone name. type: str more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    name	True	True	True	True

  • 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...

    	6.4.5	7.0.0	7.2.0
    service-sla-tie-break	True	True	True

• speedtest-bypass-routing - Enable/disable bypass routing when speedtest on a SD-WAN member. type: str choices: [disable, enable] more...

  	7.2.0
  speedtest-bypass-routing	True

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_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: <value of string>
                 dstaddr6: <value of string>
                 dstintf: <value of string>
                 id: <value of integer>
                 packet-de-duplication: <value in [disable, enable]>
                 packet-duplication: <value in [disable, force, on-demand]>
                 service: <value of string>
                 srcaddr: <value of string>
                 srcaddr6: <value of string>
                 srcintf: <value of string>
                 service-id: <value of string>
                 sla-match-service: <value in [disable, enable]>
           duplication-max-num: <value of integer>
           fail-detect: <value in [disable, enable]>
           health-check:
             -
                 _dynamic-server: <value of string>
                 addr-mode: <value in [ipv4, ipv6]>
                 diffservcode: <value of string>
                 dns-match-ip: <value of string>
                 dns-request-domain: <value of string>
                 failtime: <value of integer>
                 ftp-file: <value of string>
                 ftp-mode: <value in [passive, port]>
                 ha-priority: <value of integer>
                 http-agent: <value of string>
                 http-get: <value of string>
                 http-match: <value of string>
                 interval: <value of integer>
                 members: <value of string>
                 name: <value of string>
                 packet-size: <value of integer>
                 password: <value of string>
                 port: <value of integer>
                 probe-count: <value of integer>
                 probe-packets: <value in [disable, enable]>
                 probe-timeout: <value of integer>
                 protocol: <value in [ping, tcp-echo, udp-echo, ...]>
                 quality-measured-method: <value in [half-close, half-open]>
                 recoverytime: <value of integer>
                 security-mode: <value in [none, authentication]>
                 server: <value of string>
                 sla:
                   -
                       id: <value of integer>
                       jitter-threshold: <value of integer>
                       latency-threshold: <value of integer>
                       link-cost-factor:
                         - latency
                         - jitter
                         - packet-loss
                         - mos
                       packetloss-threshold: <value of integer>
                       mos-threshold: <value of string>
                 sla-fail-log-period: <value of integer>
                 sla-pass-log-period: <value of integer>
                 system-dns: <value in [disable, enable]>
                 threshold-alert-jitter: <value of integer>
                 threshold-alert-latency: <value of integer>
                 threshold-alert-packetloss: <value of integer>
                 threshold-warning-jitter: <value of integer>
                 threshold-warning-latency: <value of integer>
                 threshold-warning-packetloss: <value of integer>
                 update-cascade-interface: <value in [disable, enable]>
                 update-static-route: <value in [disable, enable]>
                 user: <value of string>
                 detect-mode: <value in [active, passive, prefer-passive]>
                 mos-codec: <value in [g711, g722, g729]>
                 source: <value of string>
                 vrf: <value of integer>
           load-balance-mode: <value in [source-ip-based, weight-based, usage-based, ...]>
           members:
             -
                 _dynamic-member: <value of string>
                 comment: <value of string>
                 cost: <value of integer>
                 gateway: <value of string>
                 gateway6: <value of string>
                 ingress-spillover-threshold: <value of integer>
                 interface: <value of string>
                 priority: <value of integer>
                 seq-num: <value of integer>
                 source: <value of string>
                 source6: <value of string>
                 spillover-threshold: <value of integer>
                 status: <value in [disable, enable]>
                 volume-ratio: <value of integer>
                 weight: <value of integer>
                 zone: <value of string>
                 priority6: <value of integer>
           neighbor:
             -
                 health-check: <value of string>
                 ip: <value of string>
                 member: <value of string>
                 role: <value in [primary, secondary, standalone]>
                 sla-id: <value of integer>
                 minimum-sla-meet-members: <value of integer>
                 mode: <value in [sla, speedtest]>
           neighbor-hold-boot-time: <value of integer>
           neighbor-hold-down: <value in [disable, enable]>
           neighbor-hold-down-time: <value of integer>
           service:
             -
                 addr-mode: <value in [ipv4, ipv6]>
                 bandwidth-weight: <value of integer>
                 default: <value in [disable, enable]>
                 dscp-forward: <value in [disable, enable]>
                 dscp-forward-tag: <value of string>
                 dscp-reverse: <value in [disable, enable]>
                 dscp-reverse-tag: <value of string>
                 dst: <value of string>
                 dst-negate: <value in [disable, enable]>
                 dst6: <value of string>
                 end-port: <value of integer>
                 gateway: <value in [disable, enable]>
                 groups: <value of string>
                 hash-mode: <value in [round-robin, source-ip-based, source-dest-ip-based, ...]>
                 health-check: <value of string>
                 hold-down-time: <value of integer>
                 id: <value of integer>
                 input-device: <value of string>
                 input-device-negate: <value in [disable, enable]>
                 internet-service: <value in [disable, enable]>
                 internet-service-app-ctrl: <value of integer>
                 internet-service-app-ctrl-group: <value of string>
                 internet-service-custom: <value of string>
                 internet-service-custom-group: <value of string>
                 internet-service-group: <value of string>
                 internet-service-name: <value of string>
                 jitter-weight: <value of integer>
                 latency-weight: <value of integer>
                 link-cost-factor: <value in [latency, jitter, packet-loss, ...]>
                 link-cost-threshold: <value of integer>
                 minimum-sla-meet-members: <value of integer>
                 mode: <value in [auto, manual, priority, ...]>
                 name: <value of string>
                 packet-loss-weight: <value of integer>
                 priority-members: <value of string>
                 protocol: <value of integer>
                 quality-link: <value of integer>
                 role: <value in [primary, secondary, standalone]>
                 route-tag: <value of integer>
                 sla:
                   -
                       health-check: <value of string>
                       id: <value of integer>
                 sla-compare-method: <value in [order, number]>
                 src: <value of string>
                 src-negate: <value in [disable, enable]>
                 src6: <value of string>
                 standalone-action: <value in [disable, enable]>
                 start-port: <value of integer>
                 status: <value in [disable, enable]>
                 tos: <value of string>
                 tos-mask: <value of string>
                 users: <value of string>
                 tie-break: <value in [zone, cfg-order, fib-best-match, ...]>
                 use-shortcut-sla: <value in [disable, enable]>
                 input-zone: <value of string>
                 internet-service-app-ctrl-category: <value of integer>
                 passive-measurement: <value in [disable, enable]>
                 priority-zone: <value of string>
           status: <value in [disable, enable]>
           zone:
             -
                 name: <value of string>
                 service-sla-tie-break: <value in [cfg-order, fib-best-match, input-device]>
           speedtest-bypass-routing: <value in [disable, enable]>

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

Status

• This module is not guaranteed to have a backwards compatible interface.

Authors

• Link Zheng (@chillancezen)
• Jie Xue (@JieX19)
• Frank Shen (@fshen01)
• Hongbin Lu (@fgtdev-hblu)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.