
Create an alert event with error logs attached, which aid in troubleshooting customer issues and sends it to ConnectEMC
source | The service from which this API is invoked. Allowed values: CONTROLLER, OBJECT Default: CONTROLLER |
event_id | Event id for these alerts Allowed values: 999, 599 Default: 999 |
node_id | The ids of the nodes for which log data is collected. Allowed values: standalone,syssvc-node1,syssvc-node2 etc |
node_name | The names of the nodes for which log data is collected. Allowed values: Current values of node_x_name properties |
log_name | The names of the log files to process. |
severity | The minimum severity level for a logged message. Allowed values:0-9. Default value: 7 |
start | The start datetime of the desired time window. Value is inclusive. Allowed values: "yyyy-MM-dd_HH:mm:ss" formatted date or datetime in ms. If not specified, it will start with the oldest messages first. |
end | The end datetime of the desired time window. Value is inclusive. Allowed values: "yyyy-MM-dd_HH:mm:ss" formatted date or datetime in ms. If not specified, will continue until the latest log is retrieved, or the maxCount limit is met. |
msg_regex | A regular expression to which the log message conforms. |
maxcount | Maximum number of log messages to retrieve. This may return more than max count, if there are more messages with same timestamp as of the latest message. Value should be greater than 0. |
forceAttachLogs | If true, the connectemc alert is always sent out with logs attached. If the log size exceeds the max attachment size specified in logsvc.properties, the connectemc alert will not be sent. If false, the connectemc alert is sent regardless of the log size. If the log size exceeds the max attachment size, the alert is sent out without the log attachment. By default, this parameter is false. |
force | If 1, will run multiple requests at same time. |
Requires one of the following roles:
These conditions must be met before calling this operation.
All parameters are required unless otherwise stated.
Field | Description | Type | Notes |
<event_create> | |||
<user_str> | String | ||
<contact> | String | ||
</event_create> |
This is an asychronous operation that returns a task object. For information on working with tasks, see Asynchronous Operations.
Field | Description | Type | Notes |
<task> | |||
<op_id> | The task operation id | String | |
<resource> | |||
<name> | The name of the resource | String | |
<id> | ViPR ID of the related object | URI | |
<link> | A hyperlink to the related object | ||
</resource> | |||
<tenant> | |||
<id> | ViPR ID of the related object | URI | |
<link> | A hyperlink to the related object | ||
</tenant> | |||
<associated_resources> | A list of links for associated resources | ||
<associated_resource> |
0-* Elements |
||
<name> | The name of the resource | String | |
<id> | ViPR ID of the related object | URI | |
<link> | A hyperlink to the related object | ||
</associated_resource> | |||
</associated_resources> | |||
<state> | The state of the task Valid values: queued = task is queued pending = task is pending ready = task succeed error = task fails suspended_error = task is suspended due to an error suspended_no_error = task is suspended due to config/request | String | |
<allowed_operations> | The allowed operations of the task | String | |
<message> | The task detail message | String | |
<description> | The description of the task | String | |
<service_error> | |||
<code> | The numerical code associated with the error encountered when processing a service request | Integer | |
<description> | The description of the error | String | |
<details> | Detailed information concerning the error | String | |
</service_error> | |||
<start_time> | The date and time of when the task was started | DateTime | |
<end_time> | The date and time of when the task ended | DateTime | |
<progress> | Integer | ||
<workflow> | |||
<id> | ViPR ID of the related object | URI | |
<link> | A hyperlink to the related object | ||
</workflow> | |||
<queuedStartTime> | DateTime | ||
<queueName> | String | ||
<name> | The name assigned to this resource in ViPR. The resource name is set by a user and can be changed at any time. It is not a unique identifier. | String | |
<id> | An identifier that is generated by ViPR when the resource is created. The resource ID is guaranteed to be unique and immutable across all virtual data centers for all time. | URI | |
<link> | A hyperlink to the details for this resource | ||
<creation_time> | A timestamp that shows when this resource was created in ViPR | DateTime | |
<tags> | Keywords and labels that can be added by a user to a resource to make it easy to find when doing a search. | ||
<tag> | String |
0-* Elements |
|
</tags> | |||
<inactive> | Whether or not the resource is inactive. When a user removes a resource, the resource is put in this state before it is removed from the ViPR database. | Boolean | |
<global> | Boolean | ||
<remote> | Boolean | ||
<vdc> | |||
<id> | ViPR ID of the related object | URI | |
<link> | A hyperlink to the related object | ||
</vdc> | |||
<internal> | Whether or not the resource is an internal resource. | Boolean | |
</task> |