Fabric Notifications

Equinix secure, software-defined interconnection enables customers to scale hybrid deployments, achieve network agility, directly connect to partners and providers easily and securely. With Equinix Messaging Gateway (EMG) solution, customers can now manage their Fabric notifications in near real-time.

Watch the video below to know how to receive Fabric Notifications.

EMG supports Fabric Notifications for below workflows:

1. Equinix Fabric Port Up/Down
2. Equinix Fabric Virtual Connection Up/Down

Equinix Fabric Port Up/Down Sample Notification

{
  "Task": {
    "Id": "bf9f2707-d612-4d63-9958-4c8b1fcf3cc0",
    "Source": "3e095d30-40ff-11e9-8959-5be078353003",
    "Verb": "Update",
    "Resource": "DataCenter.Network.Port",
    "ContentType": "application/json",
    "Version": "1.0",
    "Body": { 
      "timestamp":"2020-05-21T10:20:00Z",
      "type":"PORT_OPSTATUS_NOTIFICATION",
      "uuid":"11c954fb-8e8b-4515-97d7-cc80129a0985",
      "description":"Port is not operational. Connections on this port might be affected.",
      "data":{
         "type":"XF_PORT",
         "uuid":"a867f685-41b0-1b07-6de0-320a5c00abdd",
         "name":"L2-DEV-USER01-DC5-CX-10G-SECONDARY-NOKIA-02",
         "href":"https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd",
         "operation":{
            "operationalStatus":"DOWN",
            "opStatusChangedAt":"2020-05-21T10:20:00Z",
            "maintenanceMode":false
         },
         "embedded":{
            "connections":{
               "href":[
                  "https://api.equinix.com/fabric/v4/connections/8822de74-805f-4f63-b52d-93bcbf2a1d1b",
                  "https://api.equinix.com/fabric/v4/connections/8f20bea9-a5b9-47e5-88e6-a899584ebb90"
               ]
            }
         }
      }

    }
  },
  "Signature": "RWNobwp7CiAgIklkIjogIjM1MGFlZjcwLTc4MWItMTFlOSogIH0KfQ=="
}

The description of the notification schema is as follows:

Name	Mandatory	Type	Applicable Value(s)	Description
Task	Yes	Object		The task object comprises a common set of header attributes and a unique set of body attributes. The header attributes are applicable to all order types, whereas the body attributes vary for each order.
ID	Yes	String (Guid)		The unique identifier of the message. Customers must ensure to send a unique value for each message.
Source	Yes	String (Guid)		A unique value to identify the message sender. This value will be shared with the customer during the onboarding process.
Verb	Yes	String	Update	Indicates there is an update from Equinix.
Resource	Yes	String	"DataCenter.Network.Port",  "DataCenter.Network.VirtualConnection"	Indicates the notification type. DataCenter.Network.Port: indicates that the notification is related to Equinix Fabric Port. DataCenter.Network.VirtualConnection: indicates that the notification is related to Equinix Fabric Virtual Connection.
ContentType	Yes	String	application/json
CreateTimeUTC	Yes	String		Indicates the date and time at which the notification is sent by Equinix.
Version	Yes	String	1.0	The version of the notification schema.
Body	Yes	Object		An object containing the details of the notification. The attributes within the object will vary based on the resource and verb.
type	Yes	String	PORT_OPSTATUS_NOTIFICATION, CONNECTION_OPSTATUS_NOTIFICATION	Indicates type of notification. PORT_OPSTATUS_NOTIFICATION: notifies that Equinix Fabric Port is currently under maintenance. CONNECTION_OPSTATUS_NOTIFICATION: Equinix Fabric Virtual Connection is currently under maintenance.
uuid	Yes	String		Indicates the unique id supplied by Equinix for the maintenance.
description	Yes	String		Summary of the ticket from Equinix DataCenter Technician.
data	Yes	Object		An object containing the details of the customer port.
type	Yes	String	XF_PORT, EVPL_VC	Indicates port type. XF_PORT: indicates Equinix Fabric Port EVPL_VC: indicates Equinix Fabric Virtual Connection
uuid	Yes	String		Indicates the unique id of the customer port.
name	Yes	String		Indicates name of the customer port.
href	Yes	String		Link to get more details of the customer port.
operation	Yes	Object		An object containing the details related to the status of the customer port.
operationalStatus	Yes	String	UP, DOWN	Indicates the current status of the customer port.
opStatusChangedAt	Yes	String		Indicates the date and time at which the status of the customer port last monitored.
maintenanceMode	Yes	Boolean	true, false	Indicates if its a planned or unplanned maintenance.
embedded	Yes	Object		An object containing the details of the virtual connections active on this customer port.
connections	Yes	Object		An object containing the list of the virtual connections active on this customer port.
href	Yes	Array[String]		An array containing the list of the virtual connections active on this customer port.
Signature	Yes	String		Base64 encoded signature.