Records
Realm Operations
Service for creating records.
Resource path:
/records
Resource version: 1.0
start
Starts recording.
Usage
am> action Records --realm Realm --body body --actionName start
Parameters
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "description" : "The properties of a Record, which can deserialized from json.", "type" : "object", "title" : "Record properties", "properties" : { "issueID" : { "description" : "A case number is a good choice for the issueID value.", "title" : "Issue ID", "type" : "integer", "format" : "int64" }, "referenceID" : { "description" : "A second identifier to segregate multiple recording events for the same issue.", "title" : "Reference ID", "type" : "string" }, "description" : { "description" : "A textual description of the recording event.", "title" : "Description", "type" : "string" }, "threadDump" : { "description" : "Object used to specify thread dump settings.", "title" : "Thread dump settings", "type" : "object", "properties" : { "enable" : { "description" : "Whether to dump threads during the recording event.", "title" : "Thread dump enabled", "type" : "boolean" }, "delay" : { "description" : "Object used to specify an interval at which thread dumps are taken. The initial thread dump is taken at the start of the recording event; subsequent thread dumps are taken at multiples of the delay interval.", "title" : "Thread dump delay", "type" : "object", "properties" : { "timeUnit" : { "description" : "The time unit being used to specify the delay for the thread dumps.", "title" : "Thread dump delay time unit", "type" : "string", "enum" : [ "DAYS", "HOURS", "MINUTES", "SECONDS", "MILLISECONDS", "MICROSECONDS", "NANOSECONDS" ] }, "value" : { "description" : "The value for the thread dump delay, in the specified thread dump delay time unit. The initial thread dump is taken at the start of the recording event; subsequent thread dumps are taken at multiples of the delay interval.", "title" : "Thread dump delay value", "type" : "integer", "format" : "int64" } } } } }, "configExport" : { "description" : "Configuration Export properties.", "title" : "Configuration export properties", "type" : "object", "properties" : { "enable" : { "description" : "Whether to export the OpenAM configuration upon completion of the recording event.", "title" : "Config export enabled", "type" : "boolean" }, "password" : { "description" : "A key required to import the exported configuration.", "title" : "Config export password", "type" : "string" }, "sharePassword" : { "description" : "Whether to show the password value in the ssoadm start-recording, ssoadm get-recording-status, ssoadm stop-recording output and in the info.json file.", "title" : "Config export share password enabled", "type" : "boolean" } } }, "debugLogs" : { "description" : "The debug level settings for the recording event.", "title" : "Debug level settings", "type" : "object", "properties" : { "debugLevel" : { "description" : "The debug level to set for the recording event.", "title" : "Debug level", "type" : "string", "enum" : [ "OFF", "ERROR", "WARNING", "MESSAGE", "ON" ] }, "autoStop" : { "description" : "Used to specify an event that automatically ends a recording period. For time-based termination, specify a time object; for termination based on uncompressed file size, specify a fileSize object. If you specify both time and fileSize objects, the event that occurs first causes recording to stop.", "title" : "Auto stop configuration", "type" : "object", "properties" : { "time" : { "description" : "Auto stop time based settings.", "title" : "Auto stop time configuration", "type" : "object", "properties" : { "timeUnit" : { "description" : "The time unit that the auto stop time will be measured in, e.g. MINUTES.", "title" : "Auto stop time unit", "type" : "string", "enum" : [ "DAYS", "HOURS", "MINUTES", "SECONDS", "MILLISECONDS", "MICROSECONDS", "NANOSECONDS" ] }, "value" : { "description" : "The time value for auto stop.", "title" : "Auto stop time value", "type" : "integer", "format" : "int64" } } }, "fileSize" : { "description" : "Configures a recording period to terminate after the aggregate size of uncompressed debug logs has reached this size.", "title" : "Auto stop file size configuration", "type" : "object", "properties" : { "sizeUnit" : { "description" : "The size unit that the auto stop will be measured in, e.g. GB.", "title" : "Auto stop file size measurement unit", "type" : "string", "enum" : [ "GB", "MB", "KB", "B" ] }, "value" : { "description" : "The size value after which auto stop will occur", "title" : "Auto stop file size value", "type" : "integer", "format" : "int64" } } } } } } }, "zipEnable" : { "description" : "Whether to compress the output directory into a zip file when recording has stopped.", "title" : "Zip enabled", "type" : "boolean" } } }