Set-RASHALB
NAME
Set-RASHALB
SYNOPSIS
Updates the settings of a specific HALB Virtual Server.
SYNTAX
Set-RASHALB [[-Id] (uint)]** [[-LBGateways] (List1)*] [[-[LBGatewayPort](#lbgatewayport-string)] *(uint)*] [[-[EnableSSLPayload](#enablesslpayload-string)] *(bool)*] [[-[SSLMode](#SSLMode)] {SSLOffloading | SSLPassthrough}] [[-[LBSSLGateways](#LBSSLGateways)] *(List1)] [[-LBSSLGatewayPort] (uint)] [[-AcceptedSSLVersion] {TLSv1 | TLSv1_1 | TLSv1_2 | TLSv1_3}] [[-CipherStrength] {Low | Medium | High | Custom}] [[-SSLCustomCipher] (string)] [[-CertificateID] (uint)] [[-Description] (string)] [[-NewName] (string)] [[-EnableDeviceManagement] (bool)] [[-DeviceManagerGateways] (List`1)] [[-IPVersion] {Version4 | Version6 | BothVersions}] [[-VirtualIPv4] (string)] [[-SubnetMask] (string)] [[-VirtualIPv6] (string)] [[-PrefixIPV6] (uint)] [[-EnableGatewayPayload] (bool)] [CipherPreference (bool)] [ClientIdleTimeout (uint)] [ClientQueueTimeout (uint)] [Enabled (bool)] [EnableTunneling (bool)] [GatewayConnectionTimeout (uint)] [GatewayHealthCheckIntervals (uint)] [GatewayIdleTimeout (uint)] [KeepLBProxyConfig (bool)] [KeepVRRPConfig (bool)] [MaxTCPConnections (uint)] [PublicAddress (string)] [SessionRate (uint)] [VRRPAdvertisementInterval (uint)] [VRRPAuthenticationPassword (SecureString)] [VRRPBroadcastInterval (uint)] [VRRPHealthScriptCheckInterval (uint)] [VRRPHealthScriptCheckTimeout (uint)] [VRRPVirtualRouterID (uint)] [(CommonParameters)]
Set-RASHALB [-InputObject]** (HALBSettings) [[-LBGateways] (List1)*] [[-[LBGatewayPort](#lbgatewayport-string)] *(uint)*] [[-[EnableSSLPayload](#enablesslpayload-string)] *(bool)*] [[-[SSLMode](#SSLMode)] {SSLOffloading | SSLPassthrough}] [[-[LBSSLGateways](#LBSSLGateways)] *(List1)] [[-LBSSLGatewayPort] (uint)] [[-AcceptedSSLVersion] {TLSv1 | TLSv1_1 | TLSv1_2 | TLSv1_3}] [[-CipherStrength] {Low | Medium | High | Custom}] [[-SSLCustomCipher] (string)] [[-CertificateID] (uint)] [[-Description] (string)] [[-NewName] (string)] [[-EnableDeviceManagement] (bool)] [[-DeviceManagerGateways] (List`1)] [[-IPVersion] {Version4 | Version6 | BothVersions}] [[-VirtualIPv4] (string)] [[-SubnetMask] (string)] [[-VirtualIPv6] (string)] [[-PrefixIPV6] (uint)] [[-EnableGatewayPayload] (bool)] [CipherPreference (bool)] [ClientIdleTimeout (uint)] [ClientQueueTimeout (uint)] [Enabled (bool)] [EnableTunneling (bool)] [GatewayConnectionTimeout (uint)] [GatewayHealthCheckIntervals (uint)] [GatewayIdleTimeout (uint)] [KeepLBProxyConfig (bool)] [KeepVRRPConfig (bool)] [MaxTCPConnections (uint)] [PublicAddress (string)] [SessionRate (uint)] [VRRPAdvertisementInterval (uint)] [VRRPAuthenticationPassword (SecureString)] [VRRPBroadcastInterval (uint)] [VRRPHealthScriptCheckInterval (uint)] [VRRPHealthScriptCheckTimeout (uint)] [VRRPVirtualRouterID (uint)] [(CommonParameters)]
Set-RASHALB [Name] (string)** [[-SiteId] (uint)] [[-LBGateways] (List1)*] [[-[LBGatewayPort](#lbgatewayport-string)] *(uint)*] [[-[EnableSSLPayload](#enablesslpayload-string)] *(bool)*] [[-[SSLMode](#SSLMode)] {SSLOffloading | SSLPassthrough}] [[-[LBSSLGateways](#LBSSLGateways)] *(List1)] [[-LBSSLGatewayPort] (uint)] [[-AcceptedSSLVersion] {TLSv1 | TLSv1_1 | TLSv1_2 | TLSv1_3}] [[-CipherStrength] {Low | Medium | High | Custom}] [[-SSLCustomCipher] (string)] [[-CertificateID] (uint)] [[-Description] (string)] [[-NewName] (string)] [[-EnableDeviceManagement] (bool)] [[-DeviceManagerGateways] (List`1)] [[-IPVersion] {Version4 | Version6 | BothVersions}] [[-VirtualIPv4] (string)] [[-SubnetMask] (string)] [[-VirtualIPv6] (string)] [[-PrefixIPV6] (uint)] [[-EnableGatewayPayload] (bool)] [CipherPreference (bool)] [ClientIdleTimeout (uint)] [ClientQueueTimeout (uint)] [Enabled (bool)] [EnableTunneling (bool)] [GatewayConnectionTimeout (uint)] [GatewayHealthCheckIntervals (uint)] [GatewayIdleTimeout (uint)] [KeepLBProxyConfig (bool)] [KeepVRRPConfig (bool)] [MaxTCPConnections (uint)] [PublicAddress (string)] [SessionRate (uint)] [VRRPAdvertisementInterval (uint)] [VRRPAuthenticationPassword (SecureString)] [VRRPBroadcastInterval (uint)] [VRRPHealthScriptCheckInterval (uint)] [VRRPHealthScriptCheckTimeout (uint)] [VRRPVirtualRouterID (uint)] [(CommonParameters)]
DESCRIPTION
Updates the settings of a specific HALB Virtual Server.
PARAMETERS
Id (uint)
The Id of the HALB Virtual Server.
Name (string)
The name of the HALB Virtual Server.
SiteId (uint)
The site ID where the HALB settings will be created.
NewName (string)
The new name for the HALB Virtual Server.
Enabled (bool)
Enable/Disable HALB Virtual Server.
IPVersion (IPVersion)
The supported IP versions of the HALB Virtual Server.
Possible values: Version4, Version6, BothVersions
EnableGatewayPayload (bool)
Enable/Disable the Non-SSL Gateway configuration of the HALB Virtual Server .
EnableSSLPayload (bool)
Enable/Disable the SSL Gateway configuration of the HALB Virtual Server.
EnableDeviceManagement (bool)
Enable/Disable the Device Management configuration of the HALB Virtual Server.
InputObject (HALBSettings)
An object of type HALBSettings.
The object is obtained using the Get-RASHALB cmdlet.
Description (string)
The HALB Virtual Server description.
PublicAddress (string)
The HALB Virtual Server Public Address.
VirtualIPv4 (string)
The IPv4 of the HALB Virtual Server.
SubnetMask (string)
The Subnet Mask of the HALB Virtual Server.
VirtualIPv6 (string)
The IPv6 of the HALB Virtual Server.
PrefixIPV6 (uint)
The IPv6 Prefix of the HALB Virtual Server.
EnableTunneling (bool)
Enable/Disable the RDP/UDP of the HALB Virtual Server.
MaxTCPConnections (uint)
The Maximum allowed TCP Connections to the HALB Virtual Server.
VRRPAuthenticationPassword (SecureString)
The VRRP Authentication password.
ClientIdleTimeout (uint)
The client inactivity timeout.
GatewayConnectionTimeout (uint)
The Gateway connection timeout.
ClientQueueTimeout (uint)
The client queue timeout.
GatewayIdleTimeout (uint)
The Gateway inactivity timeout.
SessionRate (uint)
The amount of TCP connections per second.
GatewayHealthCheckIntervals (uint)
The Gateway Health check intervals in seconds.
VRRPVirtualRouterID (uint)
The Virtual Router ID of HALB Virtual Server (if not set, the router ID will be automatically computed).
VRRPBroadcastInterval (uint)
The VRRP broadcast interval in minutes.
VRRPHealthScriptCheckInterval (uint)
The VRRP health script check interval in seconds.
VRRPHealthScriptCheckTimeout (uint)
The VRRP health script check timeout in seconds.
VRRPAdvertisementInterval (uint)
The VRRP Advertisement interval in seconds.
KeepLBProxyConfig (bool)
Enable/Disable keeping of existing loadbalancing settings.
KeepVRRPConfig (bool)
Enable/Disable keeping of existing VRRP/keepalive settings.
LBGateways (List`1)
The list of the Non-SSL Gateways for HALB Virtual Server.
LBGatewayPort (uint)
The Non-SSL Gateway port.
SSLMode
(LoadBalancingSSLMode) The SSL Mode to use for SSL Gateways.
Possible values: SSLOffloading, SSLPassthrough
LBSSLGateways (List`1)
The list of the SSL Gateways for HALB Virtual Server.
LBSSLGatewayPort (uint)
The SSL Gateway port.
AcceptedSSLVersion
(AcceptedSSLVersion) The SSL version to be used for the SSL Gateways.
Possible values: TLSv1, TLSv1_1, TLSv1_2, TLSv1_3
CipherStrength (CipherStrength)
The Cipher strength to be used for the SSL Gateways.
Possible values: Low, Medium, High, Custom
CipherPreference (bool)
Enable or disable 'Use ciphers according to server preference'.
SSLCustomCipher (string)
The SSL custom cipher for SSL Gateways.
CertificateID (uint)
The certificate ID.
DeviceManagerGateways (List`1)
The list of the Device Management Gateways for HALB Virtual Server.
(CommonParameters)
INPUTS
OUTPUTS
-none-
EXAMPLES
---------- EXAMPLE 1 ----------
Set-RASHALB -Id 1 -NewName "HALB-VS" -VirtualIPv4 "1.2.3.4" -SubnetMask "255.255.255.0"
Update the HALB Virtual Server settings by ID. ---------- EXAMPLE 2 ----------
Set-RASHALB -Name "HALB" -NewName "HALB-VS" -IPVersion Version6 -VirtualIPv6 "1.2.3.4" -PrefixIPV6 64
Update the HALB Virtual Server settings by name.
RELATED LINKS
Last updated