Class: Ansible::Ruby::Modules::Netscaler_gslb_vserver

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

Overview

Configure gslb vserver entities in Netscaler.

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.



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

attribute :appflowlog

#backuplbmethod ⇒ :ROUNDROBIN, ...

Returns Backup load balancing method. Becomes operational if the primary load balancing method fails or cannot be used. Valid only if the primary method is based on either round-trip time (RTT) or static proximity.

Returns:

  • (:ROUNDROBIN, :LEASTCONNECTION, :LEASTRESPONSETIME, :SOURCEIPHASH, :LEASTBANDWIDTH, :LEASTPACKETS, :STATICPROXIMITY, :RTT, :CUSTOMLOAD, nil) —

    Backup load balancing method. Becomes operational if the primary load balancing method fails or cannot be used. Valid only if the primary method is based on either round-trip time (RTT) or static proximity.



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

attribute :backuplbmethod

#comment ⇒ Object?

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

Returns:

  • (Object, nil) —

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



72
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_vserver.rb', line 72

attribute :comment

#considereffectivestate ⇒ :NONE, ...

Returns If the primary state of all bound GSLB services is DOWN, consider the effective states of all the GSLB services, obtained through the Metrics Exchange Protocol (MEP), when determining the state of the GSLB virtual server. To consider the effective state, set the parameter to STATE_ONLY. To disregard the effective state, set the parameter to NONE.,The effective state of a GSLB service is the ability of the corresponding virtual server to serve traffic. The effective state of the load balancing virtual server, which is transferred to the GSLB service, is UP even if only one virtual server in the backup chain of virtual servers is in the UP state.

Returns:

  • (:NONE, :STATE_ONLY, nil) —

    If the primary state of all bound GSLB services is DOWN, consider the effective states of all the GSLB services, obtained through the Metrics Exchange Protocol (MEP), when determining the state of the GSLB virtual server. To consider the effective state, set the parameter to STATE_ONLY. To disregard the effective state, set the parameter to NONE.,The effective state of a GSLB service is the ability of the corresponding virtual server to serve traffic. The effective state of the load balancing virtual server, which is transferred to the GSLB service, is UP even if only one virtual server in the backup chain of virtual servers is in the UP state.



68
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_vserver.rb', line 68

attribute :considereffectivestate

#disabled ⇒ Symbol?

Returns When set to C(yes) the GSLB Vserver state will be set to C(disabled).,When set to C(no) the GSLB Vserver state will be set to C(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:

  • (Symbol, nil) —

    When set to C(yes) the GSLB Vserver state will be set to C(disabled).,When set to C(no) the GSLB Vserver state will be set to C(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.



103
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_vserver.rb', line 103

attribute :disabled

#disableprimaryondown ⇒ :enabled, ...

Returns Continue to direct traffic to the backup chain even after the primary GSLB virtual server returns to the UP state. Used when spillover is configured for the virtual server.

Returns:

  • (:enabled, :disabled, nil) —

    Continue to direct traffic to the backup chain even after the primary GSLB virtual server returns to the UP state. Used when spillover is configured for the virtual server.



60
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_vserver.rb', line 60

attribute :disableprimaryondown

#dnsrecordtype ⇒ :A, ...

Returns DNS record type to associate with the GSLB virtual server’s domain name.,Default value: A,Possible values = A, AAAA, CNAME, NAPTR.

Returns:

  • (:A, :AAAA, :CNAME, :NAPTR, nil) —

    DNS record type to associate with the GSLB virtual server’s domain name.,Default value: A,Possible values = A, AAAA, CNAME, NAPTR



19
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_vserver.rb', line 19

attribute :dnsrecordtype

#domain_bindings ⇒ Object?

Returns List of bindings for domains for this glsb vserver.

Returns:

  • (Object, nil) —

    List of bindings for domains for this glsb vserver.



97
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_vserver.rb', line 97

attribute :domain_bindings

#dynamicweight ⇒ :SERVICECOUNT, ...

Returns Specify if the appliance should consider the service count, service weights, or ignore both when using weight-based load balancing methods. The state of the number of services bound to the virtual server help the appliance to select the service.

Returns:

  • (:SERVICECOUNT, :SERVICEWEIGHT, :DISABLED, nil) —

    Specify if the appliance should consider the service count, service weights, or ignore both when using weight-based load balancing methods. The state of the number of services bound to the virtual server help the appliance to select the service.



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

attribute :dynamicweight

#lbmethod ⇒ :ROUNDROBIN, ...

Returns Load balancing method for the GSLB virtual server.,Default value: LEASTCONNECTION,Possible values = ROUNDROBIN, LEASTCONNECTION, LEASTRESPONSETIME, SOURCEIPHASH, LEASTBANDWIDTH, LEASTPACKETS, STATICPROXIMITY, RTT, CUSTOMLOAD.

Returns:

  • (:ROUNDROBIN, :LEASTCONNECTION, :LEASTRESPONSETIME, :SOURCEIPHASH, :LEASTBANDWIDTH, :LEASTPACKETS, :STATICPROXIMITY, :RTT, :CUSTOMLOAD, nil) —

    Load balancing method for the GSLB virtual server.,Default value: LEASTCONNECTION,Possible values = ROUNDROBIN, LEASTCONNECTION, LEASTRESPONSETIME, SOURCEIPHASH, LEASTBANDWIDTH, LEASTPACKETS, STATICPROXIMITY, RTT, CUSTOMLOAD



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

attribute :lbmethod

#mir ⇒ :enabled, ...

Returns Include multiple IP addresses in the DNS responses sent to clients.

Returns:

  • (:enabled, :disabled, nil) —

    Include multiple IP addresses in the DNS responses sent to clients.



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

attribute :mir

#name ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :name

#netmask ⇒ Object?

Returns IPv4 network mask for use in the SOURCEIPHASH load balancing method.,Minimum length = 1.

Returns:

  • (Object, nil) —

    IPv4 network mask for use in the SOURCEIPHASH load balancing method.,Minimum length = 1



31
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_vserver.rb', line 31

attribute :netmask

#persistenceid ⇒ Object?

Returns The persistence ID for the GSLB virtual server. The ID is a positive integer that enables GSLB sites to identify the GSLB virtual server, and is required if source IP address based or spill over based persistence is enabled on the virtual server.,Minimum value = C(0),Maximum value = C(65535).

Returns:

  • (Object, nil) —

    The persistence ID for the GSLB virtual server. The ID is a positive integer that enables GSLB sites to identify the GSLB virtual server, and is required if source IP address based or spill over based persistence is enabled on the virtual server.,Minimum value = C(0),Maximum value = C(65535)



44
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_vserver.rb', line 44

attribute :persistenceid

#persistencetype ⇒ :SOURCEIP, ...

Returns Use source IP address based persistence for the virtual server.,After the load balancing method selects a service for the first packet, the IP address received in response to the DNS query is used for subsequent requests from the same client.

Returns:

  • (:SOURCEIP, :NONE, nil) —

    Use source IP address based persistence for the virtual server.,After the load balancing method selects a service for the first packet, the IP address received in response to the DNS query is used for subsequent requests from the same client.



40
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_vserver.rb', line 40

attribute :persistencetype

#persistmask ⇒ Object?

Returns The optional IPv4 network mask applied to IPv4 addresses to establish source IP address based persistence.,Minimum length = 1.

Returns:

  • (Object, nil) —

    The optional IPv4 network mask applied to IPv4 addresses to establish source IP address based persistence.,Minimum length = 1



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

attribute :persistmask

#service_bindings ⇒ Object?

Returns List of bindings for gslb services bound to this gslb virtual server.

Returns:

  • (Object, nil) —

    List of bindings for gslb services bound to this gslb virtual server.



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

attribute :service_bindings

#servicetype ⇒ :HTTP, ...

Returns Protocol used by services bound to the virtual server.,.

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) —

    Protocol used by services bound to the virtual server.,



15
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_vserver.rb', line 15

attribute :servicetype

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



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

attribute :sobackupaction

#somethod ⇒ :CONNECTION, ...

Returns Type of threshold that, when exceeded, triggers spillover. Available settings function as follows:,* C(CONNECTION) - Spillover occurs when the number of client connections exceeds the threshold.,* C(DYNAMICCONNECTION) - Spillover occurs when the number of client connections at the GSLB virtual server exceeds the sum of the maximum client (Max Clients) settings for bound GSLB services. Do not specify a spillover threshold for this setting, because the threshold is implied by the Max Clients settings of the bound GSLB services.,* C(BANDWIDTH) - Spillover occurs when the bandwidth consumed by the GSLB virtual server’s incoming and outgoing traffic exceeds the threshold.,* C(HEALTH) - Spillover occurs when the percentage of weights of the GSLB services that are UP drops below the threshold. For example, if services gslbSvc1, gslbSvc2, and gslbSvc3 are bound to a virtual server, with weights 1, 2, and 3, and the spillover threshold is 50%, spillover occurs if gslbSvc1 and gslbSvc3 or gslbSvc2 and gslbSvc3 transition to DOWN.,* C(NONE) - Spillover does not occur.

Returns:

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

    Type of threshold that, when exceeded, triggers spillover. Available settings function as follows:,* C(CONNECTION) - Spillover occurs when the number of client connections exceeds the threshold.,* C(DYNAMICCONNECTION) - Spillover occurs when the number of client connections at the GSLB virtual server exceeds the sum of the maximum client (Max Clients) settings for bound GSLB services. Do not specify a spillover threshold for this setting, because the threshold is implied by the Max Clients settings of the bound GSLB services.,* C(BANDWIDTH) - Spillover occurs when the bandwidth consumed by the GSLB virtual server’s incoming and outgoing traffic exceeds the threshold.,* C(HEALTH) - Spillover occurs when the percentage of weights of the GSLB services that are UP drops below the threshold. For example, if services gslbSvc1, gslbSvc2, and gslbSvc3 are bound to a virtual server, with weights 1, 2, and 3, and the spillover threshold is 50%, spillover occurs if gslbSvc1 and gslbSvc3 or gslbSvc2 and gslbSvc3 transition to DOWN.,* C(NONE) - Spillover does not occur.



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

attribute :somethod

#sopersistence ⇒ :enabled, ...

Returns If spillover occurs, maintain source IP address based persistence for both primary and backup GSLB virtual servers.

Returns:

  • (:enabled, :disabled, nil) —

    If spillover occurs, maintain source IP address based persistence for both primary and backup GSLB virtual servers.



79
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_vserver.rb', line 79

attribute :sopersistence

#sopersistencetimeout ⇒ Object?

Returns Timeout for spillover persistence, in minutes.,Default value: C(2),Minimum value = C(2),Maximum value = C(1440).

Returns:

  • (Object, nil) —

    Timeout for spillover persistence, in minutes.,Default value: C(2),Minimum value = C(2),Maximum value = C(1440)



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

attribute :sopersistencetimeout

#sothreshold ⇒ Object?

Returns 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 = C(1),Maximum value = C(4294967287).

Returns:

  • (Object, nil) —

    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 = C(1),Maximum value = C(4294967287)



86
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_vserver.rb', line 86

attribute :sothreshold

#timeout ⇒ Object?

Returns Idle time, in minutes, after which a persistence entry is cleared.,Default value: C(2),Minimum value = C(2),Maximum value = C(1440).

Returns:

  • (Object, nil) —

    Idle time, in minutes, after which a persistence entry is cleared.,Default value: C(2),Minimum value = C(2),Maximum value = C(1440)



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

attribute :timeout

#tolerance ⇒ Object?

Returns Site selection tolerance, in milliseconds, for implementing the RTT load balancing method. If a site’s RTT deviates from the lowest RTT by more than the specified tolerance, the site is not considered when the NetScaler appliance makes a GSLB decision. The appliance implements the round robin method of global server load balancing between sites whose RTT values are within the specified tolerance. If the tolerance is 0 (zero), the appliance always sends clients the IP address of the site with the lowest RTT.,Minimum value = C(0),Maximum value = C(100).

Returns:

  • (Object, nil) —

    Site selection tolerance, in milliseconds, for implementing the RTT load balancing method. If a site’s RTT deviates from the lowest RTT by more than the specified tolerance, the site is not considered when the NetScaler appliance makes a GSLB decision. The appliance implements the round robin method of global server load balancing between sites whose RTT values are within the specified tolerance. If the tolerance is 0 (zero), the appliance always sends clients the IP address of the site with the lowest RTT.,Minimum value = C(0),Maximum value = C(100)



37
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_vserver.rb', line 37

attribute :tolerance

#v6netmasklen ⇒ Object?

Returns Number of bits to consider, in an IPv6 source IP address, for creating the hash that is required by the C(SOURCEIPHASH) load balancing method.,Default value: C(128),Minimum value = C(1),Maximum value = C(128).

Returns:

  • (Object, nil) —

    Number of bits to consider, in an IPv6 source IP address, for creating the hash that is required by the C(SOURCEIPHASH) load balancing method.,Default value: C(128),Minimum value = C(1),Maximum value = C(128)



34
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_vserver.rb', line 34

attribute :v6netmasklen

#v6persistmasklen ⇒ Object?

Returns Number of bits to consider in an IPv6 source IP address when creating source IP address based persistence sessions.,Default value: C(128),Minimum value = C(1),Maximum value = C(128).

Returns:

  • (Object, nil) —

    Number of bits to consider in an IPv6 source IP address when creating source IP address based persistence sessions.,Default value: C(128),Minimum value = C(1),Maximum value = C(128)



50
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_vserver.rb', line 50

attribute :v6persistmasklen