APIs in Category: ems | Cluster-Mode API version 1.15

ems-config-get ems-config-modify ems-destination-create ems-destination-destroy ems-destination-destroy-iter ems-destination-get ems-destination-get-iter ems-destination-modify ems-destination-modify-iter ems-mail-history-destroy ems-mail-history-destroy-iter ems-mail-history-get ems-mail-history-get-iter ems-message-get ems-message-get-iter ems-routing-add-destination ems-routing-get ems-routing-get-iter ems-routing-modify ems-routing-modify-iter ems-routing-remove-destination ems-snmp-history-destroy ems-snmp-history-destroy-iter ems-snmp-history-get ems-snmp-history-get-iter ems-status-get ems-status-get-iter | The Event Management System (EMS) is a mechanism in the Data ONTAP kernel that supports creation, forwarding, and consumption of event indications. Ems events are generated by ONTAP when errors occur or to log status. These event indications are logged to /etc/log/ems and, depending on the event and its severity, to the syslog/console. If an event has a SNMP definition, SNMP traps will also be generated by the event indication.

NetApp Manage ONTAP

ems-config-get | [top]

> Return the EMS Configuration.

> Input Name | Range | Type | Description
> desired-attributes |  | ems-config-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> Output Name | Range | Type | Description
> attributes |  | ems-config-info | The attributes of the ems-config.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

ems-config-modify | [top]

> Modify the EMS Configuration.

> Input Name | Range | Type | Description
> console |  | boolean optional | Whether console logging should be used.
> console-log-level |  | emsseverity optional | Console logging level. Possible values: "node_fault" - A data corruption has been detected or the node is unable to provide client service, "svc_fault" - A temporary loss of service has been detected, typically a transient software fault, "node_error" - A hardware error has been detected which is not immediately fatal, "svc_error" - A software error has been detected which is not immediately fatal, "warning" - A high-priority message, does not indicate a fault, "notice" - A normal-priority message, does not indicate a fault, "info" - A low-priority message, does not indicate a fault, "debug" - A debugging message, typically suppressed from customer, "var" - Message has variable severity, selected at runtime
> mail-from |  | mail-address optional | The from address of ems mail.
> mail-server |  | remote-ip optional | The mail server to use when sending mail.
> max-log-show-size | [1..10000] | integer optional | Maximum number of events to show.
> max-target-event-bytes | [10..134217728] | integer optional | Maximum bytes per event per week. Used by autosuppression to control growth of log file size.
> max-target-log-size | [1048576..134217728] | integer optional | The target upper limit of the event log file size in bytes. Used by autosuppression to control growth of log file size.
> suppression |  | boolean optional | Whether suppression should be used.
> trace-log-size | [1..10000] | integer optional | Maximum number of traces kept.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

ems-destination-create | [top]

> Creates an EMS destination.

> Input Name | Range | Type | Description
> hide-parameters |  | boolean optional | Hide parameter values?
> mail |  | mail-address[] optional | The e-mail address to which events are sent.
> name |  | string | The name of the EMS destination.
> return-record |  | boolean optional | If set to true, returns the ems-destination on successful creation. Default: false
> snmp |  | remote-ip[] optional | The SNMP addresses to which traps are sent.
> snmp-community |  | string optional | The SNMP community name.
> syslog |  | remote-ip[] optional | The remote syslog servers to which messages are sent.
> syslog-facility |  | syslog-facility optional | The syslog logging facility.
> Output Name | Range | Type | Description
> result |  | ems-destination-info optional | The ems-destination created (keys or the entire object if requested)

> Errno | Description
> EINTERNALERROR |  |

ems-destination-destroy | [top]

> Deletes the specified EMS destination.

> Input Name | Range | Type | Description
> name |  | string | The name of the EMS destination.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

ems-destination-destroy-iter | [top]

> Deletes several EMS destinations.

> Input Name | Range | Type | Description
> continue-on-failure |  | boolean optional | This input element is useful when multiple ems-destination objects match a given query. If set to true, the API will continue deleting the next matching ems-destination even when the deletion of a previous ems-destination fails. If set to false, the API will return on the first failure. Default: false
> max-failure-count | [1..2^32-1] | integer optional | When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed deletions before the server gives up and returns. If set, the API will continue deleting the next matching ems-destination even when the deletion of a previous matching ems-destination fails, and do so until the total number of objects failed to be deleted reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed deletions. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
> max-records | [1..100] | integer optional | The maximum number of ems-destination objects to delete in this call. Default: 20
> query |  | ems-destination-info | If deleting a specific ems-destination, this input element must specify all keys. If deleting multiple ems-destination objects based on query, this input element must specify a query.
> return-failure-list |  | boolean optional | If set to true, the API will return the list of ems-destination objects (just keys) that were not deleted due to some error. If set to false, the list of ems-destination objects not deleted will not be returned. Default: true
> return-success-list |  | boolean optional | If set to true, the API will return the list of ems-destination objects (just keys) that were successfully deleted. If set to false, the list of ems-destination objects deleted will not be returned. Default: true
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the next-tag obtained from the previous call.
> Output Name | Range | Type | Description
> failure-list |  | ems-destination-destroy-iter-info[] optional | Information about ems-destination objects that were not deleted due to some error. This element will be returned only if input element 'return-failure-list' is true.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more matching ems-destination objects to be deleted.
> num-failed | [0..100] | integer optional | Number of ems-destination objects that matched the query, but were not deleted due to some error.
> num-succeeded | [0..100] | integer optional | The number of ems-destination objects that matched the query and were successfully deleted.
> success-list |  | ems-destination-destroy-iter-info[] optional | The ems-destination objects that were successfully deleted. This element will be returned only if input element 'return-success-list' is true

> Errno | Description
> EINTERNALERROR |  |

ems-destination-get | [top]

> Return the specified EMS destination information.

> Input Name | Range | Type | Description
> desired-attributes |  | ems-destination-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> name |  | string | The name of the EMS destination.
> Output Name | Range | Type | Description
> attributes |  | ems-destination-info | The attributes of the ems-destination.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

ems-destination-get-iter | [top]

> Return information on EMS destinations.

> Input Name | Range | Type | Description
> desired-attributes |  | ems-destination-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> max-records | [1..100] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | ems-destination-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the ems-destination object. All ems-destination objects matching this query up to 'max-records' will be returned.
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
> Output Name | Range | Type | Description
> attributes-list |  | ems-destination-info[] optional | The list of attributes of ems-destination objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more ems-destination objects to return.
> num-records | [0..100] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

ems-destination-modify | [top]

> Modifies the specified EMS destination.

> Input Name | Range | Type | Description
> hide-parameters |  | boolean optional | Hide parameter values?
> mail |  | mail-address[] optional | The e-mail address to which events are sent.
> name |  | string | The name of the EMS destination.
> snmp |  | remote-ip[] optional | The SNMP addresses to which traps are sent.
> snmp-community |  | string optional | The SNMP community name.
> syslog |  | remote-ip[] optional | The remote syslog servers to which messages are sent.
> syslog-facility |  | syslog-facility optional | The syslog logging facility.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

ems-destination-modify-iter | [top]

> Modifies several EMS destinations.

> Input Name | Range | Type | Description
> attributes |  | ems-destination-info | Specify at least one modifiable element. Do not specify any other element.
> continue-on-failure |  | boolean optional | This input element is useful when multiple ems-destination objects match a given query. If set to true, the API will continue modifying the next matching ems-destination even when modification of a previous ems-destination fails. If set to false, the API will return on the first failure. Default: false
> max-failure-count | [1..2^32-1] | integer optional | When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed modify operations before the server gives up and returns. If set, the API will continue modifying the next matching ems-destination even when the modification of a previous matching ems-destination fails, and do so until the total number of objects failed to be modified reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed modify operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
> max-records | [1..100] | integer optional | The maximum number of objects to be modified in this call. Default: 20
> query |  | ems-destination-info | If modifying a specific ems-destination, this input element must specify all keys. If modifying ems-destination objects based on query, this input element must specify a query.
> return-failure-list |  | boolean optional | If set to true, the API will return the list of ems-destination objects (just keys) that were not modified due to some error. If set to false, the list of ems-destination objects not modified will not be returned. Default: true
> return-success-list |  | boolean optional | If set to true, the API will return the list of ems-destination objects (just keys) that were successfully updated. If set to false, the list of ems-destination objects modified will not be returned. Default: true
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
> Output Name | Range | Type | Description
> failure-list |  | ems-destination-modify-iter-info[] optional | Information about ems-destination objects that were not modified due to some error. This element will be returned only if input element 'return-failure-list' is true.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more matching ems-destination objects to be modified.
> num-failed | [0..100] | integer optional | Number of ems-destination objects that matched the query, but were not modified due to some error.
> num-succeeded | [0..100] | integer optional | The number of ems-destination objects that matched the query and were successfully updated.
> success-list |  | ems-destination-modify-iter-info[] optional | The ems-destination objects that were successfully updated. This element will be returned only if input element 'return-success-list' is true

> Errno | Description
> EINTERNALERROR |  |

ems-mail-history-destroy | [top]

> Delete an individual mail history entry.

> Input Name | Range | Type | Description
> node |  | node-name | Node emitting the EMS message.
> seq-num |  | seqnum | The message sequence number.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

ems-mail-history-destroy-iter | [top]

> Delete mail history entries.

> Input Name | Range | Type | Description
> continue-on-failure |  | boolean optional | This input element is useful when multiple ems-mail-history objects match a given query. If set to true, the API will continue deleting the next matching ems-mail-history even when the deletion of a previous ems-mail-history fails. If set to false, the API will return on the first failure. Default: false
> max-failure-count | [1..2^32-1] | integer optional | When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed deletions before the server gives up and returns. If set, the API will continue deleting the next matching ems-mail-history even when the deletion of a previous matching ems-mail-history fails, and do so until the total number of objects failed to be deleted reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed deletions. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
> max-records | [1..100] | integer optional | The maximum number of ems-mail-history objects to delete in this call. Default: 20
> query |  | ems-mail-history-info | If deleting a specific ems-mail-history, this input element must specify all keys. If deleting multiple ems-mail-history objects based on query, this input element must specify a query.
> return-failure-list |  | boolean optional | If set to true, the API will return the list of ems-mail-history objects (just keys) that were not deleted due to some error. If set to false, the list of ems-mail-history objects not deleted will not be returned. Default: true
> return-success-list |  | boolean optional | If set to true, the API will return the list of ems-mail-history objects (just keys) that were successfully deleted. If set to false, the list of ems-mail-history objects deleted will not be returned. Default: true
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the next-tag obtained from the previous call.
> Output Name | Range | Type | Description
> failure-list |  | ems-mail-history-destroy-iter-info[] optional | Information about ems-mail-history objects that were not deleted due to some error. This element will be returned only if input element 'return-failure-list' is true.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more matching ems-mail-history objects to be deleted.
> num-failed | [0..100] | integer optional | Number of ems-mail-history objects that matched the query, but were not deleted due to some error.
> num-succeeded | [0..100] | integer optional | The number of ems-mail-history objects that matched the query and were successfully deleted.
> success-list |  | ems-mail-history-destroy-iter-info[] optional | The ems-mail-history objects that were successfully deleted. This element will be returned only if input element 'return-success-list' is true

> Errno | Description
> EINTERNALERROR |  |

ems-mail-history-get | [top]

> Return an individual mail history entry.

> Input Name | Range | Type | Description
> desired-attributes |  | ems-mail-history-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> node |  | node-name | Node emitting the EMS message.
> seq-num |  | seqnum | The message sequence number.
> Output Name | Range | Type | Description
> attributes |  | ems-mail-history-info | The attributes of the ems-mail-history.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

ems-mail-history-get-iter | [top]

> Return information mail history.

> Input Name | Range | Type | Description
> desired-attributes |  | ems-mail-history-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> max-records | [1..100] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | ems-mail-history-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the ems-mail-history object. All ems-mail-history objects matching this query up to 'max-records' will be returned.
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
> Output Name | Range | Type | Description
> attributes-list |  | ems-mail-history-info[] optional | The list of attributes of ems-mail-history objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more ems-mail-history objects to return.
> num-records | [0..100] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

ems-message-get | [top]

> Return an EMS message.

> Input Name | Range | Type | Description
> desired-attributes |  | ems-message-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> node |  | node-name | Node emitting the EMS message.
> seq-num |  | seqnum | The message sequence number.
> Output Name | Range | Type | Description
> attributes |  | ems-message-info | The attributes of the ems-message.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

ems-message-get-iter | [top]

> Return EMS messages.

> Input Name | Range | Type | Description
> desired-attributes |  | ems-message-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> max-records | [1..100] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | ems-message-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the ems-message object. All ems-message objects matching this query up to 'max-records' will be returned.
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
> Output Name | Range | Type | Description
> attributes-list |  | ems-message-info[] optional | The list of attributes of ems-message objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more ems-message objects to return.
> num-records | [0..100] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

ems-routing-add-destination | [top]

> Add EMS Destinations.

> Input Name | Range | Type | Description
> destinations |  | ems-destination[] | Destinations
> message-name |  | ems-id | The name of the EMS message.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

ems-routing-get | [top]

> Return the specified EMS route information.

> Input Name | Range | Type | Description
> desired-attributes |  | ems-routing-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> message-name |  | ems-id | The name of the EMS message.
> Output Name | Range | Type | Description
> attributes |  | ems-routing-info | The attributes of the ems-routing.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

ems-routing-get-iter | [top]

> Return information on several EMS routes.

> Input Name | Range | Type | Description
> desired-attributes |  | ems-routing-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> max-records | [1..100] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | ems-routing-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the ems-routing object. All ems-routing objects matching this query up to 'max-records' will be returned.
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
> Output Name | Range | Type | Description
> attributes-list |  | ems-routing-info[] optional | The list of attributes of ems-routing objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more ems-routing objects to return.
> num-records | [0..100] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

ems-routing-modify | [top]

> Modifies the specified EMS route.

> Input Name | Range | Type | Description
> destinations |  | ems-destination[] optional | The event destinations.
> frequency-threshold | [0..2^32-1] | integer optional | Number of times an event occurs before a repeat notification of the event is sent.
> message-name |  | ems-id | The name of the EMS message.
> time-threshold | [0..2^32-1] | integer optional | Minimum number of seconds between repeat notifications of an event.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

ems-routing-modify-iter | [top]

> Modifies several EMS route.

> Input Name | Range | Type | Description
> attributes |  | ems-routing-info | Specify at least one modifiable element. Do not specify any other element.
> continue-on-failure |  | boolean optional | This input element is useful when multiple ems-routing objects match a given query. If set to true, the API will continue modifying the next matching ems-routing even when modification of a previous ems-routing fails. If set to false, the API will return on the first failure. Default: false
> max-failure-count | [1..2^32-1] | integer optional | When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed modify operations before the server gives up and returns. If set, the API will continue modifying the next matching ems-routing even when the modification of a previous matching ems-routing fails, and do so until the total number of objects failed to be modified reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed modify operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
> max-records | [1..100] | integer optional | The maximum number of objects to be modified in this call. Default: 20
> query |  | ems-routing-info | If modifying a specific ems-routing, this input element must specify all keys. If modifying ems-routing objects based on query, this input element must specify a query.
> return-failure-list |  | boolean optional | If set to true, the API will return the list of ems-routing objects (just keys) that were not modified due to some error. If set to false, the list of ems-routing objects not modified will not be returned. Default: true
> return-success-list |  | boolean optional | If set to true, the API will return the list of ems-routing objects (just keys) that were successfully updated. If set to false, the list of ems-routing objects modified will not be returned. Default: true
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
> Output Name | Range | Type | Description
> failure-list |  | ems-routing-modify-iter-info[] optional | Information about ems-routing objects that were not modified due to some error. This element will be returned only if input element 'return-failure-list' is true.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more matching ems-routing objects to be modified.
> num-failed | [0..100] | integer optional | Number of ems-routing objects that matched the query, but were not modified due to some error.
> num-succeeded | [0..100] | integer optional | The number of ems-routing objects that matched the query and were successfully updated.
> success-list |  | ems-routing-modify-iter-info[] optional | The ems-routing objects that were successfully updated. This element will be returned only if input element 'return-success-list' is true

> Errno | Description
> EINTERNALERROR |  |

ems-routing-remove-destination | [top]

> Remote EMS Destinations.

> Input Name | Range | Type | Description
> destinations |  | ems-destination[] | Destinations
> message-name |  | ems-id | The name of the EMS message.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

ems-snmp-history-destroy | [top]

> Delete an individual SNMP history entry.

> Input Name | Range | Type | Description
> node |  | node-name | Node emitting the EMS message.
> seq-num |  | seqnum | The message sequence number.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

ems-snmp-history-destroy-iter | [top]

> Delete SNMP history entries.

> Input Name | Range | Type | Description
> continue-on-failure |  | boolean optional | This input element is useful when multiple ems-snmp-history objects match a given query. If set to true, the API will continue deleting the next matching ems-snmp-history even when the deletion of a previous ems-snmp-history fails. If set to false, the API will return on the first failure. Default: false
> max-failure-count | [1..2^32-1] | integer optional | When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed deletions before the server gives up and returns. If set, the API will continue deleting the next matching ems-snmp-history even when the deletion of a previous matching ems-snmp-history fails, and do so until the total number of objects failed to be deleted reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed deletions. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
> max-records | [1..100] | integer optional | The maximum number of ems-snmp-history objects to delete in this call. Default: 20
> query |  | ems-snmp-history-info | If deleting a specific ems-snmp-history, this input element must specify all keys. If deleting multiple ems-snmp-history objects based on query, this input element must specify a query.
> return-failure-list |  | boolean optional | If set to true, the API will return the list of ems-snmp-history objects (just keys) that were not deleted due to some error. If set to false, the list of ems-snmp-history objects not deleted will not be returned. Default: true
> return-success-list |  | boolean optional | If set to true, the API will return the list of ems-snmp-history objects (just keys) that were successfully deleted. If set to false, the list of ems-snmp-history objects deleted will not be returned. Default: true
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the next-tag obtained from the previous call.
> Output Name | Range | Type | Description
> failure-list |  | ems-snmp-history-destroy-iter-info[] optional | Information about ems-snmp-history objects that were not deleted due to some error. This element will be returned only if input element 'return-failure-list' is true.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more matching ems-snmp-history objects to be deleted.
> num-failed | [0..100] | integer optional | Number of ems-snmp-history objects that matched the query, but were not deleted due to some error.
> num-succeeded | [0..100] | integer optional | The number of ems-snmp-history objects that matched the query and were successfully deleted.
> success-list |  | ems-snmp-history-destroy-iter-info[] optional | The ems-snmp-history objects that were successfully deleted. This element will be returned only if input element 'return-success-list' is true

> Errno | Description
> EINTERNALERROR |  |

ems-snmp-history-get | [top]

> Return an individual SNMP history entry.

> Input Name | Range | Type | Description
> desired-attributes |  | ems-snmp-history-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> node |  | node-name | Node emitting the EMS message.
> seq-num |  | seqnum | The message sequence number.
> Output Name | Range | Type | Description
> attributes |  | ems-snmp-history-info | The attributes of the ems-snmp-history.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

ems-snmp-history-get-iter | [top]

> Return information SNMP history.

> Input Name | Range | Type | Description
> desired-attributes |  | ems-snmp-history-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> max-records | [1..100] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | ems-snmp-history-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the ems-snmp-history object. All ems-snmp-history objects matching this query up to 'max-records' will be returned.
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
> Output Name | Range | Type | Description
> attributes-list |  | ems-snmp-history-info[] optional | The list of attributes of ems-snmp-history objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more ems-snmp-history objects to return.
> num-records | [0..100] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

ems-status-get | [top]

> Return information an EMS message.

> Input Name | Range | Type | Description
> desired-attributes |  | ems-status-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> message-name |  | ems-id | The message name.
> node |  | node-name | Node emitting the EMS message.
> Output Name | Range | Type | Description
> attributes |  | ems-status-info | The attributes of the ems-status.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

ems-status-get-iter | [top]

> Return information on EMS messages.

> Input Name | Range | Type | Description
> desired-attributes |  | ems-status-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> max-records | [1..100] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | ems-status-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the ems-status object. All ems-status objects matching this query up to 'max-records' will be returned.
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
> Output Name | Range | Type | Description
> attributes-list |  | ems-status-info[] optional | The list of attributes of ems-status objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more ems-status objects to return.
> num-records | [0..100] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

Element definition: ems-config-info | [top]

> EMS Configuration Info When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

> Name | Range | Type | Description
> console |  | boolean optional | Whether console logging should be used. Attributes: non-creatable, modifiable
> console-log-level |  | emsseverity optional | Console logging level. Attributes: non-creatable, modifiable Possible values: "node_fault" - A data corruption has been detected or the node is unable to provide client service, "svc_fault" - A temporary loss of service has been detected, typically a transient software fault, "node_error" - A hardware error has been detected which is not immediately fatal, "svc_error" - A software error has been detected which is not immediately fatal, "warning" - A high-priority message, does not indicate a fault, "notice" - A normal-priority message, does not indicate a fault, "info" - A low-priority message, does not indicate a fault, "debug" - A debugging message, typically suppressed from customer, "var" - Message has variable severity, selected at runtime
> mail-from |  | mail-address optional | The from address of ems mail. Attributes: non-creatable, modifiable
> mail-server |  | remote-ip optional | The mail server to use when sending mail. Attributes: non-creatable, modifiable
> max-log-show-size | [1..10000] | integer optional | Maximum number of events to show. Attributes: non-creatable, modifiable
> max-target-event-bytes | [10..134217728] | integer optional | Maximum bytes per event per week. Used by autosuppression to control growth of log file size. Attributes: non-creatable, modifiable
> max-target-log-size | [1048576..134217728] | integer optional | The target upper limit of the event log file size in bytes. Used by autosuppression to control growth of log file size. Attributes: non-creatable, modifiable
> suppression |  | boolean optional | Whether suppression should be used. Attributes: non-creatable, modifiable
> trace-log-size | [1..10000] | integer optional | Maximum number of traces kept. Attributes: non-creatable, modifiable

Element definition: ems-destination | [top]

> EMS destination

> [none]

Element definition: ems-destination-destroy-iter-info | [top]

> Information about the deletion operation that was attempted/performed against ems-destination object.

> Name | Range | Type | Description
> ems-destination-key |  | ems-destination-info | The keys for the ems-destination object to which the deletion applies.
> error-code | [0..2^32-1] | integer optional | Error code, if the deletion operation caused an error.
> error-message |  | string optional | Error description, if the operation caused an error.

Element definition: ems-destination-info | [top]

> EMS Destination Info When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

> Name | Range | Type | Description
> hide-parameters |  | boolean optional | Hide parameter values? Attributes: optional-for-create, modifiable
> mail |  | mail-address[] optional | The e-mail address to which events are sent. Attributes: optional-for-create, modifiable
> name |  | string optional | The name of the EMS destination. Attributes: key, required-for-create, non-modifiable
> snmp |  | remote-ip[] optional | The SNMP addresses to which traps are sent. Attributes: optional-for-create, modifiable
> snmp-community |  | string optional | The SNMP community name. Attributes: optional-for-create, modifiable
> syslog |  | remote-ip[] optional | The remote syslog servers to which messages are sent. Attributes: optional-for-create, modifiable
> syslog-facility |  | syslog-facility optional | The syslog logging facility. Attributes: optional-for-create, modifiable

Element definition: ems-destination-modify-iter-info | [top]

> Information about the modify operation that was attempted/performed against ems-destination object.

> Name | Range | Type | Description
> ems-destination-key |  | ems-destination-info | The keys for the ems-destination object to which the modify operation applies.
> error-code | [0..2^32-1] | integer optional | Error code, if the modify operation caused an error.
> error-message |  | string optional | Error description, if the modify operation caused an error.

Element definition: ems-id | [top]

> EMS Id

> [none]

Element definition: ems-mail-history-destroy-iter-info | [top]

> Information about the deletion operation that was attempted/performed against ems-mail-history object.

> Name | Range | Type | Description
> ems-mail-history-key |  | ems-mail-history-info | The keys for the ems-mail-history object to which the deletion applies.
> error-code | [0..2^32-1] | integer optional | Error code, if the deletion operation caused an error.
> error-message |  | string optional | Error description, if the operation caused an error.

Element definition: ems-mail-history-info | [top]

> EMS Mail History Info When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

> Name | Range | Type | Description
> drops-since-previous-time | [0..2^32-1] | integer optional | Number of drops since previous transmission. Attributes: non-creatable, non-modifiable
> mail-address |  | mail-address[] optional | The mail address. Attributes: non-creatable, non-modifiable
> message |  | string optional | The alert message. Attributes: non-creatable, non-modifiable
> message-name |  | ems-id optional | The emitted message's name. Attributes: non-creatable, non-modifiable
> node |  | node-name optional | Node emitting the EMS message. Attributes: key, required-for-create, non-modifiable
> previous-time |  | datetime optional | Previous transmission time. Attributes: non-creatable, non-modifiable
> seq-num |  | seqnum optional | The message sequence number. Attributes: key, required-for-create, non-modifiable
> time |  | datetime optional | The mail transmission time. Attributes: non-creatable, non-modifiable

Element definition: ems-message-info | [top]

> EMS Message Info When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

> Name | Range | Type | Description
> ems-severity |  | emsseverity optional | Message EMS severity. Attributes: non-creatable, non-modifiable Possible values: "node_fault" - A data corruption has been detected or the node is unable to provide client service, "svc_fault" - A temporary loss of service has been detected, typically a transient software fault, "node_error" - A hardware error has been detected which is not immediately fatal, "svc_error" - A software error has been detected which is not immediately fatal, "warning" - A high-priority message, does not indicate a fault, "notice" - A normal-priority message, does not indicate a fault, "info" - A low-priority message, does not indicate a fault, "debug" - A debugging message, typically suppressed from customer, "var" - Message has variable severity, selected at runtime
> event |  | string optional | The EMS event. Attributes: non-creatable, non-modifiable
> event-xml-len | [0..2^32-1] | integer optional | EMS event XML length in bytes. Attributes: non-creatable, non-modifiable
> kernel-gen | [0..2^64-1] | integer optional | The emitted message's kernel generation number. Attributes: non-creatable, non-modifiable
> kernel-seq-num | [0..2^64-1] | integer optional | The emitted message's kernel sequence number. Attributes: non-creatable, non-modifiable
> message-name |  | ems-id optional | The emitted message's name. Attributes: non-creatable, non-modifiable
> node |  | node-name optional | Node emitting the EMS message. Attributes: key, non-creatable, non-modifiable
> num-suppressed-since-last | [0..2^32-1] | integer optional | Number of times suppressed since last time the event was logged. Attributes: non-creatable, non-modifiable
> seq-num |  | seqnum optional | The message sequence number. Attributes: key, non-creatable, non-modifiable
> severity |  | eventseverity optional | Message severity. Attributes: non-creatable, non-modifiable Possible values: "emergency" - System is unusable, "alert" - Action must be taken immediately, "critical" - Critical condition, "error" - Error condition, "warning" - Warning condition, "notice" - Normal but significant condition, "informational" - Information message, "debug" - A debugging message
> source |  | string optional | The emitted message's source. Attributes: non-creatable, non-modifiable
> time |  | datetime optional | The time of message emission. Attributes: non-creatable, non-modifiable

Element definition: ems-routing-info | [top]

> EMS Routing Info When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

> Name | Range | Type | Description
> action |  | string optional | The configured action. Attributes: non-creatable, non-modifiable
> description |  | string optional | The event description. Attributes: non-creatable, non-modifiable
> destinations |  | ems-destination[] optional | The event destinations. Attributes: non-creatable, modifiable
> frequency-threshold | [0..2^32-1] | integer optional | Number of times an event occurs before a repeat notification of the event is sent. Attributes: non-creatable, modifiable
> message-name |  | ems-id optional | The name of the EMS message. Attributes: key, non-creatable, non-modifiable
> severity |  | eventseverity optional | The event severity. Attributes: non-creatable, non-modifiable Possible values: "emergency" - System is unusable, "alert" - Action must be taken immediately, "critical" - Critical condition, "error" - Error condition, "warning" - Warning condition, "notice" - Normal but significant condition, "informational" - Information message, "debug" - A debugging message
> snmp-support |  | boolean optional | Indicates whether or not the event supports SNMP traps. Attributes: non-creatable, non-modifiable
> time-threshold | [0..2^32-1] | integer optional | Minimum number of seconds between repeat notifications of an event. Attributes: non-creatable, modifiable

Element definition: ems-routing-modify-iter-info | [top]

> Information about the modify operation that was attempted/performed against ems-routing object.

> Name | Range | Type | Description
> ems-routing-key |  | ems-routing-info | The keys for the ems-routing object to which the modify operation applies.
> error-code | [0..2^32-1] | integer optional | Error code, if the modify operation caused an error.
> error-message |  | string optional | Error description, if the modify operation caused an error.

Element definition: ems-snmp-history-destroy-iter-info | [top]

> Information about the deletion operation that was attempted/performed against ems-snmp-history object.

> Name | Range | Type | Description
> ems-snmp-history-key |  | ems-snmp-history-info | The keys for the ems-snmp-history object to which the deletion applies.
> error-code | [0..2^32-1] | integer optional | Error code, if the deletion operation caused an error.
> error-message |  | string optional | Error description, if the operation caused an error.

Element definition: ems-snmp-history-info | [top]

> EMS SNMP History Info When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

> Name | Range | Type | Description
> drops-since-previous-time | [0..2^32-1] | integer optional | Number of drops since previous transmission. Attributes: non-creatable, non-modifiable
> message |  | string optional | The alert message. Attributes: non-creatable, non-modifiable
> message-name |  | ems-id optional | The emitted message's name. Attributes: non-creatable, non-modifiable
> node |  | node-name optional | Node emitting the EMS message. Attributes: key, required-for-create, non-modifiable
> previous-time |  | datetime optional | Previous transmission time. Attributes: non-creatable, non-modifiable
> seq-num |  | seqnum optional | The message sequence number. Attributes: key, required-for-create, non-modifiable
> snmp-address |  | string[] optional | The SNMP client address. Attributes: non-creatable, non-modifiable
> time |  | datetime optional | The SNMP transmission time. Attributes: non-creatable, non-modifiable

Element definition: ems-status-info | [top]

> EMS Message Info When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

> Name | Range | Type | Description
> accumulated-bytes | [0..2^32-1] | integer optional | The total number of bytes the event has accumulated in the log file. Attributes: non-creatable, non-modifiable
> change-since |  | boolean optional | The algorithm to determine which events are considered chatter is run periodically. The change-since parameter indicates whether the event has been posted since the last time the chatter determination algorithm has run. Attributes: non-creatable, non-modifiable
> drops | [0..2^32-1] | integer optional | Number of times the event has been suppressed. Attributes: non-creatable, non-modifiable
> indications | [0..2^32-1] | integer optional | Number of times the event has been posted. Attributes: non-creatable, non-modifiable
> is-chatter |  | boolean optional | Whether the event is considered chatter, and therefore subject to autosuppression. Attributes: non-creatable, non-modifiable
> last-day-histogram | [0..2^32-1] | integer[] optional | 24-hour histogram. Number of times the event was posted in the last day. The histogram is divided into 24 buckets, each bucket collecting one hour. The buckets are displayed in reverse chronological order (most recent first). Attributes: non-creatable, non-modifiable
> last-hour-histogram | [0..2^32-1] | integer[] optional | 60-minute histogram. Number of times the event was posted in the last hour. The histogram is divided into sixty buckets, each bucket collecting one minute. The buckets are displayed in reverse chronological order (most recent first). Attributes: non-creatable, non-modifiable
> last-time-dropped |  | datetime optional | Time the event was most recently posted and suppressed. Attributes: non-creatable, non-modifiable
> last-time-occurred |  | datetime optional | Time the event was most recently posted. Attributes: non-creatable, non-modifiable
> last-time-processed |  | datetime optional | Time the event was most recently posted and not suppressed. Attributes: non-creatable, non-modifiable
> last-week-histogram | [0..2^32-1] | integer[] optional | 7-day histogram. Number of times the event was posted in the last week. The histogram is divided into 7 buckets, each bucket collecting one day. The buckets are displayed in reverse chronological order (most recent first). Attributes: non-creatable, non-modifiable
> message-name |  | ems-id optional | The message name. Attributes: key, non-creatable, non-modifiable
> node |  | node-name optional | Node emitting the EMS message. Attributes: key, non-creatable, non-modifiable
> num-autosuppressed | [0..2^32-1] | integer optional | Number of times the event has been autosuppressed. Attributes: non-creatable, non-modifiable
> num-dup-suppressed | [0..2^32-1] | integer optional | Number of times the event has been duplicate suppressed. Attributes: non-creatable, non-modifiable
> num-rate-limited | [0..2^32-1] | integer optional | Number of times the event has been rate limited. Attributes: non-creatable, non-modifiable
> num-suppressed-since-last | [0..2^32-1] | integer optional | Number of times suppressed since last time logged. Attributes: non-creatable, non-modifiable
> num-timer-suppressed | [0..2^32-1] | integer optional | Number of times the event has been timer suppressed. Attributes: non-creatable, non-modifiable
> probability | [0..100] | integer optional | Probability of an event being suppressed via autosuppress. Attributes: non-creatable, non-modifiable
> severity |  | emsseverity optional | The severity of the event. Attributes: non-creatable, non-modifiable Possible values: "node_fault" - A data corruption has been detected or the node is unable to provide client service, "svc_fault" - A temporary loss of service has been detected, typically a transient software fault, "node_error" - A hardware error has been detected which is not immediately fatal, "svc_error" - A software error has been detected which is not immediately fatal, "warning" - A high-priority message, does not indicate a fault, "notice" - A normal-priority message, does not indicate a fault, "info" - A low-priority message, does not indicate a fault, "debug" - A debugging message, typically suppressed from customer, "var" - Message has variable severity, selected at runtime
> stat-starting-time |  | datetime optional | Time the event was first posted. Attributes: non-creatable, non-modifiable

Element definition: emsseverity | [top]

> NODE_FAULT|SVC_FAULT|NODE_ERROR|SVC_ERROR|WARNING|NOTICE|INFO|DEBUG|VAR Possible values: "node_fault" - A data corruption has been detected or the node is unable to provide client service, "svc_fault" - A temporary loss of service has been detected, typically a transient software fault, "node_error" - A hardware error has been detected which is not immediately fatal, "svc_error" - A software error has been detected which is not immediately fatal, "warning" - A high-priority message, does not indicate a fault, "notice" - A normal-priority message, does not indicate a fault, "info" - A low-priority message, does not indicate a fault, "debug" - A debugging message, typically suppressed from customer, "var" - Message has variable severity, selected at runtime

> [none]

Element definition: mail-address | [top]

> E-mail Address

> [none]

Element definition: node-name | [top]

> The node's name

> [none]

Element definition: remote-ip | [top]

> Remote IP Address

> [none]

Element definition: seqnum | [top]

> Reverse-ordered Integer Range : [0..2^64-1].

> [none]

Element definition: syslog-facility | [top]

> The syslog facility.

> [none]

Element definition: datetime | [top]

> The number of seconds since January 1, 1970. Range : [0..2^31-1].

> [none]

Element definition: ems-destination | [top]

> EMS destination

> [none]

Element definition: ems-destination-info | [top]

> EMS Destination Info When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

> Name | Range | Type | Description
> hide-parameters |  | boolean optional | Hide parameter values? Attributes: optional-for-create, modifiable
> mail |  | mail-address[] optional | The e-mail address to which events are sent. Attributes: optional-for-create, modifiable
> name |  | string optional | The name of the EMS destination. Attributes: key, required-for-create, non-modifiable
> snmp |  | remote-ip[] optional | The SNMP addresses to which traps are sent. Attributes: optional-for-create, modifiable
> snmp-community |  | string optional | The SNMP community name. Attributes: optional-for-create, modifiable
> syslog |  | remote-ip[] optional | The remote syslog servers to which messages are sent. Attributes: optional-for-create, modifiable
> syslog-facility |  | syslog-facility optional | The syslog logging facility. Attributes: optional-for-create, modifiable

Element definition: ems-id | [top]

> EMS Id

> [none]

Element definition: ems-routing-info | [top]

> EMS Routing Info When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

> Name | Range | Type | Description
> action |  | string optional | The configured action. Attributes: non-creatable, non-modifiable
> description |  | string optional | The event description. Attributes: non-creatable, non-modifiable
> destinations |  | ems-destination[] optional | The event destinations. Attributes: non-creatable, modifiable
> frequency-threshold | [0..2^32-1] | integer optional | Number of times an event occurs before a repeat notification of the event is sent. Attributes: non-creatable, modifiable
> message-name |  | ems-id optional | The name of the EMS message. Attributes: key, non-creatable, non-modifiable
> severity |  | eventseverity optional | The event severity. Attributes: non-creatable, non-modifiable Possible values: "emergency" - System is unusable, "alert" - Action must be taken immediately, "critical" - Critical condition, "error" - Error condition, "warning" - Warning condition, "notice" - Normal but significant condition, "informational" - Information message, "debug" - A debugging message
> snmp-support |  | boolean optional | Indicates whether or not the event supports SNMP traps. Attributes: non-creatable, non-modifiable
> time-threshold | [0..2^32-1] | integer optional | Minimum number of seconds between repeat notifications of an event. Attributes: non-creatable, modifiable

Element definition: eventseverity | [top]

> EMERGENCY|ALERT|CRITICAL|ERROR|WARNING|NOTICE|INFORMATIONAL|DEBUG Possible values: "emergency" - System is unusable, "alert" - Action must be taken immediately, "critical" - Critical condition, "error" - Error condition, "warning" - Warning condition, "notice" - Normal but significant condition, "informational" - Information message, "debug" - A debugging message

> [none]

Element definition: mail-address | [top]

> E-mail Address

> [none]

Element definition: remote-ip | [top]

> Remote IP Address

> [none]

Element definition: syslog-facility | [top]

> The syslog facility.

> [none]

Element definition: ems-destination | [top]

> EMS destination

> [none]

Element definition: ems-id | [top]

> EMS Id

> [none]