Getting information about the transfer destinations of audit log files

REST API Reference Guide for Virtual Storage Platform 5000, Virtual Storage Platform E Series, and Virtual Storage Platform G/F Series

Version
93-07-0x
90-09-0x
88-08-10
Audience
anonymous
Part Number
MK-98RD9014-17
The following request gets information, specified for a storage system, about the settings related to the transfer of audit log files to the syslog servers.

For a list of storage systems that support this API, see Overview of the initial settings of a storage system.

Execution permission

Audit Log Administrator (View Only)

Request line

GET base-URL/v1/objects/auditlog-syslog-servers/instance

Request message

Object ID

Specify instance.

If an object has only one instance, the instance is the fixed value that specifies the object ID.

Query parameters

None.

Body

None.

Response message

Body
{
  "transferProtocol": "TLS",
  "locationName": "886000123456",
  "retries": true,
  "retryInterval": 30,
  "isDetailed": true,
  "primarySyslogServer": {
    "isEnabled": true,
    "ipAddress": "192.0.1.100",
    "port": 12345
  },
  "secondarySyslogServer": {
    "isEnabled": true,
    "ipAddress": "192.0.1.200",
    "port": 12345
  }
}

Attribute

Type

Description

transferProtocol

string

Protocol to be used when transferring audit log files to the syslog servers

  • TLS: TLS1.2/RFC5424
  • UDP: UDP/RFC3164

If the transfer destination of audit log files has not been set, undefined will be output for VSP 5000 series storage systems, but UDP will be output for VSP E series, VSP G350, G370, G700, G900 , VSP F350, F370, F700, F900 storage systems.

locationName

string

Name of the storage system from which audit log files are to be transferred

retries

boolean

Specifies whether to try again if communication with a syslog server fails

This attribute is displayed if the transferProtocol attribute is TLS.
  • true: Tries again
  • false: Does not try again

retryInterval

int

Retry interval (in seconds) when communication with a syslog server fails

This attribute is displayed if the retries attribute is true.

isDetailed

boolean

Specifies whether to transfer detailed information about audit log files to the syslog servers
  • true: Transfers detailed information
  • false: Does not transfer detailed information

primarySyslogServer

object

Settings of the primary-site syslog server

The following information about the primary-site syslog server is displayed:
  • isEnabled (boolean)

    Whether audit log files are transferred to the syslog server

    • true: Audit log files are transferred to the syslog server
    • false: Audit log files are not transferred to the syslog server
  • ipAddress (string)

    IP address or host name of the server

    This is displayed when the value of the isEnabled attribute is true.

  • port (int)

    Port number

    This is displayed when the value of the isEnabled attribute is true.

secondarySyslogServer

object

Settings of the secondary-site syslog server

The following information about the secondary-site syslog server is displayed:
  • isEnabled (boolean)

    Whether audit log files are transferred to the syslog server

    • true: Audit log files are transferred to the syslog server
    • false: Audit log files are not transferred to the syslog server
  • ipAddress (string)

    IP address or host name of the server

    This is displayed when the value of the isEnabled attribute is true.

  • port (int)

    Port number

    This is displayed when the value of the isEnabled attribute is true.

Status codes

For details on the status codes of the request for this operation, see the description of HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/auditlog-syslog-servers/instance