Go to main content

Oracle® ZFS Storage Appliance RESTful API Guide, Release OS8.7.x

Exit Print View

Updated: December 2017
 
 

Alert Actions

The category property determines the type of alert action being defined. Each category has its own property set defined.

Supported categories are:

  • ad

  • all

  • appliance_software

  • backup

  • cluster

  • custom

  • hardware

  • hardware_faults

  • ndmp

  • network

  • replication

  • replication_source

  • replication_target

  • restore

  • scrk

  • shadow

  • smf

  • thresholds

  • zfs_pool

Table 8  Alert Actions "ad"
Property
Type
Description
active_directory_degraded
Boolean
Filter should match active_directory_degraded events [true or false]
smb_kerberos_client_authentication_degraded
Boolean
Filter should match mb_kerberos_client_authentication_degraded events [true or false]
Table 9  Alert Actions "all"
Property
Type
Description
all_defects
Boolean
Filter should match all_defects events [true, false]
service_alerts
Boolean
Filter should match service_alerts events true, false]
all_hardware_faults
Boolean
Filter should match all_hardware_faults events [true, false]
Table 10  Alert Actions "appliance software"
Property
Type
Description
obstacles_to_system_software_update
Boolean
Filter should match obstacles_to_system_software_update events [true, false]
operating_system_kernel_panic
Boolean
Filter should match operating_system_kernel_panic events [true or false]
Table 11  Alert Actions backup
Property
Type
Description
backup_finished
Boolean
Filter should match backup_finished events [true or false]
backup_started
Boolean
Filter should match backup_started events [true or false]
Table 12  Alert Actions "cluster"
Property
Type
Description
cluster_i/o_link_down
Boolean
Filter should match cluster_i /o_link_down events [true or false]
cluster_i/o_link_failed
Boolean
Filter should match cluster_i /o_link_failed events [true or false]
cluster_i/o_link_up
Boolean
Filter should match cluster_i /o_link_up events [true or false]
unexpected_peer_error_occurred
Boolean
Filter should match unexpected_peer_error_occurred events [true or false]
communication_to_peer_lost
Boolean
Filter should match communication_to_peer_lost events [true or false]
cluster_peer_panicked
Boolean
Filter should match cluster_peer_panicked events [true or false]
failed_to_set_sp_root_password_on_cluster_peer
Boolean
Filter should match failed_to_set_sp_root_password_on_cluster_peer events [true or false]
cluster_rejoin_failed_on_peer
Boolean
Filter should match cluster_rejoin_failed_on_peer events [true or false]
cluster_rejoin_mismatch_on_peer
Boolean
Filter should match cluster_rejoin_mismatch_on_peer events [true or false]
cluster_rejoin_completed_on_peer
Boolean
Filter should match cluster_rejoin_completed_on_peer events [true or false]
cluster_peer_lost_communication_token
Boolean
Filter should match cluster_peer_lost_communication_token events [true or false]
cluster_rejoin _failed
Boolean
Filter should match cluster_rejoin_failed events [true or false]
cluster_rejoin_mismatch
Boolean
Filter should match cluster_rejoin_mismatch events [true or false]
cluster_rejoin_completed
Boolean
Filter should match cluster_rejoin_completed events [true or false]
cluster_takeover_complete
Boolean
Filter should match cluster_takeover_complete events [true or false]
resource_import_failed_during_cluster_takeover
Boolean
Filter should match resource_import_failed_during_cluster_takeover events [true or false]
local_cluster_communication_token_lost
Boolean
Filter should match local_cluster_communication_token_lost events [true or false]
Table 13  Alert Actions "custom"
Property
Type
Description
patterns
Default
FMA event patterns
Table 14  Alert Actions "hardware"
Property
Type
Description
fibre_channel_port_down
Boolean
Filter should match fibre_channel_port_down events [true or false]
multiple_transient_fibre_channel_port_status _changes
Boolean
Filter should match multiple_transient_fibre_channel_port _status_changes events [true or false]
transient_fibre_channel_port_status_change
Boolean
Filter should match transient_fibre_channel_port_status_change events [true or false]
fibre_channel_port_up
Boolean
Filter should match fibre_channel_port_up events [true or false]
network_port_down
Boolean
Filter should match network_port_down events [true or false]
network_port_up
Boolean
Filter should match network_port_up events [true or false]
chassis_connected_to_system
Boolean
Filter should match chassis_connected_to_system events [true or false]
chassis_removed
Boolean
Filter should match chassis_removed events [true or false]
hardware_component_inserted
Boolean
Filter should match hardware_component_inserted events [true or false]
hardware_component_removed
Boolean
Filter should match hardware_component_removed events [true or false]
disk_inserted
Boolean
Filter should match disk_inserted events [true or false]
disk_removed
Boolean
Filter should match disk_removed events [true or false]
i/o_path_added
Boolean
Filter should match i/o_path_added events [true or false]
i/o_path_removed
Boolean
Filter should match i/o_path_removed events [true or false]
service_processor_offline_or_unavailable
Boolean
Filter should match service_processor_offline_or_unavailable events [true or false]
service_processor_online_after_outage
Boolean
Filter should match service_processor_online_after_outage events [true or false]
failed_to_set_root_password_on_service_processor
Boolean
Filter should match failed_to_set_root_password_on_service_processor events [true or false]
Table 15  Alert Actions "hardware_faults"
Property
Type
Description
all_hardware_faults
Boolean
Filter should match all_hardware_faults events [true or false]
Table 16  Alert Actions "ndmp"
Property
Type
Description
invalid_ndmp_restore
Boolean
Filter should match invalid_ndmp_restore events [true or false]
backup_finished
Boolean
Filter should match backup_finished events [true or false]
backup_started
Boolean
Filter should match backup_started events [true or false]
restore_finished
Boolean
Filter should match restore_finished events [true or false]
restore_started
Boolean
Filter should match restore_started events [true or false]
Table 17  Alert Actions "network"
Property
Type
Description
datalink_failed
Boolean
Filter should match datalink_failed events [true or false]
datalink_ok
Boolean
Filter should match datalink_ok events [true or false]
network_port_down
Boolean
Filter should match network_port_down events [true or false]
network_port_up
Boolean
Filter should match network_port_up events [true or false]
ip_address_conflict
Boolean
Filter should match ip_address_conflict events [true or false]
ip_address_conflict_resolved
Boolean
Filter should match ip_address_conflict_resolved events [true or false]
ip_interface_degraded
Boolean
Filter should match ip_interface_degraded events [true or false]
ip_interface_failed
Boolean
Filter should match ip_interface_failed events [true or false]
ip_interface_ok
Boolean
Filter should match ip_interface_ok events [true or false]
Table 18  Alert Actions "replication"
Property
Type
Description
receive_failed_(unsupported _version)
Boolean
Filter should match receive_failed_(unsupported_version) events [true or false]
receive_failed_(cancelled)
Boolean
Filter should match receive_failed_(cancelled) events [true or false]
receive_failed_(all_others)
Boolean
Filter should match receive_failed_(all_others) events [true or false]
receive_failed_(out_of_space)
Boolean
Filter should match receive_failed_(out_of_space) events [true or false]
receive_failed_(package_not _upgraded)
Boolean
Filter should match receive_failed_(package_not_upgraded) events [true or false]
receive_finished
Boolean
Filter should match receive_finished events [true or false]
receive_started
Boolean
Filter should match receive_started events [true or false]
send_failed_(unsupported_version)
Boolean
Filter should match send_failed_(unsupported_version) events [true or false]
send_failed_(cancelled)
Boolean
Filter should match send_failed_(cancelled) events [true or false]
send_failed_(all_others)
Boolean
Filter should match send_failed_(all_others) events [true or false]
send_failed_(connectivity)
Boolean
Filter should match send_failed_(connectivity) events [true or false]
send_failed_(out_of_space)
Boolean
Filter should match send_failed_(out_of_space) events [true or false]
send_failed_(remote _verification)
Boolean
Filter should match send_failed_(remote_verification) events [true or false]
send_finished
Boolean
Filter should match send_finished events [true or false]
send_skipped_(already_running)
Boolean
Filter should match send_skipped_(already_running) events [true or false]
send_started
Boolean
Filter should match send_started events [true or false]
Table 19  Alert Actions "replication_source"
Property
Type
Description
send_failed_(unsupported_version)
Boolean
Filter should match send_failed_(unsupported_version) events [true or false]
send_failed_(cancelled)
Boolean
Filter should match send_failed_(cancelled) events [true or false]
send_failed_(all_others)
Boolean
Filter should match send_failed_(all_others) events [true or false]
send_failed_(connectivity)
Boolean
Filter should match send_failed_(connectivity) events [true or false]
send_failed_(out_of_space)
Boolean
Filter should match send_failed_(out_of_space) events [true or false]
send_failed_(remote_verification)
Boolean
Filter should match send_failed_(remote_verification) events [true or false]
send_finished
Boolean
Filter should match send_finished events [true or false]
send_skipped_(already_running)
Boolean
Filter should match send_skipped_(already_running) events [true or false]
send_started
Boolean
Filter should match send_started events [true or false]
Table 20  Alert Actions "replication_target"
Property
Type
Description
receive_failed_(unsupported_verrsion)
Boolean
Filter should match receive_failed_(unsupported_version) events [true or false]
receive_failed_(cancelled)
Boolean
Filter should match receive_failed_(cancelled) events [true or false]
receive_failed _(all_others)
Boolean
Filter should match receive_failed_(all_others) events [true or false]
receive_failed _(out_of_space)
Boolean
Filter should match receive_failed_(out_of_space) events [true or false]
receive_failed_(package_not_upgraded)
Boolean
Filter should match receive_failed_(package_not_upgraded) events [true or false]
receive_finished
Boolean
Filter should match receive_finished events [true or false]
receive_started
Boolean
Filter should match receive_started events [true or false]
Table 21  Alert Actions "restore"
Property
Type
Description
restore_finished
Boolean
Filter should match restore_finished events [true or false]
restore_started
Boolean
Filter should match restore_started events [true or false]
Table 22  Alert Actions "scrk"
Property
Type
Description
support_bundle_build_failed
Boolean
Filter should match support_bundle_build_failed events [true or false]
support_bundle_sent
Boolean
Filter should match support_bundle_sent events [true or false]
support_bundle _upload_failed
Boolean
Filter should match support_bundle_upload_failed events [true or false]
an_update_is_available_on_my_oracle_support.
Boolean
Filter should match an_update_is_available_on_my_oracle_support. events [true or false]
no_updates_available.
Boolean
Filter should match no_updates_available. events [true or false]
the_appliance_failed_to_verify _if_an_update_i s_available.
Boolean
Filter should match the_appliance_failed_to_verify_if_an_u pdate_is_available. events [true or false]
Table 23  Alert Actions "shadow"
Property
Type
Description
shadow_migration_complete
Boolean
Filter should match shadow_migration_complete events [true or false]
Table 24  Alert Actions "smf"
Property
Type
Description
service_failures
Boolean
Filter should match service_failures events [true or false]
Table 25  Alert Actions "thresholds"
Property
Type
Description
thresholdid
Default
UUID of watch whose alerts should match
Table 26  Alert Actions "zfs_pool"
Property
Type
Description
resilver_finished
Boolean
Filter should match resilver_finished events [true or false]
resilver_started
Boolean
Filter should match resilver_started events [true or false]
scrub_finished
Boolean
Filter should match scrub_finished events [true or false]
scrub_started
Boolean
Filter should match scrub_started events [true or false]
hot_spare_activated
Boolean
Filter should match hot_spare_activated events [true or false]

List Alert Actions

The list alert actions command lists all of the alert actions. To get data for a single resource, send an HTTP GET request to the href property of the given alert actions resource.

Example Request to Get Alert Actions:

GET /api/alert/v1/actions HTTP/1.1
Authorization: Basic abcd123MWE=
Host: zfs-storage.example.com:215
Accept: application/json

Example Response:

HTTP/1.1 200 OK
X-Zfssa-Appliance-Api: 1.0
Content-Type: application/json
Content-Length: 1395

{
    "actions": [
        {
            "action": "actions-000",
            "category": "smf",
            "href": "/api/alert/v1/actions/actions-000",
            "service_failures": true
        },
        {
            "action": "actions-001",
            "category": "scrk",
            "href": "/api/alert/v1/actions/actions-001",
            "action-000": {
                    "handler": "snmp_trap",
                    "href": "/api/alert/v1/alerts/actions/actions-001
                             /action-000"
            },
            "action-001": {
                    "address": "Joe.Admin@acme.com",
                    "handler": "email",
                    "href": "/api/alert/v1/actions/actions-001
                             /action-001",
                    "subject": "Phone Home Alert"
            },
            "support_bundle_build_failed": true,
            "support_bundle_sent": true,
            "support_bundle_upload_failed": true
        },
        {
            "action": "actions-002",
            "category": "thresholds",
            "href": "/api/alert/v1/actions/actions-002",
            "action-000": {
                    "address": "Joe.Admin@acme.com",
                    "handler": "email",
                    "href": "/api/alert/v1/actions/actions-002
                             /action-000",
                    "subject": "CPU Busy Alert"
            },
            "thresholdid": "b182ca05-53d3-6604-b874-ec353335704d"
        }
    ]
}

Get Alert Action

This command is similar to List Alert Action, but it returns only the specified alert action.

Example Request:

GET /api/alert/v1/actions/actions-002 HTTP/1.1

Example Response:

HTTP/1.1 200 OK
X-Zfssa-Appliance-Api: 1.0
Content-Type: application/json
Content-Length: 331

{
    "action": {
        "category": "thresholds",
        "href": "/api/alert/v1/actions/actions-002",
        "action-000": {
                "address": "Joe.Admin@acme.com",
                "handler": "email",
                "href": "/api/alert/v1/alerts/actions/actions-002
                         /action-000",
                "subject": "CPU Busy"
        },
        "thresholdid": "b182ca05-53d3-6604-b874-ec353335704d"
    }
}

Create Alert Action

When you create an alert action POST request containing a JSON object, the action properties must be sent to /api/alert/v1/alerts/actions. The category property must be set to select the type of action to create. See the CLI documentation for all of the available category values on a given system.

Category values typically include:

"ad", "all", "appliance_software", "backup", "cluster", "custom",
"hardware", "hardware_faults", "ndmp", "network", "replication",
"replication_source", "replication_target", "restore", "scrk", "shadow",
"smf", "thresholds" or "zfs_pool"

Example Request:

POST /api/alert/v1/actions HTTP/1.1
Host: zfssa.example.com:215
X-Auth-Session: uerqghq84vbdv
Content-Type: application/json
Content-Length: 30

{"category": "hardware_faults"}

Example Response:

HTTP/1.1 201 Created
X-Zfssa-Appliance-Api: 1.0
Content-Type: application/json
Content-Length: 118
Location: /api/alert/v1/actions/actions-006

{
    "action": {
        "href": "/api/alert/v1/actions/actions-006",
        "category": "hardware_faults",
        "all_hardware_faults": true
    }
}

Modify Alert Action

Some of the properties returned by the list command can be modified by sending an HTTP PUT request.

Example Request:

PUT /api/alert/v1/actions/actions-001 HTTP/1.1
Host: zfssa.example.com:215
X-Auth-Session: uerqghq84vbdv
Content-Type: application/json
Content-Length: 30

{"support_bundle_sent": false}

Example Response:

HTTP/1.1 202 Accepted
X-Zfssa-Appliance-Api: 1.0
Content-Type: application/json
Content-Length: 195

{
    "action": {
        "href": "/api/alert/v1/actions/actions-001",
        "category": "scrk",
        "support_bundle_build_failed": true,
        "support_bundle_sent": false,
        "support_bundle_upload_failed": true
    }
}

Delete Alert Action

Sending an HTTP DELETE request to any alert actions href or action href deletes the specified resource. A successful delete response is HTTP Status 204 (No Content).

Example Request:

DELETE /api/alert/v1/actions/actions-003 HTTP/1.1
Authorization: Basic abcd123MWE=
Host: zfssa.example.com:215

Example Response:

HTTP/1.1 204 No Content
X-Zfssa-Appliance-Api: 1.0