Collect audit logs from registered manager nodes

This API is executed on a manager node to display audit logs from all nodes
inside the management plane cluster. An audit log collection will be
triggered if the local master audit log is outdated.

Request:

Method:

POST

URI Path(s):

/api/v1/administration/audit-logs

Request Headers:

n/a

Query Parameters:

AuditLogQueryParameters+

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page) A log cursor points to a specific line number in the master audit log	integer
fields	Fields to include in query results Comma-separated field names to include in query result	string
page_size	Maximum number of results to return in this page (server may return fewer) The page size determines the number of logs to be returned	integer	Minimum: 0 Maximum: 100 Default: "100"

Request Body:

AuditLogRequest+

Name	Description	Type	Notes
log_age_limit	Include logs with timstamps not past the age limit in days	integer	Minimum: 0
log_filter	Audit logs should meet the filter condition	string
log_filter_type	Type of log filter	string	Enum: TEXT, REGEX Default: "TEXT"

Example Request:

POST https://<nsx-mgr>/api/v1/administration/audit-logs?page_size=1 { "log_age_limit": 1, "log_filter": "", "log_filter_type": "TEXT" }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

AuditLogListResult+

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
last_full_sync_timestamp	Timestamp of the last full audit log collection	string	Required
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Audit log results	array of AuditLog	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "last_full_sync_timestamp": "2017-12-13T19:23:57.042633Z", "page_cursor": "1457", "result_count": 1, "results": [ { "appname": "NSX", "facility": 22, "full_log": "<182>1 2017-12-11T19:51:39.819Z junjiex-nsxmanager-sb-12479759-1-test7 NSX - SYSTEM [nsx@6876 audit=\"true\" comp=\"nsx-manager\" subcomp=\"manager\"] UserName:'admin@10.2.106.238', ModuleName:'ACCESS_CONTROL', Operation:'LOGIN', Operation status:'success'", "hostname": "junjiex-nsxmanager-sb-12479759-1-test7", "message": "UserName:'admin@10.2.106.238', ModuleName:'ACCESS_CONTROL', Operation:'LOGIN', Operation status:'success'", "msgid": "SYSTEM", "priority": 6, "procid": "-", "struct_data": { "audit": "true", "comp": "nsx-manager", "subcomp": "manager" }, "timestamp": "2017-12-11T19:51:39.819Z", "version": "1" } ] }

Collect audit logs from registered manager nodes

Request:

AuditLogQueryParameters (schema)

AuditLogRequest (schema)

Example Request:

Successful Response:

AuditLogListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: