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

Inherits:

Base

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

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

• #appflowlog ⇒ :enabled, ...

  Enable logging of AppFlow information for the specified service group.

• #autoscale ⇒ :DISABLED, ...

  Auto scale option for a servicegroup.

• #cacheable ⇒ Symbol^?

  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.

• #cachetype ⇒ :TRANSPARENT, ...

  Cache type supported by the cache server.

• #cip ⇒ :enabled, ...

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

• #cipheader ⇒ Object^?

  Name of the HTTP header whose value must be set to the IP address of the client.

• #cka ⇒ Symbol^?

  Enable client keep-alive for the service group.

• #clttimeout ⇒ Object^?

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

• #cmp ⇒ Symbol^?

  Enable compression for the specified service.

• #comment ⇒ Object^?

  Any information about the service group.

• #disabled ⇒ Symbol^?

  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.

• #downstateflush ⇒ :enabled, ...

  Flush all active transactions associated with all the services in the service group whose state transitions from UP to DOWN.

• #graceful ⇒ Symbol^?

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

• #healthmonitor ⇒ Symbol^?

  Monitor the health of this service.

• #httpprofilename ⇒ Object^?

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

• #maxbandwidth ⇒ Object^?

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

• #maxclient ⇒ Object^?

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

• #maxreq ⇒ Object^?

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

• #memberport ⇒ Object^?

  Member port.

• #monitorbindings ⇒ Array<Hash>, ...

  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.

• #monthreshold ⇒ Object^?

  Minimum sum of weights of the monitors that are bound to this service.

• #netprofile ⇒ Object^?

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

• #pathmonitor ⇒ Object^?

  Path monitoring for clustering.

• #pathmonitorindv ⇒ Object^?

  Individual Path monitoring decisions.

• #rtspsessionidremap ⇒ Symbol^?

  Enable RTSP session ID mapping for the service group.

• #servicegroupname ⇒ String^?

  Name of the service group.

• #servicemembers ⇒ Array<Hash>, ...

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

• #servicetype ⇒ :HTTP, ...

  Protocol used to exchange data with the service.

• #sp ⇒ Symbol^?

  Enable surge protection for the service group.

• #svrtimeout ⇒ Object^?

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

• #tcpb ⇒ Symbol^?

  Enable TCP buffering for the service group.

• #tcpprofilename ⇒ Object^?

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

• #useproxyport ⇒ Symbol^?

  Use the proxy port as the source port when initiating connections with the server.

• #usip ⇒ Object^?

  Use client’s IP address as the source IP address when initiating connection to the server.

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

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

attribute :appflowlog

#autoscale ⇒ :DISABLED, ...

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

attribute :autoscale

#cacheable ⇒ Symbol^?

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

attribute :cacheable

#cachetype ⇒ :TRANSPARENT, ...

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

attribute :cachetype

#cip ⇒ :enabled, ...

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

attribute :cip

#cipheader ⇒ Object^?

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

attribute :cipheader

#cka ⇒ Symbol^?

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

attribute :cka

#clttimeout ⇒ Object^?

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

attribute :clttimeout

#cmp ⇒ Symbol^?

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

attribute :cmp

#comment ⇒ Object^?

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

attribute :comment

#disabled ⇒ Symbol^?

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

attribute :disabled

#downstateflush ⇒ :enabled, ...

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

attribute :downstateflush

#graceful ⇒ Symbol^?

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

attribute :graceful

#healthmonitor ⇒ Symbol^?

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

attribute :healthmonitor

#httpprofilename ⇒ Object^?

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

attribute :httpprofilename

#maxbandwidth ⇒ Object^?

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

attribute :maxbandwidth

#maxclient ⇒ Object^?

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

attribute :maxclient

#maxreq ⇒ Object^?

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

attribute :maxreq

#memberport ⇒ Object^?

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

attribute :memberport

#monitorbindings ⇒ Array<Hash>, ...

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

attribute :monitorbindings

#monthreshold ⇒ Object^?

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

attribute :monthreshold

#netprofile ⇒ Object^?

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

attribute :netprofile

#pathmonitor ⇒ Object^?

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

attribute :pathmonitor

#pathmonitorindv ⇒ Object^?

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

attribute :pathmonitorindv

#rtspsessionidremap ⇒ Symbol^?

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

attribute :rtspsessionidremap

#servicegroupname ⇒ String^?

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

attribute :servicegroupname

#servicemembers ⇒ Array<Hash>, ...

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

attribute :servicemembers

#servicetype ⇒ :HTTP, ...

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

attribute :servicetype

#sp ⇒ Symbol^?

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

attribute :sp

#svrtimeout ⇒ Object^?

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

attribute :svrtimeout

#tcpb ⇒ Symbol^?

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

attribute :tcpb

#tcpprofilename ⇒ Object^?

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

attribute :tcpprofilename

#useproxyport ⇒ Symbol^?

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

attribute :useproxyport

#usip ⇒ Object^?

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

attribute :usip