Class: Ansible::Ruby::Modules::Netscaler_servicegroup

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

Overview

Manage service group configuration in Netscaler. 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, #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 of AppFlow information for the specified service group.

Returns:

  • (:enabled, :disabled, nil) —

    Enable logging of AppFlow information for the specified service group.



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

attribute :appflowlog

#autoscale ⇒ :DISABLED, ...

Returns Auto scale option for a servicegroup.

Returns:

  • (:DISABLED, :DNS, :POLICY, nil) —

    Auto scale option for a servicegroup.



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

attribute :autoscale

#cacheable ⇒ Object?

Returns Use the transparent cache redirection virtual server to forward the request to the cache server.,Note: Do not set this parameter if you set the Cache Type.

Returns:

  • (Object, nil) —

    Use the transparent cache redirection virtual server to forward the request to the cache server.,Note: Do not set this parameter if you set the Cache Type.



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

attribute :cacheable

#cachetype ⇒ :TRANSPARENT, ...

Returns Cache type supported by the cache server.

Returns:

  • (:TRANSPARENT, :REVERSE, :FORWARD, nil) —

    Cache type supported by the cache server.



21
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_servicegroup.rb', line 21

attribute :cachetype

#cip ⇒ :enabled, ...

Returns Insert the Client IP header in requests forwarded to the service.

Returns:

  • (:enabled, :disabled, nil) —

    Insert the Client IP header in requests forwarded to the service.



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

attribute :cip

#cipheader ⇒ Object?

Returns Name of the HTTP header whose value must be set to the IP address of the client. Used with the Client IP parameter. If client IP insertion is enabled, and the client IP header is not specified, the value of Client IP Header parameter or the value set by the set ns config command is used as client’s IP header name.,Minimum length = 1.

Returns:

  • (Object, nil) —

    Name of the HTTP header whose value must be set to the IP address of the client. Used with the Client IP parameter. If client IP insertion is enabled, and the client IP header is not specified, the value of Client IP Header parameter or the value set by the set ns config command is used as client’s IP header name.,Minimum length = 1



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

attribute :cipheader

#cka ⇒ Object?

Returns Enable client keep-alive for the service group.

Returns:

  • (Object, nil) —

    Enable client keep-alive for the service group.



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

attribute :cka

#clttimeout ⇒ Object?

Returns Time, in seconds, after which to terminate an idle client connection.,Minimum value = C(0),Maximum value = C(31536000).

Returns:

  • (Object, nil) —

    Time, in seconds, after which to terminate an idle client connection.,Minimum value = C(0),Maximum value = C(31536000)



62
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_servicegroup.rb', line 62

attribute :clttimeout

#cmp ⇒ Object?

Returns Enable compression for the specified service.

Returns:

  • (Object, nil) —

    Enable compression for the specified service.



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

attribute :cmp

#comment ⇒ Object?

Returns Any information about the service group.

Returns:

  • (Object, nil) —

    Any information about the service group.



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

attribute :comment

#disabled ⇒ Boolean?

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

  • (Boolean, nil) —

    When set to C(yes) the service group state will be set to DISABLED.,When set to C(no) the service group state will be set to 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.



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

attribute :disabled

#downstateflush ⇒ :enabled, ...

Returns Flush all active transactions associated with all the services in the service group 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 all the services in the service group whose state transitions from UP to DOWN. Do not enable this option for applications that must complete their transactions.



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

attribute :downstateflush

#graceful ⇒ Object?

Returns Wait for all existing connections to the service to terminate before shutting down the service.

Returns:

  • (Object, nil) —

    Wait for all existing connections to the service to terminate before shutting down the service.



110
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_servicegroup.rb', line 110

attribute :graceful

#healthmonitor ⇒ Object?

Returns Monitor the health of this service. Available settings function as follows:,C(yes) - Send probes to check the health of the service.,C(no) - Do not send probes to check the health of the service. With the NO option, the appliance shows the service as UP at all times.

Returns:

  • (Object, nil) —

    Monitor the health of this service. Available settings function as follows:,C(yes) - Send probes to check the health of the service.,C(no) - Do not send probes to check the health of the service. With the NO option, the appliance shows the service as UP at all times.



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

attribute :healthmonitor

#httpprofilename ⇒ Object?

Returns Name of the HTTP profile that contains HTTP configuration settings for the service group.,Minimum length = 1,Maximum length = 127.

Returns:

  • (Object, nil) —

    Name of the HTTP profile that contains HTTP configuration settings for the service group.,Minimum length = 1,Maximum length = 127



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

attribute :httpprofilename

#maxbandwidth ⇒ Object?

Returns Maximum bandwidth, in Kbps, allocated for all the services in the service group.,Minimum value = C(0),Maximum value = C(4294967287).

Returns:

  • (Object, nil) —

    Maximum bandwidth, in Kbps, allocated for all the services in the service group.,Minimum value = C(0),Maximum value = C(4294967287)



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

attribute :maxbandwidth

#maxclient ⇒ Object?

Returns Maximum number of simultaneous open connections for the service group.,Minimum value = C(0),Maximum value = C(4294967294).

Returns:

  • (Object, nil) —

    Maximum number of simultaneous open connections for the service group.,Minimum value = C(0),Maximum value = C(4294967294)



25
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_servicegroup.rb', line 25

attribute :maxclient

#maxreq ⇒ Object?

Returns Maximum number of requests that can be sent on a persistent connection to the service group.,Note: Connection requests beyond this value are rejected.,Minimum value = C(0),Maximum value = C(65535).

Returns:

  • (Object, nil) —

    Maximum number of requests that can be sent on a persistent connection to the service group.,Note: Connection requests beyond this value are rejected.,Minimum value = C(0),Maximum value = C(65535)



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

attribute :maxreq

#memberport ⇒ Object?

Returns member port.

Returns:

  • (Object, nil) —

    member port.



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

attribute :memberport

#monitorbindings ⇒ Array<Hash>, ...

Returns A list of monitornames to bind to this service,Note that the monitors must have already been setup possibly using the M(netscaler_lb_monitor) module or some other method.

Returns:

  • (Array<Hash>, Hash, nil) —

    A list of monitornames to bind to this service,Note that the monitors must have already been setup possibly using the M(netscaler_lb_monitor) module or some other method



117
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_servicegroup.rb', line 117

attribute :monitorbindings

#monthreshold ⇒ Object?

Returns Minimum sum of weights of the monitors that are bound to this service. Used to determine whether to mark a service as UP or DOWN.,Minimum value = C(0),Maximum value = C(65535).

Returns:

  • (Object, nil) —

    Minimum sum of weights of the monitors that are bound to this service. Used to determine whether to mark a service as UP or DOWN.,Minimum value = C(0),Maximum value = C(65535)



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

attribute :monthreshold

#netprofile ⇒ Object?

Returns Network profile for the service group.,Minimum length = 1,Maximum length = 127.

Returns:

  • (Object, nil) —

    Network profile for the service group.,Minimum length = 1,Maximum length = 127



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

attribute :netprofile

#pathmonitor ⇒ Object?

Returns Path monitoring for clustering.

Returns:

  • (Object, nil) —

    Path monitoring for clustering.



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

attribute :pathmonitor

#pathmonitorindv ⇒ Object?

Returns Individual Path monitoring decisions.

Returns:

  • (Object, nil) —

    Individual Path monitoring decisions.



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

attribute :pathmonitorindv

#rtspsessionidremap ⇒ Object?

Returns Enable RTSP session ID mapping for the service group.

Returns:

  • (Object, nil) —

    Enable RTSP session ID mapping for the service group.



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

attribute :rtspsessionidremap

#servicegroupname ⇒ String?

Returns Name of the service group. Must begin with an ASCII alphabetic or underscore C(_) character, and must contain only ASCII alphanumeric, underscore C(_), hash C(#), period C(.), space C( ), colon C(:), at C(@), equals C(=), and hyphen C(-) characters. Can be changed after the name is created.,Minimum length = 1.

Returns:

  • (String, nil) —

    Name of the service group. Must begin with an ASCII alphabetic or underscore C(_) character, and must contain only ASCII alphanumeric, underscore C(_), hash C(#), period C(.), space C( ), colon C(:), at C(@), equals C(=), and hyphen C(-) characters. Can be changed after the name is created.,Minimum length = 1



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

attribute :servicegroupname

#servicemembers ⇒ Array<Hash>, ...

Returns A list of dictionaries describing each service member of the service group.

Returns:

  • (Array<Hash>, Hash, nil) —

    A list of dictionaries describing each service member of the service group.



113
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_servicegroup.rb', line 113

attribute :servicemembers

#servicetype ⇒ :HTTP, ...

Returns Protocol used to exchange data with the service.

Returns:

  • (:HTTP, :FTP, :TCP, :UDP, :SSL, :SSL_BRIDGE, :SSL_TCP, :DTLS, :NNTP, :RPCSVR, :DNS, :ADNS, :SNMP, :RTSP, :DHCPRA, :ANY, :SIP_UDP, :SIP_TCP, :SIP_SSL, :DNS_TCP, :ADNS_TCP, :MYSQL, :MSSQL, :ORACLE, :RADIUS, :RADIUSListener, :RDP, :DIAMETER, :SSL_DIAMETER, :TFTP, :SMPP, :PPTP, :GRE, :SYSLOGTCP, :SYSLOGUDP, :FIX, :SSL_FIX, nil) —

    Protocol used to exchange data with the service.



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

attribute :servicetype

#sp ⇒ Object?

Returns Enable surge protection for the service group.

Returns:

  • (Object, nil) —

    Enable surge protection for the service group.



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

attribute :sp

#svrtimeout ⇒ Object?

Returns Time, in seconds, after which to terminate an idle server connection.,Minimum value = C(0),Maximum value = C(31536000).

Returns:

  • (Object, nil) —

    Time, in seconds, after which to terminate an idle server connection.,Minimum value = C(0),Maximum value = C(31536000)



65
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_servicegroup.rb', line 65

attribute :svrtimeout

#tcpb ⇒ Object?

Returns Enable TCP buffering for the service group.

Returns:

  • (Object, nil) —

    Enable TCP buffering for the service group.



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

attribute :tcpb

#tcpprofilename ⇒ Object?

Returns Name of the TCP profile that contains TCP configuration settings for the service group.,Minimum length = 1,Maximum length = 127.

Returns:

  • (Object, nil) —

    Name of the TCP profile that contains TCP configuration settings for the service group.,Minimum length = 1,Maximum length = 127



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

attribute :tcpprofilename

#useproxyport ⇒ Object?

Returns Use the proxy port as the source port when initiating connections with the server. With the NO setting, the client-side connection port is used as the source port for the server-side connection.,Note: This parameter is available only when the Use Source IP C(usip) parameter is set to C(yes).

Returns:

  • (Object, nil) —

    Use the proxy port as the source port when initiating connections with the server. With the NO setting, the client-side connection port is used as the source port for the server-side connection.,Note: This parameter is available only when the Use Source IP C(usip) parameter is set to C(yes).



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

attribute :useproxyport

#usip ⇒ Object?

Returns Use client’s IP address as the source IP address when initiating connection to the server. With the NO setting, which is the default, a mapped IP (MIP) address or subnet IP (SNIP) address is used as the source IP address to initiate server side connections.

Returns:

  • (Object, nil) —

    Use client’s IP address as the source IP address when initiating connection to the server. With the NO setting, which is the default, a mapped IP (MIP) address or subnet IP (SNIP) address is used as the source IP address to initiate server side connections.



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

attribute :usip