Cliauditlog: GET

Gets the list of GPFS audit events.

Availability

Available on all IBM Storage Scale editions.

Description

The GET cliauditlog request gets a record of various actions that are performed in the system. This helps the system administrator to audit the commands and tasks the users and administrators are performing. These logs can also be used to troubleshoot issues that are reported in the system. For more information about the fields in the data structures that are returned, see mmaudit command.

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v2/cliauditlog
where
cliauditlog
Specifies that the GET request fetches the audit details of the various actions that are performed in the cluster.

Request headers

Content-Type: application/json
Accept: application/json

Parameters

The following parameters can be used in the request URL to customize the request:
Table 1. List of parameters
Parameter name Description and applicable keywords Required/optional
fields Comma separated list of fields to be included in response. ':all:' selects all available fields. Optional.
filter Filter objects by expression. For example, 'status=HEALTHY,entityType=FILESET' Optional.

Request data

No request data.

Response data

The following list of attributes are available in the response data:

{      
"status":
   {
      "code": ReturnCode
      "message": "ReturnMessage",   
   },
"paging":
   {
      "next": Next page URL
      "fields": "Fields",  
      "filter": Filter
      "baseUrl": "URL", 
      "lastID": ID
      ,  
   },
{
   "auditLogRecords": [
      {
         "oid": "ID"
         "arguments": "Arguments"
         "command": "Commands"
         "node": "Nodes"
         "returnCode": "Return code"
         "originator": "Originator"
         "user": "User"
         "pid": "PID"
         "entryTime": "Entry time"
         "exitTime": "Exit time"
        
       }
}
"status":
Return status.
"code": ReturnCode,
The HTTP status code that was returned by the request.
"message": "ReturnMessage"
The return message.
"paging":
An array of information about the paging information that is used for displaying the details.
"next": "Next page URL"
The URL to retrieve the next page. Paging is enabled when more than 1000 objects would be returned by the query.
"fields": "Fields in the request"
The fields that are used in the original request.
"filter": "Filters used in the request"
The filter that is used in the original request.
"baseUrl": "URL"
The URL of the request without any parameters.
"lastId": "ID"
The ID of the last element that can be used to retrieve the next elements.
"auditLogRecords":
An array of information that provides the action that is performed.
"oid": "ID"
ID used for paging.
"arguments": "Arguments"
Arguments of a GPFS command.
"command": "Command name"
Name of the GPFS command.
"node": "Node"
Name of the node where a GPFS command was running.
"returnCode": "Return code"
Return Code of the GPFS command.
"originator": "Originator"
Originator of the GPFS command.
"user": "User name"
The user who issued the GPFS command.
"pid": "ID"
PID of the GPFS command.
"entryTime": "Entry time"
Entry time of the GPFS command.
"exitTime": "Exit time"
Exit time of the GPFS command.

The return information and the information that the command retrieves are returned in the same way as they are for the other requests. The parameters that are returned are the same as the configuration attributes that are displayed by the mmaudit command. For more information, see the mmaudit command.

Examples

The following example gets information about the cluster configuration.

Request data: 
curl -k -u admin:admin001 -X GET --header 'accept:application/json' 
'https://198.51.100.1:443/scalemgmt/v2/cliauditlog'
Response data:
Note: In the JSON data that is returned, the return code indicates whether the command is successful. The response code 200 indicates that the command successfully retrieved the information. Error code 400 represents an invalid request and 500 represents internal server error.
The cliauditlog array provides information about the action that is performed on the cluster. 
{
  "status": {
    "code": 200,
    "message": "..."
  },
  "paging": {
    "next": "https://localhost:443/scalemgmt/v2/filesystems/gpfs0/filesets?lastId=10001",
    "fields": "period,restrict,sensorName",
    "filter": "usedInodes>100,maxInodes>1024",
    "baseUrl": "/scalemgmt/v2/perfmon/sensor/config",
    "lastId": 10001
  },
  "auditLogRecords": [
    {
      "oid": 0,
      "arguments": "-A yes -D nfs4 -k nfs4",
      "command": "mmchfs",
      "node": "testnode-11",
      "returnCode": 0,
      "originator": "GUI",
      "user": "root",
      "pid": 7891,
      "entryTime": "2017-07-30 14:00:00",
      "exitTime": "2017-07-31 18:00:00"
    }
  ]
}