< Back
New-NSlbvserver
Post
NAME New-NSlbvserver
SYNOPSIS
The new-NSlbvserver creates a load balancing virtual server.
SYNTAX
New-NSlbvserver -name <string> -servicetype <string> [-comment <string>] [-ipmask <string>] [-ippattern <string>]
[-ipv46 <string>] [-lbmethod <string>] [-persistencetype <string>] [-port <ushort>] [-returnobject
<SwitchParameter>] [-session <nitro_service>] [-state <string>] [<CommonParameters>]
DESCRIPTION
Use the new-NSlbvserver command to create a load balancing vserver. Without IP address, the server is
non-addressable, you can specify a single IP with -ipv46, or a pattern with -ippattern and ipmask
PARAMETERS
-session <nitro_service>
This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and
pipelined into this command.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-ipv46 <string>
Specify the IP address. You can specify the IP address with this parameter, or a pattern with the -ippattern
parameter. If neither is used, the vserver will be non-addressable.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-name <string>
Specify the name of the virtual server. This is required.
Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-comment <string>
Specify an optional comment.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-ippattern <string>
Specify an IP pattern. When using -ippattern, you must use -ipmask as well. For example -ippattern "10.0.0.4"
-ipmask "255.255.255.254" will make the vserver listen on IP 10.0.0.4 and 10.0.0.5.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-ipmask <string>
Specify the IP mask.Required whn using -ippattern. For example -ippattern "10.0.0.4" -ipmask "255.255.255.254"
will make the vserver listen on IP 10.0.0.4 and 10.0.0.5.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-lbmethod <string>
Specify the load balancing method. Possible values = ROUNDROBIN, LEASTCONNECTION, LEASTRESPONSETIME, URLHASH,
DOMAINHASH, DESTINATIONIPHASH, SOURCEIPHASH, SRCIPDESTIPHASH, LEASTBANDWIDTH, LEASTPACKETS, TOKEN,
SRCIPSRCPORTHASH, LRTM, CALLIDHASH, CUSTOMLOAD, LEASTREQUEST, AUDITLOGHASH, STATICPROXIMITY, USER_TOKEN.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-persistencetype <string>
Specify the persistence type. Possible values = SOURCEIP, COOKIEINSERT, SSLSESSION, RULE, URLPASSIVE,
CUSTOMSERVERID, DESTIP, SRCIPDESTIP, CALLID, RTSPSID, DIAMETER, FIXSESSION, USERSESSION, NONE
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-port <ushort>
Specify the port. Not required for a non-addressable vserver.
Required? false
Position? named
Default value 0
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-servicetype <string>
Specify the service type. Possible values = 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, SSL_FIX, USER_TCP, USER_SSL_TCP
Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-state <string>
Specify the initial state of the vserver. Default is "ENABLED". Possible values are "ENABLED", "DISABLED"
Required? false
Position? named
Default value ENABLED
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-returnobject <SwitchParameter>
If set to true, the object that is created is returned. This is useful to testing purposes.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
com.citrix.netscaler.nitro.service.nitro_service
This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and
pipelined into this command.
System.String
Specify the IP address. You can specify the IP address with this parameter, or a pattern with the -ippattern
parameter. If neither is used, the vserver will be non-addressable.
System.String
Specify the name of the virtual server. This is required.
System.String
Specify an optional comment.
System.String
Specify an IP pattern. When using -ippattern, you must use -ipmask as well. For example -ippattern "10.0.0.4"
-ipmask "255.255.255.254" will make the vserver listen on IP 10.0.0.4 and 10.0.0.5.
System.String
Specify the IP mask.Required whn using -ippattern. For example -ippattern "10.0.0.4" -ipmask "255.255.255.254"
will make the vserver listen on IP 10.0.0.4 and 10.0.0.5.
System.String
Specify the load balancing method. Possible values = ROUNDROBIN, LEASTCONNECTION, LEASTRESPONSETIME, URLHASH,
DOMAINHASH, DESTINATIONIPHASH, SOURCEIPHASH, SRCIPDESTIPHASH, LEASTBANDWIDTH, LEASTPACKETS, TOKEN,
SRCIPSRCPORTHASH, LRTM, CALLIDHASH, CUSTOMLOAD, LEASTREQUEST, AUDITLOGHASH, STATICPROXIMITY, USER_TOKEN.
System.String
Specify the persistence type. Possible values = SOURCEIP, COOKIEINSERT, SSLSESSION, RULE, URLPASSIVE,
CUSTOMSERVERID, DESTIP, SRCIPDESTIP, CALLID, RTSPSID, DIAMETER, FIXSESSION, USERSESSION, NONE
System.UInt16
Specify the port. Not required for a non-addressable vserver.
System.String
Specify the service type. Possible values = 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, SSL_FIX, USER_TCP, USER_SSL_TCP
System.String
Specify the initial state of the vserver. Default is "ENABLED". Possible values are "ENABLED", "DISABLED"
System.Management.Automation.SwitchParameter
If set to true, the object that is created is returned. This is useful to testing purposes.
OUTPUTS
com.citrix.netscaler.nitro.resource.config.lb.lbvserver
RELATED LINKS
SYNOPSIS
The new-NSlbvserver creates a load balancing virtual server.
SYNTAX
New-NSlbvserver -name <string> -servicetype <string> [-comment <string>] [-ipmask <string>] [-ippattern <string>]
[-ipv46 <string>] [-lbmethod <string>] [-persistencetype <string>] [-port <ushort>] [-returnobject
<SwitchParameter>] [-session <nitro_service>] [-state <string>] [<CommonParameters>]
DESCRIPTION
Use the new-NSlbvserver command to create a load balancing vserver. Without IP address, the server is
non-addressable, you can specify a single IP with -ipv46, or a pattern with -ippattern and ipmask
PARAMETERS
-session <nitro_service>
This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and
pipelined into this command.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-ipv46 <string>
Specify the IP address. You can specify the IP address with this parameter, or a pattern with the -ippattern
parameter. If neither is used, the vserver will be non-addressable.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-name <string>
Specify the name of the virtual server. This is required.
Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-comment <string>
Specify an optional comment.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-ippattern <string>
Specify an IP pattern. When using -ippattern, you must use -ipmask as well. For example -ippattern "10.0.0.4"
-ipmask "255.255.255.254" will make the vserver listen on IP 10.0.0.4 and 10.0.0.5.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-ipmask <string>
Specify the IP mask.Required whn using -ippattern. For example -ippattern "10.0.0.4" -ipmask "255.255.255.254"
will make the vserver listen on IP 10.0.0.4 and 10.0.0.5.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-lbmethod <string>
Specify the load balancing method. Possible values = ROUNDROBIN, LEASTCONNECTION, LEASTRESPONSETIME, URLHASH,
DOMAINHASH, DESTINATIONIPHASH, SOURCEIPHASH, SRCIPDESTIPHASH, LEASTBANDWIDTH, LEASTPACKETS, TOKEN,
SRCIPSRCPORTHASH, LRTM, CALLIDHASH, CUSTOMLOAD, LEASTREQUEST, AUDITLOGHASH, STATICPROXIMITY, USER_TOKEN.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-persistencetype <string>
Specify the persistence type. Possible values = SOURCEIP, COOKIEINSERT, SSLSESSION, RULE, URLPASSIVE,
CUSTOMSERVERID, DESTIP, SRCIPDESTIP, CALLID, RTSPSID, DIAMETER, FIXSESSION, USERSESSION, NONE
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-port <ushort>
Specify the port. Not required for a non-addressable vserver.
Required? false
Position? named
Default value 0
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-servicetype <string>
Specify the service type. Possible values = 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, SSL_FIX, USER_TCP, USER_SSL_TCP
Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-state <string>
Specify the initial state of the vserver. Default is "ENABLED". Possible values are "ENABLED", "DISABLED"
Required? false
Position? named
Default value ENABLED
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-returnobject <SwitchParameter>
If set to true, the object that is created is returned. This is useful to testing purposes.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
com.citrix.netscaler.nitro.service.nitro_service
This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and
pipelined into this command.
System.String
Specify the IP address. You can specify the IP address with this parameter, or a pattern with the -ippattern
parameter. If neither is used, the vserver will be non-addressable.
System.String
Specify the name of the virtual server. This is required.
System.String
Specify an optional comment.
System.String
Specify an IP pattern. When using -ippattern, you must use -ipmask as well. For example -ippattern "10.0.0.4"
-ipmask "255.255.255.254" will make the vserver listen on IP 10.0.0.4 and 10.0.0.5.
System.String
Specify the IP mask.Required whn using -ippattern. For example -ippattern "10.0.0.4" -ipmask "255.255.255.254"
will make the vserver listen on IP 10.0.0.4 and 10.0.0.5.
System.String
Specify the load balancing method. Possible values = ROUNDROBIN, LEASTCONNECTION, LEASTRESPONSETIME, URLHASH,
DOMAINHASH, DESTINATIONIPHASH, SOURCEIPHASH, SRCIPDESTIPHASH, LEASTBANDWIDTH, LEASTPACKETS, TOKEN,
SRCIPSRCPORTHASH, LRTM, CALLIDHASH, CUSTOMLOAD, LEASTREQUEST, AUDITLOGHASH, STATICPROXIMITY, USER_TOKEN.
System.String
Specify the persistence type. Possible values = SOURCEIP, COOKIEINSERT, SSLSESSION, RULE, URLPASSIVE,
CUSTOMSERVERID, DESTIP, SRCIPDESTIP, CALLID, RTSPSID, DIAMETER, FIXSESSION, USERSESSION, NONE
System.UInt16
Specify the port. Not required for a non-addressable vserver.
System.String
Specify the service type. Possible values = 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, SSL_FIX, USER_TCP, USER_SSL_TCP
System.String
Specify the initial state of the vserver. Default is "ENABLED". Possible values are "ENABLED", "DISABLED"
System.Management.Automation.SwitchParameter
If set to true, the object that is created is returned. This is useful to testing purposes.
OUTPUTS
com.citrix.netscaler.nitro.resource.config.lb.lbvserver
RELATED LINKS