NetScaler Application Delivery Controller Plugin Reference
The Citrix NetScaler Application Delivery Controller plugin allows XL Deploy to manage deployments to application and web servers whose traffic is managed by a NetScaler load-balancing device.
This document provides information that is specific to this version of the NetScaler plugin. For general information about the plugin, refer to Introduction to the XL Deploy NetScaler plugin.
Requirements
- XL Deploy 5.0.0 or later
- XL Deploy Load Balancer plugin (provided with the NetScaler plugin distribution ZIP file)
- Plugins bundled with XL Deploy:
- XL Deploy Group Orchestrator plugin
- XL Deploy Web Server plugin
- NetScaler 8.1, 9.x, or 10.x
Important: Ensure that you download the plugin distribution ZIP file from the XebiaLabs Software Distribution site, as it includes the Load Balancer plugin.
Release notes
NetScaler plugin 6.0.0
XL Deploy 6.0.0 compatibility.
NetScaler plugin 5.0.1
Improvements
- [DEPL-8194] - Support parallel deployment orchestrators in the load balancer plugins
NetScaler plugin 5.0.0
XL Deploy 5.0.0 compatibility.
NetScaler plugin 4.5.0
XL Deploy 4.5.0 compatibility.
NetScaler plugin 4.0.0
XL Deploy 4.0.0 compatibility.
CI Reference
Configuration Item Overview
Deployables
| CI | Description |
|---|---|
| lb.LoadBalancerDeployable | The supertype of all Deployables |
Deployeds
| CI | Description |
|---|---|
| lb.DisableServerInLoadBalancer | The supertype of all Deployeds |
| lb.EnableServerInLoadBalancer | The supertype of all Deployeds |
| lb.LoadBalancerDeployed | The supertype of all Deployeds |
Containers
| CI | Description |
|---|---|
| lb.LoadBalancer | The Load Balancer super type |
| netscaler.NetScaler | A Citrix NetScaler LoadBalancer |
Other Configuration Items
| CI | Description |
|---|---|
| lb.DisableServerInLoadBalancer | The supertype of all Deployeds |
| lb.EnableServerInLoadBalancer | The supertype of all Deployeds |
| lb.LoadBalancer | The Load Balancer super type |
| lb.LoadBalancerDeployable | The supertype of all Deployables |
| lb.LoadBalancerDeployed | The supertype of all Deployeds |
| netscaler.NetScaler | A Citrix NetScaler LoadBalancer |
| netscaler.NetScalerParameters | Default implementation of a CI that provides ID, name and type information |
| netscaler.NetScalerScriptParameters | Default implementation of a CI that provides ID, name and type information |
Configuration Item Details
lb.DisableServerInLoadBalancer
| Type Hierarchy | lb.LoadBalancerDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem |
The supertype of all Deployeds.
| Parent | ||
|---|---|---|
|
|
|
container
:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public Properties | ||
|---|---|---|
|
|
|
deployable
:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
netscalerServiceGroup
:
STRING
|
|
The Service Group that contains the service to disable while this deployed is deploying.
|
||
|
|
|
netscalerServiceGroupName
:
STRING
|
|
The name of the service in the service group that needs to be disabled while this deployed is deploying.
|
||
|
|
|
netscalerServiceGroupPort
:
INTEGER
|
|
The port of the service in the service group that needs to be disabled while this deployed is deploying.
|
lb.EnableServerInLoadBalancer
| Type Hierarchy | lb.LoadBalancerDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem |
The supertype of all Deployeds.
| Parent | ||
|---|---|---|
|
|
|
container
:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public Properties | ||
|---|---|---|
|
|
|
deployable
:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
netscalerServiceGroup
:
STRING
|
|
The Service Group that contains the service to disable while this deployed is deploying.
|
||
|
|
|
netscalerServiceGroupName
:
STRING
|
|
The name of the service in the service group that needs to be disabled while this deployed is deploying.
|
||
|
|
|
netscalerServiceGroupPort
:
INTEGER
|
|
The port of the service in the service group that needs to be disabled while this deployed is deploying.
|
lb.LoadBalancer
| Virtual Type | |
|---|---|
| Type Hierarchy | udm.BaseContainer >> udm.BaseConfigurationItem |
| Interfaces | udm.Container, overthere.HostContainer, udm.ConfigurationItem, udm.Taggable |
The Load Balancer super type.
| Public Properties | ||
|---|---|---|
|
|
|
managedServers
:
SET_OF_CI<udm.Container>
|
|
The servers managed by this load balancer
|
| Hidden Properties | ||
|---|---|---|
|
|
|
disableInLoadBalancer
:
BOOLEAN
|
|
Whether this server should be disabled in the load balancer when it is being deployed to
|
||
|
|
|
netscalerAddress
:
STRING
|
|
The IP address or name this server is registered under in the NetScaler load balancer
|
||
|
|
|
netscalerShutdownDelay
:
INTEGER
|
|
The amount of seconds before the server is disabled in the NetScaler load balancer (A value of -1 triggers use of the defaultShutdownDelay of the NetScaler device)
|
||
|
|
|
netscalerType
:
STRING
= server
|
|
Whether this is a 'server' or a 'service' in the NetScaler load balancer
|
||
|
|
|
tags
:
SET_OF_STRING
|
|
If set, only deployables with the same tag will be automatically mapped to this container.
|
lb.LoadBalancerDeployable
| Type Hierarchy | udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.ConfigurationItem, udm.Taggable, udm.Deployable |
The supertype of all Deployables.
| Public Properties | ||
|---|---|---|
|
|
|
netscalerServiceGroup
:
STRING
= {{NETSCALER_SERVICE_GROUP}}
|
|
The Service Group that contains the service to disable while this deployed is deploying.
|
||
|
|
|
netscalerServiceGroupName
:
STRING
= {{NETSCALER_SERVICE_GROUP_NAME}}
|
|
The name of the service in the service group that needs to be disabled while this deployed is deploying.
|
||
|
|
|
netscalerServiceGroupPort
:
STRING
= {{NETSCALER_SERVICE_GROUP_PORT}}
|
|
The port of the service in the service group that needs to be disabled while this deployed is deploying.
|
||
|
|
|
tags
:
SET_OF_STRING
|
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
lb.LoadBalancerDeployed
| Virtual Type | |
|---|---|
| Type Hierarchy | udm.BaseDeployed >> udm.BaseConfigurationItem |
| Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem |
The supertype of all Deployeds.
| Parent | ||
|---|---|---|
|
|
|
container
:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public Properties | ||
|---|---|---|
|
|
|
deployable
:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
netscalerServiceGroup
:
STRING
|
|
The Service Group that contains the service to disable while this deployed is deploying.
|
||
|
|
|
netscalerServiceGroupName
:
STRING
|
|
The name of the service in the service group that needs to be disabled while this deployed is deploying.
|
||
|
|
|
netscalerServiceGroupPort
:
INTEGER
|
|
The port of the service in the service group that needs to be disabled while this deployed is deploying.
|
netscaler.NetScaler
| Type Hierarchy | lb.LoadBalancer >> udm.BaseContainer >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Container, overthere.HostContainer, udm.ConfigurationItem, udm.Taggable |
A Citrix NetScaler LoadBalancer
| Parent | ||
|---|---|---|
|
|
|
host
:
CI<overthere.Host>
|
|
Host
|
| Public Properties | ||
|---|---|---|
|
|
|
defaultShutdownDelay
:
INTEGER
= 0
|
|
The amount of seconds to wait before the servers are disabled in the load balancer
|
||
|
|
|
managedServers
:
SET_OF_CI<udm.Container>
|
|
The servers managed by this load balancer
|
| Hidden Properties | ||
|---|---|---|
|
|
|
disableServersOrder
:
INTEGER
= 8
|
|
Disable Servers Order
|
||
|
|
|
disableServersScript
:
STRING
= netscaler/disable-server.cli.ftl
|
|
Disable Servers Script
|
||
|
|
|
enableServersOrder
:
INTEGER
= 94
|
|
Enable Servers Order
|
||
|
|
|
enableServersScript
:
STRING
= netscaler/enable-server.cli.ftl
|
|
Enable Servers Script
|
||
|
|
|
runScript
:
STRING
= netscaler/run-script.cli.ftl
|
|
Run Script
|
||
|
|
|
sourceCommand
:
STRING
= source
|
|
Source Command
|
||
|
|
|
disableInLoadBalancer
:
BOOLEAN
|
|
Whether this server should be disabled in the load balancer when it is being deployed to
|
||
|
|
|
netscalerAddress
:
STRING
|
|
The IP address or name this server is registered under in the NetScaler load balancer
|
||
|
|
|
netscalerShutdownDelay
:
INTEGER
|
|
The amount of seconds before the server is disabled in the NetScaler load balancer (A value of -1 triggers use of the defaultShutdownDelay of the NetScaler device)
|
||
|
|
|
netscalerType
:
STRING
= server
|
|
Whether this is a 'server' or a 'service' in the NetScaler load balancer
|
||
|
|
|
tags
:
SET_OF_STRING
|
|
If set, only deployables with the same tag will be automatically mapped to this container.
|
| Control task | Parameter CI | Attributes | Description |
|---|---|---|---|
| disableService | netscaler.NetScalerParameters |
no description |
|
| enableService | netscaler.NetScalerParameters |
no description |
|
| runScript | netscaler.NetScalerScriptParameters |
no description |
netscaler.NetScalerParameters
| Type Hierarchy | udm.Parameters >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.ConfigurationItem |
Default implementation of a CI that provides ID, name and type information.
| Public Properties | ||
|---|---|---|
|
|
|
serviceGroup
:
STRING
|
|
NetScaler service group
|
||
|
|
|
serviceGroupName
:
STRING
|
|
NetScaler service name
|
||
|
|
|
serviceGroupPort
:
INTEGER
= 0
|
|
NetScaler service port
|
netscaler.NetScalerScriptParameters
| Type Hierarchy | udm.Parameters >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.ConfigurationItem |
Default implementation of a CI that provides ID, name and type information.
| Public Properties | ||
|---|---|---|
|
|
|
netScalerScript
:
STRING
|
|
Script to execute on the NetScaler device
|