radware / radware.radware_alteon / 1.1.2 / module / alteon_config_server_group Manage server group in Radware Alteon | "added in version" 1.0.0 of radware.radware_alteon" Authors: Leon Meguira (@leonmeguira), Nati Fridman (@natifridman) preview | supported by certifiedradware.radware_alteon.alteon_config_server_group (1.1.2) — module
Install with ansible-galaxy collection install radware.radware_alteon:==1.1.2
collections: - name: radware.radware_alteon version: 1.1.2
Manage server group in Radware Alteon
- name: alteon configuration command alteon_config_server_group: provider: server: 192.168.1.1 user: admin password: admin validate_certs: false https_port: 443 ssh_port: 22 timeout: 5 state: present parameters: index: group_test slb_metric: bandwidth health_check_id: test_hc slow_start_time_second: 60 persist_overload_max_conn_server: enabled server_names: - server1 - server2
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 type: str 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(false), SSL certificates will not be validated. - This should only set to C(false) used on personally controlled sites using self-signed certificates. required: true type: bool type: dict parameters: description: - Parameters for server group configuration. suboptions: backup_group_name: default: null description: - The backup real server group for this group. required: false type: str backup_server_name: default: null description: - The backup real server for this group. required: false type: str backup_type: choices: - none - server - group default: none description: - The real server or real server group used as the backup or overflow server or server group for this real server group. - You can assign a backup real server or real server group to prevent loss of service if the entire real server group fails. - If the real server group becomes unavailable, Alteon activates the backup real server or real server group until one of the original real servers becomes available again. - The backup server or real server group is also used in overflow situations. If all the servers in the real server group reach their maximum connections limit, Alteon activates the backup server or real server group to provide additional processing power until resources become available on one of the original servers. - You can assign the same backup real server or real server group to more than one real server group at the same time. required: false group_server_type: choices: - local - wanlink default: local description: - The server group type. required: false health_check_id: default: tcp description: - Select a predefined or user-defined health check. required: false type: str index: default: null description: - Group ID. required: true type: str ip_ver: choices: - ipv4 - ipv6 - mixed default: ipv4 description: - The IP version type of the real server group IP address. required: false name: default: null description: - The name of the real server group. required: false type: str persist_hash_mask: default: 255.255.255.255 description: - Specifies whether Alteon hashes the client IP address or network for the persistent hash selection. required: false type: str persist_overload_max_conn_server: choices: - enabled - disabled default: disabled description: - Specifies whether to ignore the overflow/overload server status, under certain conditions. - When enabled, new connections are allocated to a server for which the maximum connections limit has been reached (overflow) or which is in overloaded status as a result of a health check, if the new connections belong to existing persistent sessions on that server (with Persistency Mode set to Client IP, SSL ID, or Cookie). required: false secondary_backup_group_name: default: null description: - The secondary backup real server group for this group. required: false type: str server_names: default: null description: - Group members elements: str required: false type: list slb_metric: choices: - roundRobin - leastConnections - minMisses - hash - response - bandwidth - phash - svcLeast - hrw default: leastConnections description: - The metric used to select next server in the group. - In C(leastConnections), Alteon sends the incoming connections to the real port with the least number of connections. - In C(roundRobin), when an available server is selected, Alteon ensures even distribution when choosing a real port to receive the incoming connection. - C(minMisses) is optimized for cache redirection. Alteon calculates a value for each available real server based on the relevant IP address information in the client request. The server with the highest value is assigned the connection. This metric attempts to minimize the disruption of persistence when servers are removed from service. Use only when persistence is required. - In C(response), Alteon uses the response time between itself and real servers as a weighting factor. Alteon monitors and records the amount of time it takes for each real server to reply to a health check to adjust the real server weights. The weights are adjusted so they are inversely proportional to a moving average of response time. In such a scenario, a server with half the response time as another server receives a weight twice as large. - In C(bandwidth), Alteon monitors the number of octets sent between itself and real servers. Servers that process more octets are considered to have less available bandwidth. Alteon assigns requests client requests to the server with the greatest available bandwidth. When the upload and download bandwidths are configured for WAN link groups, Alteon calculates the server bandwidth based on bandwidth utilization, not on octets. - In C(hash), Alteon selects the real server based on a hash of the client IP address. - In C(phash), Alteon selects the real server based on a hash of the client IP address. With Persistent Hash enabled, Alteon supports an even load distribution (Hash) and stable server assignment (Minmiss) even when a server in the group goes down. With the Persistent Hash metric, the first hash always is the same even if a real server is down. If the first hash hits an unavailable server, Alteon rehashes the client request based on the actual number of servers available. This results in a request always being sent to a server that is available. - In C(svcLeast), Alteon selects the real server based only on the number of active connections for the service which is load balanced, and not the total number of connections active on the server. For example, when selecting a real server for a new HTTP session, a real server serving one HTTP connection and 20 FTP connections takes precedence over a real server serving two HTTP connections only. required: false slb_rport_metric: choices: - roundRobin - hash - leastConnections default: roundRobin description: - Specifies how a specific service instance (port) is selected on a real server when multiple service ports are configured on that real server. required: false slow_start_time_second: default: 0 description: - Specifies the slow start time, in seconds, for this server group. - The slow start time is the interval between the time at which the server is identified as up, and the time at which the server is considered part of the server group. required: false type: int vip_health_check_mode: choices: - enabled - disabled default: enabled description: - Specifies whether to enable VIP health checking in DSR mode. required: false type: dict 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
obj: description: parameters object type returned: changed, read type: dict status: description: Message detailing run result returned: success sample: object deployed successfully type: str