PowerCLI Reference



This cmdlet configures the remote syslog server of the specified hosts.


Set-VMHostSysLogServer [[-SysLogServer] <NamedIPEndPoint[]>] [-VMHost] <VMHost[]> [-Server <VIServer[]>] [-SysLogServerPort <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]

Related Commands

Online Version

Detailed Description

This cmdlet configures the remote syslog server of the specified hosts.


NameTypeDescriptionRequired?Pipeline InputDefault Value
SysLogServerNamedIPEndPoint[]Specifies the sys log servers you want to configure. The parameter accepts objects of the NamedIPEndPoint, IPEndPoint, IPAddress, and String types. The accepted formats, if string is used, are DNS names and the standard IPv6/IPv4 format: FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:, where the FFFF:FFFF:FFFF:FFFF:FFFF:FFFF can be replaced by any hex value with the same structure (both upper or lower case). It is only meaningful in case of IPv6 address and is omitted for IPv4. The part is mandatory and can be any address in the IPv4 format. The :80 part is optional. If omitted, the port must be specified through the SysLogServerPort parameter. If Syslog is set to $null, the configured syslog server, if any, is removed.falseTrue (ByValue)
VMHostVMHost[]Specifies the host whose syslog servers you want to configure.trueTrue (ByValue)
ConfirmSwitchParameterIf the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.falseFalse
ServerVIServer[]Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.falseFalse
SysLogServerPortInt32Specifies the sys log server port. Must be specified if the string that is passed to the SysLogServer parameter does not contain the port value, or the argument of the SysLogServer is an IP address.falseFalse
WhatIfSwitchParameterIndicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falseFalse

Return Type

The modified NamedIPEndPoint object



-------------------------- Example 1 --------------------------

Set-VMHostSysLogServer -SysLogServer '' -VMHost Host

Sets a SysLog server on the Host virtual machine host.

-------------------------- Example 2 --------------------------

Set-VMHostSysLogServer -SysLogServer $null -VMHost Host

Removes the SysLog server from the Host virtual machine host.

Copyright © VMware, Inc. All rights reserved.