radware.radware_modules.alteon_config_virtual_server (0.6.12) — module

Manage virtual server 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 virtual server 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_virtual_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: virt_test
      state: enabled
      ip_address: 56.56.56.56
      domain_name: test.com
      weight: 6
      availability: 10
      availability_persist: enabled
      connection_rst_invalid_port: enabled
      return_to_src_mac: enabled

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 virtual server configuration.
    suboptions:
      availability:
        default: 1
        description:
        - Specifies the Global Server Load Balancing (GSLB) priority for the virtual server.
        - Rules that use Availability as the primary metric handle failures by selecting
          the server with the next highest score compared to that of the server that failed,
          and begin forwarding requests to that server. If the server that failed becomes
          operational again, that server regains precedence and requests are routed to
          it once more.
        required: false
        type: int
      availability_persist:
        choices:
        - enabled
        - disabled
        default: disabled
        description:
        - Specifies whether a server that failed and became operational again, can (Disable)
          or cannot (Enable) regain precedence from the recovery server.
        - Ensuring that the former primary server does not regain precedence is achieved
          by assigning the highest possible availability value (48) to the server that
          takes over after a failure. If this new primary server fails, its original availability
          value is restored and the next server in the list gains the higher precedence.
        required: false
      connection_rst_invalid_port:
        choices:
        - enabled
        - disabled
        default: enabled
        description:
        - Specifies whether to drop or reset connections to an invalid virtual port.
        required: false
      domain_name:
        default: null
        description:
        - 'Specifies the domain name for this virtual server. When configured the domain
          name is used for:'
        - DNS resolution for global load balancing. Additional domains can be defined
          on the same virtual server by attaching multiple DNS (GSLB) rules, each with
          a different domain.
        - HTTP/S health check, if the health check Host parameter is set to Inherit.
        - ''
        - The domain name typically includes the name of the company or organization,
          and the Internet group code (.com, .edu, .gov, .org, and so on). For example,
          'foocorp.com'.
        - It does not include the hostname portion (www, www2, ftp, and so on).
        required: false
        type: str
      index:
        default: null
        description:
        - Specifies the identifier of the virtual server.
        - Alteon uses the name and the application as the identifier for all objects created
          for this service (group, SSL policy, FastView policy).
        required: true
        type: str
      ip6_address:
        default: null
        description:
        - Specifies the IP version and address of the virtual server. The virtual server
          created within Alteon responds to ARPs and pings from network ports as if it
          was a normal server.
        - Client requests directed to the virtual server IP address are balanced among
          the real servers available to it through real server group assignments.
        required: false
        type: str
      ip_address:
        default: null
        description:
        - Specifies the IP version and address of the virtual server. The virtual server
          created within Alteon responds to ARPs and pings from network ports as if it
          was a normal server.
        - Client requests directed to the virtual server IP address are balanced among
          the real servers available to it through real server group assignments.
        required: false
        type: str
      ip_ver:
        choices:
        - ipv4
        - ipv6
        default: ipv4
        description:
        - Specifies the type of IP address for the virtual server.
        required: false
      return_to_src_mac:
        choices:
        - enabled
        - disabled
        default: disabled
        description:
        - Specifies how to forward response traffic to the client.
        - C(enabled)-Alteon returns the response traffic to the MAC address from which
          the request arrived, bypassing all routing configuration in the device.
        - C(disabled)-Alteon returns the traffic using the routing table.
        required: false
      src_network_class_id:
        default: null
        description:
        - Specifies the network class that defines the clients to which this virtual server
          provides service. Defining a source network per virtual server allows you to
          provide differentiated services for the same application to different clients
          or departments.
        required: false
        type: str
      state:
        choices:
        - enabled
        - disabled
        default: disabled
        description:
        - Specifies whether to enable the virtual server. This option activates the virtual
          server so that it can service client requests sent to its defined IP address.
        required: false
      virtual_server_name:
        default: null
        description:
        - Specifies a descriptive name for the virtual server.
        required: false
        type: str
      wan_link_id:
        default: null
        description:
        - Specifies the WAN Link via which this virtual server can be accessed, when the
          application can be accessed via multiple WAN links (multihoming).
        required: false
        type: str
      weight:
        default: 1
        description:
        - Specifies the global server weight for the virtual server.
        - The higher the weight value, the more connections that are directed to the local
          site.
        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