radware.radware_modules.alteon_config_server (0.6.12) — module

Manage real server in Radware Alteon

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

preview | 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 real server in Radware Alteon


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: alteon configuration command
  alteon_config_server:
    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: real1
      state: disabled_with_fastage
      ip_address: 80.80.80.80
      weight: 7
      availability: 5
      health_check_id: hc_test
      server_ports:
        - 80
        - 8080
        - 8081

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.
        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 real server configuration.
    suboptions:
      availability:
        default: null
        description:
        - The weight of the server when performing the Global Server Load Balancing (GSLB)
          decision using the availability metric.
        required: false
        type: int
      connection_mode:
        choices:
        - physical
        - logical
        default: physical
        description:
        - Specifies the maximum connections mode.
        - Real servers with the same IP address must be configured with the same maximum
          connections mode.
        - In C(physical), real servers with the same IP address configured with the physical
          maximum connections mode must all have the same Maximum Connections value.
        - In C(logical), real servers with the same IP address configured with the logical
          maximum connections mode can each have a different Maximum Connections value.
        required: false
      health_check_id:
        default: null
        description:
        - Health check ID.
        required: false
        type: str
      index:
        default: null
        description:
        - Real server ID.
        required: true
        type: str
      ip6_address:
        default: null
        description:
        - The IPv6 address of the real server.
        required: false
        type: str
      ip_address:
        default: null
        description:
        - The IPv4 address of the real server.
        required: false
        type: str
      ip_ver:
        choices:
        - ipv4
        - ipv6
        default: ipv4
        description:
        - Specifies the type of IP address.
        required: false
      max_connections:
        default: 0
        description:
        - Specifies the maximum number of simultaneous connections that this real server
          can support.
        - No new connections are issued to this server if this limit is reached. New connections
          are issued again to this server once the number of current connections has decreased
          below the limit.
        - 0 means no connection limit
        required: false
        type: int
      name:
        default: null
        description:
        - The name of the real server.
        required: false
        type: str
      nat6_address:
        default: null
        description:
        - The Client NAT IPv6 address for the real server.
        required: false
        type: str
      nat6_prefix:
        default: null
        description:
        - The prefix for the Client NAT address for the real server.
        required: false
        type: int
      nat_address:
        default: null
        description:
        - The Client NAT address for the real server.
        required: false
        type: str
      nat_ip_persistency:
        choices:
        - disable
        - client
        - host
        default: disable
        description:
        - Client NAT Persistency when persistency mode is address or subnet.
        required: false
      nat_mode:
        choices:
        - enable
        - address
        - nwclss
        - disable
        default: enable
        description:
        - Specifies Client NAT configuration source.
        required: false
      nat_net_class_ip_persistency:
        choices:
        - disable
        - client
        default: disable
        description:
        - Client NAT Persistency when persistency mode is network class.
        required: false
      nat_network_class_name:
        default: null
        description:
        - NAT network class name.
        required: false
        type: str
      nat_subnet:
        default: null
        description:
        - The subnet mask for the Client NAT address for the real server.
        required: false
        type: str
      server_ports:
        default: null
        description:
        - The Layer 4 real-service port number.
        elements: int
        required: false
        type: list
      server_type:
        choices:
        - local_server
        - remote_server
        default: local_server
        description:
        - The server type. It participates in global Server Load Balancing when it is
          configured as remote-server.
        required: false
      state:
        choices:
        - enabled
        - disabled
        - disabled_with_fastage
        - shutdown_connection
        - shutdown_persistent_sessions
        default: null
        description:
        - Real server state.
        required: false
      weight:
        default: 1
        description:
        - The server weight.
        required: false
        type: int

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