JavaScript is required to for searching.
ナビゲーションリンクをスキップ
印刷ビューの終了
Oracle® ZFS Storage Appliance RESTful API ガイド、Release 2013.1.3.0
Oracle Technology Network
ライブラリ
PDF
印刷ビュー
フィードバック
search filter icon
search icon

ドキュメント情報

Oracle ZFS Storage Appliance RESTful API の概要

RESTful API の操作

RESTful API 警告サービス

警告サービスコマンド

警告しきい値

警告しきい値の一覧表示

警告しきい値の取得

警告しきい値の作成

警告しきい値の変更

警告しきい値の削除

警告アクション

警告アクションの一覧表示

警告アクションの取得

警告アクションの作成

警告アクションの変更

警告アクションの削除

警告アクション項目

警告項目の作成

警告アクションの変更

警告アクション項目の削除

Analytics サービス

ハードウェアサービス

ログのコマンド

ネットワークのコマンド

RESTful API 問題サービス

RESTful API ロールサービス

RESTful API SAN サービス

サービスコマンド

RESTful API ストレージサービス

システムコマンド

RESTful API ユーザーサービス

ワークフローコマンド

RESTful クライアント

警告アクション

カテゴリプロパティーにより、定義される警告アクションのタイプが決定されます。各カテゴリには、定義済みの独自のプロパティーセットがあります。

サポートされているカテゴリ:

表 3-3  警告アクション「ad」
プロパティー
説明
active_directory_degraded
Boolean
フィルタは active_directory_degraded イベント [true または false] に一致する必要があります
smb_kerberos_client_authentication_degraded
Boolean
フィルタは mb_kerberos_client_authentication_degraded イベント [true または false] に一致する必要があります
表 3-4  警告アクション「all」
プロパティー
説明
all_defects
Boolean
フィルタは all_defects イベント [true、false] に一致する必要があります
service_alerts
Boolean
フィルタは service_alerts イベント [true、false] に一致する必要があります
all_hardware_faults
Boolean
フィルタは all_hardware_faults イベント [true、false] に一致する必要があります
表 3-5  警告アクション「appliance_software」
プロパティー
説明
obstacles_to_system_software_update
Boolean
フィルタは obstacles_to_system_software_update イベント [true、false] に一致する必要があります
operating_system_kernel_panic
Boolean
フィルタは operating_system_kernel_panic イベント [true または false] に一致する必要があります
表 3-6  警告アクション「backup」
プロパティー
説明
backup_finished
Boolean
フィルタは backup_finished イベント [true または false] に一致する必要があります
backup_started
Boolean
フィルタは backup_started イベント [true または false] に一致する必要があります
表 3-7  警告アクション「cluster」
プロパティー
説明
cluster_i /o_link_down
Boolean
フィルタは cluster_i /o_link_down イベント [true または false] に一致する必要があります
cluster_i /o_link_failed
Boolean
フィルタは cluster_i /o_link_failed イベント [true または false] に一致する必要があります
cluster_i /o_link_up
Boolean
フィルタは cluster_i /o_link_up イベント [true または false] に一致する必要があります
unexpected_peer_error_occurred
Boolean
フィルタは unexpected_peer_error_occurred イベント [true または false] に一致する必要があります
communication_t o_peer_lost
Boolean
フィルタは communication_to_peer_lost イベント [true または false] に一致する必要があります
cluster_peer_panicked
Boolean
フィルタは cluster_peer_panicked イベント [true または false] に一致する必要があります
failed_to_set_s p_root_password_on_cluster_peer
Boolean
フィルタは failed_to_set_sp_root_password_on_cluster_peer イベント [true または false] に一致する必要があります
cluster_rejoin_failed_on_peer
Boolean
フィルタは cluster_rejoin_failed_on_peer イベント [true または false] に一致する必要があります
cluster_rejoin_mismatch_on_peer
Boolean
フィルタは cluster_rejoin_mismatch_on_peer イベント [true または false] に一致する必要があります
cluster_rejoin_completed_on_peer
Boolean
フィルタは cluster_rejoin_completed_on_peer イベント [true または false] に一致する必要があります
cluster_peer_lost_communication_token
Boolean
フィルタは cluster_peer_lost_communication_token イベント [true または false] に一致する必要があります
cluster_rejoin _failed
Boolean
フィルタは cluster_rejoin_failed イベント [true または false] に一致する必要があります
cluster_rejoin_mismatch
Boolean
フィルタは cluster_rejoin_mismatch イベント [true または false] に一致する必要があります
cluster_rejoin_completed
Boolean
フィルタは cluster_rejoin_completed イベント [true または false] に一致する必要があります
cluster_takeover_complete
Boolean
フィルタは cluster_takeover_complete イベント [true または false] に一致する必要があります
resource_import_failed_during_cluster_takeover
Boolean
フィルタは resource_import_failed_during_cluster_takeover イベント [true または false] に一致する必要があります
local_cluster_communication_token_lost
Boolean
フィルタは local_cluster_communication_token_lost イベント [true または false] に一致する必要があります
表 3-8  警告アクション「custom」
プロパティー
説明
patterns
Default
FMA イベントのパターン
表 3-9  警告アクション「hardware」
プロパティー
説明
fibre_channel_port_down
Boolean
フィルタは fibre_channel_port_down イベント [true または false] に一致する必要があります
multiple_transient_fibre_channel_port_status _changes
Boolean
フィルタは multiple_transient_fibre_channel_port _status_changes イベント [true または false] に一致する必要があります
transient_fibre_channel_port_status_change
Boolean
フィルタは transient_fibre_channel_port_status_change イベント [true または false] に一致する必要があります
fibre_channel_port_up
Boolean
フィルタは fibre_channel_port_up イベント [true または false] に一致する必要があります
network_port_down
Boolean
フィルタは network_port_down イベント [true または false] に一致する必要があります
network_port_up
Boolean
フィルタは network_port_up イベント [true または false] に一致する必要があります
chassis_connected_to_system
Boolean
フィルタは chassis_connected_to_system イベント [true または false] に一致する必要があります
chassis_removed
Boolean
フィルタは chassis_removed イベント [true または false] に一致する必要があります
hardware_component_inserted
Boolean
フィルタは hardware_component_inserted イベント [true または false] に一致する必要があります
hardware_component_removed
Boolean
フィルタは hardware_component_removed イベント [true または false] に一致する必要があります
disk_inserted
Boolean
フィルタは disk_inserted イベント [true または false] に一致する必要があります
disk_removed
Boolean
フィルタは disk_removed イベント [true または false] に一致する必要があります
i/o_path_added
Boolean
フィルタは i/o_path_added イベント [true または false] に一致する必要があります
i/o_path_removed
Boolean
フィルタは i/o_path_removed イベント [true または false] に一致する必要があります
service_processor_offline_or_unavailable
Boolean
フィルタは service_processor_offline_or_unavailable イベント [true または false] に一致する必要があります
service_processor_online_after_outage
Boolean
フィルタは service_processor_online_after_outage イベント [true または false] に一致する必要があります
failed_to_set_root_password_on_service_processor
Boolean
フィルタは failed_to_set_root_password_on_service_processor イベント [true または false] に一致する必要があります
表 3-10  警告アクション「hardware_faults」
プロパティー
説明
all_hardware_faults
Boolean
フィルタは all_hardware_faults イベント [true または false] に一致する必要があります
表 3-11  警告アクション「ndmp」
プロパティー
説明
invalid_ndmp_restore
Boolean
フィルタは invalid_ndmp_restore イベント [true または false] に一致する必要があります
backup_finished
Boolean
フィルタは backup_finished イベント [true または false] に一致する必要があります
backup_started
Boolean
フィルタは backup_started イベント [true または false] に一致する必要があります
restore_finished
Boolean
フィルタは restore_finished イベント [true または false] に一致する必要があります
restore_started
Boolean
フィルタは restore_started イベント [true または false] に一致する必要があります
表 3-12  警告アクション「network」
プロパティー
説明
datalink_failed
Boolean
フィルタは datalink_failed イベント [true または false] に一致する必要があります
datalink_ok
Boolean
フィルタは datalink_ok イベント [true または false] に一致する必要があります
network_port_down
Boolean
フィルタは network_port_down イベント [true または false] に一致する必要があります
network_port_up
Boolean
フィルタは network_port_up イベント [true または false] に一致する必要があります
ip_address_conflict
Boolean
フィルタは ip_address_conflict イベント [true または false] に一致する必要があります
ip_address_conflict_resolved
Boolean
フィルタは ip_address_conflict_resolved イベント [true または false] に一致する必要があります
ip_interface_degraded
Boolean
フィルタは ip_interface_degraded イベント [true または false] に一致する必要があります
ip_interface_failed
Boolean
フィルタは ip_interface_failed イベント [true または false] に一致する必要があります
ip_interface_ok
Boolean
フィルタは ip_interface_ok イベント [true または false] に一致する必要があります
表 3-13  警告アクション「replication」
プロパティー
説明
receive_failed_(unsupported _version)
Boolean
フィルタは receive_failed_(unsupported_version) イベント [true または false] に一致する必要があります
receive_failed_(cancelled)
Boolean
フィルタは receive_failed_(cancelled) イベント [true または false] に一致する必要があります
receive_failed_(all_others)
Boolean
フィルタは receive_failed_(all_others) イベント [true または false] に一致する必要があります
receive_failed_(out_of_space)
Boolean
フィルタは receive_failed_(out_of_space) イベント [true または false] に一致する必要があります
receive_failed_(package_not _upgraded)
Boolean
フィルタは receive_failed_(package_not_upgraded) イベント [true または false] に一致する必要があります
receive_finished
Boolean
フィルタは receive_finished イベント [true または false] に一致する必要があります
receive_started
Boolean
フィルタは receive_started イベント [true または false] に一致する必要があります
send_failed_(unsupported_version)
Boolean
フィルタは send_failed_(unsupported_version) イベント [true または false] に一致する必要があります
send_failed_(cancelled)
Boolean
フィルタは send_failed_(cancelled) イベント [true または false] に一致する必要があります
send_failed_(all_others)
Boolean
フィルタは send_failed_(all_others) イベント [true または false] に一致する必要があります
send_failed_(connectivity)
Boolean
フィルタは send_failed_(connectivity) イベント [true または false] に一致する必要があります
send_failed_(out_of_space)
Boolean
フィルタは send_failed_(out_of_space) イベント [true または false] に一致する必要があります
send_failed_(remote _verification)
Boolean
フィルタは send_failed_(remote_verification) イベント [true または false] に一致する必要があります
send_finished
Boolean
フィルタは send_finished イベント [true または false] に一致する必要があります
send_skipped_(already_running)
Boolean
フィルタは send_skipped_(already_running) イベント [true または false] に一致する必要があります
send_started
Boolean
フィルタは send_started イベント [true または false] に一致する必要があります
表 3-14  警告アクション「replication_source」
プロパティー
説明
send_failed_(unsupported_version)
Boolean
フィルタは send_failed_(unsupported_version) イベント [true または false] に一致する必要があります
send_failed_(cancelled)
Boolean
フィルタは send_failed_(cancelled) イベント [true または false] に一致する必要があります
send_failed_(all_others)
Boolean
フィルタは send_failed_(all_others) イベント [true または false] に一致する必要があります
send_failed_(connectivity)
Boolean
フィルタは send_failed_(connectivity) イベント [true または false] に一致する必要があります
send_failed_(out_of_space)
Boolean
フィルタは send_failed_(out_of_space) イベント [true または false] に一致する必要があります
send_failed_(remote_verification)
Boolean
フィルタは send_failed_(remote_verification) イベント [true または false] に一致する必要があります
send_finished
Boolean
フィルタは send_finished イベント [true または false] に一致する必要があります
send_skipped_(already_running)
Boolean
フィルタは send_skipped_(already_running) イベント [true または false] に一致する必要があります
send_started
Boolean
フィルタは send_started イベント [true または false] に一致する必要があります
表 3-15  警告アクション「replication_target」
プロパティー
説明
receive_failed_(unsupported_verrsion)
Boolean
フィルタは receive_failed_(unsupported_version) イベント [true または false] に一致する必要があります
receive_failed_(cancelled)
Boolean
フィルタは receive_failed_(cancelled) イベント [true または false] に一致する必要があります
receive_failed _(all_others)
Boolean
フィルタは receive_failed_(all_others) イベント [true または false] に一致する必要があります
receive_failed _(out_of_space)
Boolean
フィルタは receive_failed_(out_of_space) イベント [true または false] に一致する必要があります
receive_failed_(package_not_upgraded)
Boolean
フィルタは receive_failed_(package_not_upgraded) イベント [true または false] に一致する必要があります
receive_finished
Boolean
フィルタは receive_finished イベント [true または false] に一致する必要があります
receive_started
Boolean
フィルタは receive_started イベント [true または false] に一致する必要があります
表 3-16  警告アクション「restore」
プロパティー
説明
restore_finished
Boolean
フィルタは restore_finished イベント [true または false] に一致する必要があります
restore_started
Boolean
フィルタは restore_started イベント [true または false] に一致する必要があります
表 3-17  警告アクション「scrk」
プロパティー
説明
support_bundle_build_failed
Boolean
フィルタは support_bundle_build_failed イベント [true または false] に一致する必要があります
support_bundle_sent
Boolean
フィルタは support_bundle_sent イベント [true または false] に一致する必要があります
support_bundle _upload_failed
Boolean
フィルタは support_bundle_upload_failed イベント [true または false] に一致する必要があります
an_update_is_available_on_my_oracle_support.
Boolean
フィルタは an_update_is_available_on_my_oracle_support. イベント [true または false] に一致する必要があります
no_updates_available.
Boolean
フィルタは no_updates_available. イベント [true または false] に一致する必要があります
the_appliance_failed_to_verify _if_an_update_i s_available.
Boolean
フィルタは the_appliance_failed_to_verify_if_an_u pdate_is_available. イベント [true または false] に一致する必要があります
表 3-18  警告アクション「shadow」
プロパティー
説明
shadow_migration_complete
Boolean
フィルタは shadow_migration_complete イベント [true または false] に一致する必要があります
表 3-19  警告アクション「smf」
プロパティー
説明
service_failures
Boolean
フィルタは service_failures イベント [true または false] に一致する必要があります
表 3-20  警告アクション「thresholds」
プロパティー
説明
thresholdid
Default
警告が一致する必要のあるウォッチの UUID です
表 3-21  警告アクション「zfs_pool」
プロパティー
説明
resilver_finished
Boolean
フィルタは resilver_finished イベント [true または false] に一致する必要があります
resilver_started
Boolean
フィルタは resilver_started イベント [true または false] に一致する必要があります
scrub_finished
Boolean
フィルタは scrub_finished イベント [true または false] に一致する必要があります
scrub_started
Boolean
フィルタは scrub_started イベント [true または false] に一致する必要があります
hot_spare_activated
Boolean
フィルタは hot_spare_activated イベント [true または false] に一致する必要があります

警告アクションの一覧表示

警告アクションの一覧表示コマンドは、すべての警告アクションを一覧表示します。単一のリソースに対するデータを取得するには、特定の警告アクションリソースの href プロパティーに HTTP GET リクエストを送信します。

警告アクションを取得するリクエストの例:

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

レスポンスの例:

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 /api/alert/v1/actions/actions-002 HTTP/1.1

レスポンスの例:

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"
    }
}

警告アクションの作成

JSON オブジェクトを含む警告アクション POST リクエストを作成する場合、アクションプロパティーを /api/alert/v1/alerts/actions に送信する必要があります。作成するアクションのタイプを選択するには、カテゴリプロパティーを設定する必要があります。特定のシステムで使用可能なすべてのカテゴリ値については、CLI のドキュメントを参照してください。

カテゴリ値には通常次のものがあります。

"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"

リクエストの例:

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"}

レスポンスの例:

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
    }
}

警告アクションの変更

list コマンドにより返された一部のプロパティーは、HTTP PUT リクエストを送信することで変更できます。

リクエストの例:

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}

レスポンスの例:

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
    }
}

警告アクションの削除

HTTP DELETE リクエストを、警告アクション href またはアクション href に送信すると、指定されたリソースを削除します。削除に成功すると、応答は HTTP ステータス 204 (No Content) になります。

リクエストの例:

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

レスポンスの例:

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