radware.radware_modules.alteon_config_health_check_tcp (0.6.12) — module

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 tcp health checks in Radware Alteon

Requirements

• alteon-sdk

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: alteon configuration command
  radware.radware_modules.alteon_config_health_check_tcp:
    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: tcp_80
      description: tcp_80
      ip_ver: ipv4
      destination_ip_or_hostname: 1.1.1.1
      connection_termination: rst
      destination_port: 80
      interval_second: 8
      interval_downtime_second: 4       

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 TCP health check configuration.
    suboptions:
      connection_termination:
        choices:
        - fin
        - rst
        default: fin
        description:
        - Set connection termination.
        - 'Value for the tcphalfopen out-of-the-box health check: RST.'
        required: false
      description:
        default: null
        description:
        - Set descriptive health check name.
        required: false
        type: str
      destination_ip_or_hostname:
        default: none
        description:
        - Set destination IP address or hostname.
        - This parameter required only when the IP Version is IPv4 or IPv6.
        required: false
        type: str
      destination_port:
        default: null
        description:
        - Set desination port.
        - Set value to none in order to take this value from rport or the bound element.
        required: false
        type: str
      index:
        default: null
        description:
        - TCP health check ID.
        required: true
        type: str
      interval_downtime_second:
        default: 0
        description:
        - Set the time, in seconds, between health checks when a server is down.
        required: false
        type: int
      interval_second:
        default: 5
        description:
        - Set time, in seconds, between keep-alive attempts.
        required: false
        type: int
      invert_result:
        choices:
        - enabled
        - disabled
        default: disabled
        description:
        - Set whether to invert of expected result.
        required: false
      ip_ver:
        choices:
        - ipv4
        - ipv6
        - none
        default: none
        description:
        - Set destination IP version.
        - Choose none to inherit from real server.
        required: false
      response_timeout_second:
        default: 5
        description:
        - Set the time, in seconds, to wait for response. This value must be lower or
          equal to the Interval parameter.
        required: false
        type: int
      retries_failure:
        default: 4
        description:
        - Set the number of failed attempts to declare a server down.
        required: false
        type: int
      retries_restore:
        default: 2
        description:
        - Set the number of successful attempts to declare a server up.
        required: false
        type: int
      standalone_real_hc_mode:
        choices:
        - enabled
        - disabled
        default: disabled
        description:
        - Perform health check for real servers that are not attached to any virtual service
          or filter.
        required: false
      transparent_health_check:
        choices:
        - enabled
        - disabled
        default: disabled
        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