VMware Developer Documentation
API Reference PowerCLI Reference
[{"label":"Latest (2.0.1)","version":"latest"}]
telco-cloud-service-assurance
Telco Cloud Service Assurance Tmf Alarms

List Alarm

Description

This operation lists or finds Alarm entities How to apply filter: The filtering mechanism is implemented in the query of the URL itself. However there is no specific query parameter named ‘filter’.

The filtering is based on using name value query parameters on entity attributes. The basic expression is a sequence of attribute assertions being ANDED to formulate a filtering expression:

  • GET {apiRoot} /{resourceName}?[{attributeName}={attributeValue}&*]

For examples:

  • GET /tcsa/api/tmf/v1/alarms?ackState=ACKNOWLEDGED&alarmRaisedTime=2022-09-14T04:56:08Z

Here the the filter applied specifies that the alarms returned should have its ackState as ACKNOWLEDGED and should have been raised on 022-09-14T04:56:08Z.

The above mechanism is only for attribute value equality. Attribute values ORING is supported and is achieved by providing a filtering expression where the same attribute name is duplicated a number of times with different values. For example:

  • GET /tcsa/api/tmf/v1/alarms?ackState=ACKNOWLEDGED&ackState=UNACKNOWLEDGED

Here the filter applied specifies that the alarms returned should have ackState as either ACKNOWLEDGED or UNACKNOWLEDGED.

Alternatively ORING can also be achieved by comma separating the attribute values. [{attributeName}={attributeValue},{ attributeValue }*]. For example:

  • GET /tcsa/api/tmf/v1/alarms?ackState=ACKNOWLEDGED,UNACKNOWLEDGED

Request

Request

URL

URL

get
https://{api_host}tcsa.host.com/tcsa/api/tmf/v1/alarms
Copy
Query Parameters

Query Parameters

string
fields Optional

Comma-separated properties to be provided in response
fields example
"id"
integer
limit Optional

Requested number of resources to be provided in response
limit example
10
integer
offset Optional

Requested index for start of resources to be provided in response
offset example
0
string
sort Optional

sort contains the following query parameters:

  • Sort-Query-Parameters : “sort”, “=”, (Sort-Direction), Sort-Field

where:

  • Sort-Direction : “-“ or “+”
  • Sort-Field: The field to sort on.

The default direction is Ascending order, the use of the modifier in front of the sort field name, “-“, changes the sort order direction. For example:

  • ?sort=name (Sorts the result set on the name.)
  • ?sort=-name (Sorts the result set on the name in descending order.)

Furthermore multiple attribute names can be specified by separating the names with commas. The sorting order will be specified from the left to right order of the fields listed. For example:

  • ?sort= [attributeName],…,[attributeName]

Nested resource attributes can be specified as:

  • [parentResource].[childResource].[attributeName]

Complete example:

  • GET /tcsa/api/tmf/v1/alarms?sort=alarmRaisedTime,perceivedSeverity
  • GET /tcsa/api/tmf/v1/alarms?sort=-alarmRaisedTime,perceivedSeverity (Descending)
sort example
"alarmRaisedTime"

Authentication

Authentication

This operation uses the following authentication methods.

bearerAuth

Response

Response

Response Body

Response Body

200 OK

Returns array of Alarm of type application/json 
[
	{
		"@baseType": "alarm",
		"@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
		"@type": "notification",
		"ackState": "UNACKNOWLEDGED",
		"ackSystemId": null,
		"ackUserId": null,
		"affectedService": null,
		"alarmChangedTime": "2022-08-02T12:53:41Z",
		"alarmClearedTime": null,
		"alarmDetails": "Indicates that all of the system's IPv4 and IPv6 addresses not responding and the SNMPAgent is not responding as well. ",
		"alarmEscalation": null,
		"alarmRaisedTime": "2020-08-27T08:03:03Z",
		"alarmReportingTime": "2022-10-25T08:09:12.161Z",
		"alarmType": "Unresponsive",
		"alarmedObject": {
			"@baseType": "alarm",
			"@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
			"@type": "notification",
			"href": "/tcsa/api/topology/v1/instances/AMPMNEWUS23000_PS_Router_267%24Router%24INCHARGE-SA-PRES2",
			"id": "AMPMNEWUS23000_PS_Router_267$Router$INCHARGE-SA-PRES2"
		},
		"alarmedObjectType": "Router",
		"clearSystemId": null,
		"clearUserId": null,
		"comment": [
			{
				"@baseType": "alarm",
				"@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
				"@type": "notification",
				"comment": "Server: INCHARGE-SA-AGG2",
				"systemId": null,
				"time": "2022-08-02T12:53:30Z",
				"userId": "DXA"
			},
			{
				"@baseType": "alarm",
				"@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
				"@type": "notification",
				"comment": "Server: INCHARGE-SA-AGG2",
				"systemId": null,
				"time": "2022-08-02T12:47:14Z",
				"userId": "DXA"
			},
			{
				"@baseType": "alarm",
				"@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
				"@type": "notification",
				"comment": "INCHARGE-SA-AGG2: ICS initialization",
				"systemId": null,
				"time": "2022-08-02T12:45:56Z",
				"userId": "SYSTEM"
			},
			{
				"@baseType": "alarm",
				"@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
				"@type": "notification",
				"comment": "Server: INCHARGE-SA-AGG2",
				"systemId": null,
				"time": "2022-01-31T13:22:13Z",
				"userId": "DXA"
			},
			{
				"@baseType": "alarm",
				"@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
				"@type": "notification",
				"comment": "Server: INCHARGE-SA-AGG2",
				"systemId": null,
				"time": "2022-01-31T13:16:48Z",
				"userId": "DXA"
			},
			{
				"@baseType": "alarm",
				"@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
				"@type": "notification",
				"comment": "INCHARGE-SA-AGG2: ICS initialization",
				"systemId": null,
				"time": "2022-01-31T13:14:32Z",
				"userId": "SYSTEM"
			},
			{
				"@baseType": "alarm",
				"@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
				"@type": "notification",
				"comment": "Server: INCHARGE-SA-AGG2",
				"systemId": null,
				"time": "2021-03-02T09:11:06Z",
				"userId": "DXA"
			}
		],
		"correlatedAlarm": [],
		"crossedThresholdInformation": {},
		"externalAlarmId": null,
		"href": "/tcsa/api/tmf/v1/alarms/Name%3ANOTIFICATION-Router_AMPMNEWUS23000__PS__Router__267_Unresponsive%24Source%3AINCHARGE-SA-PRES2%24",
		"id": "Name:NOTIFICATION-Router_AMPMNEWUS23000__PS__Router__267_Unresponsive$Source:INCHARGE-SA-PRES2$",
		"isRootCause": false,
		"parentAlarm": [
			{
				"@baseType": "alarm",
				"@referredType": "null",
				"@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
				"@type": "notification",
				"href": "/tcsa/api/alarms/Name%3ANOTIFICATION-Router_AMPMNEWUS23000__PS__Router__2_Down%24Source%3AINCHARGE-SA-PRES2%24",
				"id": "Name:NOTIFICATION-Router_AMPMNEWUS23000__PS__Router__2_Down$Source:INCHARGE-SA-PRES2$",
				"name": "Name:NOTIFICATION-Router_AMPMNEWUS23000__PS__Router__2_Down$Source:INCHARGE-SA-PRES2$"
			},
			{
				"@baseType": "alarm",
				"@referredType": "null",
				"@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
				"@type": "notification",
				"href": "/tcsa/api/alarms/Name%3ANOTIFICATION-Router_AMPMNEWUS23000__PS__Router__267_Down%24Source%3AINCHARGE-SA-PRES2%24",
				"id": "Name:NOTIFICATION-Router_AMPMNEWUS23000__PS__Router__267_Down$Source:INCHARGE-SA-PRES2$",
				"name": "Name:NOTIFICATION-Router_AMPMNEWUS23000__PS__Router__267_Down$Source:INCHARGE-SA-PRES2$"
			}
		],
		"perceivedSeverity": "UNKNOWN",
		"place": [],
		"plannedOutageIndicator": "OUT_OF_SERVICE",
		"probableCause": null,
		"proposedRepairedActions": null,
		"reportingSystemId": null,
		"serviceAffecting": null,
		"sourceSystemId": "AMPMNEWUS23000",
		"specificProblem": null,
		"state": "ACTIVE"
	}
]
string
@baseType Optional

The base type of this alarm.
string
@schemaLocation Optional

A reference to the schema describing this alarm.
string
@type Optional

The type for this alarm.
string
ackState Optional

Provides the Acknowledgement State of the alarm
string
ackSystemId Optional

Provides the name of the system that last changed the ackState of an alarm, i.e. acknowledged or unacknowledged the alarm.
string
ackUserId Optional

Provides the id of the user who has last changed the ack state of the alarm, i.e. acknowledged or unacknowledged the alarm.
array of AffectedService
affectedService Optional

Identifies the service affected by the alarm.
string as date-time
alarmChangedTime Optional

Indicates the last date and time when the alarm is changed on the alarm-owning system. Any change to the alarm whether coming from the alarmed resource, or triggered by a change from the client is changing this time.
string as date-time
alarmClearedTime Optional

Indicates the time (as a date + time) at which the alarm is cleared at the source.
string
alarmDetails Optional

Contains further information on the alarm.
boolean
alarmEscalation Optional

Indicates if this alarm has been escalated or not.
string as date-time
alarmRaisedTime Optional

Indicates the time (as a date + time) at which the alarm occurred at its source.
string as date-time
alarmReportingTime Optional

Indicates the time (as a date + time) at which the alarm was reported by the owning OSS. It might be different from the alarmRaisedTime. For instance, if the alarm list is maintained by an EMS, the alarmRaisedtime would be the time the alarm was detected by the NE, while the alarmReportingTime would be the time this alarm was stored in the alarm list of the EMS.
string
alarmType Optional

Categorize the alarm.
AlarmedObject
alarmedObject Optional

Identifies the managed object instance associated with the alarm.
string
alarmedObjectType Optional

The type (class) of the managed object associated with the event.
string
clearSystemId Optional

Provides the id of the system where the user who invoked the alarmCleared operation is located.
string
clearUserId Optional

Provides the id of the user who invoked the alarmCleared operation
array of Comment
comment Optional

Indicates the comments entered on the alarm.
array of AlarmRef
correlatedAlarm Optional

Indicates other alarms related to this alarm.
CrossedThresholdInformation
crossedThresholdInformation Optional

Identifies the details of the threshold that has been crossed.
string
externalAlarmId Optional

An identifier of the alarm in the source system.
string
href Optional

A reference to the alarm.
string
id Optional

Identifier of the alarm, determined by the alarm owning system
boolean
isRootCause Optional

Indicates whether the alarm is a root cause alarm..
array of AlarmRef
parentAlarm Optional

Indicates the parent alarms of the alarm.
string
perceivedSeverity Optional

Lists the possible severities that can be allocated to an Alarm.

Possible values are: CRITICAL , MAJOR , MINOR , NORMAL , UNKNOWN

array of RelatedPlaceRefOrValue
place Optional

Related Entity reference. A related place defines a place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the place entity and not the RelatedPlaceRefOrValue class itself
string
plannedOutageIndicator Optional

Indicates that the Managed Object (related to this alarm) is in planned outage (in planned maintenance, or out-of-service).

Possible values are: PLANNED_MAINTENANCE , OUT_OF_SERVICE

string
probableCause Optional

Provides the probable cause of the alarm.
string
proposedRepairedActions Optional

Indicates proposed repair actions, if known to the system emitting the alarm.
string
reportingSystemId Optional

Reporting system identity.
boolean
serviceAffecting Optional

Indicates whether the alarm affects service or not.
string
sourceSystemId Optional

Source system identity.
string
specificProblem Optional

Provides more specific information about the alarm.
string
state Optional

Defines the alarm state during its life cycle
Response Headers
integer
X-Total-Count

Total number of items matching criteria
X-Total-Count example
1000
integer
X-Result-Count

Actual number of items returned in the response body
X-Result-Count example
10
Errors

Errors

Error
400

Bad Request
Error
401

Unauthorized
Error
403

Forbidden
Error
404

Not Found
Error
405

Method Not allowed
Error
409

Conflict
Error
500

Internal Server Error
Code Samples

Code Samples

cURL Command

curl https://{api_host}tcsa.host.com/tcsa/api/tmf/v1/alarms

Generated on: 18 May 23 14:04 UTC
[{"label":"Latest (2.0.1)","version":"latest"}]
telco-cloud-service-assurance
On This Page
Tmf Alarms Operations
post
Create Ack Alarms
post
Create Alarm
post
Create Clear Alarms
post
Create Comment Alarms
post
Create Un Ack Alarms
delete
Delete Alarm
get
List Ack Alarms
get
List Alarm
get
List Clear Alarms
get
List Comment Alarms
get
List Un Ack Alarms
patch
Patch Alarm
get
Retrieve Ack Alarms
get
Retrieve Alarm
get
Retrieve Clear Alarms
get
Retrieve Comment Alarms
get
Retrieve Un Ack Alarms
Feedback

Was this page helpful?

© 2023 VMware Inc. Terms of Use Privacy Your California Privacy Rights Accessibility Trademarks Glossary Help Contact Us