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

Inherits:
Base show all
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 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

#accessdown ⇒ Boolean?

Returns Use Layer 2 mode to bridge the packets sent to this service if it is marked as DOWN. If the service is DOWN, and this parameter is disabled, the packets are dropped.

Returns:

  • (Boolean, nil) —

    Use Layer 2 mode to bridge the packets sent to this service if it is marked as DOWN. If the service is DOWN, and this parameter is disabled, the packets are dropped.



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

attribute :accessdown

#appflowlog ⇒ :enabled, ...

Returns Enable logging of AppFlow information.

Returns:

  • (:enabled, :disabled, nil) —

    Enable logging of AppFlow information.



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

attribute :appflowlog

#cacheable ⇒ Boolean?

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

Returns:

  • (Boolean, nil) —

    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.



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

attribute :cacheable

#cachetype ⇒ :TRANSPARENT, ...

Returns Cache type supported by the cache server.

Returns:

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

    Cache type supported by the cache server.



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

attribute :cachetype

#cip ⇒ :enabled, ...

Returns Before forwarding a request to the service, insert an HTTP header with the client’s IPv4 or IPv6 address as its value. Used if the server needs the client’s IP address for security, accounting, or other purposes, and setting the Use Source IP parameter is not a viable option.

Returns:

  • (:enabled, :disabled, nil) —

    Before forwarding a request to the service, insert an HTTP header with the client’s IPv4 or IPv6 address as its value. Used if the server needs the client’s IP address for security, accounting, or other purposes, and setting the Use Source IP parameter is not a viable option.



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

attribute :cip

#cipheader ⇒ Object?

Returns Name for the HTTP header whose value must be set to the IP address of the client. Used with the Client IP parameter. If you set the Client IP parameter, and you do not specify a name for the header, the appliance uses the header name specified for the global Client IP Header parameter (the cipHeader parameter in the set ns param CLI command or the Client IP Header parameter in the Configure HTTP Parameters dialog box at System > Settings > Change HTTP parameters). If the global Client IP Header parameter is not specified, the appliance inserts a header with the name “client-ip.”.,Minimum length = 1.

Returns:

  • (Object, nil) —

    Name for the HTTP header whose value must be set to the IP address of the client. Used with the Client IP parameter. If you set the Client IP parameter, and you do not specify a name for the header, the appliance uses the header name specified for the global Client IP Header parameter (the cipHeader parameter in the set ns param CLI command or the Client IP Header parameter in the Configure HTTP Parameters dialog box at System > Settings > Change HTTP parameters). If the global Client IP Header parameter is not specified, the appliance inserts a header with the name “client-ip.”.,Minimum length = 1



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

attribute :cipheader

#cka ⇒ Object?

Returns Enable client keep-alive for the service.

Returns:

  • (Object, nil) —

    Enable client keep-alive for the service.



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

attribute :cka

#cleartextport ⇒ Object?

Returns Port to which clear text data must be sent after the appliance decrypts incoming SSL traffic. Applicable to transparent SSL services.,Minimum value = 1.

Returns:

  • (Object, nil) —

    Port to which clear text data must be sent after the appliance decrypts incoming SSL traffic. Applicable to transparent SSL services.,Minimum value = 1



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

attribute :cleartextport

#clttimeout ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :clttimeout

#cmp ⇒ Object?

Returns Enable compression for the service.

Returns:

  • (Object, nil) —

    Enable compression for the service.



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

attribute :cmp

#comment ⇒ Object?

Returns Any information about the service.

Returns:

  • (Object, nil) —

    Any information about the service.



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

attribute :comment

#customserverid ⇒ Object?

Returns Unique identifier for the service. Used when the persistency type for the virtual server is set to Custom Server ID.

Returns:

  • (Object, nil) —

    Unique identifier for the service. Used when the persistency type for the virtual server is set to Custom Server ID.



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

attribute :customserverid

#disabled ⇒ Symbol?

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

Returns:

  • (Symbol, nil) —

    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.



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

attribute :disabled

#dnsprofilename ⇒ Object?

Returns Name of the DNS profile to be associated with the service. DNS profile properties will applied to the transactions processed by a service. This parameter is valid only for ADNS and ADNS-TCP services.,Minimum length = 1,Maximum length = 127.

Returns:

  • (Object, nil) —

    Name of the DNS profile to be associated with the service. DNS profile properties will applied to the transactions processed by a service. This parameter is valid only for ADNS and ADNS-TCP services.,Minimum length = 1,Maximum length = 127



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

attribute :dnsprofilename

#downstateflush ⇒ :enabled, ...

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



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

attribute :downstateflush

#graceful ⇒ Boolean?

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

Returns:

  • (Boolean, nil) —

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



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

attribute :graceful

#hashid ⇒ Object?

Returns A numerical identifier that can be used by hash based load balancing methods. Must be unique for each service.,Minimum value = 1.

Returns:

  • (Object, nil) —

    A numerical identifier that can be used by hash based load balancing methods. Must be unique for each service.,Minimum value = 1



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

attribute :hashid

#healthmonitor ⇒ Boolean?

Returns Monitor the health of this service.

Returns:

  • (Boolean, nil) —

    Monitor the health of this service



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

attribute :healthmonitor

#httpprofilename ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :httpprofilename

#ip ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :ip

#ipaddress ⇒ String?

Returns The new IP address of the service.

Returns:

  • (String, nil) —

    The new IP address of the service.



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

attribute :ipaddress

#maxbandwidth ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :maxbandwidth

#maxclient ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :maxclient

#maxreq ⇒ Object?

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

Returns:

  • (Object, nil) —

    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



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

attribute :maxreq

#monitor_bindings ⇒ Array<String>, ...

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

Returns:

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

    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.



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

attribute :monitor_bindings

#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 = 0,Maximum value = 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 = 0,Maximum value = 65535



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

attribute :monthreshold

#name ⇒ String?

Returns Name for the service. 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. Cannot be changed after the service has been created.,Minimum length = 1.

Returns:

  • (String, nil) —

    Name for the service. 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. Cannot be changed after the service has been created.,Minimum length = 1



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

attribute :name

#netprofile ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :netprofile

#pathmonitor ⇒ Object?

Returns Path monitoring for clustering.

Returns:

  • (Object, nil) —

    Path monitoring for clustering.



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

attribute :pathmonitor

#pathmonitorindv ⇒ Object?

Returns Individual Path monitoring decisions.

Returns:

  • (Object, nil) —

    Individual Path monitoring decisions.



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

attribute :pathmonitorindv

#port ⇒ Integer?

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

Returns:

  • (Integer, nil) —

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



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

attribute :port

#processlocal ⇒ :enabled, ...

Returns By turning on this option packets destined to a service in a cluster will not under go any steering. Turn this option for single packet request response mode or when the upstream device is performing a proper RSS for connection based distribution.

Returns:

  • (:enabled, :disabled, nil) —

    By turning on this option packets destined to a service in a cluster will not under go any steering. Turn this option for single packet request response mode or when the upstream device is performing a proper RSS for connection based distribution.



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

attribute :processlocal

#rtspsessionidremap ⇒ Boolean?

Returns Enable RTSP session ID mapping for the service.

Returns:

  • (Boolean, nil) —

    Enable RTSP session ID mapping for the service.



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

attribute :rtspsessionidremap

#serverid ⇒ Object?

Returns The identifier for the service. This is used when the persistency type is set to Custom Server ID.

Returns:

  • (Object, nil) —

    The identifier for the service. This is used when the persistency type is set to Custom Server ID.



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

attribute :serverid

#servername ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :servername

#servicetype ⇒ :HTTP, ...

Returns Protocol in which data is exchanged 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 in which data is exchanged with the service.



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

attribute :servicetype

#sp ⇒ Object?

Returns Enable surge protection for the service.

Returns:

  • (Object, nil) —

    Enable surge protection for the service.



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

attribute :sp

#svrtimeout ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :svrtimeout

#tcpb ⇒ Object?

Returns Enable TCP buffering for the service.

Returns:

  • (Object, nil) —

    Enable TCP buffering for the service.



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

attribute :tcpb

#tcpprofilename ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :tcpprofilename

#td ⇒ Object?

Returns Integer value that uniquely identifies the traffic domain in which you want to configure the entity. If you do not specify an ID, the entity becomes part of the default traffic domain, which has an ID of 0.,Minimum value = 0,Maximum value = 4094.

Returns:

  • (Object, nil) —

    Integer value that uniquely identifies the traffic domain in which you want to configure the entity. If you do not specify an ID, the entity becomes part of the default traffic domain, which has an ID of 0.,Minimum value = 0,Maximum value = 4094



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

attribute :td

#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 (USIP) parameter is set to 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 (USIP) parameter is set to YES.



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

attribute :useproxyport

#usip ⇒ Object?

Returns Use the client’s IP address as the source IP address when initiating a connection to the server. When creating a service, if you do not set this parameter, the service inherits the global Use Source IP setting (available in the enable ns mode and disable ns mode CLI commands, or in the System > Settings > Configure modes > Configure Modes dialog box). However, you can override this setting after you create the service.

Returns:

  • (Object, nil) —

    Use the client’s IP address as the source IP address when initiating a connection to the server. When creating a service, if you do not set this parameter, the service inherits the global Use Source IP setting (available in the enable ns mode and disable ns mode CLI commands, or in the System > Settings > Configure modes > Configure Modes dialog box). However, you can override this setting after you create the service.



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

attribute :usip