[{"label":"Latest (2.0.1)","version":"latest"}]

telco-cloud-service-assurance

Create Alarm

Description

This operation creates an Alarm entity.

Request

URL

post

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

Copy

Request Body

AlarmCreate of mimetype application/json Required

The Alarm to be created

Show optional properties

{
    "alarmType": "OpenAPIExample",
    "alarmedObject": {
        "id": "gNodeB-service-mavenir$gNodeB$INCHARGE-SA-PRES"
    },
    "alarmedObjectType": "gNodeB",
    "perceivedSeverity": "MAJOR"
}

{
    "ackSystemId": "postman-api",
    "ackUserId": "admin",
    "affectedService": [
        {
            "id": "Name:NOTIFICATION-Router_AMPMNEWUS23000__PS__Router__267_Unresponsive$Source:INCHARGE-SA-PRES2$"
        }
    ],
    "alarmEscalation": false,
    "alarmType": "OpenAPIExample",
    "alarmedObject": {
        "id": "gNodeB-service-mavenir$gNodeB$INCHARGE-SA-PRES"
    },
    "alarmedObjectType": "gNodeB",
    "clearSystemId": "creating clearSystemId",
    "clearUserId": "creating clearUserId",
    "externalAlarmId": "creating External Alarm ID",
    "perceivedSeverity": "MAJOR",
    "probableCause": "UserDefined probable cause",
    "proposedRepairedActions": "UserDefined proposed repaired actions",
    "reportingSystemId": "creating Reporting System ID",
    "serviceAffecting": false,
    "specificProblem": "creating specific problem"
}

string

alarmType Required

Categorize the alarm.

string

perceivedSeverity Required

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

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

string

alarmedObjectType Required

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

AlarmedObjectCreate

alarmedObject Required

string

ackState Optional

Provides the Acknowledgement State of the alarm

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

array of AffectedService

affectedService Optional

Identifies the service affected by 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.

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.

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

ackSystemId Optional

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

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

Authentication

This operation uses the following authentication methods.

bearerAuth

Response

Response Body

201 Created

Returns AlarmCreateResponse of type application/json

{
	"href": "/tcsa/api/tmf/v1/alarms/Name%3ANOTIFICATION-gNodeB_gNodeB-service-mavenir_OpenAPIExample%24Source%3AINCHARGE-SA-PRES%24",
	"id": "Name:NOTIFICATION-gNodeB_gNodeB-service-mavenir_OpenAPIExample$Source:INCHARGE-SA-PRES$"
}

string

href Optional

A reference to the alarm.

string

id Optional

Identifier of the alarm, determined by the alarm owning system

Errors

Error

400

Bad Request

Error

401

Unauthorized

Error

403

Forbidden

Error

405

Method Not allowed

Error

409

Conflict

Error

500

Internal Server Error

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"ackSystemId":"postman-api","ackUserId":"admin","affectedService":[{"id":"Name:NOTIFICATION-Router_AMPMNEWUS23000__PS__Router__267_Unresponsive$Source:INCHARGE-SA-PRES2$"}],"alarmEscalation":false,"alarmType":"OpenAPIExample","alarmedObject":{"id":"gNodeB-service-mavenir$gNodeB$INCHARGE-SA-PRES"},"alarmedObjectType":"gNodeB","clearSystemId":"creating clearSystemId","clearUserId":"creating clearUserId","externalAlarmId":"creating External Alarm ID","perceivedSeverity":"MAJOR","probableCause":"UserDefined probable cause","proposedRepairedActions":"UserDefined proposed repaired actions","reportingSystemId":"creating Reporting System ID","serviceAffecting":false,"specificProblem":"creating specific problem"}' https://{api_host}tcsa.host.com/tcsa/api/tmf/v1/alarms

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:

x-codegen-request-body-name: alarm

[{"label":"Latest (2.0.1)","version":"latest"}]

telco-cloud-service-assurance

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

Create Alarm

Request

URL

Request Body

Authentication

bearerAuth

Response

Response Body

201 Created

Errors

Code Samples

cURL Command

Vendor Extensions

On This Page

Tmf Alarms Operations

Was this page helpful?