Property Name |
Type |
Display Name (ENU) |
Description (ENU) |
Key |
Max Length |
Min Length |
Case Sensitive |
System.Entity: |
DisplayName |
string |
Display Name |
Display name of monitoring object. |
false | 256 |
0 |
False |
ComTrade.Citrix.NetScaler.Appliance.Component.Base: |
HostID |
string |
MPNS Key |
The NetScaler Management Pack key value. It is combination of host id, serial number and NetScaler IP address. |
false | 256 |
0 |
False |
IPAddress |
string |
Device IP Address |
The NetScaler Device IP Address. |
false | 256 |
0 |
False |
DeviceKey |
string |
Device Key |
The key property of the device node in System Center Operations Manager. |
true | 256 |
0 |
False |
ComTrade.Citrix.NetScaler.Appliance.Component.VirtualServer: |
name |
string |
Name |
The name for the virtual server. |
true | 256 |
0 |
False |
servicename |
string |
Service Name |
The name of the service, if any, to which the virtual server policy is bound. |
false | 256 |
0 |
False |
ComTrade.Citrix.NetScaler.Appliance.Component.AccessGateway.VirtualServer: |
appflowlog |
string |
AppFlow Logging |
Enable logging AppFlow flow information. |
false | 256 |
0 |
False |
authentication |
string |
Enable Authentication |
This option toggles on or off the application of authentication of incoming users to the VPN. |
false | 256 |
0 |
False |
backupvserver |
string |
Backup Virtual Server |
The name of the backup VPN virtual server for this VPN virtual server. |
false | 256 |
0 |
False |
bindpoint |
string |
Bind Point |
Bind point to which the policy is bound. |
false | 256 |
0 |
False |
cachetype |
string |
Cache Type |
Virtual server's cache type. The options are: TRANSPARENT, REVERSE and FORWARD. |
false | 256 |
0 |
False |
cachevserver |
string |
Cache Virtual Server |
The name of the default target cache virtual server, if any, to which requests are redirected. |
false | 256 |
0 |
False |
clttimeout |
string |
Client Timeout |
The idle time, if any, in seconds after which the client connection is terminated. |
false | 256 |
0 |
False |
comment |
string |
Comments |
Comments associated with this virtual server. |
false | 256 |
0 |
False |
disableprimaryondown |
string |
Disable Primary On Down |
Tells whether traffic will continue reaching backup virtual servers even after primary comes UP from DOWN state. |
false | 256 |
0 |
False |
domain |
string |
Domain |
The domain name of the server for which a service needs to be added. If the IP Address has been specified, the domain name does not need to be specified. |
false | 256 |
0 |
False |
downstateflush |
string |
Down State Flush |
Perform delayed cleanup of connections on this virtual server. |
false | 256 |
0 |
False |
gotopriorityexpression |
string |
Go To Priority Expression |
Next priority expression. |
false | 256 |
0 |
False |
httpprofilename |
string |
HTTP Profile |
Name of the HTTP profile. |
false | 256 |
0 |
False |
icaonly |
string |
ICA Only License |
This option tells whether ICA only license feature is on or off. |
false | 256 |
0 |
False |
ip |
string |
Virtual IP Address |
The Virtual IP address of the VPN virtual server. |
false | 256 |
0 |
False |
ipv46 |
string |
IP Address |
The IP address for the VPN virtual server. |
false | 256 |
0 |
False |
listenpolicy |
string |
Listen Policy Rule |
Use this parameter to specify the listen policy for VPN virtual server. The string can be either an existing expression name (configured using add policy expression command) or else it can be an in-line expression with a maximum of 1500 characters. |
false | 256 |
0 |
False |
listenpriority |
string |
Listen Priority |
Use this parameter to specify the priority for listen policy of VPN virtual server. |
false | 256 |
0 |
False |
map |
string |
Map |
Whether or not Mapped IP Addresses are ON or OFF. Mapped IP addresses are source IP addresses for the virtual servers running on the NetScaler. Mapped IP addresses are used by the system to connect to the backend servers. |
false | 256 |
0 |
False |
maxaaausers |
string |
Max Users |
The maximum number of concurrent users allowed to login into this virtual server at a time. The administrator can configure any number between 0 and 65535 for this virtual server, but the actual number of users allowed to login into this virtual server will also depend on the total number of user licenses and the total number of currently logged in users. |
false | 256 |
0 |
False |
newname |
string |
New Name |
The new name of the virtual server. |
false | 256 |
0 |
False |
policy |
string |
Policy |
The name of the policy, if any, bound to the VPN virtual server. |
false | 256 |
0 |
False |
port |
string |
Port |
The TCP port on which the virtual server listens. |
false | 256 |
0 |
False |
precedence |
string |
Precedence |
This argument is used only when configuring content switching on the specified virtual server. This is applicable only if both the URL and RULE-based policies have been configured on the same virtual server. It specifies the type of policy (URL or RULE) that takes precedence on the content switching virtual server. The default setting is RULE. URL - In this case, the incoming request is matched against the URL-based policies before the rule-based policies. RULE - In this case, the incoming request is matched against the rule-based policies before the URL-based policies. For all URL-based policies, the precedence hierarchy is: 1. Domain and exact URL 2. Domain, prefix and suffix 3. Domain and suffix 4. Domain and prefix 5. Domain only 6. Exact URL 7. Prefix and suffix 8. Suffix only 9. Prefix only 10. Default. |
false | 256 |
0 |
False |
priority |
string |
Priority |
The priority, if any, of the VPN virtual server policy. |
false | 256 |
0 |
False |
range |
string |
Range |
Range of VPN virtual server IP addresses. The new range of VPN virtual servers will have IP addresses consecutively numbered, starting with the primary address specified with the <ipaddress> argument. |
false | 256 |
0 |
False |
redirect |
string |
Redirect |
The cache redirect policy. The valid redirect policies are: 1. CACHE - Directs all requests to the cache. 2. POLICY - Applies cache redirection policy to determine whether the request should be directed to the cache or origin. This is the default setting. 3. ORIGIN - Directs all requests to the origin server. |
false | 256 |
0 |
False |
redirecturl |
string |
Redirect URL |
The URL where traffic is redirected if the virtual server in system becomes unavailable. WARNING! Make sure that the domain you specify in the URL does not match the domain specified in the -d domainName argument of the ###add cs policy### command. If the same domain is specified in both arguments, the request will be continuously redirected to the same unavailable virtual server in the system. If so, the user may not get the requested content. |
false | 256 |
0 |
False |
rule |
string |
Rule |
The name of the rule, or expression, if any, that policy for the VPN server is to use. Rules are combinations of Expressions. Expressions are simple conditions, such as a test for equality, applied to operands, such as a URL string or an IP address. Expression syntax is described in the Installation and Configuration Guide. The default rule is ns_true. |
false | 256 |
0 |
False |
servicetype |
string |
Service Type (Protocol) |
The VPN virtual server's protocol type, e.g. SSL. |
false | 256 |
0 |
False |
somethod |
string |
SO Method |
VPN client applications are allocated from a block of Intranet IP addresses. That block may be exhausted after a certain number of connections. This switch specifies the method used to determine whether or not a new connection will spillover, or exhaust, the allocated block of Intranet IP addresses for that application. Possible values are CONNECTION or DYNAMICCONNECTION.CONNECTION means that a static integer value is the hard limit for the spillover threshold. The spillover threshold is described below. DYNAMICCONNECTION means that the spillover threshold is set according to the maximum number of connections defined for the VPN virtual server. |
false | 256 |
0 |
False |
sopersistence |
string |
SO Persistence |
Whether or not cookie-based site persistence is enabled for this VPN virtual server. Possible values are ConnectionProxy, HTTPRedirect, or NONE. |
false | 256 |
0 |
False |
sopersistencetimeout |
string |
Persistence Time-out(min) |
The timeout, if any, for cookie-based site persistence of this VPN virtual server. |
false | 256 |
0 |
False |
sothreshold |
string |
SO Threshold |
VPN client applications are allocated from a block of Intranet IP addresses. That block may be exhausted after a certain number of connections. The value of this option is number of client connections after which the Mapped IP address is used as the client source IP address instead of an address from the allocated block of Intranet IP addresses. |
false | 256 |
0 |
False |
tcpprofilename |
string |
TCP Profile Name |
The name of the TCP profile. |
false | 256 |
0 |
False |
type |
string |
Type |
The type of Virtual Server, e.g. CONTENT based or ADDRESS based. |
false | 256 |
0 |
False |
usemip |
string |
Use MIP |
Deprecated. See 'map' below. |
false | 256 |
0 |
False |
value |
string |
Value |
Indicates whether or not the Certificate is bound or if SSL offload is disabled. |
false | 256 |
0 |
False |
weight |
string |
Weight |
Weight for this service, if any. This weight is used when the system performs load balancing, giving greater priority to a specific service. It is useful when the services bound to a virtual server are of different capacity. |
false | 256 |
0 |
False |