Resource Type: netscaler_lbvserver

Defined in:
lib/puppet/type/netscaler_lbvserver.rb
Providers:
rest

Overview

Manage Load Balanced VServer on the NetScaler appliance.

Properties

  • appflow_logging
  • authentication
  • authentication_401
  • authentication_fqdn

    Fully qualified domain name (FQDN) of the authentication virtual server to which the user must be redirected for authentication. Make sure that the Authentication parameter is set to ENABLED.

  • authentication_profile_name

    Name of the authentication profile to be used when authentication is turned on.

  • authentication_virtual_server_name

    Name of an authentication virtual server with which to authenticate users.

  • backup_persistence_timeout

    Time period for which backup persistence is in effect.

    Minimum value: 2 Maximum value: 1440

  • backup_virtual_server

    Name of the backup virtual server to which to forward requests if the primary virtual server goes DOWN or reaches its spillover threshold.

  • bypass_aaaa
  • cacheable
  • client_timeout

    Idle time, in seconds, after which a client connection is terminated.

    Maximum value: 31536000

  • comment

    Any comments that you might want to associate with the virtual server.

  • connection_failover

    Mode in which the connection failover feature must operate for the virtual server. After a failover, established TCP connections and UDP packet flows are kept active and resumed on the secondary appliance. Clients remain connected to the same servers. Available settings function as follows:

    • STATEFUL - The primary appliance shares state information with the secondary appliance, in real time, resulting in some runtime processing overhead.

    • STATELESS - State information is not shared, and the new primary appliance tries to re-create the packet flow on the basis of the information contained in the packets it receives.

    • DISABLED - Connection failover does not occur.

  • cookie_name

    Use this parameter to specify the cookie name for COOKIE peristence type. It specifies the name of cookie with a maximum of 32 characters. If not specified, cookie name is internally generated.

  • data_length

    Length of the token to be extracted from the data segment of an incoming packet, for use in the token method of load balancing. The length of the token, specified in bytes, must not be greater than 24 KB. Applicable to virtual servers of type TCP. Minimum value: 1 Maximum value: 100

  • data_offset

    Offset to be considered when extracting a token from the TCP payload. Applicable to virtual servers, of type TCP, using the token method of load balancing. Must be within the first 24 KB of the TCP payload. Maximum value: 25400

  • database_specific_lb
  • db_profile_name

    Name of the DB profile whose settings are to be applied to the virtual server.

  • disable_primary_on_down
  • dns64
  • down_state_flush
  • ensure (defaults to: present)

    The basic property that the resource should be in.

    Supported values:
    • present
    • absent
  • health_threshold

    Threshold in percent of active services below which vserver state is made down. If this threshold is 0, vserver state will be up even if one bound service is up.

    Minimum value: 0 Maximum value: 100

  • http_profile_name

    Name of the HTTP profile whose settings are to be applied to the virtual server.

  • icmp_virtual_server_response

    How the NetScaler appliance responds to ping requests received for an IP address that is common to one or more virtual servers. Available settings function as follows:

    • If set to PASSIVE on all the virtual servers that share the IP address, the appliance always responds to the ping requests.

    • If set to ACTIVE on all the virtual servers that share the IP address, the appliance responds to the ping requests if at least one of the virtual servers is UP. Otherwise, the appliance does not respond.

    • If set to ACTIVE on some virtual servers and PASSIVE on the others, the appliance responds if at least one virtual server with the ACTIVE setting is UP. Otherwise, the appliance does not respond.

    Note: This parameter is available at the virtual server level. A similar parameter, ICMP Response, is available at the IP address level, for IPv4 addresses of type VIP. To set that parameter, use the add ip command in the CLI or the Create IP dialog box in the GUI.

  • ip_address

    IPv4 or IPv6 address to assign to the virtual server.

  • ip_mask

    IP mask, in dotted decimal notation, for the IP Pattern parameter. Can have leading or trailing non-zero octets (for example, 255.255.240.0 or 0.0.255.255). Accordingly, the mask specifies whether the first n bits or the last n bits of the destination IP address in a client request are to be matched with the corresponding bits in the IP pattern. The former is called a forward mask. The latter is called a reverse mask.

  • ip_pattern

    IP address pattern, in dotted decimal notation, for identifying packets to be accepted by the virtual server. The IP Mask parameter specifies which part of the destination IP address is matched against the pattern. Mutually exclusive with the IP Address parameter. For example, if the IP pattern assigned to the virtual server is 198.51.100.0 and the IP mask is 255.255.240.0 (a forward mask), the first 20 bits in the destination IP addresses are matched with the first 20 bits in the pattern. The virtual server accepts requests with IP addresses that range from 198.51.96.1 to 198.51.111.254. You can also use a pattern such as 0.0.2.2 and a mask such as 0.0.255.255 (a reverse mask). If a destination IP address matches more than one IP pattern, the pattern with the longest match is selected, and the associated virtual server processes the request. For example, if virtual servers vs1 and vs2 have the same IP pattern, 0.0.100.128, but different IP masks of 0.0.255.255 and 0.0.224.255, a destination IP address of 198.51.100.128 has the longest match with the IP pattern of vs1. If a destination IP address matches two or more virtual servers to the same extent, the request is processed by the virtual server whose port number matches the port number in the request.

  • layer2_parameters
  • lb_method

    Load balancing method. The available settings function as follows:

    • ROUNDROBIN - Distribute requests in rotation, regardless of the load. Weights can be assigned to services to enforce weighted round robin distribution.

    • LEASTCONNECTION (default) - Select the service with the fewest connections.

    • LEASTRESPONSETIME - Select the service with the lowest average response time.

    • LEASTBANDWIDTH - Select the service currently handling the least traffic.

    • LEASTPACKETS - Select the service currently serving the lowest number of packets per second.

    • CUSTOMLOAD - Base service selection on the SNMP metrics obtained by custom load monitors.

    • LRTM - Select the service with the lowest response time. Response times are learned through monitoring probes. This method also takes the number of active connections into account.

    Also available are a number of hashing methods, in which the appliance extracts a predetermined portion of the request, creates a hash of the portion, and then checks whether any previous requests had the same hash value. If it finds a match, it forwards the request to the service that served those previous requests. Following are the hashing methods:

    • URLHASH - Create a hash of the request URL (or part of the URL).

    • DOMAINHASH - Create a hash of the domain name in the request (or part of the domain name). The domain name is taken from either the URL or the Host header. If the domain name appears in both locations, the URL is preferred. If the request does not contain a domain name, the load balancing method defaults to LEASTCONNECTION.

    • DESTINATIONIPHASH - Create a hash of the destination IP address in the IP header.

    • SOURCEIPHASH - Create a hash of the source IP address in the IP header.

    • TOKEN - Extract a token from the request, create a hash of the token, and then select the service to which any previous requests with the same token hash value were sent.

    • SRCIPDESTIPHASH - Create a hash of the string obtained by concatenating the source IP address and destination IP address in the IP header.

    • SRCIPSRCPORTHASH - Create a hash of the source IP address and source port in the IP header.

    • CALLIDHASH - Create a hash of the SIP Call-ID header.

  • lb_method_hash_length

    Number of bytes to consider for the hash value used in the URLHASH and DOMAINHASH load balancing methods. Minimum value = 1 Maximum value = 4096

  • lb_method_ipv6_mask_length

    Number of bits to consider in an IPv6 destination or source IP address, for creating the hash that is required by the DESTINATIONIPHASH and SOURCEIPHASH load balancing methods. Minimum value = 1 Maximum value = 128

  • lb_method_netmask

    IPv4 subnet mask to apply to the destination IP address or source IP address when the load balancing method is DESTINATIONIPHASH or SOURCEIPHASH. Minimum length = 1

  • listen_policy

    Default syntax expression identifying traffic accepted by the virtual server. Can be either an expression (for example, CLIENT.IP.DST.IN_SUBNET(192.0.2.0/24) or the name of a named expression. In the above example, the virtual server accepts all requests whose destination IP address is in the 192.0.2.0/24 subnet.

  • listen_priority

    Integer specifying the priority of the listen policy. A higher number specifies a lower priority. If a request matches the listen policies of more than one virtual server the virtual server whose listen policy has the highest priority (the lowest priority number) accepts the request.

    Maximum value: 101

  • macmode_retain_vlan
  • max_autoscale_members

    Maximum number of members expected to be present when vserver is used in Autoscale.

    Maximum value: 5000

  • min_autoscale_members

    Minimum number of members expected to be present when vserver is used in Autoscale.

    Maximum value: 5000

  • mssql_server_version

    For a load balancing virtual server of type MSSQL, the Microsoft SQL Server version. Set this parameter if you expect some clients to run a version different from the version of the database. This setting provides compatibility between the client-side and server-side connections by ensuring that all communication conforms to the server’s version. Valid options: 70, 2000, 2000SP1, 2005, 2008, 2008R2, 2012.

  • mysql_character_set

    Character set that the virtual server advertises to clients.

  • mysql_protocol_version

    MySQL protocol version that the virtual server advertises to clients.

  • mysql_server_capabilities

    Server capabilities that the virtual server advertises to clients.

  • mysql_server_version

    MySQL server version string that the virtual server advertises to clients.

  • net_profile_name

    Name of the network profile to associate with the virtual server. If you set this parameter, the virtual server uses only the IP addresses in the network profile as source IP addresses when initiating connections with servers.

  • new_service_request_increment_interval

    Interval, in seconds, between successive increments in the load on a new service or a service whose state has just changed from DOWN to UP. A value of 0 (zero) specifies manual slow start.

    Maximum value: 3600

  • new_service_request_rate

    Number of requests, or percentage of the load on existing services, by which to increase the load on a new service at each interval in slow-start mode. A non-zero value indicates that slow-start is applicable. A zero value indicates that the global RR startup parameter is applied. Changing the value to zero will cause services currently in slow start to take the full traffic as determined by the LB method. Subsequently, any new services added will use the global RR factor.

  • new_service_request_unit

    Units in which to increment load at each interval in slow-start mode. Possible values = PER_SECOND, PERCENT

  • oracle_server_version

    Oracle server version. Valid options: 10G, 11G.

  • persist_avp_no

    Persist AVP number for Diameter Persistency.

    In case this AVP is not defined in Base RFC 3588 and it is nested inside a Grouped AVP,
define a sequence of AVP numbers (max 3) in order of parent to child. So say persist AVP number X
is nested inside AVP Y which is nested in Z, then define the list as  Z Y X

    Minimum value: 1

  • persistence_backup

    Backup persistence type for the virtual server. Becomes operational if the primary persistence mechanism fails. Valid options: SOURCEIP, NONE.

  • persistence_ipv4_mask

    Persistence mask for IP based persistence types, for IPv4 virtual servers.

  • persistence_ipv6_mask_length

    Persistence mask for IP based persistence types, for IPv6 virtual servers.

    Minimum value: 1 Maximum value: 128

  • persistence_timeout

    Time period for which a persistence session is in effect.

    Maximum value: 1440

  • persistence_type

    Type of persistence for the virtual server. Available settings function as follows:

    • SOURCEIP - Connections from the same client IP address belong to the same persistence session.

    • COOKIEINSERT - Connections that have the same HTTP Cookie, inserted by a Set-Cookie directive from a server, belong to the same persistence session.

    • SSLSESSION - Connections that have the same SSL Session ID belong to the same persistence session.

    • CUSTOMSERVERID - Connections with the same server ID form part of the same session. For this persistence type, set the Server ID (CustomServerID) parameter for each service and configure the Rule parameter to identify the server ID in a request.

    • RULE - All connections that match a user defined rule belong to the same persistence session.

    • URLPASSIVE - Requests that have the same server ID in the URL query belong to the same persistence session. The server ID is the hexadecimal representation of the IP address and port of the service to which the request must be forwarded. This persistence type requires a rule to identify the server ID in the request.

    • DESTIP - Connections to the same destination IP address belong to the same persistence session.

    • SRCIPDESTIP - Connections that have the same source IP address and destination IP address belong to the same persistence session.

    • CALLID - Connections that have the same CALL-ID SIP header belong to the same persistence session.

    • RTSPSID - Connections that have the same RTSP Session ID belong to the same persistence session.

  • port

    Port number for the virtual server.

  • priority_queuing
  • process_local
  • push
  • push_label_expression

    Expression for extracting a label from the server’s response. Can be either an expression or the name of a named expression.

  • push_multiple_clients
  • push_virtual_server_name

    Name of the load balancing virtual server, of type PUSH or SSL_PUSH, to which the server pushes updates received on the load balancing virtual server that you are configuring.

  • range

    Number of IP addresses that the appliance must generate and assign to the virtual server. The virtual server then functions as a network virtual server, accepting traffic on any of the generated IP addresses. The IP addresses are generated automatically, as follows:

    • For a range of n, the last octet of the address specified by the IP Address parameter increments n-1 times.

    • If the last octet exceeds 255, it rolls over to 0 and the third octet increments by 1.

    Note: The Range parameter assigns multiple IP addresses to one virtual server. To generate an array of virtual servers, each of which owns only one IP address, use brackets in the IP Address and Name parameters to specify the range. For example: add lb vserver my_vserver HTTP 192.0.2. 80

    Minimum value: 1 Maximum value: 254

  • recursion_available
  • redirect_port_rewrite
  • redirect_url

    URL to which to redirect traffic if the virtual server becomes unavailable. WARNING! Make sure that the domain in the URL does not match the domain specified for a content switching policy. If it does, requests are continuously redirected to the unavailable virtual server.

  • redirection_mode

    Redirection mode for load balancing. Available settings function as follows:

    • IP - Before forwarding a request to a server, change the destination IP address to the server’s IP address.

    • MAC - Before forwarding a request to a server, change the destination MAC address to the server’s MAC address. The destination IP address is not changed. MAC-based redirection mode is used mostly in firewall load balancing deployments.

    • IPTUNNEL - Perform IP-in-IP encapsulation for client IP packets. In the outer IP headers, set the destination IP address to the IP address of the server and the source IP address to the subnet IP (SNIP). The client IP packets are not modified. Applicable to both IPv4 and IPv6 packets.

    • TOS - Encode the virtual server’s TOS ID in the TOS field of the IP header.

    You can use either the IPTUNNEL or the TOS option to implement Direct Server Return (DSR).

  • response_rule

    Default syntax expression specifying which part of a server’s response to use for creating rule based persistence sessions (persistence type RULE). Can be either an expression or the name of a named expression. Example: HTTP.RES.HEADER("setcookie").VALUE(0).TYPECAST_NVLIST_T(‘=’,‘;’).VALUE("server1").

  • rhi_state

    Route Health Injection (RHI) functionality of the NetSaler appliance for advertising the route of the VIP address associated with the virtual server. When Vserver RHI Level (RHI) parameter is set to VSVR_CNTRLD, the following are different RHI behaviors for the VIP address on the basis of RHIstate (RHI STATE) settings on the virtual servers associated with the VIP address:

    • If you set RHI STATE to PASSIVE on all virtual servers, the NetScaler ADC always advertises the route for the VIP address.

    • If you set RHI STATE to ACTIVE on all virtual servers, the NetScaler ADC advertises the route for the VIP address if at least one of the associated virtual servers is in UP state.

    • If you set RHI STATE to ACTIVE on some and PASSIVE on others, the NetScaler ADC advertises the route for the VIP address if at least one of the associated virtual servers, whose RHI STATE set to ACTIVE, is in UP state.

  • rtsp_natting
  • rule

    Expression, or name of a named expression, against which traffic is evaluated. Written in the classic or default syntax. Note: Maximum length of a string literal in the expression is 255 characters. A longer string can be split into smaller strings of up to 255 characters each, and the smaller strings concatenated with the + operator. For example, you can create a 500-character string as follows: ‘"<string of 255 characters>" + "<string of 245 characters>"’ The following requirements apply only to the NetScaler CLI:

    • If the expression includes one or more spaces, enclose the entire expression in double quotation marks.

    • If the expression itself includes double quotation marks, escape the quotations by using the \ character.

    • Alternatively, you can use single quotation marks to enclose the rule, in which case you do not have to escape the double quotation marks.

  • service_type

    Protocol used by the service (also called the service type). Valid options: HTTP, FTP, TCP, UDP, SSL, SSL_BRIDGE, SSL_TCP, DTLS, NNTP, DNS, DHCPRA, ANY, SIP_UDP, DNS_TCP, RTSP, PUSH, SSL_PUSH, RADIUS, RDP, MYSQL, MSSQL, DIAMETER, SSL_DIAMETER, TFTP, ORACLE.

  • sessionless
  • skip_persistency

    This argument decides the behavior incase the service which is selected from an existing persistence session has reached threshold. Valid options: Bypass, ReLb, None.

  • spillover_backup_action

    Action to be performed if spillover is to take effect, but no backup chain to spillover is usable or exists. Valid options: DROP, ACCEPT, REDIRECT.

  • spillover_method

    Type of threshold that, when exceeded, triggers spillover. Available settings function as follows:

    • CONNECTION - Spillover occurs when the number of client connections exceeds the threshold.

    • DYNAMICCONNECTION - Spillover occurs when the number of client connections at the virtual server exceeds the sum of the maximum client (Max Clients) settings for bound services. Do not specify a spillover threshold for this setting, because the threshold is implied by the Max Clients settings of bound services.

    • BANDWIDTH - Spillover occurs when the bandwidth consumed by the virtual server’s incoming and outgoing traffic exceeds the threshold.

    • HEALTH - Spillover occurs when the percentage of weights of the services that are UP drops below the threshold. For example, if services svc1, svc2, and svc3 are bound to a virtual server, with weights 1, 2, and 3, and the spillover threshold is 50%, spillover occurs if svc1 and svc3 or svc2 and svc3 transition to DOWN.

    • NONE - Spillover does not occur.

  • spillover_persistence
  • spillover_persistence_timeout

    Timeout for spillover persistence, in minutes.

    Minimum value: 2 Maximum value: 1440

  • spillover_threshold

    Threshold at which spillover occurs. Specify an integer for the CONNECTION spillover method, a bandwidth value in kilobits per second for the BANDWIDTH method (do not enter the units), or a percentage for the HEALTH method (do not enter the percentage symbol). Minimum value: 1 Maximum value: 4294967287

  • state
  • sure_connect
  • tcp_profile_name

    Name of the TCP profile whose settings are to be applied to the virtual server.

  • tos_id

    TOS ID of the virtual server. Applicable only when the load balancing redirection mode is set to TOS. Minimum value: 1 Maximum value: 63

  • traffic_domain

    Integer value that uniquely identifies the traffic domain in which you want to configure the entity. If you do not specify an ID, the entity becomes part of the default traffic domain, which has an ID of 0. Minimum value: 0 Maximum value: 4094

  • vip_header_name

    Name for the inserted header. The default name is vip-header.

  • virtual_server_ip_port_insertion

    Insert an HTTP header, whose value is the IP address and port number of the virtual server, before forwarding a request to the server. The format of the header is <vipHeader>: <virtual server IP address>_<port number >, where vipHeader is the name that you specify for the header. If the virtual server has an IPv6 address, the address in the header is enclosed in brackets ([ and ]) to separate it from the port number. If you have mapped an IPv4 address to a virtual server’s IPv6 address, the value of this parameter determines which IP address is inserted in the header, as follows:

    • VIPADDR - Insert the IP address of the virtual server in the HTTP header regardless of whether the virtual server has an IPv4 address or an IPv6 address. A mapped IPv4 address, if configured, is ignored.

    • V6TOV4MAPPING - Insert the IPv4 address that is mapped to the virtual server’s IPv6 address. If a mapped IPv4 address is not configured, insert the IPv6 address.

    • OFF - Disable header insertion.

Parameters

  • name (namevar)
  • provider

    The specific backend to use for this ‘netscaler_lbvserver` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.