Home > Configuration > Basic

Use this method to creates a custom location entry on the NetScaler. Custom locations can be used instead of a static location database if the number of locations you need does not exceed 500. Custom locations can also be used to override incorrect entries in the static database, because the appliance searches the static database before it searches the static location database.

Use this method to loads the static location database from the specified file.

Use this method to loads the IPv6 static location database from the specified file.

Use this method to add a radiusnode and its secret key configuration on NS

Use this method to creates a server entry on the NetScaler. The NetScaler appliance supports two types of servers: IP address based servers and domain based servers.

Use this method to creates a service on the NetScaler. If the service is domain based, before you create the service, create the server entry by using the add server method. Then, in this method, specify the Server parameter.

Use this method to creates a service group. You can group similar services into a service group and use them as a single entity.

Name of the monitor to bind to the service.

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

Specify the TTL for DNS record for domain based service.The default value of ttl is 0 which indicates to use the TTL received in DNS response for monitors

Unique numerical identifier used by hash based load balancing methods to identify a service.

IP address of the server that hosts the service. Mutually exclusive with the Server Name parameter.

The name of the service or a service group to which the monitor is to be bound.

Specify the nameserver to which the query for bound domain needs to be sent. If not specified, use the global nameserver

Order number to be assigned to the servicegroup member

Port number of the service. Each service must have a unique port number.

The identifier for the service. This is used when the persistency type is set to Custom Server ID.
NOTE: This attribute is deprecated.
Instead of integer now serverId will be a string and you can use -customserverid instead of -serverID.

Name of the server that hosts the service. Mutually exclusive with the IP address parameter.

Initial state of the service after binding.

Use this method to clears all location information, including custom and static database entries.

Use this method to disables all services on the server. When a server is disabled, all services on the server are disabled.

Use this method to disables a service.

Use this method to disables a service group or a member of a service group. To disable a service group, provide only the service group name. To disable only a member of a service group, in addition to the service group name, provide the name of the server that hosts the service, and the port number of the service.

Use this method to use this method to disable (take out of service) a virtual server.
NOTE: This method is deprecated.
This method is deprecated in 10.0, instead you can use methods such as disable lb vserver

Use this method to dump records from trace buffers to file.

Use this method to enables all services on the specified server.

Use this method to enables a service.

Use this method to enables a service group or a member of the service group.

Use this method to use this method to enable a virtual server.
Note: Virtual servers, when added, are enabled by default.
NOTE: This method is deprecated.
This method is deprecated in 10.0, instead you can use methods such as enable lb vserver

Use this method to get the global configuration of extendedmemory. LSN and Subscriber Session Stores use this memory configuration.

Use this method to get all the custom location entries configured on the NetScaler, or just the entry for the specified IP address range.

Use this method to get the name, including the absolute path, and format of the location file currently loaded on the NetScaler.

Use this method to get the name, including the absolute path, and format of the location file currently loaded on the NetScaler.

Use this method to get current values for the location parameters, which are used for static-proximity based load balancing.

Use this method to get nstrace parameters set through 'start nstrace' method.

Use this method to get radius node configuration

Use this method to get the parameters of all the server entries on the appliance, or the parameters of the specified server entry.

Use this method to get a list of all services configured on the NetScaler, or the configuration details of the specified service.

Use this method to get the specified service group's binding information.

Use this method to get servicegroup information followed by vservers bound to it.

Use this method to get a list of all virtual servers to which the service is bound.

Use this method to get all UI internal data information for the entities

Use this method to imports the specified location file to the NetScaler, assigns it the specified name and the maximum size of locationfile can be upto 300MB

Use this method to imports the specified location file to the NetScaler, assigns it the specified name and the maximum size of locationfile can be upto 300MB

Use this method to renames a server.

Use this method to renames a service.

Use this method to renames a service group.

Use this method to immediately send DNS queries to resolve the domain names of all the domain-based servers configured on the NetScaler.

Use this method to removes a custom location entry from the NetScaler.

Use this method to removes the currently loaded static location database from the NetScaler.

Use this method to removes the currently loaded static location database from the NetScaler.

Use this method to remove radius node configuration from NS

Use this method to removes a server entry from the NetScaler.

Use this method to removes a service.

Use this method to removes a service group.

Use this method to use this method to remove a virtual server.
NOTE: This method is deprecated.
This method is deprecated in 10.0, instead you can use methods such as rm lb vserver

Use this method to set amount of NetScaler memory to reserve for the memory used by LSN and Subscriber Session Store feature, in multiples of 2MB.

Note: If you later reduce the value of this parameter, the amount of active memory is not reduced. Changing the configured memory limit can only increase the amount of active memory.

Use this method to set context for describing locations. In geographic context, qualifier labels are assigned by default in the following sequence: Continent.Country.Region.City.ISP.Organization. In custom context, the qualifiers labels can have any meaning that you designate.

Use this method to set indicates whether wildcard qualifiers should match any other
qualifier including non-wildcard while evaluating
location based expressions.
Possible values: Yes, No, Expression.
Yes - Wildcard qualifiers match any other qualifiers.
No - Wildcard qualifiers do not match non-wildcard
qualifiers, but match other wildcard qualifiers.
Expression - Wildcard qualifiers in an expression
match any qualifier in an LDNS location,
wildcard qualifiers in the LDNS location do not match
non-wildcard qualifiers in an expression

Use this method to set label specifying the meaning of the first qualifier. Can be specified for custom context only.

Use this method to set label specifying the meaning of the second qualifier. Can be specified for custom context only.

Use this method to set label specifying the meaning of the third qualifier. Can be specified for custom context only.

Use this method to set label specifying the meaning of the fourth qualifier. Can be specified for custom context only.

Use this method to set label specifying the meaning of the fifth qualifier. Can be specified for custom context only.

Use this method to set label specifying the meaning of the sixth qualifier. Can be specified for custom context only.

Use this method to set the key shared between the RADIUS server and clients.
Required for NetScaler to communicate with the RADIUS nodes.

Use this method to set any information about the server.

Use this method to set immediately send a DNS query to resolve the server's domain name.

Use this method to set time, in seconds, for which the NetScaler must wait, after DNS resolution fails, before sending the next DNS query to resolve the domain name.

Use this method to set name of the server whose parameters you are configuring.

Use this method to set iP address used to transform the server's DNS-resolved IP address.

Use this method to set the netmask of the translation ip

Use this method to set 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.

Use this method to set enable logging of AppFlow information.

Use this method to set 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.

Use this method to set 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.

Use this method to set enable client keep-alive for the service.

Use this method to set time, in seconds, after which to terminate an idle client connection.

Use this method to set enable compression for the service.

Use this method to set any information about the service.

Use this method to set name of the ContentInspection profile that contains IPS/IDS communication related setting for the service

Use this method to set unique identifier for the service. Used when the persistency type for the virtual server is set to Custom Server ID.

Use this method to set 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, ADNS-TCP and ADNS-DOT services.

Use this method to set 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.

Use this method to set a numerical identifier that can be used by hash based load balancing methods. Must be unique for each service.

Use this method to set monitor the health of this service. Available settings function as follows:
YES - Send probes to check the health of the service.
NO - Do not send probes to check the health of the service. With the NO option, the appliance shows the service as UP at all times.

Use this method to set name of the HTTP profile that contains HTTP configuration settings for the service.

Use this method to set the new IP address of the service.

Use this method to set maximum bandwidth, in Kbps, allocated to the service.

Use this method to set maximum number of simultaneous open connections to the service.

Use this method to set maximum number of requests that can be sent on a persistent connection to the service.
Note: Connection requests beyond this value are rejected.

Use this method to set close monitoring connections by sending the service a connection termination message with the specified bit set.

Use this method to set 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.

Use this method to set network profile to use for the service.

Use this method to set path monitoring for clustering

Use this method to set individual Path monitoring decisions

Use this method to set 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.

Use this method to set name of QUIC profile which will be attached to the service.

Use this method to set enable RTSP session ID mapping for the service.

Use this method to set the identifier for the service. This is used when the persistency type is set to Custom Server ID.
NOTE: This attribute is deprecated.
Instead of integer now serverId will be a string and you can use -customserverid instead of -serverID.

Use this method to set enable surge protection for the service.

Use this method to set time, in seconds, after which to terminate an idle server connection.

Use this method to set enable TCP buffering for the service.

Use this method to set name of the TCP profile that contains TCP configuration settings for the service.

Use this method to set 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.

Use this method to set 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 methods, or in the System > Settings > Configure modes > Configure Modes dialog box). However, you can override this setting after you create the service.

Use this method to set weight to assign to the monitor-service binding. When a monitor is UP, the weight assigned to its binding with the service determines how much the monitor contributes toward keeping the health of the service above the value configured for the Monitor Threshold parameter.

Use this method to set enable logging of AppFlow information for the specified service group.

Use this method to set indicates graceful movement of IP-Port binding/s to TROFS when IP addresses are removed from DNS response. System will wait for monitor response timeout period before moving to TROFS .

Use this method to set the time allowed (in seconds) for a graceful shutdown. During this period, new connections or requests will continue to be sent to this service for clients who already have a persistent session on the system. Connections or requests from fresh or new clients who do not yet have a persistence sessions on the system will not be sent to the service. Instead, they will be load balanced among other available services. After the delay time expires, no new requests or connections will be sent to the service.

Use this method to set indicates graceful shutdown of the service. System will wait for all outstanding connections to this service to be closed before disabling the service.

Use this method to set set this parameter to API to enable using Desired State API for binding intended servicegroup member set. Setting this parameter to API may result in error if the already existing member bindings fall under below category -
1. Domain based server
2. Named servers
3. servers whose name and IP do not match. example: add server 1.2.3.4 4.3.2.1
4. Loopback servers should be named only 127.0.0.1 or 0000:0000:0000:0000:0000:0000:0000:0001.

Use this method to set 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.

Use this method to set insert the Client IP header in requests forwarded to the service.

Use this method to set enable client keep-alive for the service group.

Use this method to set time, in seconds, after which to terminate an idle client connection.

Use this method to set enable compression for the specified service.

Use this method to set any information about the service group.

Use this method to set flush all active transactions associated with all the services in the service group whose state transitions from UP to DOWN. Do not enable this option for applications that must complete their transactions.

Use this method to set monitor the health of this service. Available settings function as follows:
YES - Send probes to check the health of the service.
NO - Do not send probes to check the health of the service. With the NO option, the appliance shows the service as UP at all times.

Use this method to set name of the HTTP profile that contains HTTP configuration settings for the service group.

Use this method to set maximum bandwidth, in Kbps, allocated for all the services in the service group.

Use this method to set maximum number of simultaneous open connections for the service group.

Use this method to set maximum number of requests that can be sent on a persistent connection to the service group.
Note: Connection requests beyond this value are rejected.

Use this method to set close monitoring connections by sending the service a connection termination message with the specified bit set.

Use this method to set name of the monitor bound to the service group. Used to assign a weight to the monitor.

Use this method to set 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.

Use this method to set network profile for the service group.

Use this method to set path monitoring for clustering

Use this method to set individual Path monitoring decisions.

Use this method to set name of QUIC profile which will be attached to the service group.

Use this method to set enable RTSP session ID mapping for the service group.

Use this method to set name of the server to which to bind the service group.

Use this method to set enable surge protection for the service group.

Use this method to set time, in seconds, after which to terminate an idle server connection.

Use this method to set enable TCP buffering for the service group.

Use this method to set name of the TCP profile that contains TCP configuration settings for the service group.

Use this method to set 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.

Use this method to set use client's IP address as the source IP address when initiating connection to the server. With the NO setting, which is the default, a mapped IP (MIP) address or subnet IP (SNIP) address is used as the source IP address to initiate server side connections.

Use this method to set the application template associated with entity

Use this method to set dNS Security tag asscociated with the entity

Use this method to set rules associated with entity

Use this method to set the application template associated with entity

Use this method to set the name of the backup virtual server for this virtual server.
NOTE: This attribute is deprecated.
'forward references' (like an lb vserver having as backup a vserver that is written to ns.conf *after* said lb vserver) can now be handled by config infrastructure (see handling of NS_ARGDEFER flag in config_load())

Use this method to set use this option to specify whether a virtual server (used for load balancing or content switching) routes requests to the cache redirection virtual server before sending it to the configured servers.
NOTE: This attribute is deprecated.
Adding back set vserver

Use this method to set the timeout value in seconds for idle client connection
NOTE: This attribute is deprecated.
Adding back set vserver

Use this method to set the lb vserver of type PUSH/SSL_PUSH to which server pushes the updates received on the client facing non-push lb vserver.

Use this method to set the URL where traffic is redirected if the virtual server in the system becomes unavailable.
NOTE: This attribute is deprecated.
Adding back set vserver

Use this method to set the spillover factor. The system will use this value to determine if it should send traffic to the backupvserver when the main virtual server reaches the spillover threshold.
NOTE: This attribute is deprecated.
Adding back set vserver

Use this method to set the state of the spillover persistence.
NOTE: This attribute is deprecated.
Adding back set vserver

Use this method to set the spillover persistence entry timeout.
NOTE: This attribute is deprecated.
Adding back set vserver

Use this method to set the spillver threshold value.
NOTE: This attribute is deprecated.
Adding back set vserver

Use this method to start NetScaler packet capture tool. There should be at least 2 GB of free disk space for trace to start

Use this method to stop running NetScaler packet capture tool.

Name of the monitor assigned to the service.

IP address of the server that hosts the service. Mutually exclusive with the Server Name parameter.

Name of the monitor to bind to the service group.

Port number of the service.

Name of the server that hosts the service. Mutually exclusive with the IP Address parameter.

Amount of NetScaler memory to reserve for the memory used by LSN and Subscriber Session Store feature, in multiples of 2MB.

Note: If you later reduce the value of this parameter, the amount of active memory is not reduced. Changing the configured memory limit can only increase the amount of active memory.

Context for describing locations. In geographic context, qualifier labels are assigned by default in the following sequence: Continent.Country.Region.City.ISP.Organization. In custom context, the qualifiers labels can have any meaning that you designate.

Indicates whether wildcard qualifiers should match any other
qualifier including non-wildcard while evaluating
location based expressions.
Possible values: Yes, No, Expression.
Yes - Wildcard qualifiers match any other qualifiers.
No - Wildcard qualifiers do not match non-wildcard
qualifiers, but match other wildcard qualifiers.
Expression - Wildcard qualifiers in an expression
match any qualifier in an LDNS location,
wildcard qualifiers in the LDNS location do not match
non-wildcard qualifiers in an expression

Label specifying the meaning of the first qualifier. Can be specified for custom context only.

Label specifying the meaning of the second qualifier. Can be specified for custom context only.

Label specifying the meaning of the third qualifier. Can be specified for custom context only.

Label specifying the meaning of the fourth qualifier. Can be specified for custom context only.

Label specifying the meaning of the fifth qualifier. Can be specified for custom context only.

Label specifying the meaning of the sixth qualifier. Can be specified for custom context only.

Any information about the server.

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.

Enable logging of AppFlow information.

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.

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.

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 method 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."

Enable client keep-alive for the service.

Time, in seconds, after which to terminate an idle client connection.

Enable compression for the service.

Any information about the service.

Name of the ContentInspection profile that contains IPS/IDS communication related setting for the service

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

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, ADNS-TCP and ADNS-DOT services.

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.

A numerical identifier that can be used by hash based load balancing methods. Must be unique for each service.

Monitor the health of this service. Available settings function as follows:
YES - Send probes to check the health of the service.
NO - Do not send probes to check the health of the service. With the NO option, the appliance shows the service as UP at all times.

Name of the HTTP profile that contains HTTP configuration settings for the service.

Maximum bandwidth, in Kbps, allocated to the service.

Maximum number of simultaneous open connections to the service.

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

Close monitoring connections by sending the service a connection termination message with the specified bit set.

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.

Network profile to use for the service.

Path monitoring for clustering

Individual Path monitoring decisions

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.

Name of QUIC profile which will be attached to the service.

Enable RTSP session ID mapping for the service.

The identifier for the service. This is used when the persistency type is set to Custom Server ID.
NOTE: This attribute is deprecated.
Instead of integer now serverId will be a string and you can use -customserverid instead of -serverID.

Enable surge protection for the service.

Time, in seconds, after which to terminate an idle server connection.

Enable TCP buffering for the service.

Name of the TCP profile that contains TCP configuration settings for the service.

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.

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 methods, or in the System > Settings > Configure modes > Configure Modes dialog box). However, you can override this setting after you create the service.

Enable logging of AppFlow information for the specified service group.

Indicates graceful movement of IP-Port binding/s to TROFS when IP addresses are removed from DNS response. System will wait for monitor response timeout period before moving to TROFS .

The time allowed (in seconds) for a graceful shutdown. During this period, new connections or requests will continue to be sent to this service for clients who already have a persistent session on the system. Connections or requests from fresh or new clients who do not yet have a persistence sessions on the system will not be sent to the service. Instead, they will be load balanced among other available services. After the delay time expires, no new requests or connections will be sent to the service.

Indicates graceful shutdown of the service. System will wait for all outstanding connections to this service to be closed before disabling the service.

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.

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

CIP Header.

Enable client keep-alive for the service group.

Time, in seconds, after which to terminate an idle client connection.

Enable compression for the specified service.

Any information about the service group.

Flush all active transactions associated with all the services in the service group whose state transitions from UP to DOWN. Do not enable this option for applications that must complete their transactions.

Monitor the health of this service. Available settings function as follows:
YES - Send probes to check the health of the service.
NO - Do not send probes to check the health of the service. With the NO option, the appliance shows the service as UP at all times.

Name of the HTTP profile that contains HTTP configuration settings for the service group.

Maximum bandwidth, in Kbps, allocated for all the services in the service group.

Maximum number of simultaneous open connections for the service group.

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

Close monitoring connections by sending the service a connection termination message with the specified bit set.

Name of the monitor bound to the service group. Used to assign a weight to the monitor.

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.

Network profile for the service group.

Path monitoring for clustering

Individual Path monitoring decisions.

Name of QUIC profile which will be attached to the service group.

Enable RTSP session ID mapping for the service group.

The name of the server to be changed.

Enable surge protection for the service group.

Time, in seconds, after which to terminate an idle server connection.

Enable TCP buffering for the service group.

Name of the TCP profile that contains TCP configuration settings for the service group.

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.

Use client's IP address as the source IP address when initiating connection to the server. With the NO setting, which is the default, a mapped IP (MIP) address or subnet IP (SNIP) address is used as the source IP address to initiate server side connections.

weight of the monitor that is bound to servicegroup.

unset all/remove UI internal data for the entity

unset the comment

unset DNS Security tag asscociated with the entity

unset the rule

unset the template

The backup virtual server to be unset.

Use this option to specify whether a virtual server (used for load balancing or content switching) routes requests to the cache redirection virtual server before sending it to the configured servers.
NOTE: This attribute is deprecated.
Adding back set vserver

The timeout value in seconds for idle client connection
NOTE: This attribute is deprecated.
Adding back set vserver

The lb vserver of type PUSH/SSL_PUSH to which server pushes the updates received on the client facing non-push lb vserver.

The URL where traffic is redirected if the virtual server in the system becomes unavailable.
NOTE: This attribute is deprecated.
Adding back set vserver

The URL where traffic is redirected if the virtual server in the system becomes unavailable.
NOTE: This attribute is deprecated.
Adding back set vserver

The spillover factor. The system will use this value to determine if it should send traffic to the backupvserver when the main virtual server reaches the spillover threshold.
NOTE: This attribute is deprecated.
Adding back set vserver

The state of the spillover persistence.
NOTE: This attribute is deprecated.
Adding back set vserver

The spillover persistence entry timeout.
NOTE: This attribute is deprecated.
Adding back set vserver

The spillver threshold value.
NOTE: This attribute is deprecated.
Adding back set vserver