Resource Type: netscaler_csvserver

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

Overview

Manage Content Switching VServer on the NetScaler appliance.

Properties

  • appflow_logging
  • authentication
  • authentication_401
  • authentication_fqdn

    FQDN of authentication vserver

  • authentication_profile_name

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

  • authentication_virtual_server_name

    Name of authentication vserver

  • backup_virtual_server

    The backup virtual server for content switching.

  • cacheable
  • case_sensitive
  • client_timeout

    Client timeout in seconds.

    Maximum value: 31536000

  • comment

    Comments associated with this virtual server.

  • db_profile_name

    Name of the DB profile.

  • default_lbvserver

    The virtual server name to which content will be switched. This is a special case, where the binding to the lbvserver is created when the csvserver is created

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

    The basic property that the resource should be in.

    Supported values:
    • present
    • absent
  • http_profile_name

    Name of the HTTP profile.

  • icmp_virtual_server_response

    Can be active or passive. Valid options: PASSIVE, ACTIVE.

  • ip_address

    The new IP address of the virtual server.

  • ip_mask

    The IP Mask of the virtual server IP Pattern

  • ip_pattern

    The IP Pattern of the virtual server.

  • layer2_parameters
  • listen_policy

    Use this parameter to specify the listen policy for CS Vserver. The string can be either an existing expression name (configured using add policy expression command) or else it can be an in-line expression with a maximum of 1499 characters.

  • listen_priority

    Use this parameter to specify the priority for listen policy of CS Vserver.

    Maximum value: 100

  • mssql_server_version

    The version of the MSSQL server. Valid options: 70, 2000, 2000SP1, 2005, 2008, 2008R2.

  • mysql_character_set

    The character set returned by the mysql vserver.

  • mysql_protocol_version

    The protocol version returned by the mysql vserver.

  • mysql_server_capabilities

    The server capabilities returned by the mysql vserver.

  • mysql_server_version

    The server version string returned by the mysql vserver.

  • net_profile_name

    The name of the network profile.

  • oracle_server_version

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

  • port

    A port number for the virtual server. Minimum value: 1

  • precedence

    The precedence on the content switching virtual server between rule-based and URL-based policies. The default precedence is set to RULE. If the precedence is configured as RULE, the incoming request is applied against the content switching policies created with the -rule argument. If none of the rules match, then the URL in the request is applied against the content switching policies created with the -url option. For example, this precedence can be used if certain client attributes (such as a specific type of browser) need to be served different content and all other clients can be served from the content distributed among the servers. If the precedence is configured as URL, the incoming request URL is applied against the content switching policies created with the -url option. If none of the policies match, then the request is applied against the content switching policies created with the -rule option. Also, this precedence can be used if some content (such as images) is the same for all clients, but other content (such as text) is different for different clients. In this case, the images will be served to all clients, but the text will be served to specific clients based on specific attributes, such as Accept-Language. Valid options: RULE, URL.

  • push
  • push_label_expression

    Use this parameter to specify the expression to extract the label in response from server. The string can be either a named expression (configured using add policy expression command) or else it can be an in-line expression with a maximum of 63 characters.

  • push_multiple_clients
  • push_virtual_server_name

    The lb vserver of type PUSH/SSL_PUSH to which server pushes the updates received on the client facing non-push lb vserver.

  • range

    An IP address range.

    Minimum value: 1 Maximum value: 254

  • redirect_port_rewrite
  • redirect_url

    The redirect URL for content switching.

  • rhi_state

    A host route is injected according to the setting on the virtual servers * If set to PASSIVE on all the virtual servers that share the IP address, the appliance always injects the hostroute. * If set to ACTIVE on all the virtual servers that share the IP address, the appliance injects even if one virtual server is UP. * If set to ACTIVE on some virtual servers and PASSIVE on the others, the appliance, injects even if one virtual server set to ACTIVE is UP. Valid options: PASSIVE, ACTIVE

  • rtsp_natting
  • service_type

    The service type of the virtual server. Valid options: HTTP, SSL, TCP, FTP, RTSP, SSL_TCP, UDP, DNS, SIP_UDP, ANY, RADIUS, RDP, MYSQL, MSSQL, DIAMETER, SSL_DIAMETER.

  • 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

    The spillover factor. When traffic on the main virtual server reaches this threshold, additional traffic is sent to the backupvserver. Valid options: CONNECTION, DYNAMICCONNECTION, BANDWIDTH, HEALTH, NONE.

  • spillover_persistence
  • spillover_persistence_timeout

    The spillover persistency entry timeout.

    Minimum value: 2 Maximum value: 1440

  • spillover_threshold

    If the spillover method is set to CONNECTION or DYNAMICCONNECTION, this value is treated as the maximum number of connections a virtual server will handle before spillover takes place. If the spillover method is set to BANDWIDTH, this value is treated as the amount of incoming and outgoing traffic (in Kbps) a vserver will handle before spillover takes place. Minimum value: 1 Maximum value: 4294967287

  • state
  • state_update
  • tcp_profile_name

    The name of the TCP profile.

  • 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 of virtual server IP and port header, for use with the VServer IP Port Insertion parameter. Minimum length = 1

  • virtual_server_ip_port_insertion

    The virtual IP and port header insertion option for the vserver. VIPADDR - Header contains the vserver’s IP address and port number without any translation. OFF - The virtual IP and port header insertion option is disabled. V6TOV4MAPPING - Header contains the mapped IPv4 address that corresponds to the IPv6 address of the vserver and the port number. An IPv6 address can be mapped to a user-specified IPv4 address using the set ns ip6 command.

Parameters

  • name (namevar)
  • provider

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

  • purge_bindings