powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Set-VMHostSysLogServer



NAME
Set-VMHostSysLogServer

SYNOPSIS
Configures the remote syslog server of the specified hosts.

SYNTAX
Set-VMHostSysLogServer [[-SysLogServer] ] [-VMHost] [-SysLogServerPort ] [-Serve
r ] [-WhatIf] [-Confirm] []


DESCRIPTION
Configures the remote syslog server of the specified hosts.


PARAMETERS
-SysLogServer
Specify the sys log servers you want to configure. The parameter takes objects of the NamedIPEndPoint, IPEndPoi
nt, IPAddress, and String types.
The accepted formats, if string is used, are DNS names and the standard IPv6/IPv4 format: FFFF:FFFF:FFFF:FFFF:F
FFF: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. T
he 192.168.0.1 part is mandatory and can be any address in the IPv4 format. The :80 part is optional. If omitte
d, the port must be specified through the SysLogServerPort parameter. If Syslog is set to null, then the config
ured syslog server, if any, is removed.

Required? false
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false

-VMHost
Specify the host whose syslog servers you want to configure.

Required? true
Position? 2
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? true

-SysLogServerPort
Specify the sys log server port. Must be specified if the string that is passed to the SysLogServer parameter d
oes not contain the port value, or the argument of the SysLogServer is an IP address.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Server
Specify the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the co
mmand runs on the default servers. For more information about default servers, see the description of Connect-V
IServer.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? true

-WhatIf
Indicate that the cmdlet is run only to display the changes that would be made and actually no objects are modi
fied.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Confirm
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


This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS



OUTPUTS
NamedIPEndPoint


NOTES




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

C:\PS>Set-VMHostSysLogServer -SysLogServer '192.168.0.1:133' -VMHost Host


Sets a SysLog server on the Host virtual machine host.





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

C:\PS>Set-VMHostSysLogServer -SysLogServer $null -VMHost Host


Removes the SysLog server from the Host virtual machine host.






RELATED LINKS
Online version: http://www.vmware.com/support/developer/PowerCLI/PowerCLI501/html/Set-VMHostSysLogServer.html
Get-VMHostSysLogServer