< Back
Sync-NSlbvserver
Post
NAME Sync-NSlbvserver
SYNOPSIS
The sync-NSlbvserver allows for a fast update of the services bound to a vserver
SYNTAX
Sync-NSlbvserver -ipaddress <string[]> -vserver <string> [-force <SwitchParameter>] [-monitor <string[]>] [-port
<ushort>] [-serviceNamingPattern <string>] [-serviceType <string>] [-session <nitro_service>] [<CommonParameters>]
DESCRIPTION
the sync-nslbvserver is used to update the services bound to an LB vserver. It takes array of IP addresses and
uses that confirm the services that should be bound. If a service is missing it is created. Similarly, IP
addresses NOT included will also be removed. It's a fast way of updating a lB vserver for example when using
scalesets.
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
-ipaddress <string[]>
Specify an array of IP addresses (strings) that specify which services should be bound to the vserver. This
specifies the end state. Hence, if an IP address is not included but has a matching service, that service is
unbound and removed.
Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-vserver <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
-port <ushort>
specify the ports for the service. If no services currently exist, port from vserver will be used. Otherwise,
this function will use the port used by the first service current bound to the vserver
Required? false
Position? named
Default value 0
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-serviceType <string>
Specify the service type. If no services exist, the service type will be same as the vserver, otherwise values
from first service will be used. Possible values = 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,
SSL_FIX, USER_TCP, USER_SSL_TCP .
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-monitor <string[]>
specify the name of the monitor(s) to use. If not specified, then the monitor(s) used by the first existing
service is used, or default is set. Specifying this may update existing services to use this monitor
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-serviceNamingPattern <string>
Specify the naming pattern for the service. this consist of a prefix, index and suffix.Specify a string with
##index## where the index goes. "LB-web-##index##-svc"
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-force <SwitchParameter>
If set, force deletion without confirmation.
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 an array of IP addresses (strings) that specify which services should be bound to the vserver. This
specifies the end state. Hence, if an IP address is not included but has a matching service, that service is
unbound and removed.
System.String
Specify the name of the virtual server. This is required.
System.UInt16
specify the ports for the service. If no services currently exist, port from vserver will be used. Otherwise,
this function will use the port used by the first service current bound to the vserver
System.String
Specify the service type. If no services exist, the service type will be same as the vserver, otherwise values
from first service will be used. Possible values = 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,
SSL_FIX, USER_TCP, USER_SSL_TCP .
System.String[]
specify the name of the monitor(s) to use. If not specified, then the monitor(s) used by the first existing
service is used, or default is set. Specifying this may update existing services to use this monitor
System.Management.Automation.SwitchParameter
If set, force deletion without confirmation.
OUTPUTS
RELATED LINKS
SYNOPSIS
The sync-NSlbvserver allows for a fast update of the services bound to a vserver
SYNTAX
Sync-NSlbvserver -ipaddress <string[]> -vserver <string> [-force <SwitchParameter>] [-monitor <string[]>] [-port
<ushort>] [-serviceNamingPattern <string>] [-serviceType <string>] [-session <nitro_service>] [<CommonParameters>]
DESCRIPTION
the sync-nslbvserver is used to update the services bound to an LB vserver. It takes array of IP addresses and
uses that confirm the services that should be bound. If a service is missing it is created. Similarly, IP
addresses NOT included will also be removed. It's a fast way of updating a lB vserver for example when using
scalesets.
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
-ipaddress <string[]>
Specify an array of IP addresses (strings) that specify which services should be bound to the vserver. This
specifies the end state. Hence, if an IP address is not included but has a matching service, that service is
unbound and removed.
Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-vserver <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
-port <ushort>
specify the ports for the service. If no services currently exist, port from vserver will be used. Otherwise,
this function will use the port used by the first service current bound to the vserver
Required? false
Position? named
Default value 0
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-serviceType <string>
Specify the service type. If no services exist, the service type will be same as the vserver, otherwise values
from first service will be used. Possible values = 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,
SSL_FIX, USER_TCP, USER_SSL_TCP .
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-monitor <string[]>
specify the name of the monitor(s) to use. If not specified, then the monitor(s) used by the first existing
service is used, or default is set. Specifying this may update existing services to use this monitor
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-serviceNamingPattern <string>
Specify the naming pattern for the service. this consist of a prefix, index and suffix.Specify a string with
##index## where the index goes. "LB-web-##index##-svc"
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-force <SwitchParameter>
If set, force deletion without confirmation.
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 an array of IP addresses (strings) that specify which services should be bound to the vserver. This
specifies the end state. Hence, if an IP address is not included but has a matching service, that service is
unbound and removed.
System.String
Specify the name of the virtual server. This is required.
System.UInt16
specify the ports for the service. If no services currently exist, port from vserver will be used. Otherwise,
this function will use the port used by the first service current bound to the vserver
System.String
Specify the service type. If no services exist, the service type will be same as the vserver, otherwise values
from first service will be used. Possible values = 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,
SSL_FIX, USER_TCP, USER_SSL_TCP .
System.String[]
specify the name of the monitor(s) to use. If not specified, then the monitor(s) used by the first existing
service is used, or default is set. Specifying this may update existing services to use this monitor
System.Management.Automation.SwitchParameter
If set, force deletion without confirmation.
OUTPUTS
RELATED LINKS