chillancezen.fortimanager.fmgr_wanprof_system_sdwan (2.1.6) — module

no description

| "added in version" 1.0.0 of chillancezen.fortimanager"

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

preview | supported by community

Install collection

Install with ansible-galaxy collection install chillancezen.fortimanager:==2.1.6


Add to requirements.yml

  collections:
    - name: chillancezen.fortimanager
      version: 2.1.6

Description

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.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
 - 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]>

Outputs

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_message:
  description: The descriptive message of the api response
  returned: always
  sample: OK.
  type: str