Skip to content

Latest commit

 

History

History
385 lines (270 loc) · 24.5 KB

netscaler_module_docs.md

File metadata and controls

385 lines (270 loc) · 24.5 KB

Citrix Netscaler Modules

Requirements

  • Python requests
  • Everything tested was with Netscaler version 11.x

Modules

netscaler_lbvserver

Manages LB VServer resources and attributes.

  • Synopsis
  • Options
  • Examples

Synopsis

Manages Netscaler LB VServer configurations using Nitro API.

Options

Parameter required default choices comments
comment no A comment about the lbvserver
lbvserver_port no The port the lbvserver will listen on. Valid protocol port ranges and "*" are supported.
use_ssl no True Determines whether to use HTTPS(True) or HTTP(False).
port no The TCP port used to connect to the Netscaler if other than the default used by the transport method(http=80, https=443).
state no present
  • absent
  • present
 The desired state of the specified object. Absent will delete resource. Present will create resource.
provider no Dictionary which acts as a collection of arguments used to define the characteristics of how to connect to the device. Arguments hostname, username, and password must be specified in either provider or local param. Local params take precedence, e.g. hostname is preferred to provider["hostname"] when both are specefied.
service_type no
  • HTTP
  • FTP
  • TCP
  • UDP
  • SSL
  • SSL_BRIDGE
  • SSL_TCP
  • DTLS
  • NNTP
  • DNS
  • DHCPRA
  • ANY
  • SIP_UDP
  • SIP_TCP
  • SIP_SSL
  • DNS_TCP
  • RTSP
  • PUSH
  • SSL_PUSH
  • RADIUS
  • RDP
  • MYSQL
  • MSSQL
  • DIAMETER
  • SSL_DIAMETER
  • TFTP
  • ORACLE
  • SMPP
  • SYSLOGTCP
  • SYSLOGUDP
  • FIX
 The type of service the lbvserver provides.
conn_failover no
  • DISABLED
  • STATEFUL
  • STATELESS
 The lbvserver connection setting
lbmethod no
  • ROUNDROBIN
  • LEASTCONNECTION
  • LEASTRESPONSETIME
  • URLHASH
  • DOMAINHASH
  • DESTINATIONIPHASH
  • SOURCEIPHASH
  • SRCIPDESTIPHASH
  • LEASTBANDWIDTH
  • LEASTPACKETS
  • TOKEN
  • SRCIPSRCPORTHASH
  • LRTM
  • CALLIDHASH
  • CUSTOMLOAD
  • LEASTREQUEST
  • AUDITLOGHASH
  • STATICPROXIMITY
 The method to load balance traffic.
persistence no
  • SOURCEIP
  • COOKIEINSERT
  • SSLSESSION
  • RULE
  • URLPASSIVE
  • CUSTOMSERVERID
  • DESTIP
  • SRCIPDESTIP
  • CALLID
  • RTSPSID
  • DIAMETER
  • FIXSESSION
  • NONE
 The persistence type used by the lbvserver.
client_timeout no Seconds to wait before terminating a client session. Valid inputs are from 0 to 31536000.
username yes The username used to authenticate with the Netscaler.
cookie_name no The name of the cookie to use. Used with a COOKIE persistence type.
lbvserver_state no enabled
  • disabled
  • enabled
 The resources desired activity. Disabled marks it out of service. Enabled marks it serviceable.
host yes The Netscaler's Address.
password no The password associated with the username account.
ip_address no The IP address of the Server Object.
backup_lbvserver no The name of the backup lbvserver
traffic_domain no 0 The traffic domain associated with the servicegroup
partition no The Netscaler's partition if not the "default" partition.
lbvserver_name yes The name of the lbvserver object
validate_certs no False Determines whether to validate certs against a trusted certificate file (True), or accept all certs (False)

netscaler_monitor

Manages Monitor resources and attributes

  • Synopsis
  • Options
  • Examples

Synopsis

Manages Netscaler Monitor configurations using Nitro API

Options

Parameter required default choices comments
monitor_secondary_password no A secondary password to authenticate with the monitored service
use_ssl no True Determines whether to use HTTPS(True) or HTTP(False).
monitor_name yes The name of the monitor
port no The TCP port used to connect to the Netscaler if other than the default used by the transport method(http=80, https=443).
response_code_action no add
  • add
  • remove
 The action to take for response code items that differ from existing response codes. add will add any missing values to the existing response codes. remove will remove any matching values to the existing response codes.
state no present
  • absent
  • present
 The desired state of the specified object. Absent will delete resource. Present will create resource.
monitor_use_ssl no
  • YES
  • NO
 Specifies to use SSL for the monitor
provider no Dictionary which acts as a collection of arguments used to define the characteristics of how to connect to the device. Arguments hostname, username, and password must be specified in either provider or local param. Local params take precedence, e.g. hostname is preferred to provider["hostname"] when both are specefied.
username yes The username used to authenticate with the Netscaler.
http_request no The request to send to the server
monitor_dest_ip no The IP address to monitor.
monitor_dest_port no The port to monitor on the server
monitor_state no enabled
  • disabled
  • enabled
 The resources desired activity. Disabled marks it out of service. Enabled marks it serviceable.
monitor_password no The password used to authenticate with the monitored service.
host yes The Netscaler's Address.
custom_headers no Custom headers to add to the monitor request
password no The password associated with the username account.
response_code no The HTTP response code expected back from the monitored resource.
partition no The Netscaler's partition if not the "default" partition.
monitor_username no The username used to authenticate with the monitored service.
validate_certs no False Determines whether to validate certs against a trusted certificate file (True), or accept all certs (False)
monitor_type no
  • PING
  • TCP
  • HTTP
  • TCP-ECV
  • HTTP-ECV
  • UDP-ECV
  • DNS
  • FTP
  • LDNS-PING
  • LDNS-TCP
  • LDNS-DNS
  • RADIUS
  • USER
  • HTTP-INLINE
  • SIP-UDP
  • SIP-TCP
  • LOAD
  • FTP-EXTENDED
  • SMTP
  • SNMP
  • NNTP
  • MYSQL
  • MYSQL-ECV
  • MSSQL-ECV
  • ORACLE-ECV
  • LDAP
  • POP3
  • CITRIX-XML-SERVICE
  • CITRIX-WEB-INTERFACE
  • DNS-TCP
  • RTSP
  • ARP
  • CITRIX-AG
  • CITRIX-AAC-LOGINPAGE
  • CITRIX-AAC-LAS
  • CITRIX-XD-DDC
  • ND6
  • CITRIX-WI-EXTENDED
  • DIAMETER
  • RADIUS_ACCOUNTING
  • STOREFRONT
  • APPC
  • SMPP
  • CITRIX-XNC-ECV
  • CITRIX-XDM
 The type of service to monitor

netscaler_lbvserver_certkey

Manages lbvserver to cert key bindings

  • Synopsis
  • Options
  • Examples

Synopsis

Manages Netscaler lbvserver to cert key binding configurations using Nitro API

Options

Parameter required default choices comments
username yes The username used to authenticate with the Netscaler.
vserver_name yes The name of the vserver to bind the cert key to.
ocsp_check no
  • Mandatory
  • Optional
 The state of the OCSP check parameter.
skip_ca_name no
  • true
  • false
 Used to indicate whether CA Name needs to be sent to the SSL client during the SSL handshake.
ca_cert no
  • true
  • false
 Specifies if the certificate is a CA.
partition no The Netscaler's partition if not the "default" partition.
state no present
  • absent
  • present
 The desired state of the specified object. Absent will delete resource. Present will create resource.
crl_check
  • Mandatory
  • Optional
 The state of the CRL check parameter.
sni_cert
  • true
  • false
 Specifies if SNI processing is in use.
host yes The Netscaler's Address.
cert_key_name yes The name of the cert key to bind to the lbvserver.
provider no Dictionary which acts as a collection of arguments used to define the characteristics of how to connect to the device. Arguments hostname, username, and password must be specified in either provider or local param. Local params take precedence, e.g. hostname is preferred to provider["hostname"] when both are specefied.
use_ssl no True Determines whether to use HTTPS(True) or HTTP(False).
password no The password associated with the username account.
validate_certs no False Determines whether to validate certs against a trusted certificate file (True), or accept all certs (False)
port no The TCP port used to connect to the Netscaler if other than the default used by the transport method(http=80, https=443).

netscaler_servicegroup_server

Manages service group to server bindings.

  • Synopsis
  • Options
  • Examples

Synopsis

Manages Netscaler service group to server binding configurations using Nitro API.

Options

Parameter required default choices comments
username yes The username used to authenticate with the Netscaler.
servicegroup_name yes The service group name which the server is being bound to.
server_name yes The server name which is being bound to a service group.
partition no The Netscaler's partition if not the "default" partition.
host yes The Netscaler's Address.
weight no The weight to assing the servers in the Service Group.
state no present
  • absent
  • present
 The desired state of the specified object. Absent will delete resource. Present will create resource.
server_port yes The port the server is listening on to offer services.
provider no Dictionary which acts as a collection of arguments used to define the characteristics of how to connect to the device. Arguments hostname, username, and password must be specified in either provider or local param. Local params take precedence, e.g. hostname is preferred to provider["hostname"] when both are specefied.
use_ssl no True Determines whether to use HTTPS(True) or HTTP(False).
password no The password associated with the username account.
validate_certs no False Determines whether to validate certs against a trusted certificate file (True), or accept all certs (False)
port no The TCP port used to connect to the Netscaler if other than the default used by the transport method(http=80, https=443).

netscaler_lbvserver_servicegroup

Manages lbvserver to service group bindings.

  • Synopsis
  • Options
  • Examples

Synopsis

Manages Netscaler lbvserver to service group binding configurations using Nitro API.

Options

Parameter required default choices comments
username yes The username used to authenticate with the Netscaler.
servicegroup_name yes The service group name which the lbvserver is being bound to.
partition no The Netscaler's partition if not the "default" partition.
host yes The Netscaler's Address.
lbvserver_name yes The lbvserver name which is being bound to a service group.
state no present
  • absent
  • present
 The desired state of the specified object. Absent will delete resource. Present will create resource.
provider no Dictionary which acts as a collection of arguments used to define the characteristics of how to connect to the device. Arguments hostname, username, and password must be specified in either provider or local param. Local params take precedence, e.g. hostname is preferred to provider["hostname"] when both are specefied.
use_ssl no True Determines whether to use HTTPS(True) or HTTP(False).
password no The password associated with the username account.
validate_certs no False Determines whether to validate certs against a trusted certificate file (True), or accept all certs (False)
port no The TCP port used to connect to the Netscaler if other than the default used by the transport method(http=80, https=443).

netscaler_servicegroup_monitor

Manages service group to monitor bindings.

  • Synopsis
  • Options
  • Examples

Synopsis

Manages Netscaler service group to monitor binding configurations using Nitro API.

Options

Parameter required default choices comments
username yes The username used to authenticate with the Netscaler.
servicegroup_name yes The service group name which the server is being bound to.
weight no The weight to assing the servers in the Service Group.
monitor_name yes The monitor name which is being bound to a service group.
partition no The Netscaler's partition if not the "default" partition.
host yes The Netscaler's Address.
state no present
  • absent
  • present
 The desired state of the specified object. Absent will delete resource. Present will create resource.
provider no Dictionary which acts as a collection of arguments used to define the characteristics of how to connect to the device. Arguments hostname, username, and password must be specified in either provider or local param. Local params take precedence, e.g. hostname is preferred to provider["hostname"] when both are specefied.
use_ssl no True Determines whether to use HTTPS(True) or HTTP(False).
password no The password associated with the username account.
validate_certs no False Determines whether to validate certs against a trusted certificate file (True), or accept all certs (False)
port no The TCP port used to connect to the Netscaler if other than the default used by the transport method(http=80, https=443).

netscaler_facts

Gathers Netscaler Facts

  • Synopsis
  • Options
  • Examples

Synopsis

Gathers System, Hardware, and Configuration Facts for Netscaler Nitro API

Options

Parameter required default choices comments
username yes The username used to authenticate with the Netscaler.
partition no The Netscaler's partition if not the "default" partition.
config_scope no false
  • true
  • false
 The configuration scope to retrieve; used when gathering "config" fact. setting to "true" will include default configuration values.
host yes The Netscaler's Address.
gather_subset no [u'all']
  • all
  • hardware_data
  • interface_data
  • lbvserver_stats
  • config
  • server_config
  • service_group_config
  • lbvserver_config
  • monitor_config
  • !all
  • !hardware_data
  • !interface_data
  • !lbvserver_stats
  • !config
  • !server_config
  • !service_group_config
  • !lbvserver_config
  • !monitor_config
 The list of facts to gather. Gathered facts are limited using either an include list, or using an exclude list ("!...").
provider no Dictionary which acts as a collection of arguments used to define the characteristics of how to connect to the device. Arguments hostname, username, and password must be specified in either provider or local param. Local params take precedence, e.g. hostname is preferred to provider["hostname"] when both are specefied.
use_ssl no True Determines whether to use HTTPS(True) or HTTP(False).
password no The password associated with the username account.
validate_certs no False Determines whether to validate certs against a trusted certificate file (True), or accept all certs (False)
port no The TCP port used to connect to the Netscaler if other than the default used by the transport method(http=80, https=443).

netscaler_server

Manages Server resources and attributes

  • Synopsis
  • Options
  • Examples

Synopsis

Manages Netscaler Server configurations using Nitro API

Options

Parameter required default choices comments
username yes The username used to authenticate with the Netscaler.
comment no A comment to add to the object.
server_name no The name of the Server Object.
server_state no enabled
  • disabled
  • enabled
 The server's desired activity. Disabled marks it out of service. Enabled marks it serviceable.
traffic_domain no 0 The traffic domain the server should belong to.
partition no The Netscaler's partition if not the "default" partition.
host yes The Netscaler's Address.
validate_certs no False Determines whether to validate certs against a trusted certificate file (True), or accept all certs (False)
state no present
  • absent
  • present
 The desired state of the specified object. Absent will delete resource. Present will create resource.
provider no Dictionary which acts as a collection of arguments used to define the characteristics of how to connect to the device. Arguments hostname, username, and password must be specified in either provider or local param. Local params take precedence, e.g. hostname is preferred to provider["hostname"] when both are specefied.
use_ssl no True Determines whether to use HTTPS(True) or HTTP(False).
password no The password associated with the username account.
ip_address no The IP address of the Server Object.
port no The TCP port used to connect to the Netscaler if other than the default used by the transport method(http=80, https=443).

netscaler_save_config

Saves the running configuration to the Netscaler.

  • Synopsis
  • Options
  • Examples

Synopsis

Saves the running configuration to the Netscaler for the specified partition.

Options

Parameter required default choices comments

netscaler_servicegroup

Manages Service Group resources and attributes

  • Synopsis
  • Options
  • Examples

Synopsis

Manages Netscaler Service Group configurations using Nitro API

Options

Parameter required default choices comments
username yes The username used to authenticate with the Netscaler.
comment no A comment about the servicegroup.
servicegroup_state no enabled
  • disabled
  • enabled
 The servicegroup's desired activity. Disabled marks it out of service. Enabled marks it serviceable.
server_timeout no Seconds to wait before terminating a server session. Valid inputs are from 0 to 31536000
servicegroup_name yes The name of the servicegroup object
max_client no maximum number of simultaneous open connections Valid inputs are from 0 to 65535
traffic_domain no 0 The traffic domain associated with the servicegroup
partition no The Netscaler's partition if not the "default" partition.
state no present
  • absent
  • present
 The desired state of the specified object. Absent will delete resource. Present will create resource.
host yes The Netscaler's Address.
max_req no maximum number of simultaneous open connections Valid inputs are from 0 to 65535
provider no Dictionary which acts as a collection of arguments used to define the characteristics of how to connect to the device. Arguments hostname, username, and password must be specified in either provider or local param. Local params take precedence, e.g. hostname is preferred to provider["hostname"] when both are specefied.
service_type no
  • 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
 The type of service associated with the bound vservers. must be included for new servicegroup objects.
use_ssl no True Determines whether to use HTTPS(True) or HTTP(False).
password no The password associated with the username account.
validate_certs no False Determines whether to validate certs against a trusted certificate file (True), or accept all certs (False)
port no The TCP port used to connect to the Netscaler if other than the default used by the transport method(http=80, https=443).
client_timeout no Seconds to wait before terminating a client session. Valid inputs are from 0 to 31536000.

Created by Network to Code, LLC For: 2015