radware.radware_modules.alteon_config_health_check_http (0.6.12) — module

Manage HTTP health check in Radware Alteon

| "added in version" 2.9 of radware.radware_modules"

Authors: Leon Meguira (@leonmeguira), Nati Fridman (@natifridman)

stableinterface | supported by certified

Install collection

Install with ansible-galaxy collection install radware.radware_modules:==0.6.12


Add to requirements.yml

  collections:
    - name: radware.radware_modules
      version: 0.6.12

Description

Manage HTTP health check in Radware Alteon


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: alteon configuration command
  radware.radware_modules.alteon_config_health_check_http:
    provider: 
      server: 192.168.1.1
      user: admin
      password: admin
      validate_certs: no
      https_port: 443
      ssh_port: 22
      timeout: 5
    state: present
    parameters:
      index: test_http_hc
      description: test_http_hc
      ip_ver: ipv4
      destination_ip_or_hostname: 1.1.1.1
      connection_termination: rst
      standalone_real_hc_mode: enabled
      interval_second: 5
      interval_downtime_second: 4
      https: enabled
      http2: enabled
      http_hostname: hostanme.com
      return_string_lookup_type: incl
      overload_string_lookup_type: incl
      return_value: some_value
      overload_value: overload_value
      https_cipher: userDefined
      https_user_defined_cipher: ALL:!DH:!NULL:!aNULL:!EXPORT:!RC4:!RC2:!3DES:!DES:!DSS:!SRP:!PSK:!IDEA:!SSLv2:!RSA

Inputs

    
state:
    choices:
    - present
    - absent
    - read
    - overwrite
    - append
    default: null
    description:
    - When C(present), guarantees that the object exists with the provided attributes.
    - When C(absent), when applicable removes the object.
    - When C(read), when exists read object from configuration to parameter format.
    - When C(overwrite), removes the object if exists then recreate it
    - When C(append), append object configuration with the provided parameters
    required: true

provider:
    description:
    - Radware Alteon connection details.
    required: true
    suboptions:
      https_port:
        default: null
        description:
        - Radware Alteon https port.
        required: true
      password:
        default: null
        description:
        - Radware Alteon password.
        required: true
      server:
        default: null
        description:
        - Radware Alteon IP address.
        required: true
      ssh_port:
        default: null
        description:
        - Radware Alteon ssh port.
        required: true
      timeout:
        default: null
        description:
        - Timeout for connection.
        required: true
      user:
        default: null
        description:
        - Radware Alteon username.
        required: true
      validate_certs:
        default: null
        description:
        - If C(no), SSL certificates will not be validated.
        - This should only set to C(no) used on personally controlled sites using self-signed
          certificates.
        required: true
        type: bool

parameters:
    description:
    - Parameters for HTTP health check configuration.
    suboptions:
      auth_password:
        default: null
        description:
        - Set authentication password.
        required: false
        type: str
      auth_username:
        default: null
        description:
        - Set authentication username.
        required: false
        type: str
      authentication:
        choices:
        - none
        - basic
        - ntlm2
        - ntlmssp
        default: null
        description:
        - Set authentication.
        required: false
      connection_termination:
        choices:
        - fin
        - rst
        default: null
        description:
        - Set connection termination.
        required: false
      description:
        default: null
        description:
        - Descriptive health check name.
        required: false
        type: str
      destination_ip_or_hostname:
        default: null
        description: -Destination address or hostname.
        required: false
        type: str
      destination_port:
        default: null
        description:
        - Application port.
        required: false
        type: int
      expected_return_codes:
        default: null
        description:
        - Set expected response status code.
        required: false
        type: str
      http2:
        choices:
        - enabled
        - disabled
        default: null
        description:
        - Enable/disable HTTP/2.
        required: false
      http_body:
        default: null
        description:
        - Set request body.
        required: false
        type: str
      http_headers_raw:
        default: null
        description:
        - Set request header.
        required: false
        type: str
      http_hostname:
        default: null
        description:
        - Set host header.
        required: false
        type: str
      http_method:
        choices:
        - get
        - post
        - head
        default: null
        description:
        - Set HTTP method.
        required: false
      http_path:
        default: null
        description:
        - Set request path.
        required: false
        type: str
      https:
        choices:
        - enabled
        - disabled
        default: null
        description:
        - Enable/disable SSL for HTTPS Health check.
        required: false
      https_cipher:
        choices:
        - userDefined
        - low
        - medium
        - high
        default: null
        description:
        - Set cipher-suite for HTTPS Health check.
        required: false
      https_user_defined_cipher:
        default: null
        description:
        - Set user-defined cipher-suite for HTTPS Health check.
        required: false
        type: str
      index:
        default: null
        description:
        - Health check ID.
        required: true
        type: str
      interval_downtime_second:
        default: null
        description:
        - Interval between health checks when server is down.
        required: false
        type: int
      interval_second:
        default: null
        description:
        - Interval between health checks in seconds.
        required: false
        type: int
      invert_result:
        choices:
        - enabled
        - disabled
        default: null
        description:
        - Enable/disable invert of expected result.
        required: false
      ip_ver:
        choices:
        - ipv4
        - ipv6
        - none
        default: null
        description:
        - Destination IP address version.
        required: false
      overload_string_lookup_type:
        choices:
        - none
        - incl
        default: null
        description:
        - Set expected response for server overload.
        required: false
      overload_value:
        default: null
        description:
        - Set expected response string for server overload.
        required: false
        type: str
      proxy_request:
        choices:
        - enabled
        - disabled
        default: null
        description:
        - Enable/disable proxy request.
        required: false
      response_timeout_second:
        default: null
        description:
        - Max seconds to wait for response.
        required: false
        type: int
      retries_failure:
        default: null
        description:
        - Number of failed attempts to declare server down.
        required: false
        type: int
      retries_restore:
        default: null
        description:
        - Number of successful attempts to declare server up.
        required: false
        type: int
      return_string_lookup_type:
        choices:
        - none
        - incl
        - excl
        default: null
        description:
        - Set response string lookup type.
        required: false
      return_value:
        default: null
        description:
        - Set expected response string.
        required: false
        type: str
      standalone_real_hc_mode:
        choices:
        - enabled
        - disabled
        default: null
        description:
        - Enable/disable always performing the health check.
        required: false
      transparent_health_check:
        choices:
        - enabled
        - disabled
        default: null
        description:
        - Enable/disable transparent health check.
        required: false

revert_on_error:
    default: false
    description:
    - If an error occurs, perform revert on alteon.
    required: false
    type: bool

write_on_change:
    default: false
    description:
    - Executes Alteon write calls only when an actual change has been evaluated.
    required: false
    type: bool

Outputs

obj:
  description: parameters object type
  returned: changed, read
  type: dictionary
status:
  description: Message detailing run result
  returned: success
  sample: object deployed successfully
  type: str