Field Type Description. Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Alarm — Get alarm by rule ID • Description: Filter out alarms by a rule ID. Time range is the default value set in the Management Server, and you can customize the time range using the startTimeMS and durationMS parameter. status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Alarm — Get current alarms Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Alarm — Get history alarms status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Alarm — Get topology object current alarms Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Alarm — Get topology object history alarms status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Alarm — Push alarms • Description: Push an alarm to an existing topology object, and the imported alarm will show on the Alarm dashboard. The “topologyObjectId” field is mandatory and the "ruleId" field is optional. This API set the value of “ruleId” to ExternalAlarm by default, if this field is not set. If you invoke this API using both fields, ensure that ruleId is properly defined to link with its topologyObjectId; otherwise the alarm might be imported into a wrong topology object. Consider for example a rule “CPU Utilization” is related to the "HostCPUs" object. If you define topologyObjectId to Host, this API imports CPU Utilization to the Host object. Postman provides "Alarm - Push Alarm XML" and "Alarm - Push Alarm JSON” sample codes for reference. Click here to download and import the sample codes. • Sample usage: When using the pushAlarm API, note the following: ▪ Make sure to use the following as the value of alarmMessage: AAA. BBB. AAA represents the title of the alarm dialog box, while BBB stands for the alarm message. Make sure to add a space between “.” and “BBB”. ▪ To get the value of ruleId, do either of the following: ▫ Invoke the Rule — Get all rules’ data API. ▫ Execute the following scripts in the Administration > Tooling > Script Console dashboard: def ruleName = <RULE_NAME> def rule = server.RuleService.getAllRules().find{ xx.xxxx == ruleName } if(rule){ return xxxx.xx; }else{ return "Rule not found." } Request body in XML: <externalAlarmParamBean> <alarmMessage>title of alarm dialog. alarm message</alarmMessage> <severity>3</severity> <topologyObjectId>94e27d92-08a5-4c28-9a90-8856a7689105</topologyObjectId> 2 Warning 3 Critical 4 Fatal
Appears in 1 contract
Samples: Software License Agreement
Field Type Description. Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Alarm — Get alarm by rule ID • Description: Filter out alarms by a rule ID. Time range is the default value set in the Management Server, and you can customize the time range using the startTimeMS and durationMS parameter. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Alarm — Get current alarms Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Alarm — Get history alarms Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Alarm — Get topology object current alarms Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Alarm — Get topology object history alarms Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Alarm — Push alarms • Description: Push an alarm to an existing topology object, and the imported alarm will show on the Alarm dashboard. The “topologyObjectId” field is mandatory and the "ruleId" field is optional. This API set the value of “ruleId” to ExternalAlarm by default, if this field is not set. If you invoke this API using both fields, ensure that ruleId is properly defined to link with its topologyObjectId; otherwise the alarm might be imported into a wrong topology object. Consider for example a rule “CPU Utilization” is related to the "HostCPUs" object. If you define topologyObjectId to Host, this API imports CPU Utilization to the Host object. Postman provides "Alarm - Push Alarm XML" and "Alarm - Push Alarm JSON” sample codes for reference. Click here to download and import the sample codes. • Sample usage: When using the pushAlarm API, note the following: ▪ Make sure to use the following as the value of alarmMessage: AAA. BBB. AAA represents the title of the alarm dialog box, while BBB stands for the alarm message. Make sure to add a space between “.” and “BBB”. ▪ To get the value of ruleId, do either of the following: ▫ Invoke the Rule — Get all rules’ data API. ▫ Execute the following scripts in the Administration > Tooling > Script Console dashboard: def ruleName = <RULE_NAME> def rule = server.RuleService.getAllRules().find{ xx.xxxx == ruleName } if(rule){ return xxxx.xx; }else{ return "Rule not found." } The following illustrates the sample code of request body in XML and JSON separately. Request body in XML: <externalAlarmParamBean> <alarmMessage>> title of alarm dialog. alarm message</alarmMessagemessage </alarmMessage> <severity>3</severity/topologyObjectId> <topologyObjectId>94e27d92ruleId> c83632ae-3468-4ac1-bd69-523595e18750 </ruleId> </externalAlarmParamBean> Request body in JSON {"alarmMessage":"title of alarm dialog. alarm message”, "severity":"2", "topologyObjectId":"94e27d92-08a5-4c28-9a90-8856a7689105</topologyObjectId> 2 Warning 3 Critical 4 Fatal8856a7689105"}
Appears in 1 contract
Samples: Software License Agreement
Field Type Description. Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. Content- Type String • Data format = JSON, this value is application/json”. status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Cartridge The Cartridge related APIs include the following: • Cartridge — Get all cartridges’ data • Cartridge — Get all core cartridges’ data • Cartridge — Get all non-core cartridges’ data Cartridge — Get all cartridges’ data Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Cartridge — Get all core cartridges’ data Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. status String The response status. data String Either the response data format (JSON/XML) exception message. error String Error code if some exception occurs; otherwise this field is not shown. Cartridge — Get all non-core cartridges’ data Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Registry • Registry — Get all registries’ data Registry — Get all registries’ data Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Alarm Remote client The Remote related API includes the following: • Remote client — Get alarm by rule ID all remote clients’ data • DescriptionAPI Name: Filter out alarms by a rule ID. Time range is the default value set in the Management Server, and you can customize the time range using the startTimeMS and durationMS parameter. status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Alarm — Get current alarms all remote clients’ data Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Alarm Rule The Rule related APIs include the following: • Rule — Get history alarms status all rules’ data • Rule — Get rule by id Rule — Get all rules’ data Access- Token String The response statustoken is retrieved after successfully logging in to the Management Server. data Accept String Either Specifies the response data format (JSONwhich can be either application/XML) json or exception messageapplication/xml. The default value is application/json. error String Error code if some exception occurs; otherwise this field is not shown. Alarm Rule — Get topology object current alarms rule by id Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Alarm shown Script The Script related API includes the following: • Script — Get topology object history alarms status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Alarm Run Script • Script — Push alarms Publish custom REST API Script — Run Script • Description: Push an alarm You need be granted both the Administrator and API Access roles to an existing topology object, and the imported alarm will show on the Alarm dashboard. The “topologyObjectId” field is mandatory and the "ruleId" field is optionaluse this API. This API set the value of “ruleId” to ExternalAlarm by default, if this field is not set. If you invoke this API using both fields, ensure that ruleId is properly defined to link with its topologyObjectId; otherwise the alarm might be imported into a wrong topology object. Consider for example a rule “CPU Utilization” is related similar to the "HostCPUs" object. If you define topologyObjectId to Hostscript console, this API imports CPU Utilization to the Host object. Postman provides "Alarm - Push Alarm XML" but it does not support functionHelper, log, and "Alarm - Push Alarm JSON” sample codes for reference. Click here to download and import the sample codes. • Sample usage: When using the pushAlarm API, note the following: ▪ Make sure to use the following as the value of alarmMessage: AAA. BBB. AAA represents the title of the alarm dialog box, while BBB stands for the alarm message. Make sure to add a space between “.” and “BBB”. ▪ To get the value of ruleId, do either of the following: ▫ Invoke the Rule — Get all rules’ data API. ▫ Execute the following scripts out variables that are supported in the Administration > Tooling > Script Console dashboard: def ruleName = <RULE_NAME> def rule = serverscript console. script The script content.RuleService.getAllRules().find{ xx.xxxx == ruleName } if(rule){ return xxxx.xx; }else{ return "Rule not found." } Request body in XML: <externalAlarmParamBean> <alarmMessage>title of alarm dialog. alarm message</alarmMessage> <severity>3</severity> <topologyObjectId>94e27d92-08a5-4c28-9a90-8856a7689105</topologyObjectId> 2 Warning 3 Critical 4 Fatal
Appears in 1 contract
Samples: Software License Agreement
Field Type Description. Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Alarm — Get alarm by rule ID • Description: Filter out alarms by a rule ID. Time range is the default value set in the Management Server, and you can customize the time range using the startTimeMS and durationMS parameter. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Alarm — Get current alarms Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Alarm — Get history alarms Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Alarm — Get topology object current alarms Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Alarm — Get topology object history alarms Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Alarm — Push alarms • Description: Push an alarm to an existing topology object, and the imported alarm will show on the Alarm dashboard. The “topologyObjectId” field is mandatory and the "ruleId" field is optional. This API set the value of “ruleId” to ExternalAlarm by default, if this field is not set. If you invoke this API using both fields, ensure that ruleId is properly defined to link with its topologyObjectId; otherwise the alarm might be imported into a wrong topology object. Consider for example a rule “CPU Utilization” is related to the "HostCPUs" object. If you define topologyObjectId to Host, this API imports CPU Utilization to the Host object. Postman provides "Alarm - Push Alarm XML" and "Alarm - Push Alarm JSON” sample codes for reference. Click here to download and import the sample codes. • Sample usage: When using the pushAlarm API, note the following: ▪ Make sure to use the following as the value of alarmMessage: AAA. BBB. AAA represents the title of the alarm dialog box, while BBB stands for the alarm message. Make sure to add a space between “.” and “BBB”. ▪ To get the value of ruleId, do either of the following: ▫ Invoke the Rule — Get all rules’ data API. ▫ Execute the following scripts in the Administration > Tooling > Script Console dashboard: def ruleName = <RULE_NAME> def rule = server.RuleService.getAllRules().find{ xx.xxxx == ruleName } if(rule){ return xxxx.xx; }else{ return "Rule not found." } The following illustrates the sample code of request body in XML and JSON separately. Request body in XML: <externalAlarmParamBean> <alarmMessage>> title of alarm dialog. alarm message</alarmMessagemessage </alarmMessage> <severity>3</severityruleId> c83632ae-3468-4ac1-bd69-523595e18750 </ruleId> <topologyObjectId>94e27d92/externalAlarmParamBean> Request body in JSON {"alarmMessage":"title of alarm dialog. alarm message”, "severity":"2", "topologyObjectId":"94e27d92-08a5-4c28-9a90-8856a7689105</topologyObjectId> 8856a7689105"} 2 Warning 3 Critical 4 Fatal
Appears in 1 contract
Samples: Software License Agreement
Field Type Description. Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Alarm — Get alarm by rule ID • Description: Filter out alarms by a rule ID. Time range is the default value set in the Management Server, and you can customize the time range using the startTimeMS and durationMS parameter. status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Alarm — Get current alarms Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Alarm — Get history alarms status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Alarm — Get topology object current alarms Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Alarm — Get topology object history alarms status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Alarm — Push alarms • Description: Push an alarm to an existing topology object, and the imported alarm will show on the Alarm dashboard. The “topologyObjectId” field is mandatory and the "ruleId" field is optional. This API set the value of “ruleId” to ExternalAlarm by default, if this field is not set. If you invoke this API using both fields, ensure that ruleId is properly defined to link with its topologyObjectId; otherwise the alarm might be imported into a wrong topology object. Consider for example a rule “CPU Utilization” is related to the "HostCPUs" object. If you define topologyObjectId to Host, this API imports CPU Utilization to the Host object. Postman provides "Alarm - Push Alarm XML" and "Alarm - Push Alarm JSON” sample codes for reference. Click here to download and import the sample codes. • Sample usage: When using the pushAlarm API, note the following: ▪ Make sure to use the following as the value of alarmMessage: AAA. BBB. AAA represents the title of the alarm dialog box, while BBB stands for the alarm message. Make sure to add a space between “.” and “BBB”. ▪ To get the value of ruleId, do either of the following: ▫ Invoke the Rule — Get all rules’ data API. ▫ Execute the following scripts in the Administration > Tooling > Script Console dashboard: def ruleName = <RULE_NAME> def rule = server.RuleService.getAllRules().find{ xx.xxxx == ruleName } if(rule){ return xxxx.xx; }else{ return "Rule not found." } Request body in XML: <externalAlarmParamBean> <alarmMessage>title of alarm dialog. alarm message</alarmMessage> <severity>3</severity> <topologyObjectId>94e27d92-08a5-4c28-9a90-8856a7689105</topologyObjectId> 2 Warning 3 Critical 4 Fatal
Appears in 1 contract
Samples: Software License Agreement
Field Type Description. Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Alarm Cartridge — Get alarm by rule ID • Description: Filter out alarms by a rule ID. Time range all core cartridges’ data Access- Token String The token is the default value set retrieved after successfully logging in to the Management Server, and you . Accept String Specifies the response data format which can customize be either application/json or application/xml. The default value is application/json. status String The response status. data String Either the time range using the startTimeMS and durationMS parameterresponse data format (JSON/XML) exception message. error String Error code if some exception occurs; otherwise this field is not shown. Cartridge — Get all non-core cartridges’ data or application/xml. The default value is application/json. status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Alarm Registry • Registry — Get current alarms all registries’ data Registry — Get all registries’ data Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Alarm Remote client The Remote related API includes the following: • Remote client — Get history alarms status String The response status. all remote clients’ data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Alarm — • API Name: Get topology object current alarms all remote clients’ data Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Alarm Rule The Rule related APIs include the following: • Rule — Get topology object history alarms all rules’ data • Rule — Get rule by id Rule — Get all rules’ data Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Alarm Rule — Push alarms • Description: Push an alarm Get rule by id Access- Token String The token is retrieved after successfully logging in to an existing topology object, and the imported alarm will show on Management Server. Accept String Specifies the Alarm dashboardresponse data format which can be either application/json or application/xml. The “topologyObjectId” field default value is mandatory and application/json. status String The response status. data String Either the "ruleId" field is optionalresponse data format (JSON/XML) or exception message. This API set the value of “ruleId” to ExternalAlarm by default, error String Error code if some exception occurs; otherwise this field is not set. If you invoke this shown Script The Script related API using both fields, ensure that ruleId is properly defined to link with its topologyObjectId; otherwise the alarm might be imported into a wrong topology object. Consider for example a rule “CPU Utilization” is related to the "HostCPUs" object. If you define topologyObjectId to Host, this API imports CPU Utilization to the Host object. Postman provides "Alarm - Push Alarm XML" and "Alarm - Push Alarm JSON” sample codes for reference. Click here to download and import the sample codes. • Sample usage: When using the pushAlarm API, note includes the following: ▪ Make sure to use the following as the value of alarmMessage: AAA. BBB. AAA represents the title of the alarm dialog box, while BBB stands for the alarm message. Make sure to add a space between “.” and “BBB”. ▪ To get the value of ruleId, do either of the following: ▫ Invoke the Rule • Script — Get all rules’ data API. ▫ Execute the following Run Script • Script — Publish custom REST API • Script — Run named scripts Script — Run Script supported in the Administration > Tooling > Script Console dashboard: def ruleName = <RULE_NAME> def rule = serverscript console. script The script content. catridgeName Specifies the name of associated cartridge, and the name is case- sensitive. scopeObjectId Specifies the scope object. This item must be set if the scope variable is being used in scripts. This API is disabled by default after the installation. Refer to the REST_DisabledAPI Registry Variable in Table 2 for more information about how to change this configuration.RuleService.getAllRules().find{ xx.xxxx == ruleName } if(rule){ return xxxx.xx; }else{ return "Rule not found." } Request body in XML: <externalAlarmParamBean> <alarmMessage>title of alarm dialog. alarm message</alarmMessage> <severity>3</severity> <topologyObjectId>94e27d92-08a5-4c28-9a90-8856a7689105</topologyObjectId> 2 Warning 3 Critical 4 Fatal
Appears in 1 contract
Samples: Software License Agreement
