Set-VMHostSysLogServer

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

Syntax

[-VMHost]  <VMHost[]>
[-Server  <VIServer[]>]
[-SysLogServer  <NamedIPEndPoint[]>]
[-SysLogServerPort  <Int32>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
VMHost
VMHost[] 1
  • wildcards
  • pipeline
  • Specifies the host whose syslog servers you want to configure.
    optional
    Server
    VIServer[] named
  • wildcards
  • Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.
    optional
    SysLogServer
    NamedIPEndPoint[] named
  • pipeline
  • 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.
    optional
    SysLogServerPort
    Int32 named 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.

    Output

    VMware.VimAutomation.ViCore.Types.V1.NamedIPEndPoint

    Examples


    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 Commands

    Feedback

    Was this page helpful?