Class: Ansible::Ruby::Modules::Netscaler_cs_vserver

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb

Overview

Manage content switching vserver This module is intended to run either on the ansible control node or a bastion (jumpserver) with access to the actual netscaler instance

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#appflowlog ⇒ :enabled, ...

Returns Enable logging appflow flow information.

Returns:

  • (:enabled, :disabled, nil) —

    Enable logging appflow flow information.



177
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 177

attribute :appflowlog

#authentication ⇒ Symbol?

Returns Authenticate users who request a connection to the content switching virtual server.

Returns:

  • (Symbol, nil) —

    Authenticate users who request a connection to the content switching virtual server.



114
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 114

attribute :authentication

#authenticationhost ⇒ Object?

Returns FQDN of the authentication virtual server. The service type of the virtual server should be either C(HTTP) or C(SSL).,Minimum length = 3,Maximum length = 252.

Returns:

  • (Object, nil) —

    FQDN of the authentication virtual server. The service type of the virtual server should be either C(HTTP) or C(SSL).,Minimum length = 3,Maximum length = 252



111
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 111

attribute :authenticationhost

#authn401 ⇒ Symbol?

Returns Enable HTTP 401-response based authentication.

Returns:

  • (Symbol, nil) —

    Enable HTTP 401-response based authentication.



121
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 121

attribute :authn401

#authnprofile ⇒ Object?

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

Returns:

  • (Object, nil) —

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



192
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 192

attribute :authnprofile

#authnvsname ⇒ Object?

Returns Name of authentication virtual server that authenticates the incoming user requests to this content switching virtual server. .,Minimum length = 1,Maximum length = 252.

Returns:

  • (Object, nil) —

    Name of authentication virtual server that authenticates the incoming user requests to this content switching virtual server. .,Minimum length = 1,Maximum length = 252



125
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 125

attribute :authnvsname

#backupip ⇒ Object?

Returns .,Minimum length = 1.

Returns:

  • (Object, nil) —

    .,Minimum length = 1



204
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 204

attribute :backupip

#backupvserver ⇒ Object?

Returns Name of the backup virtual server that you are configuring. Must begin with an ASCII alphanumeric or underscore C(_) character, and must contain only ASCII alphanumeric, underscore C(_), hash C(#), period C(.), space C( ), colon C(:), at sign C(@), equal sign C(=), and hyphen C(-) characters. Can be changed after the backup virtual server is created. You can assign a different backup virtual server or rename the existing virtual server.,Minimum length = 1.

Returns:

  • (Object, nil) —

    Name of the backup virtual server that you are configuring. Must begin with an ASCII alphanumeric or underscore C(_) character, and must contain only ASCII alphanumeric, underscore C(_), hash C(#), period C(.), space C( ), colon C(:), at sign C(@), equal sign C(=), and hyphen C(-) characters. Can be changed after the backup virtual server is created. You can assign a different backup virtual server or rename the existing virtual server.,Minimum length = 1



93
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 93

attribute :backupvserver

#cacheable ⇒ Symbol?

Returns Use this option to specify whether a virtual server, used for load balancing or content switching, routes requests to the cache redirection virtual server before sending it to the configured servers.

Returns:

  • (Symbol, nil) —

    Use this option to specify whether a virtual server, used for load balancing or content switching, routes requests to the cache redirection virtual server before sending it to the configured servers.



49
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 49

attribute :cacheable

#casesensitive ⇒ Symbol?

Returns Consider case in URLs (for policies that use URLs instead of RULES). For example, with the C(on) setting, the URLs /a/1.html and /A/1.HTML are treated differently and can have different targets (set by content switching policies). With the C(off) setting, /a/1.html and /A/1.HTML are switched to the same target.

Returns:

  • (Symbol, nil) —

    Consider case in URLs (for policies that use URLs instead of RULES). For example, with the C(on) setting, the URLs /a/1.html and /A/1.HTML are treated differently and can have different targets (set by content switching policies). With the C(off) setting, /a/1.html and /A/1.HTML are switched to the same target.



63
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 63

attribute :casesensitive

#clttimeout ⇒ Object?

Returns Idle time, in seconds, after which the client connection is terminated. The default values are:,Minimum value = C(0),Maximum value = C(31536000).

Returns:

  • (Object, nil) —

    Idle time, in seconds, after which the client connection is terminated. The default values are:,Minimum value = C(0),Maximum value = C(31536000)



56
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 56

attribute :clttimeout

#comment ⇒ Object?

Returns Information about this virtual server.

Returns:

  • (Object, nil) —

    Information about this virtual server.



155
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 155

attribute :comment

#cookiedomain ⇒ Object?

Returns .,Minimum length = 1.

Returns:

  • (Object, nil) —

    .,Minimum length = 1



207
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 207

attribute :cookiedomain

#cookietimeout ⇒ Object?

Returns .,Minimum value = C(0),Maximum value = C(1440).

Returns:

  • (Object, nil) —

    .,Minimum value = C(0),Maximum value = C(1440)



210
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 210

attribute :cookietimeout

#dbprofilename ⇒ Object?

Returns Name of the DB profile.,Minimum length = 1,Maximum length = 127.

Returns:

  • (Object, nil) —

    Name of the DB profile.,Minimum length = 1,Maximum length = 127



148
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 148

attribute :dbprofilename

#disabled ⇒ :yes, ...

Returns When set to C(yes) the cs vserver will be disabled.,When set to C(no) the cs vserver will be enabled.,Note that due to limitations of the underlying NITRO API a C(disabled) state change alone does not cause the module result to report a changed status.

Returns:

  • (:yes, :no, nil) —

    When set to C(yes) the cs vserver will be disabled.,When set to C(no) the cs vserver will be enabled.,Note that due to limitations of the underlying NITRO API a C(disabled) state change alone does not cause the module result to report a changed status.



222
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 222

attribute :disabled

#disableprimaryondown ⇒ :enabled, ...

Returns Continue forwarding the traffic to backup virtual server even after the primary server comes UP from the DOWN state.

Returns:

  • (:enabled, :disabled, nil) —

    Continue forwarding the traffic to backup virtual server even after the primary server comes UP from the DOWN state.



96
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 96

attribute :disableprimaryondown

#dnsprofilename ⇒ Object?

Returns Name of the DNS profile to be associated with the VServer. DNS profile properties will applied to the transactions processed by a VServer. This parameter is valid only for DNS and DNS-TCP VServers.,Minimum length = 1,Maximum length = 127.

Returns:

  • (Object, nil) —

    Name of the DNS profile to be associated with the VServer. DNS profile properties will applied to the transactions processed by a VServer. This parameter is valid only for DNS and DNS-TCP VServers.,Minimum length = 1,Maximum length = 127



195
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 195

attribute :dnsprofilename

#domainname ⇒ Object?

Returns Domain name for which to change the time to live (TTL) and/or backup service IP address.,Minimum length = 1.

Returns:

  • (Object, nil) —

    Domain name for which to change the time to live (TTL) and/or backup service IP address.,Minimum length = 1



198
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 198

attribute :domainname

#downstateflush ⇒ :enabled, ...

Returns Flush all active transactions associated with a virtual server whose state transitions from UP to DOWN. Do not enable this option for applications that must complete their transactions.

Returns:

  • (:enabled, :disabled, nil) —

    Flush all active transactions associated with a virtual server whose state transitions from UP to DOWN. Do not enable this option for applications that must complete their transactions.



89
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 89

attribute :downstateflush

#httpprofilename ⇒ Object?

Returns Name of the HTTP profile containing HTTP configuration settings for the virtual server. The service type of the virtual server should be either C(HTTP) or C(SSL).,Minimum length = 1,Maximum length = 127.

Returns:

  • (Object, nil) —

    Name of the HTTP profile containing HTTP configuration settings for the virtual server. The service type of the virtual server should be either C(HTTP) or C(SSL).,Minimum length = 1,Maximum length = 127



145
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 145

attribute :httpprofilename

#icmpvsrresponse ⇒ :PASSIVE, ...

Returns Can be active or passive.

Returns:

  • (:PASSIVE, :ACTIVE, nil) —

    Can be active or passive.



184
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 184

attribute :icmpvsrresponse

#insertvserveripport ⇒ :OFF, ...

Returns Insert the virtual server’s VIP address and port number in the request header. Available values function as follows:,C(VIPADDR) - Header contains the vserver’s IP address and port number without any translation.,C(OFF) - The virtual IP and port header insertion option is disabled.,C(V6TOV4MAPPING) - Header contains the mapped IPv4 address corresponding 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.

Returns:

  • (:OFF, :VIPADDR, :V6TOV4MAPPING, nil) —

    Insert the virtual server’s VIP address and port number in the request header. Available values function as follows:,C(VIPADDR) - Header contains the vserver’s IP address and port number without any translation.,C(OFF) - The virtual IP and port header insertion option is disabled.,C(V6TOV4MAPPING) - Header contains the mapped IPv4 address corresponding 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.



100
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 100

attribute :insertvserveripport

#ipmask ⇒ Object?

Returns IP mask, in dotted decimal notation, for the IP Pattern parameter. Can have leading or trailing non-zero octets (for example, C(255.255.240.0) or C(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.

Returns:

  • (Object, nil) —

    IP mask, in dotted decimal notation, for the IP Pattern parameter. Can have leading or trailing non-zero octets (for example, C(255.255.240.0) or C(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.



35
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 35

attribute :ipmask

#ippattern ⇒ Object?

Returns 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 C(198.51.100.0) and the IP mask is C(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 C(0.0.2.2) and a mask such as C(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 the virtual servers, C(vs1) and C(vs2), have the same IP pattern, C(0.0.100.128), but different IP masks of C(0.0.255.255) and C(0.0.224.255), a destination IP address of 198.51.100.128 has the longest match with the IP pattern of C(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.

Returns:

  • (Object, nil) —

    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 C(198.51.100.0) and the IP mask is C(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 C(0.0.2.2) and a mask such as C(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 the virtual servers, C(vs1) and C(vs2), have the same IP pattern, C(0.0.100.128), but different IP masks of C(0.0.255.255) and C(0.0.224.255), a destination IP address of 198.51.100.128 has the longest match with the IP pattern of C(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.



32
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 32

attribute :ippattern

#ipv46 ⇒ String?

Returns IP address of the content switching virtual server.,Minimum length = 1.

Returns:

  • (String, nil) —

    IP address of the content switching virtual server.,Minimum length = 1



24
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 24

attribute :ipv46

#l2conn ⇒ Object?

Returns Use L2 Parameters to identify a connection.

Returns:

  • (Object, nil) —

    Use L2 Parameters to identify a connection.



162
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 162

attribute :l2conn

#lbvserver ⇒ Object?

Returns The default Load Balancing virtual server.

Returns:

  • (Object, nil) —

    The default Load Balancing virtual server.



216
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 216

attribute :lbvserver

#listenpolicy ⇒ Object?

Returns String specifying the listen policy for the content switching virtual server. Can be either the name of an existing expression or an in-line expression.

Returns:

  • (Object, nil) —

    String specifying the listen policy for the content switching virtual server. Can be either the name of an existing expression or an in-line expression.



118
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 118

attribute :listenpolicy

#mssqlserverversion ⇒ 70, ...

Returns The version of the MSSQL server.

Returns:

  • (70, 2000, :"2000SP1", 2005, 2008, :"2008R2", 2012, 2014, nil) —

    The version of the MSSQL server.



158
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 158

attribute :mssqlserverversion

#mysqlcharacterset ⇒ Object?

Returns The character set returned by the mysql vserver.

Returns:

  • (Object, nil) —

    The character set returned by the mysql vserver.



171
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 171

attribute :mysqlcharacterset

#mysqlprotocolversion ⇒ Object?

Returns The protocol version returned by the mysql vserver.

Returns:

  • (Object, nil) —

    The protocol version returned by the mysql vserver.



165
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 165

attribute :mysqlprotocolversion

#mysqlservercapabilities ⇒ Object?

Returns The server capabilities returned by the mysql vserver.

Returns:

  • (Object, nil) —

    The server capabilities returned by the mysql vserver.



174
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 174

attribute :mysqlservercapabilities

#mysqlserverversion ⇒ Object?

Returns The server version string returned by the mysql vserver.,Minimum length = 1,Maximum length = 31.

Returns:

  • (Object, nil) —

    The server version string returned by the mysql vserver.,Minimum length = 1,Maximum length = 31



168
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 168

attribute :mysqlserverversion

#name ⇒ String?

Returns Name for the content switching virtual server. Must begin with an ASCII alphanumeric or underscore C(_) character, and must contain only ASCII alphanumeric, underscore C(_), hash C(#), period C(.), space, colon C(:), at sign C(@), equal sign C(=), and hyphen C(-) characters.,Cannot be changed after the CS virtual server is created.,Minimum length = 1.

Returns:

  • (String, nil) —

    Name for the content switching virtual server. Must begin with an ASCII alphanumeric or underscore C(_) character, and must contain only ASCII alphanumeric, underscore C(_), hash C(#), period C(.), space, colon C(:), at sign C(@), equal sign C(=), and hyphen C(-) characters.,Cannot be changed after the CS virtual server is created.,Minimum length = 1



13
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 13

attribute :name

#netprofile ⇒ Object?

Returns The name of the network profile.,Minimum length = 1,Maximum length = 127.

Returns:

  • (Object, nil) —

    The name of the network profile.,Minimum length = 1,Maximum length = 127



181
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 181

attribute :netprofile

#oracleserverversion ⇒ :"10G", ...

Returns Oracle server version.

Returns:

  • (:"10G", :"11G", nil) —

    Oracle server version.



151
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 151

attribute :oracleserverversion

#port ⇒ Integer?

Returns Port number for content switching virtual server.,Minimum value = 1,Range C(1) - C(65535),* in CLI is represented as 65535 in NITRO API.

Returns:

  • (Integer, nil) —

    Port number for content switching virtual server.,Minimum value = 1,Range C(1) - C(65535),* in CLI is represented as 65535 in NITRO API



41
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 41

attribute :port

#precedence ⇒ :RULE, ...

Returns Type of precedence to use for both RULE-based and URL-based policies on the content switching virtual server. With the default C(RULE) setting, incoming requests are evaluated against the rule-based content switching policies. If none of the rules match, the URL in the request is evaluated against the URL-based content switching policies.

Returns:

  • (:RULE, :URL, nil) —

    Type of precedence to use for both RULE-based and URL-based policies on the content switching virtual server. With the default C(RULE) setting, incoming requests are evaluated against the rule-based content switching policies. If none of the rules match, the URL in the request is evaluated against the URL-based content switching policies.



59
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 59

attribute :precedence

#push ⇒ :enabled, ...

Returns Process traffic with the push virtual server that is bound to this content switching virtual server (specified by the Push VServer parameter). The service type of the push virtual server should be either C(HTTP) or C(SSL).

Returns:

  • (:enabled, :disabled, nil) —

    Process traffic with the push virtual server that is bound to this content switching virtual server (specified by the Push VServer parameter). The service type of the push virtual server should be either C(HTTP) or C(SSL).



128
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 128

attribute :push

#pushlabel ⇒ Object?

Returns Expression for extracting the label from the response received from server. This string can be either an existing rule name or an inline expression. The service type of the virtual server should be either C(HTTP) or C(SSL).

Returns:

  • (Object, nil) —

    Expression for extracting the label from the response received from server. This string can be either an existing rule name or an inline expression. The service type of the virtual server should be either C(HTTP) or C(SSL).



135
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 135

attribute :pushlabel

#pushmulticlients ⇒ Symbol?

Returns Allow multiple Web 2.0 connections from the same client to connect to the virtual server and expect updates.

Returns:

  • (Symbol, nil) —

    Allow multiple Web 2.0 connections from the same client to connect to the virtual server and expect updates.



138
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 138

attribute :pushmulticlients

#pushvserver ⇒ Object?

Returns Name of the load balancing virtual server, of type C(PUSH) or C(SSL_PUSH), to which the server pushes updates received on the client-facing load balancing virtual server.,Minimum length = 1.

Returns:

  • (Object, nil) —

    Name of the load balancing virtual server, of type C(PUSH) or C(SSL_PUSH), to which the server pushes updates received on the client-facing load balancing virtual server.,Minimum length = 1



132
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 132

attribute :pushvserver

#range ⇒ Object?

Returns Number of consecutive IP addresses, starting with the address specified by the IP Address parameter, to include in a range of addresses assigned to this virtual server.,Minimum value = C(1),Maximum value = C(254).

Returns:

  • (Object, nil) —

    Number of consecutive IP addresses, starting with the address specified by the IP Address parameter, to include in a range of addresses assigned to this virtual server.,Minimum value = C(1),Maximum value = C(254)



38
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 38

attribute :range

#redirectportrewrite ⇒ :enabled, ...

Returns State of port rewrite while performing HTTP redirect.

Returns:

  • (:enabled, :disabled, nil) —

    State of port rewrite while performing HTTP redirect.



85
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 85

attribute :redirectportrewrite

#redirecturl ⇒ Object?

Returns URL to which traffic is redirected if the virtual server becomes unavailable. The service type of the virtual server should be either C(HTTP) or C(SSL).,Caution: 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.,Minimum length = 1.

Returns:

  • (Object, nil) —

    URL to which traffic is redirected if the virtual server becomes unavailable. The service type of the virtual server should be either C(HTTP) or C(SSL).,Caution: 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.,Minimum length = 1



53
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 53

attribute :redirecturl

#rhistate ⇒ :PASSIVE, ...

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

Returns:

  • (:PASSIVE, :ACTIVE, nil) —

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



188
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 188

attribute :rhistate

#rtspnat ⇒ Symbol?

Returns Enable network address translation (NAT) for real-time streaming protocol (RTSP) connections.

Returns:

  • (Symbol, nil) —

    Enable network address translation (NAT) for real-time streaming protocol (RTSP) connections.



107
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 107

attribute :rtspnat

#servicetype ⇒ :HTTP, ...

Returns Protocol used by the virtual server.

Returns:

  • (:HTTP, :SSL, :TCP, :FTP, :RTSP, :SSL_TCP, :UDP, :DNS, :SIP_UDP, :SIP_TCP, :SIP_SSL, :ANY, :RADIUS, :RDP, :MYSQL, :MSSQL, :DIAMETER, :SSL_DIAMETER, :DNS_TCP, :ORACLE, :SMPP, nil) —

    Protocol used by the virtual server.



20
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 20

attribute :servicetype

#sitedomainttl ⇒ Object?

Returns .,Minimum value = C(1).

Returns:

  • (Object, nil) —

    .,Minimum value = C(1)



213
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 213

attribute :sitedomainttl

#sobackupaction ⇒ :DROP, ...

Returns Action to be performed if spillover is to take effect, but no backup chain to spillover is usable or exists.

Returns:

  • (:DROP, :ACCEPT, :REDIRECT, nil) —

    Action to be performed if spillover is to take effect, but no backup chain to spillover is usable or exists.



81
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 81

attribute :sobackupaction

#somethod ⇒ :CONNECTION, ...

Returns Type of spillover used to divert traffic to the backup virtual server when the primary virtual server reaches the spillover threshold. Connection spillover is based on the number of connections. Bandwidth spillover is based on the total Kbps of incoming and outgoing traffic.

Returns:

  • (:CONNECTION, :DYNAMICCONNECTION, :BANDWIDTH, :HEALTH, :NONE, nil) —

    Type of spillover used to divert traffic to the backup virtual server when the primary virtual server reaches the spillover threshold. Connection spillover is based on the number of connections. Bandwidth spillover is based on the total Kbps of incoming and outgoing traffic.



67
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 67

attribute :somethod

#sopersistence ⇒ :enabled, ...

Returns Maintain source-IP based persistence on primary and backup virtual servers.

Returns:

  • (:enabled, :disabled, nil) —

    Maintain source-IP based persistence on primary and backup virtual servers.



71
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 71

attribute :sopersistence

#sopersistencetimeout ⇒ Object?

Returns Time-out value, in minutes, for spillover persistence.,Minimum value = C(2),Maximum value = C(1440).

Returns:

  • (Object, nil) —

    Time-out value, in minutes, for spillover persistence.,Minimum value = C(2),Maximum value = C(1440)



75
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 75

attribute :sopersistencetimeout

#sothreshold ⇒ Object?

Returns Depending on the spillover method, the maximum number of connections or the maximum total bandwidth (Kbps) that a virtual server can handle before spillover occurs.,Minimum value = C(1),Maximum value = C(4294967287).

Returns:

  • (Object, nil) —

    Depending on the spillover method, the maximum number of connections or the maximum total bandwidth (Kbps) that a virtual server can handle before spillover occurs.,Minimum value = C(1),Maximum value = C(4294967287)



78
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 78

attribute :sothreshold

#ssl_certkey ⇒ Object?

Returns The name of the ssl certificate that is bound to this service.,The ssl certificate must already exist.,Creating the certificate can be done with the M(netscaler_ssl_certkey) module.,This option is only applicable only when C(servicetype) is C(SSL).

Returns:

  • (Object, nil) —

    The name of the ssl certificate that is bound to this service.,The ssl certificate must already exist.,Creating the certificate can be done with the M(netscaler_ssl_certkey) module.,This option is only applicable only when C(servicetype) is C(SSL).



219
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 219

attribute :ssl_certkey

#stateupdate ⇒ :enabled, ...

Returns Enable state updates for a specific content switching virtual server. By default, the Content Switching virtual server is always UP, regardless of the state of the Load Balancing virtual servers bound to it. This parameter interacts with the global setting as follows:,Global Level | Vserver Level | Result,enabled enabled enabled,enabled disabled enabled,disabled enabled enabled,disabled disabled disabled,If you want to enable state updates for only some content switching virtual servers, be sure to disable the state update parameter.

Returns:

  • (:enabled, :disabled, nil) —

    Enable state updates for a specific content switching virtual server. By default, the Content Switching virtual server is always UP, regardless of the state of the Load Balancing virtual servers bound to it. This parameter interacts with the global setting as follows:,Global Level | Vserver Level | Result,enabled enabled enabled,enabled disabled enabled,disabled enabled enabled,disabled disabled disabled,If you want to enable state updates for only some content switching virtual servers, be sure to disable the state update parameter.



45
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 45

attribute :stateupdate

#targettype ⇒ :GSLB?

Returns Virtual server target type.

Returns:

  • (:GSLB, nil) —

    Virtual server target type.



28
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 28

attribute :targettype

#tcpprofilename ⇒ Object?

Returns Name of the TCP profile containing TCP configuration settings for the virtual server.,Minimum length = 1,Maximum length = 127.

Returns:

  • (Object, nil) —

    Name of the TCP profile containing TCP configuration settings for the virtual server.,Minimum length = 1,Maximum length = 127



142
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 142

attribute :tcpprofilename

#td ⇒ Object?

Returns 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.

Returns:

  • (Object, nil) —

    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



17
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 17

attribute :td

#ttl ⇒ Object?

Returns .,Minimum value = C(1).

Returns:

  • (Object, nil) —

    .,Minimum value = C(1)



201
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 201

attribute :ttl

#vipheader ⇒ Object?

Returns Name of virtual server IP and port header, for use with the VServer IP Port Insertion parameter.,Minimum length = 1.

Returns:

  • (Object, nil) —

    Name of virtual server IP and port header, for use with the VServer IP Port Insertion parameter.,Minimum length = 1



104
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_cs_vserver.rb', line 104

attribute :vipheader