ems

Contributors

ems-autosupport-log

This ONTAPI call does not have an equivalent REST API call.

ems-config-get

GET /api/support/ems

ONTAPI attribute REST attribute Comment

auto-suppress-exempt-filter

No REST Equivalent

console

No REST Equivalent

console-log-level

No REST Equivalent

duplicate-suppression-duration

No REST Equivalent

log-rotation-size

No REST Equivalent

mail-from

mail_from

mail-server

mail_server

max-destination-count

No REST Equivalent

max-filter-count

No REST Equivalent

max-filter-rule-count

No REST Equivalent

max-log-show-size

No REST Equivalent

max-notification-count

No REST Equivalent

max-target-event-bytes

No REST Equivalent

max-target-log-size

No REST Equivalent

proxy-url

proxy_url

proxy-user

proxy_user

rest-delivery-timeout

No REST Equivalent

suppression

No REST Equivalent

trace-log-size

No REST Equivalent

ems-config-modify

PATCH /api/support/ems

ONTAPI attribute REST attribute Comment

auto-suppress-exempt-filter

No REST Equivalent

console

No REST Equivalent

console-log-level

No REST Equivalent

duplicate-suppression-duration

No REST Equivalent

log-rotation-size

No REST Equivalent

mail-from

mail_from

mail-server

mail_server

max-destination-count

No REST Equivalent

max-filter-count

No REST Equivalent

max-filter-rule-count

No REST Equivalent

max-log-show-size

No REST Equivalent

max-notification-count

No REST Equivalent

max-target-event-bytes

No REST Equivalent

max-target-log-size

No REST Equivalent

proxy-url

proxy_url

proxy-user

proxy_user

rest-delivery-timeout

No REST Equivalent

suppression

No REST Equivalent

trace-log-size

No REST Equivalent

ems-config-set-proxy-password

PATCH /api/support/ems

ONTAPI attribute REST attribute Comment

password-for-proxy-server

proxy_password

ems-destination-create

Note: Deprecated ONTAPI.

This ONTAPI call does not have an equivalent REST API call.

ems-destination-destroy

Note: Deprecated ONTAPI.

This ONTAPI call does not have an equivalent REST API call.

ems-destination-destroy-iter

Note: Deprecated ONTAPI.

This ONTAPI call does not have an equivalent REST API call.

ems-destination-get

Note: Deprecated ONTAPI.

This ONTAPI call does not have an equivalent REST API call.

ems-destination-get-iter

Note: Deprecated ONTAPI.

This ONTAPI call does not have an equivalent REST API call.

ems-destination-modify

Note: Deprecated ONTAPI.

This ONTAPI call does not have an equivalent REST API call.

ems-destination-modify-iter

Note: Deprecated ONTAPI.

This ONTAPI call does not have an equivalent REST API call.

ems-event-catalog-get-iter

GET /api/support/ems/messages

ONTAPI attribute REST attribute Comment

action

corrective_action

deprecated

deprecated

description

description

filter-name

No REST Equivalent

message-name

name

severity

severity

snmp-trap-type

snmp_trap_type

max-records

max_records

The maximum number of records to return before paging

ems-event-filter-copy

This ONTAPI call does not have an equivalent REST API call.

ems-event-filter-create

POST /api/support/ems/filters

Note: Rules can also be specified during filter creation.

ONTAPI attribute REST attribute Comment

filter-name

name

ems-event-filter-destroy-iter

DELETE /api/support/ems/filters

Note: To delete multiple filters, use a query.
eg: DELETE /api/support/ems/filters?name={name1|name2|name3}.
You can use attributes other than 'name' in the query.

ONTAPI attribute REST attribute Comment

continue-on-failure

continue_on_failure

force-delete-notification

No REST Equivalent

max-failure-count

No REST Equivalent

max-records

max_records

The maximum number of records to return before paging

event-filter-rule

No REST Equivalent

This attribute is not used by ZAPI either

filter-name

name

return-failure-list

No REST Equivalent

return-success-list

No REST Equivalent

ems-event-filter-get-iter

GET /api/support/ems/filters

ONTAPI attribute REST attribute Comment

event-filter-rule

rules

filter-name

name

max-records

max_records

The maximum number of records to return before paging

ems-event-filter-rename

PATCH /api/support/ems/filters/{name}?new_name={new_name}

ONTAPI attribute REST attribute Comment

filter-name

name

new-filter-name

new_name

ems-event-filter-rule-add

POST /api/support/ems/filters/{name}/rules

ONTAPI attribute REST attribute Comment

filter-name

name

message-name

message_criteria.name_pattern

position

index

severity

message_criteria.severities

snmp-trap-type

message_criteria.snmp_trap_types

type

type

ems-event-filter-rule-delete

DELETE /api/support/ems/filters/{name}/rules/{index}

ONTAPI attribute REST attribute Comment

filter-name

name

position

index

ems-event-filter-rule-reorder

PATCH /api/support/ems/filters/{name}/rules/{index}?new_index={new_index}

ONTAPI attribute REST attribute Comment

filter-name

name

position

index

to-position

new_index

ems-event-filter-test

This ONTAPI call does not have an equivalent REST API call.

ems-event-notification-create

POST /api/support/ems/destinations

Note: The notification is created internally during the creation or modification
of a destination. There is no explicit user action required.

ONTAPI attribute REST attribute Comment

destinations

name

filter-name

filters.name

ems-event-notification-destination-check

This ONTAPI call does not have an equivalent REST API call.

ems-event-notification-destination-create

POST /api/support/ems/destinations

ONTAPI attribute REST attribute Comment

certificate-authority

certificate.ca

certificate-serial

certificate.serial_number

email

destination

REST attr "type" must be set to "email"

name

name

rest-api-url

destination

REST attr "type" must be set to "rest_api"

return-record

No REST Equivalent

syslog

destination

REST attr "type" must be set to "syslog"

ems-event-notification-destination-destroy-iter

DELETE /api/support/ems/destinations

Note: To delete multiple notification destinations, use a query.
eg: DELETE /api/support/ems/destinations?name={name1|name2|name3}.
You can use attributes other than 'name' in the query.

ONTAPI attribute REST attribute Comment

continue-on-failure

continue_on_failure

force-delete-notification

No REST Equivalent

max-failure-count

No REST Equivalent

max-records

max_records

The maximum number of records to return before paging

certificate-authority

certificate.ca

certificate-serial

certificate.serial_number

email

destination

name

name

rest-api-url

destination

syslog

destination

return-failure-list

No REST Equivalent

return-success-list

No REST Equivalent

ems-event-notification-destination-get-iter

GET /api/support/ems/destinations

ONTAPI attribute REST attribute Comment

certificate-authority

certificate.ca

certificate-serial

certificate.serial_number

destination

destination

Unlike ONTAPI, REST attr can be an array

is-certificate-valid

No REST Equivalent

is-server-ca-present

No REST Equivalent

name

name

type

type

max-records

max_records

The maximum number of records to return before paging

ems-event-notification-destination-modify-iter

PATCH /api/support/ems/destinations

Note: To modify multiple notification destinations, use a query.
eg: PATCH /api/support/ems/destinations?name={name1|name2|name3}.
You can use attributes other than 'name' in the query.

ONTAPI attribute REST attribute Comment

certificate-authority

certificate.ca

certificate-serial

certificate.serial_number

email

destination

REST attribute "type" must be set to "email"

name

name

rest-api-url

destination

REST attribute "type" must be set to "rest_api"

syslog

destination

continue-on-failure

continue_on_failure

max-failure-count

No REST Equivalent

max-records

max_records

The maximum number of records to return before paging

return-failure-list

No REST Equivalent

return-success-list

No REST Equivalent

ems-event-notification-destroy-iter

PATCH /api/support/ems/destinations

Note: Notifications are internally maintained as part of a
destination in the REST API. The "filters" attribute creates
notifications from the filters to the destination. The notifications
can be deleted by modifying the associated destination.
To delete multiple notifications, use a query.
eg: PATCH /api/support/ems/destinations?name={name1|name2|name3}
and pass the 'filters' list as empty.

ONTAPI attribute REST attribute Comment

continue-on-failure

continue_on_failure

max-failure-count

No REST Equivalent

max-records

max_records

The maximum number of records to return before paging

destinations

name

filter-name

filters.name

id

No REST Equivalent

return-failure-list

No REST Equivalent

return-success-list

No REST Equivalent

ems-event-notification-get-iter

GET /api/support/ems/destinations

Note: Notifications are internally maintained as part of a
destination in the REST API. The "filters" attribute creates
notifications from the filters to the destination.

ONTAPI attribute REST attribute Comment

destinations

name

filter-name

filters.name

id

No REST Equivalent

max-records

max_records

The maximum number of records to return before paging

ems-event-notification-history-get-iter

This ONTAPI call does not have an equivalent REST API call.

ems-event-notification-modify-iter

PATCH /api/support/ems/destinations

Note: Modifying the destination associated with a notification modifies
the notification too. To modify multiple notifications, use a query.
eg: PATCH /api/support/ems/destinations?name={name1|name2|name3}.
You can use attributes other than 'name' in the query.

ONTAPI attribute REST attribute Comment

destinations

name

filter-name

filters.name

id

No REST Equivalent

continue-on-failure

continue_on_failure

max-failure-count

No REST Equivalent

max-records

max_records

The maximum number of records to return before paging

return-failure-list

No REST Equivalent

return-success-list

No REST Equivalent

ems-mail-history-destroy

Note: Deprecated ONTAPI.

This ONTAPI call does not have an equivalent REST API call.

ems-mail-history-destroy-iter

Note: Deprecated ONTAPI.

This ONTAPI call does not have an equivalent REST API call.

ems-mail-history-get

Note: Deprecated ONTAPI.

This ONTAPI call does not have an equivalent REST API call.

ems-mail-history-get-iter

Note: Deprecated ONTAPI.

This ONTAPI call does not have an equivalent REST API call.

ems-message-get

GET /api/support/ems/events?node={node}&index={seqnum}

ONTAPI attribute REST attribute Comment

ems-severity

No REST Equivalent

event

log_message

event-xml-len

No REST Equivalent

filter-name

filter.name

kernel-gen

No REST Equivalent

kernel-seq-num

No REST Equivalent

message-name

message.name

node

node

num-suppressed-since-last

No REST Equivalent

parameters

parameters

seq-num

index

severity

message.severity

source

source

time

time

version

No REST Equivalent

ems-message-get-iter

GET /api/support/ems/events

ONTAPI attribute REST attribute Comment

ems-severity

No REST Equivalent

event

log_message

event-xml-len

No REST Equivalent

filter-name

filter.name

kernel-gen

No REST Equivalent

kernel-seq-num

No REST Equivalent

message-name

message.name

node

node

num-suppressed-since-last

No REST Equivalent

parameters

parameters

seq-num

index

severity

message.severity

source

source

time

time

version

No REST Equivalent

node

node

max-records

max_records

The maximum number of records to return before paging

ems-routing-add-destination

Note: Deprecated ONTAPI.

This ONTAPI call does not have an equivalent REST API call.

ems-routing-get

Note: Deprecated ONTAPI.

This ONTAPI call does not have an equivalent REST API call.

ems-routing-get-iter

Note: Deprecated ONTAPI.

This ONTAPI call does not have an equivalent REST API call.

ems-routing-modify

Note: Deprecated ONTAPI.

This ONTAPI call does not have an equivalent REST API call.

ems-routing-modify-iter

Note: Deprecated ONTAPI.

This ONTAPI call does not have an equivalent REST API call.

ems-routing-remove-destination

Note: Deprecated ONTAPI.

This ONTAPI call does not have an equivalent REST API call.

ems-snmp-history-destroy

Note: Deprecated ONTAPI.

This ONTAPI call does not have an equivalent REST API call.

ems-snmp-history-destroy-iter

Note: Deprecated ONTAPI.

This ONTAPI call does not have an equivalent REST API call.

ems-snmp-history-get

Note: Deprecated ONTAPI.

This ONTAPI call does not have an equivalent REST API call.

ems-snmp-history-get-iter

Note: Deprecated ONTAPI.

This ONTAPI call does not have an equivalent REST API call.

ems-status-get

This ONTAPI call does not have an equivalent REST API call.

ems-status-get-iter

This ONTAPI call does not have an equivalent REST API call.