drmofu.fortimanager.fmgr_wanprof_system_virtualwanlink_healthcheck (2.2.2) — module

Install collection

Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2

Add to requirements.yml

  collections:
    - name: drmofu.fortimanager
      version: 2.2.2

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

Scanned by Steampunk Spotter

• 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: SD-WAN status checking or health checking.
      fmgr_wanprof_system_virtualwanlink_healthcheck:
         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>
         state: <value in [present, absent]>
         wanprof_system_virtualwanlink_healthcheck:
            _dynamic-server: <value of string>
            addr-mode: <value in [ipv4, ipv6]>
            failtime: <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>
            protocol: <value in [ping, tcp-echo, udp-echo, ...]>
            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
                  packetloss-threshold: <value of integer>
            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]>
            internet-service-id: <value of string>
            probe-packets: <value in [disable, enable]>
            sla-fail-log-period: <value of integer>
            sla-pass-log-period: <value of integer>
            timeout: <value of integer>
            ha-priority: <value of integer>
            diffservcode: <value of string>
            probe-timeout: <value of integer>
            dns-request-domain: <value of string>
            probe-count: <value of integer>
            system-dns: <value in [disable, enable]>

Inputs

    
adom:
    description: the parameter (adom) in requested url
    required: true
    type: str

state:
    choices:
    - present
    - absent
    description: The directive to create, update or delete an object.
    required: true
    type: str

wanprof:
    description: the parameter (wanprof) in requested url
    required: true
    type: str

rc_failed:
    description: The rc codes list with which the conditions to fail will be overriden.
    elements: int
    required: false
    type: list

enable_log:
    default: false
    description: Enable/Disable logging for task.
    required: false
    type: bool

access_token:
    description: The token to access FortiManager without using username and password.
    required: false
    type: str

rc_succeeded:
    description: The rc codes list with which the conditions to succeed will be overriden.
    elements: int
    required: false
    type: list

proposed_method:
    choices:
    - update
    - set
    - add
    description: The overridden method for the underlying Json RPC request.
    required: false
    type: str

bypass_validation:
    default: false
    description: Only set to True when module schema diffs with FortiManager API structure,
      module continues to execute without validating parameters.
    required: false
    type: bool

workspace_locking_adom:
    description: The adom to lock for FortiManager running in workspace mode, the value
      can be global and others including root.
    required: false
    type: str

forticloud_access_token:
    description: Authenticate Ansible client with forticloud API access token.
    required: false
    type: str

workspace_locking_timeout:
    default: 300
    description: The maximum time in seconds to wait for other user to release the workspace
      lock.
    required: false
    type: int

wanprof_system_virtualwanlink_healthcheck:
    description: the top level parameters set
    required: false
    suboptions:
      _dynamic-server:
        description: no description
        type: str
      addr-mode:
        choices:
        - ipv4
        - ipv6
        description: Address mode
        type: str
      diffservcode:
        description: Differentiated services code point
        type: str
      dns-request-domain:
        description: Fully qualified domain name to resolve for the DNS probe.
        type: str
      failtime:
        description: Number of failures before server is considered lost
        type: int
      ha-priority:
        description: HA election priority
        type: int
      http-agent:
        description: String in the http-agent field in the HTTP header.
        type: str
      http-get:
        description: URL used to communicate with the server if the protocol if the protocol
          is HTTP.
        type: str
      http-match:
        description: Response string expected from the server if the protocol is HTTP.
        type: str
      internet-service-id:
        description: Internet service ID.
        type: str
      interval:
        description: Status check interval, or the time between attempting to connect
          to the server
        type: int
      members:
        description: Member sequence number list.
        type: str
      name:
        description: Status check or health check name.
        type: str
      packet-size:
        description: Packet size of a twamp test session,
        type: int
      password:
        description: description
        type: str
      port:
        description: Port number used to communicate with the server over the selected
          protocol.
        type: int
      probe-count:
        description: Number of most recent probes that should be used to calculate latency
          and jitter
        type: int
      probe-packets:
        choices:
        - disable
        - enable
        description: Enable/disable transmission of probe packets.
        type: str
      probe-timeout:
        description: Time to wait before a probe packet is considered lost
        type: int
      protocol:
        choices:
        - ping
        - tcp-echo
        - udp-echo
        - http
        - twamp
        - ping6
        - dns
        description: Protocol used to determine if the FortiGate can communicate with
          the server.
        type: str
      recoverytime:
        description: Number of successful responses received before server is considered
          recovered
        type: int
      security-mode:
        choices:
        - none
        - authentication
        description: Twamp controller security mode.
        type: str
      server:
        description: description
        type: str
      sla:
        description: description
        elements: dict
        suboptions:
          id:
            description: SLA ID.
            type: int
          jitter-threshold:
            description: Jitter for SLA to make decision in milliseconds.
            type: int
          latency-threshold:
            description: Latency for SLA to make decision in milliseconds.
            type: int
          link-cost-factor:
            choices:
            - latency
            - jitter
            - packet-loss
            description: description
            elements: str
            type: list
          packetloss-threshold:
            description: Packet loss for SLA to make decision in percentage.
            type: int
        type: list
      sla-fail-log-period:
        description: Time interval in seconds that SLA fail log messages will be generated
        type: int
      sla-pass-log-period:
        description: Time interval in seconds that SLA pass log messages will be generated
        type: int
      system-dns:
        choices:
        - disable
        - enable
        description: Enable/disable system DNS as the probe server.
        type: str
      threshold-alert-jitter:
        description: Alert threshold for jitter
        type: int
      threshold-alert-latency:
        description: Alert threshold for latency
        type: int
      threshold-alert-packetloss:
        description: Alert threshold for packet loss
        type: int
      threshold-warning-jitter:
        description: Warning threshold for jitter
        type: int
      threshold-warning-latency:
        description: Warning threshold for latency
        type: int
      threshold-warning-packetloss:
        description: Warning threshold for packet loss
        type: int
      timeout:
        description: How long to wait before not receiving a reply from the server to
          consider the connetion attempt a failure
        type: int
      update-cascade-interface:
        choices:
        - disable
        - enable
        description: Enable/disable update cascade interface.
        type: str
      update-static-route:
        choices:
        - disable
        - enable
        description: Enable/disable updating the static route.
        type: str
    type: dict

Outputs

meta:
  contains:
    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_data:
      description: The api response.
      returned: always
      type: list
    response_message:
      description: The descriptive message of the api response.
      returned: always
      sample: OK.
      type: str
    system_information:
      description: The information of the target system.
      returned: always
      type: dict
  description: The result of the request.
  returned: always
  type: dict
rc:
  description: The status the request.
  returned: always
  sample: 0
  type: int
version_check_warning:
  description: Warning if the parameters used in the playbook are not supported by
    the current FortiManager version.
  returned: complex
  type: list