com.emc.vipr.client.system

Class CallHome

java.lang.Object

com.emc.vipr.client.system.CallHome

public class CallHome
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
CallHome(RestClient client)

Method Summary

Modifier and Type	Method and Description
Device	getNodeDataForEsrs() Retrieve virtual machine information required for ESRS setup.
TaskResourceRep	sendAlert(java.lang.String source, java.lang.Integer eventId, java.util.List<java.lang.String> nodeIds, java.util.List<java.lang.String> logNames, java.lang.Integer severity, java.lang.String start, java.lang.String end, java.lang.String msgRegex, java.lang.Integer maxCount, boolean multipleRequests, EventParameters eventParameters) Deprecated. Replaced by
TaskResourceRep	sendAlert(java.lang.String source, java.lang.Integer eventId, java.util.List<java.lang.String> nodeIds, java.util.List<java.lang.String> nodeNames, java.util.List<java.lang.String> logNames, java.lang.Integer severity, java.lang.String start, java.lang.String end, java.lang.String msgRegex, java.lang.Integer maxCount, boolean multipleRequests, EventParameters eventParameters) Create an alert event with error logs attached, which aid in troubleshooting customer issues and sends it to ConnectEMC.
TaskResourceRep	sendAlert(java.lang.String start, java.lang.String end, EventParameters eventParameters) Create an alert event with error logs attached, which aid in troubleshooting customer issues and sends it to ConnectEMC.
void	sendHeartbeatEvent() Send a heartbeat event to ConnectEMC with configuration properties.
void	sendRegistrationEvent() Send a registration event to ConnectEMC with configuration properties

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CallHome

public CallHome(RestClient client)

Method Detail

sendRegistrationEvent

public void sendRegistrationEvent()

Send a registration event to ConnectEMC with configuration properties

API Call: POST /callhome/registration

sendHeartbeatEvent

public void sendHeartbeatEvent()

Send a heartbeat event to ConnectEMC with configuration properties.

API Call: POST /callhome/registration

sendAlert

public TaskResourceRep sendAlert(java.lang.String start,
                                 java.lang.String end,
                                 EventParameters eventParameters)

Create an alert event with error logs attached, which aid in troubleshooting customer issues and sends it to ConnectEMC. Convienence method that takes fewer parameters.

API Call: POST /callhome/alert

Parameters:

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. Default: Set to yesterday same time

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.

eventParameters - The event parameters

Returns:

The system service task

sendAlert

@Deprecated
public TaskResourceRep sendAlert(java.lang.String source,
                                              java.lang.Integer eventId,
                                              java.util.List<java.lang.String> nodeIds,
                                              java.util.List<java.lang.String> logNames,
                                              java.lang.Integer severity,
                                              java.lang.String start,
                                              java.lang.String end,
                                              java.lang.String msgRegex,
                                              java.lang.Integer maxCount,
                                              boolean multipleRequests,
                                              EventParameters eventParameters)

Deprecated. Replaced by

Create an alert event with error logs attached, which aid in troubleshooting customer issues and sends it to ConnectEMC.

API Call: POST /callhome/alert

Parameters:

source - The service from which this API is invoked. Allowed values: CONTROLLER, OBJECT Default: CONTROLLER

eventId - Event id for these alerts Allowed values: 999, 599 Default: 999

nodeIds - The ids of the nodes for which log data is collected. Allowed values: standalone,syssvc-node1,syssvc-node2 etc

logNames - 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. Default: Set to yesterday same time

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.

msgRegex - 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.

multipleRequests - If true, will run multiple requests at same time.

eventParameters - The event parameters

Returns:

The system service task

See Also:

sendAlert(String, Integer, List, List, List, Integer, String, String, String, Integer, boolean, EventParameters)

sendAlert

public TaskResourceRep sendAlert(java.lang.String source,
                                 java.lang.Integer eventId,
                                 java.util.List<java.lang.String> nodeIds,
                                 java.util.List<java.lang.String> nodeNames,
                                 java.util.List<java.lang.String> logNames,
                                 java.lang.Integer severity,
                                 java.lang.String start,
                                 java.lang.String end,
                                 java.lang.String msgRegex,
                                 java.lang.Integer maxCount,
                                 boolean multipleRequests,
                                 EventParameters eventParameters)

Create an alert event with error logs attached, which aid in troubleshooting customer issues and sends it to ConnectEMC.

API Call: POST /callhome/alert

Parameters:

source - The service from which this API is invoked. Allowed values: CONTROLLER, OBJECT Default: CONTROLLER

eventId - Event id for these alerts Allowed values: 999, 599 Default: 999

nodeIds - The ids of the nodes for which log data is collected. Allowed values: standalone,syssvc-node1,syssvc-node2 etc

nodeNames - The names of the nodes for which log data is collected. Allowed values: Current values of node_x_name properties

logNames - 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. Default: Set to yesterday same time

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.

msgRegex - 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.

multipleRequests - If true, will run multiple requests at same time.

eventParameters - The event parameters

Returns:

The system service task

getNodeDataForEsrs

public Device getNodeDataForEsrs()

Retrieve virtual machine information required for ESRS setup.

API Call: GET /callhome/esrs-device

Returns:

Device information