Class: Ansible::Ruby::Modules::Netscaler_service

Inherits:

Base

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

Defined in:

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

Overview

Manage service configuration in Netscaler. This module allows the creation, deletion and modification of Netscaler services. This module is intended to run either on the ansible control node or a bastion (jumpserver) with access to the actual netscaler instance. This module supports check mode.

Instance Method Summary

• #accessdown ⇒ Boolean^?

  Use Layer 2 mode to bridge the packets sent to this service if it is marked as DOWN.

• #appflowlog ⇒ :enabled, ...

  Enable logging of AppFlow information.

• #cacheable ⇒ Boolean^?

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

• #cachetype ⇒ :TRANSPARENT, ...

  Cache type supported by the cache server.

• #cip ⇒ :enabled, ...

  Before forwarding a request to the service, insert an HTTP header with the client’s IPv4 or IPv6 address as its value.

• #cipheader ⇒ Object^?

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

• #cka ⇒ Object^?

  Enable client keep-alive for the service.

• #cleartextport ⇒ Object^?

  Port to which clear text data must be sent after the appliance decrypts incoming SSL traffic.

• #clttimeout ⇒ Object^?

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

• #cmp ⇒ Object^?

  Enable compression for the service.

• #comment ⇒ Object^?

  Any information about the service.

• #customserverid ⇒ Object^?

  Unique identifier for the service.

• #disabled ⇒ Symbol^?

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

• #dnsprofilename ⇒ Object^?

  Name of the DNS profile to be associated with the service.

• #downstateflush ⇒ :enabled, ...

  Flush all active transactions associated with a service whose state transitions from UP to DOWN.

• #graceful ⇒ Boolean^?

  Shut down gracefully, not accepting any new connections, and disabling the service when all of its connections are closed.

• #hashid ⇒ Object^?

  A numerical identifier that can be used by hash based load balancing methods.

• #healthmonitor ⇒ Boolean^?

  Monitor the health of this service.

• #httpprofilename ⇒ Object^?

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

• #ip ⇒ Object^?

  IP to assign to the service.,Minimum length = 1.

• #ipaddress ⇒ String^?

  The new IP address of the service.

• #maxbandwidth ⇒ Object^?

  Maximum bandwidth, in Kbps, allocated to the service.,Minimum value = 0,Maximum value = 4294967287.

• #maxclient ⇒ Object^?

  Maximum number of simultaneous open connections to the service.,Minimum value = 0,Maximum value = 4294967294.

• #maxreq ⇒ Object^?

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

• #monitor_bindings ⇒ Array<String>, ...

  A list of load balancing monitors to bind to this service.,Each monitor entry is a dictionary which may contain the following options.,Note that if not using the built in monitors they must first be setup.

• #monthreshold ⇒ Object^?

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

• #name ⇒ String^?

  Name for the service.

• #netprofile ⇒ Object^?

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

• #pathmonitor ⇒ Object^?

  Path monitoring for clustering.

• #pathmonitorindv ⇒ Object^?

  Individual Path monitoring decisions.

• #port ⇒ Integer^?

  Port number of the service.,Range 1 - 65535,* in CLI is represented as 65535 in NITRO API.

• #processlocal ⇒ :enabled, ...

  By turning on this option packets destined to a service in a cluster will not under go any steering.

• #rtspsessionidremap ⇒ Boolean^?

  Enable RTSP session ID mapping for the service.

• #serverid ⇒ Object^?

  The identifier for the service.

• #servername ⇒ Object^?

  Name of the server that hosts the service.,Minimum length = 1.

• #servicetype ⇒ :HTTP, ...

  Protocol in which data is exchanged with the service.

• #sp ⇒ Object^?

  Enable surge protection for the service.

• #svrtimeout ⇒ Object^?

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

• #tcpb ⇒ Object^?

  Enable TCP buffering for the service.

• #tcpprofilename ⇒ Object^?

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

• #td ⇒ Object^?

  Integer value that uniquely identifies the traffic domain in which you want to configure the entity.

• #useproxyport ⇒ Object^?

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

• #usip ⇒ Object^?

  Use the client’s IP address as the source IP address when initiating a 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

#accessdown ⇒ Boolean^?

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

attribute :accessdown

#appflowlog ⇒ :enabled, ...

# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_service.rb', line 127

attribute :appflowlog

#cacheable ⇒ Boolean^?

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

attribute :cacheable

#cachetype ⇒ :TRANSPARENT, ...

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

attribute :cachetype

#cip ⇒ :enabled, ...

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

attribute :cip

#cipheader ⇒ Object^?

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

attribute :cipheader

#cka ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_service.rb', line 92

attribute :cka

#cleartextport ⇒ Object^?

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

attribute :cleartextport

#clttimeout ⇒ Object^?

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

attribute :clttimeout

#cmp ⇒ Object^?

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

attribute :cmp

#comment ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_service.rb', line 124

attribute :comment

#customserverid ⇒ Object^?

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

attribute :customserverid

#disabled ⇒ Symbol^?

# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_service.rb', line 156

attribute :disabled

#dnsprofilename ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_service.rb', line 141

attribute :dnsprofilename

#downstateflush ⇒ :enabled, ...

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

attribute :downstateflush

#graceful ⇒ Boolean^?

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

attribute :graceful

#hashid ⇒ Object^?

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

attribute :hashid

#healthmonitor ⇒ Boolean^?

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

attribute :healthmonitor

#httpprofilename ⇒ Object^?

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

attribute :httpprofilename

#ip ⇒ Object^?

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

attribute :ip

#ipaddress ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_service.rb', line 144

attribute :ipaddress

#maxbandwidth ⇒ Object^?

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

attribute :maxbandwidth

#maxclient ⇒ Object^?

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

attribute :maxclient

#maxreq ⇒ Object^?

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

attribute :maxreq

#monitor_bindings ⇒ Array<String>, ...

# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_service.rb', line 152

attribute :monitor_bindings

#monthreshold ⇒ Object^?

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

attribute :monthreshold

#name ⇒ String^?

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

attribute :name

#netprofile ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_service.rb', line 131

attribute :netprofile

#pathmonitor ⇒ Object^?

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

attribute :pathmonitor

#pathmonitorindv ⇒ Object^?

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

attribute :pathmonitorindv

#port ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_service.rb', line 29

attribute :port

#processlocal ⇒ :enabled, ...

# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_service.rb', line 137

attribute :processlocal

#rtspsessionidremap ⇒ Boolean^?

# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_service.rb', line 76

attribute :rtspsessionidremap

#serverid ⇒ Object^?

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

attribute :serverid

#servername ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_service.rb', line 22

attribute :servername

#servicetype ⇒ :HTTP, ...

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

attribute :servicetype

#sp ⇒ Object^?

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

attribute :sp

#svrtimeout ⇒ Object^?

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

attribute :svrtimeout

#tcpb ⇒ Object^?

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

attribute :tcpb

#tcpprofilename ⇒ Object^?

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

attribute :tcpprofilename

#td ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_service.rb', line 134

attribute :td

#useproxyport ⇒ Object^?

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

attribute :useproxyport

#usip ⇒ Object^?

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

attribute :usip