< Back

Set-VMHostSysLogServer

Sun Jan 19, 2020 7:12 pm

NAME Set-VMHostSysLogServer



SYNOPSIS

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





SYNTAX

Set-VMHostSysLogServer [[-SysLogServer] <NamedIPEndPoint[]>] [-VMHost] <VMHost[]> [-Server <VIServer[]>]

[-SysLogServerPort <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

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





PARAMETERS

-Server <VIServer[]>

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.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? true



-SysLogServer <NamedIPEndPoint[]>

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:192.168.0.1:80, 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 192.168.0.1 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.



Required? false

Position? 1

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-SysLogServerPort <Int32>

Specifies 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.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-VMHost <VMHost[]>

Specifies the host whose syslog servers you want to configure.



Required? true

Position? 2

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? true



-Confirm [<SwitchParameter>]

If 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.



Required? false

Position? named

Default value $true

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are

modified.



Required? false

Position? named

Default value False

Accept pipeline input? False

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



OUTPUTS

The modified NamedIPEndPoint object







NOTES









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



Set-VMHostSysLogServer -SysLogServer '192.168.0.1:133' -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.



RELATED LINKS

Online Version: https://code.vmware.com/doc/preview?id= ... erver.html

Get-VMHostSysLogServer