Items with tag notification

    article

    • Events and Notifications
      How to manage Event Notifications through the API. Covers both monitoring and maintenance events, and how configure which email addresses get notified about these events.

    go

    python

    reference

    • acknowledge
      Acknowledge the associated [SoftLayer_Notification_Occurrence_Event](/reference/datatypes/SoftLayer_Notification_Occurrence_Event) for this impacted user.
    • acknowledgeNotification
      <<<< EOT
    • clearSnoozeTimer
    • createObject
      Use the method to create a new subscription for a notification. This method is the entry method to the notification system. Certain properties are required to create a subscription while others are optional. The required property is the resourceRecord property which is type SoftLayer_Notification_User_Subscriber_Resource. For the resourceRecord property, the only property that needs to be populated is the resourceTableId. The resourceTableId is the unique identifier of a SoftLayer service to create the subscription for. For example, the unique identifier of the Storage Evault service to create the subscription on. Optional properties that can be set is the preferences property. The preference property is an array SoftLayer_Notification_User_Subscriber_Preference. By default, the system will populate the preferences with the default values if no preferences are passed in. The preferences passed in must be the preferences related to the notification subscribing to. The notification preferences and preference details (such as minimum and maximum values) can be retrieved using the SoftLayer_Notification service. The properties that need to be populated for preferences are the notificationPreferenceId and value. For example to create a subscriber for a Storage EVault service to be notified 15 times during a billing cycle and to be notified when the vault usage reaches 85% of its allowed capacity use the following structure: *userRecordId = 1111 *notificationId = 3 *resourceRecord **resourceTableId = 1234 *preferences[1] **notificationPreferenceId = 2 **value = 85 *preference[2] **notificationPreferenceId = 3 **value = 15
    • createObject
      Use the method to create a new subscription for a notification. This method is the entry method to the notification system. Certain properties are required to create a subscription while others are optional. The required property is the resourceRecord property which is type SoftLayer_Notification_User_Subscriber_Resource. For the resourceRecord property, the only property that needs to be populated is the resourceTableId. The resourceTableId is the unique identifier of a SoftLayer service to create the subscription for. For example, the unique identifier of the Storage Evault service to create the subscription on. Optional properties that can be set is the preferences property. The preference property is an array SoftLayer_Notification_User_Subscriber_Preference. By default, the system will populate the preferences with the default values if no preferences are passed in. The preferences passed in must be the preferences related to the notification subscribing to. The notification preferences and preference details (such as minimum and maximum values) can be retrieved using the SoftLayer_Notification service. The properties that need to be populated for preferences are the notificationPreferenceId and value. For example to create a subscriber for a Storage EVault service to be notified 15 times during a billing cycle and to be notified when the vault usage reaches 85% of its allowed capacity use the following structure: *userRecordId = 1111 *notificationId = 3 *resourceRecord **resourceTableId = 1234 *preferences[1] **notificationPreferenceId = 2 **value = 85 *preference[2] **notificationPreferenceId = 3 **value = 15
    • createObject
      Use the method to create a new subscription for a notification. This method is the entry method to the notification system. Certain properties are required to create a subscription while others are optional. The required property is the resourceRecord property which is type SoftLayer_Notification_User_Subscriber_Resource. For the resourceRecord property, the only property that needs to be populated is the resourceTableId. The resourceTableId is the unique identifier of a SoftLayer service to create the subscription for. For example, the unique identifier of the Storage Evault service to create the subscription on. Optional properties that can be set is the preferences property. The preference property is an array SoftLayer_Notification_User_Subscriber_Preference. By default, the system will populate the preferences with the default values if no preferences are passed in. The preferences passed in must be the preferences related to the notification subscribing to. The notification preferences and preference details (such as minimum and maximum values) can be retrieved using the SoftLayer_Notification service. The properties that need to be populated for preferences are the notificationPreferenceId and value. For example to create a subscriber for a Storage EVault service to be notified 15 times during a billing cycle and to be notified when the vault usage reaches 85% of its allowed capacity use the following structure: *userRecordId = 1111 *notificationId = 3 *resourceRecord **resourceTableId = 1234 *preferences[1] **notificationPreferenceId = 2 **value = 85 *preference[2] **notificationPreferenceId = 3 **value = 15
    • createObject
      Use the method to create a new notification preference for a subscriber
    • createSubscriberForMobileDevice
      Create a new subscriber for a given resource.
    • editObject
      The subscriber's subscription status can be 'turned off' or 'turned on' if the subscription is not required. Subscriber preferences may also be edited. To edit the preferences, you must pass in the id off the preferences to edit. Here is an example of structure to pass in. In this example, the structure will set the subscriber status to active and the threshold preference to 90 and the limit preference to 20 *id = 1111 *active = 1 *preferences[1] **id = 11 **value = 90 *preference[2] **id = 12 **value = 20
    • editObject
      The subscriber's subscription status can be 'turned off' or 'turned on' if the subscription is not required. Subscriber preferences may also be edited. To edit the preferences, you must pass in the id off the preferences to edit. Here is an example of structure to pass in. In this example, the structure will set the subscriber status to active and the threshold preference to 90 and the limit preference to 20 *id = 1111 *active = 1 *preferences[1] **id = 11 **value = 90 *preference[2] **id = 12 **value = 20
    • editObject
      The subscriber's subscription status can be 'turned off' or 'turned on' if the subscription is not required. Subscriber preferences may also be edited. To edit the preferences, you must pass in the id off the preferences to edit. Here is an example of structure to pass in. In this example, the structure will set the subscriber status to active and the threshold preference to 90 and the limit preference to 20 *id = 1111 *active = 1 *preferences[1] **id = 11 **value = 90 *preference[2] **id = 12 **value = 20
    • editObjects
    • getAcknowledgedFlag
      Indicates whether or not this event has been acknowledged by the user.
    • getAllObjects
      Use this method to retrieve all active notifications that can be subscribed to.
    • getAllObjects
      Use this method to retrieve all active notifications that can be subscribed to.
    • getAllObjects
    • getAllObjects
      Returns a collection of impacted users, an account master user has the ability to see all impacted users under the account.
    • getAttachedFile
      Retrieve the contents of the file attached to a SoftLayer event by it's given identifier.
    • getAttachments
      A collection of attachments for this event which provide supplementary information to impacted users some examples are RFO (Reason For Outage) and root cause analysis documents.
    • getDefaultPreference
      Details such name, keyname, minimum and maximum values for the preference.
    • getDeliveryMethods
      The delivery methods used to send the subscribed notification.
    • getDeliveryMethods
      The delivery methods used to send the subscribed notification.
    • getDeliveryMethods
      The delivery methods used to send the subscribed notification.
    • getFirstUpdate
      The first update for this event.
    • getImpactedAccountCount
      This method will return the number of impacted owned accounts associated with this event for the current user.
    • getImpactedAccounts
      A collection of accounts impacted by this event. Each impacted account record relates directly to a [SoftLayer_Account](/reference/datatypes/SoftLayer_Account).
    • getImpactedDeviceCount
      This method will return the number of impacted devices associated with this event for the current user.
    • getImpactedDeviceCount
      A count representing the number of the user's devices currently impacted by the associated event will be returned.
    • getImpactedDevices
      This method will return a collection of SoftLayer_Notification_Occurrence_Resource objects which is a listing of the current users' impacted devices that are associated with this event.
    • getImpactedResources
      A collection of resources impacted by this event. Each record will relate to some physical resource that the user has access to such as [SoftLayer_Hardware](/reference/datatypes/SoftLayer_Hardware) or [SoftLayer_Virtual_Guest](/reference/datatypes/SoftLayer_Virtual_Guest).
    • getImpactedResources
      A collection of resources impacted by the associated event.
    • getImpactedUsers
      A collection of users impacted by this event. Each impacted user record relates directly to a [SoftLayer_User_Customer](/reference/datatypes/SoftLayer_User_Customer).
    • getLastUpdate
      The last update for this event.
    • getNotification
      Notification subscribed to.
    • getNotification
      Notification subscribed to.
    • getNotification
      Notification subscribed to.
    • getNotificationOccurrenceEvent
      The associated event.
    • getNotificationOccurrenceEventType
      The type of event such as planned or unplanned maintenance.
    • getNotificationUserSubscriber
      Details of the subscriber tied to the preference.
    • getObject
      Retrieve a SoftLayer_Notification record.
    • getObject
      Retrieve a SoftLayer_Notification_Mobile record.
    • getObject
      Retrieve a SoftLayer_Notification_Occurrence_Event record.
    • getObject
      Retrieve a SoftLayer_Notification_Occurrence_User record.
    • getObject
      Retrieve a SoftLayer_Notification_User_Subscriber record.
    • getObject
      Retrieve a SoftLayer_Notification_User_Subscriber_Billing record.
    • getObject
      Retrieve a SoftLayer_Notification_User_Subscriber_Mobile record.
    • getObject
      Retrieve a SoftLayer_Notification_User_Subscriber_Preference record.
    • getPreferences
      The preferences related to the notification. These are preferences are configurable and optional for subscribers to use.
    • getPreferences
      The preferences related to the notification. These are preferences are configurable and optional for subscribers to use.
    • getPreferences
      Associated subscriber preferences used for the notification subscription. For example, preferences include number of deliveries (limit) and threshold.
    • getPreferences
      Associated subscriber preferences used for the notification subscription. For example, preferences include number of deliveries (limit) and threshold.
    • getPreferences
      Associated subscriber preferences used for the notification subscription. For example, preferences include number of deliveries (limit) and threshold.
    • getPreferencesDetails
      Preference details such as description, minimum and maximum limits, default value and unit of measure.
    • getPreferencesDetails
      Preference details such as description, minimum and maximum limits, default value and unit of measure.
    • getPreferencesDetails
      Preference details such as description, minimum and maximum limits, default value and unit of measure.
    • getRequiredPreferences
      The required preferences related to the notification. While configurable, the subscriber does not have the option whether to use the preference.
    • getRequiredPreferences
      The required preferences related to the notification. While configurable, the subscriber does not have the option whether to use the preference.
    • getResourceRecord
      The subscriber id to resource id mapping.
    • getResourceRecord
      The subscriber id to resource id mapping.
    • getResourceRecord
      The subscriber id to resource id mapping.
    • getStatusCode
    • getUpdates
      All updates for this event.
    • getUser
      The impacted user.
    • getUserRecord
      User record for the subscription.
    • getUserRecord
      User record for the subscription.
    • getUserRecord
      User record for the subscription.
    • setSnoozeTimer
    • SoftLayer_Notification
      Details provided for the notification are basic. Details such as the related preferences, name and keyname for the notification can be retrieved. The keyname property for the notification can be used to refer to a notification when integrating into the SoftLayer Notification system. The name property can used more for display purposes.
    • SoftLayer_Notification
      SoftLayer Customers can use this service to view all of the available notifications that can be subscribed to. Some of the notifications are required while others are not.
    • SoftLayer_Notification_Delivery_Method
      Provides details for the delivery methods available.
    • SoftLayer_Notification_Mobile
      This is an extension of the SoftLayer_Notification class. These are implementation details specific to those notifications which can be subscribed to and received on a mobile device.
    • SoftLayer_Notification_Mobile
      SoftLayer Customers can use this service to view all of the available mobile notifications that can be subscribed to. No mobile notifications are required.
    • SoftLayer_Notification_Occurrence_Account
    • SoftLayer_Notification_Occurrence_Event
      The [SoftLayer_Notification_Occurrence_Event](/reference/datatypes/SoftLayer_Notification_Occurrence_Event) service represents all events with potential to cause a disruption in service.
    • SoftLayer_Notification_Occurrence_Event
      The [SoftLayer_Notification_Occurrence_Event](/reference/datatypes/SoftLayer_Notification_Occurrence_Event) service represents all events with potential to cause a disruption in service.
    • SoftLayer_Notification_Occurrence_Event_Attachment
      SoftLayer events can have have files attached to them by a SoftLayer employee. Attaching a file to a event is a way to provide supplementary information such as a RFO (reason for outage) document or root cause analysis. The SoftLayer_Notification_Occurrence_Event_Attachment data type models a single file attached to a event.
    • SoftLayer_Notification_Occurrence_Event_Type
      This represents the type of SoftLayer_Notification_Occurrence_Event.
    • SoftLayer_Notification_Occurrence_Resource
      This type contains general information relating to any hardware or services that may be impacted by a SoftLayer_Notification_Occurrence_Event.
    • SoftLayer_Notification_Occurrence_Resource_Hardware
      This type contains general information related to a [SoftLayer_Hardware](/reference/datatypes/SoftLayer_Hardware) resource that is impacted by a [SoftLayer_Notification_Occurrence_Event](/reference/datatypes/SoftLayer_Notification_Occurrence_Event).
    • SoftLayer_Notification_Occurrence_Resource_Network_Application_Delivery_Controller
      This type contains general information related to a [SoftLayer_Network_Application_Delivery_Controller](/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller) resource that is impacted by a [SoftLayer_Notification_Occurrence_Event](/reference/datatypes/SoftLayer_Notification_Occurrence_Event).
    • SoftLayer_Notification_Occurrence_Resource_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress
      This type contains general information related to a [SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress](/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) resource that is impacted by a [SoftLayer_Notification_Occurrence_Event](/reference/datatypes/SoftLayer_Notification_Occurrence_Event).
    • SoftLayer_Notification_Occurrence_Resource_Network_Storage_Iscsi_NetApp
      This type contains general information related to a [SoftLayer_Network_Storage_Iscsi_NetApp](/reference/datatypes/SoftLayer_Network_Storage_Iscsi_NetApp) resource that is impacted by a [SoftLayer_Notification_Occurrence_Event](/reference/datatypes/SoftLayer_Notification_Occurrence_Event).
    • SoftLayer_Notification_Occurrence_Resource_Network_Storage_Lockbox
      This type contains general information related to a [SoftLayer_Network_Storage_Lockbox](/reference/datatypes/SoftLayer_Network_Storage_Lockbox) resource that is impacted by a [SoftLayer_Notification_Occurrence_Event](/reference/datatypes/SoftLayer_Notification_Occurrence_Event).
    • SoftLayer_Notification_Occurrence_Resource_Network_Storage_Nas
      This type contains general information related to a [SoftLayer_Network_Storage_Nas](/reference/datatypes/SoftLayer_Network_Storage_Nas) resource that is impacted by a [SoftLayer_Notification_Occurrence_Event](/reference/datatypes/SoftLayer_Notification_Occurrence_Event).
    • SoftLayer_Notification_Occurrence_Resource_Network_Storage_NetApp_Volume
      This type contains general information related to a [SoftLayer_Network_Storage](/reference/datatypes/SoftLayer_Network_Storage) resource that is impacted by a [SoftLayer_Notification_Occurrence_Event](/reference/datatypes/SoftLayer_Notification_Occurrence_Event).
    • SoftLayer_Notification_Occurrence_Resource_Network_Storage_NetApp_Volume_Replicant_Iscsi
      This type contains general information related to a [SoftLayer_Network_Storage_Iscsi](/reference/datatypes/SoftLayer_Network_Storage_Iscsi) resource that is impacted by a [SoftLayer_Notification_Occurrence_Event](/reference/datatypes/SoftLayer_Notification_Occurrence_Event).
    • SoftLayer_Notification_Occurrence_Resource_Network_Storage_NetApp_Volume_Replicant_Nas
      This type contains general information related to a [SoftLayer_Network_Storage_NetApp_Volume_Replicant_Nas](/reference/datatypes/SoftLayer_Network_Storage_NetApp_Volume_Replicant_Nas) resource that is impacted by a [SoftLayer_Notification_Occurrence_Event](/reference/datatypes/SoftLayer_Notification_Occurrence_Event).
    • SoftLayer_Notification_Occurrence_Resource_Virtual
      This type contains general information related to a [SoftLayer_Virtual_Guest](/reference/datatypes/SoftLayer_Virtual_Guest) resource that is impacted by a [SoftLayer_Notification_Occurrence_Event](/reference/datatypes/SoftLayer_Notification_Occurrence_Event).
    • SoftLayer_Notification_Occurrence_Status_Code
    • SoftLayer_Notification_Occurrence_Update
    • SoftLayer_Notification_Occurrence_User
      This type contains general information relating to a user that may be impacted by a [SoftLayer_Notification_Occurrence_Event](/reference/datatypes/SoftLayer_Notification_Occurrence_Event).
    • SoftLayer_Notification_Occurrence_User
    • SoftLayer_Notification_Preference
      Retrieve details for preferences. Preferences are used to allow the subscriber to modify their subscription in various ways. Details such as friendly name, keyname maximum and minimum values can be retrieved. These provide details to help configure subscriber preferences correctly.
    • SoftLayer_Notification_Subscriber
    • SoftLayer_Notification_Subscriber_Customer
    • SoftLayer_Notification_Subscriber_Delivery_Method
      Provides details for the subscriber's delivery methods.
    • SoftLayer_Notification_User_Subscriber
      A notification subscriber will have details pertaining to the subscriber's notification subscription. You can receive details such as preferences, details of the preferences, delivery methods and the delivery methods for the subscriber. NOTE: There are preferences and delivery methods that cannot be modified. Also, there are some subscriptions that are required.
    • SoftLayer_Notification_User_Subscriber
      SoftLayer Customers can subscribe to receive notifications for various notification types. This service also allows you to 'turn on' or 'turn off' notification messages sent to a subscriber for certain notifications.
    • SoftLayer_Notification_User_Subscriber_Billing
      A notification subscriber will have details pertaining to the subscriber's notification subscription. You can receive details such as preferences, details of the preferences, delivery methods and the delivery methods for the subscriber. NOTE: There are preferences and delivery methods that cannot be modified. Also, there are some subscriptions that are required.
    • SoftLayer_Notification_User_Subscriber_Billing
      SoftLayer Customers can subscribe to receive notifications for various notification types. This service also allows you to 'turn on' or 'turn off' notification messages sent to a subscriber for certain notifications.
    • SoftLayer_Notification_User_Subscriber_Delivery_Method
      Provides mapping details of how the subscriber's notification will be delivered. This maps the subscriber's id with all the delivery method ids used to delivery the notification.
    • SoftLayer_Notification_User_Subscriber_Mobile
      A notification subscriber will have details pertaining to the subscriber's notification subscription. You can receive details such as preferences, details of the preferences, delivery methods and the delivery methods for the subscriber. NOTE: There are preferences and delivery methods that cannot be modified. Also, there are some subscriptions that are required.
    • SoftLayer_Notification_User_Subscriber_Mobile
      SoftLayer Customers can subscribe to receive notifications for various notification types. This service also allows you to 'turn on' or 'turn off' notification messages sent to a subscriber for certain notifications.
    • SoftLayer_Notification_User_Subscriber_Preference
      Preferences are settings that can be modified to change the behavior of the subscription. For example, modify the limit preference to only receive notifications 10 times instead of 1 during a billing cycle. NOTE: Some preferences have certain restrictions on values that can be set.
    • SoftLayer_Notification_User_Subscriber_Preference
    • SoftLayer_Notification_User_Subscriber_Resource
      Retrieve identifier cross-reference information. SoftLayer_Notification_User_Subscriber_Resource provides the resource table id and subscriber id relation. The resource table id is the id of the service the subscriber receives alerts for. This resource table id could be the unique identifier for a Storage Evault service or CDN service.

    ruby

Open Source SDKs

softlayer-python
 softlayer-java
 softlayer-go
 softlayer-perl
 softlayer-php
 softlayer-ruby

SL CLI

Standalone SoftLayer CLI
Installation
Documentation
Feature Request
Bug Report
Changelog

SL Plugin

Classic Infrastructure Plugin for ibmcloud CLI
Installation
Documentation
Feature Request
Bug Report
Changelog