Class: Ansible::Ruby::Modules::Netscaler_gslb_service

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Netscaler_gslb_service

Defined in:

lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_service.rb

Overview

Manage gslb service entities in Netscaler.

Instance Method Summary

• #appflowlog ⇒ :enabled, ...

  Enable logging appflow flow information.

• #cip ⇒ :enabled, ...

  In the request that is forwarded to the GSLB service, insert a header that stores the client’s IP address.

• #cipheader ⇒ Object^?

  Name for the HTTP header that stores the client’s IP address.

• #clttimeout ⇒ Object^?

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

• #cnameentry ⇒ String^?

  Canonical name of the GSLB service.

• #comment ⇒ Object^?

  Any comments that you might want to associate with the GSLB service.

• #downstateflush ⇒ :enabled, ...

  Flush all active transactions associated with the GSLB service when its state transitions from UP to DOWN.

• #hashid ⇒ Object^?

  Unique hash identifier for the GSLB service, used by hash based load balancing methods.,Minimum value = C(1).

• #healthmonitor ⇒ Symbol^?

  Monitor the health of the GSLB service.

• #ipaddress ⇒ Object^?

  IP address for the GSLB service.

• #maxaaausers ⇒ Object^?

  Maximum number of SSL VPN users that can be logged on concurrently to the VPN virtual server that is represented by this GSLB service.

• #maxbandwidth ⇒ Object^?

  Integer specifying the maximum bandwidth allowed for the service.

• #maxclient ⇒ Object^?

  The maximum number of open connections that the service can support at any given time.

• #monitor_bindings ⇒ Object^?

  Bind monitors to this gslb service.

• #monthreshold ⇒ Object^?

  Monitoring threshold value for the GSLB service.

• #port ⇒ Object^?

  Port on which the load balancing entity represented by this GSLB service listens.,Minimum value = 1,Range 1 - 65535,* in CLI is represented as 65535 in NITRO API.

• #publicip ⇒ Object^?

  The public IP address that a NAT device translates to the GSLB service’s private IP address.

• #publicport ⇒ Object^?

  The public port associated with the GSLB service’s public IP address.

• #servername ⇒ Object^?

  Name of the server hosting the GSLB service.,Minimum length = 1.

• #servicename ⇒ String^?

  Name for the GSLB service.

• #servicetype ⇒ :HTTP, ...

  Type of service to create.

• #sitename ⇒ String^?

  Name of the GSLB site to which the service belongs.,Minimum length = 1.

• #sitepersistence ⇒ :ConnectionProxy, ...

  Use cookie-based site persistence.

• #siteprefix ⇒ Object^?

  The site’s prefix string.

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.

# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_service.rb', line 83

attribute :appflowlog

#cip ⇒ :enabled, ...

Returns In the request that is forwarded to the GSLB service, insert a header that stores the client’s IP address. Client IP header insertion is used in connection-proxy based site persistence.

Returns:

• (:enabled, :disabled, nil) —

  In the request that is forwarded to the GSLB service, insert a header that stores the client’s IP address. Client IP header insertion is used in connection-proxy based site persistence.

# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_service.rb', line 47

attribute :cip

#cipheader ⇒ Object^?

Returns Name for the HTTP header that stores the client’s IP address. Used with the Client IP option. If client IP header insertion is enabled on the service and a name is not specified for the header, the NetScaler appliance uses the name specified by the cipHeader parameter in the set ns param command or, in the GUI, the Client IP Header parameter in the Configure HTTP Parameters dialog box.,Minimum length = 1.

Returns:

• (Object, nil) —

  Name for the HTTP header that stores the client’s IP address. Used with the Client IP option. If client IP header insertion is enabled on the service and a name is not specified for the header, the NetScaler appliance uses the name specified by the cipHeader parameter in the set ns param command or, in the GUI, the Client IP Header parameter in the Configure HTTP Parameters dialog box.,Minimum length = 1

# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_service.rb', line 51

attribute :cipheader

#clttimeout ⇒ Object^?

Returns Idle time, in seconds, after which a client connection is terminated. Applicable if connection proxy based site persistence is used.,Minimum value = 0,Maximum value = 31536000.

Returns:

• (Object, nil) —

  Idle time, in seconds, after which a client connection is terminated. Applicable if connection proxy based site persistence is used.,Minimum value = 0,Maximum value = 31536000

# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_service.rb', line 61

attribute :clttimeout

#cnameentry ⇒ String^?

Returns Canonical name of the GSLB service. Used in CNAME-based GSLB.,Minimum length = 1.

Returns:

• (String, nil) —

  Canonical name of the GSLB service. Used in CNAME-based GSLB.,Minimum length = 1

# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_service.rb', line 16

attribute :cnameentry

#comment ⇒ Object^?

Returns Any comments that you might want to associate with the GSLB service.

Returns:

• (Object, nil) —

  Any comments that you might want to associate with the GSLB service.

# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_service.rb', line 80

attribute :comment

#downstateflush ⇒ :enabled, ...

Returns Flush all active transactions associated with the GSLB service when its state transitions from UP to DOWN. Do not enable this option for services that must complete their transactions. Applicable if connection proxy based site persistence is used.

Returns:

• (:enabled, :disabled, nil) —

  Flush all active transactions associated with the GSLB service when its state transitions from UP to DOWN. Do not enable this option for services that must complete their transactions. Applicable if connection proxy based site persistence is used.

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

attribute :downstateflush

#hashid ⇒ Object^?

Returns Unique hash identifier for the GSLB service, used by hash based load balancing methods.,Minimum value = C(1).

Returns:

• (Object, nil) —

  Unique hash identifier for the GSLB service, used by hash based load balancing methods.,Minimum value = C(1)

# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_service.rb', line 77

attribute :hashid

#healthmonitor ⇒ Symbol^?

Returns Monitor the health of the GSLB service.

Returns:

• (Symbol, nil) —

  Monitor the health of the GSLB service.

# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_service.rb', line 39

attribute :healthmonitor

#ipaddress ⇒ Object^?

Returns IP address for the GSLB service. Should represent a load balancing, content switching, or VPN virtual server on the NetScaler appliance, or the IP address of another load balancing device.

Returns:

• (Object, nil) —

  IP address for the GSLB service. Should represent a load balancing, content switching, or VPN virtual server on the NetScaler appliance, or the IP address of another load balancing device.

# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_service.rb', line 87

attribute :ipaddress

#maxaaausers ⇒ Object^?

Returns Maximum number of SSL VPN users that can be logged on concurrently to the VPN virtual server that is represented by this GSLB service. A GSLB service whose user count reaches the maximum is not considered when a GSLB decision is made, until the count drops below the maximum.,Minimum value = C(0),Maximum value = C(65535).

Returns:

• (Object, nil) —

  Maximum number of SSL VPN users that can be logged on concurrently to the VPN virtual server that is represented by this GSLB service. A GSLB service whose user count reaches the maximum is not considered when a GSLB decision is made, until the count drops below the maximum.,Minimum value = C(0),Maximum value = C(65535)

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

attribute :maxaaausers

#maxbandwidth ⇒ Object^?

Returns Integer specifying the maximum bandwidth allowed for the service. A GSLB service whose bandwidth reaches the maximum is not considered when a GSLB decision is made, until its bandwidth consumption drops below the maximum.

Returns:

• (Object, nil) —

  Integer specifying the maximum bandwidth allowed for the service. A GSLB service whose bandwidth reaches the maximum is not considered when a GSLB decision is made, until its bandwidth consumption drops below the maximum.

# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_service.rb', line 64

attribute :maxbandwidth

#maxclient ⇒ Object^?

Returns The maximum number of open connections that the service can support at any given time. A GSLB service whose connection count reaches the maximum is not considered when a GSLB decision is made, until the connection count drops below the maximum.,Minimum value = C(0),Maximum value = C(4294967294).

Returns:

• (Object, nil) —

  The maximum number of open connections that the service can support at any given time. A GSLB service whose connection count reaches the maximum is not considered when a GSLB decision is made, until the connection count drops below the maximum.,Minimum value = C(0),Maximum value = C(4294967294)

# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_service.rb', line 36

attribute :maxclient

#monitor_bindings ⇒ Object^?

Returns Bind monitors to this gslb service.

Returns:

• (Object, nil) —

  Bind monitors to this gslb service

# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_service.rb', line 90

attribute :monitor_bindings

#monthreshold ⇒ Object^?

Returns Monitoring threshold value for the GSLB service. If the sum of the weights of the monitors that are bound to this GSLB service and are in the UP state is not equal to or greater than this threshold value, the service is marked as DOWN.,Minimum value = C(0),Maximum value = C(65535).

Returns:

• (Object, nil) —

  Monitoring threshold value for the GSLB service. If the sum of the weights of the monitors that are bound to this GSLB service and are in the UP state is not equal to or greater than this threshold value, the service is marked as DOWN.,Minimum value = C(0),Maximum value = C(65535)

# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_service.rb', line 74

attribute :monthreshold

#port ⇒ Object^?

Returns Port on which the load balancing entity represented by this GSLB service listens.,Minimum value = 1,Range 1 - 65535,* in CLI is represented as 65535 in NITRO API.

Returns:

• (Object, nil) —

  Port on which the load balancing entity represented by this GSLB service listens.,Minimum value = 1,Range 1 - 65535,* in CLI is represented as 65535 in NITRO API

# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_service.rb', line 27

attribute :port

#publicip ⇒ Object^?

Returns The public IP address that a NAT device translates to the GSLB service’s private IP address. Optional.

Returns:

• (Object, nil) —

  The public IP address that a NAT device translates to the GSLB service’s private IP address. Optional.

# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_service.rb', line 30

attribute :publicip

#publicport ⇒ Object^?

Returns The public port associated with the GSLB service’s public IP address. The port is mapped to the service’s private port number. Applicable to the local GSLB service. Optional.

Returns:

• (Object, nil) —

  The public port associated with the GSLB service’s public IP address. The port is mapped to the service’s private port number. Applicable to the local GSLB service. Optional.

# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_service.rb', line 33

attribute :publicport

#servername ⇒ Object^?

Returns Name of the server hosting the GSLB service.,Minimum length = 1.

Returns:

• (Object, nil) —

  Name of the server hosting the GSLB service.,Minimum length = 1

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

attribute :servername

#servicename ⇒ String^?

Returns Name for the GSLB service. 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 C(@), equals C(=), and hyphen C(-) characters. Can be changed after the GSLB service is created.,,Minimum length = 1.

Returns:

• (String, nil) —

  Name for the GSLB service. 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 C(@), equals C(=), and hyphen C(-) characters. Can be changed after the GSLB service is created.,,Minimum length = 1

# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_service.rb', line 12

attribute :servicename

#servicetype ⇒ :HTTP, ...

Returns Type of service to create.

Returns:

• (:HTTP, :FTP, :TCP, :UDP, :SSL, :SSL_BRIDGE, :SSL_TCP, :NNTP, :ANY, :SIP_UDP, :SIP_TCP, :SIP_SSL, :RADIUS, :RDP, :RTSP, :MYSQL, :MSSQL, :ORACLE, nil) —

  Type of service to create.

# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_service.rb', line 23

attribute :servicetype

#sitename ⇒ String^?

Returns Name of the GSLB site to which the service belongs.,Minimum length = 1.

Returns:

• (String, nil) —

  Name of the GSLB site to which the service belongs.,Minimum length = 1

# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_service.rb', line 43

attribute :sitename

#sitepersistence ⇒ :ConnectionProxy, ...

Returns Use cookie-based site persistence. Applicable only to C(HTTP) and C(SSL) GSLB services.

Returns:

• (:ConnectionProxy, :HTTPRedirect, :NONE, nil) —

  Use cookie-based site persistence. Applicable only to C(HTTP) and C(SSL) GSLB services.

# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_service.rb', line 54

attribute :sitepersistence

#siteprefix ⇒ Object^?

Returns The site’s prefix string. When the service is bound to a GSLB virtual server, a GSLB site domain is generated internally for each bound service-domain pair by concatenating the site prefix of the service and the name of the domain. If the special string NONE is specified, the site-prefix string is unset. When implementing HTTP redirect site persistence, the NetScaler appliance redirects GSLB requests to GSLB services by using their site domains.

Returns:

• (Object, nil) —

  The site’s prefix string. When the service is bound to a GSLB virtual server, a GSLB site domain is generated internally for each bound service-domain pair by concatenating the site prefix of the service and the name of the domain. If the special string NONE is specified, the site-prefix string is unset. When implementing HTTP redirect site persistence, the NetScaler appliance redirects GSLB requests to GSLB services by using their site domains.

# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_service.rb', line 58

attribute :siteprefix