Skip to main content

Syslog Remote Log Settings

Table 1. Syslog remote log settings properties

Field

Type

Read only

Description

Status

String

False

Status for remote syslog:

  • enable

  • disable

PortType

String

False

Port type allowed for remote syslog:

  • UDP

  • TCP

HostName

String

False

Host name of remote log server. Server address support the following:

  • IP Address (Both Ipv4 and Ipv6 format)

  • FQDN (Fully qualified domain name) format

PortNumber

Number

False

Port number of remote log server

Request​

Get Syslog Remote Log Settings

GET https://{{ip}}/redfish/v1/Managers/Self/LogServices/Oem/Lenovo/Syslog
Content-Type: application/json

Response​

{
    "@odata.context": "/redfish/v1/$metadata#LenovoSyslog.LenovoSyslog",
    "@odata.etag": "\"1579438309\"",
    "@odata.id": "/redfish/v1/Managers/Self/LogServices/Oem/Lenovo/Syslog",
    "@odata.type": "#LenovoSyslog.LenovoSyslog",
    "HostName": "none",
    "Id": "Syslog",
    "Name": "LogService Syslog Settings",
    "PortNumber": 0,
    "PortType": "none",
    "Status": "disable"
}

Request​

Change Syslog Remote Log Settings

PATCH https://{{ip}}/redfish/v1/Managers/Self/LogServices/Oem/Lenovo/Syslog
Content-Type: application/json

Request body​

Disable remote syslog:

{
    "Status": "disable"
}

Enable remote syslog:

{
    "Status": "enable",
    "PortType": "UDP",
    "HostName": "remote.log.com",
    "PortNumber": 514
}

Response code​

The response content is 204 accepted with no body.

Note
If entering port number 0, it will set port number as default. The default port number is 514.