JavaScript is required to for searching.
Omitir vínculos de navegación
Salir de la Vista de impresión
Guía de API de RESTful de Oracle® ZFS Storage Appliance, versión 2013.1.3.0
Red de tecnología de Oracle
Biblioteca
PDF
Vista de impresión
Comentarios
search filter icon
search icon

Información del documento

Introducción a la API de RESTful de Oracle ZFS Storage Appliance

Trabajo con la API de RESTful

Servicio de alertas de la API de RESTful

Comandos del servicio de alertas

Umbrales de alerta

Mostrar umbrales de alertas

Obtener umbral de alerta

Crear umbral de alerta

Modificar umbral de alerta

Suprimir umbral de alerta

Acciones de alerta

Mostrar acciones de alertas

Obtener acción de alerta

Crear acción de alerta

Modificar acción de alerta

Suprimir acción de alerta

Elementos de acción de alerta

Crear elemento de alerta

Modificar acción de alerta

Suprimir elemento de acción de alerta

Servicios de análisis

Servicios de hardware

Comandos de log

Comandos de red

Servicio de problemas de la API de RESTful

Servicio de rol de la API de RESTful

Servicio de SAN de la API de RESTful

Comandos de servicio

Servicio de almacenamiento de la API de RESTful

Comandos del sistema

Servicio de usuario de la API de RESTful

Comandos de flujo de trabajo

Clientes RESTful

Acciones de alerta

La propiedad de la categoría determina el tipo de acción de alerta que se define. Cada categoría tiene su propio conjunto de propiedades definido.

Las categorías admitidas son las siguientes:

Tabla 3-3  Acciones de alerta "ad"
Propiedad
Tipo
Descripción
active_directory_degraded
Boolean
El filtro debe coincidir con active_directory_degraded events [true or false]
smb_kerberos_client_authentication_degraded
Boolean
El filtro debe coincidir con mb_kerberos_client_authentication_degraded events [true or false]
Tabla 3-4  Acciones de alerta "all"
Propiedad
Tipo
Descripción
all_defects
Boolean
El filtro debe coincidir con all_defects [true, false]
service_alerts
Boolean
El filtro debe coincidir con service_alerts events true, false]
all_hardware_faults
Boolean
El filtro debe coincidir con all_hardware_faults [true, false]
Tabla 3-5  Acciones de alerta "appliance software"
Propiedad
Tipo
Descripción
obstacles_to_system_software_update
Boolean
El filtro debe coincidir con obstacles_to_system_software_update events [true, false]
operating_system_kernel_panic
Boolean
El filtro debe coincidir con operating_system_kernel_panic events [true or false]
Tabla 3-6  Alert Actions backup
Propiedad
Tipo
Descripción
backup_finished
Boolean
El filtro debe coincidir con backup_finished events [true or false]
backup_started
Boolean
El filtro debe coincidir con backup_started events [true or false]
Tabla 3-7  Acciones de alerta "cluster"
Propiedad
Tipo
Descripción
cluster_i /o_link_down
Boolean
El filtro debe coincidir con cluster_i /o_link_down events [true or false]
cluster_i /o_link_failed
Boolean
El filtro debe coincidir con cluster_i /o_link_failed events [true or false]
cluster_i /o_link_up
Boolean
El filtro debe coincidir con cluster_i /o_link_up events [true or false]
unexpected_peer_error_occurred
Boolean
El filtro debe coincidir con unexpected_peer_error_occurred events [true or false]
communication_t o_peer_lost
Boolean
El filtro debe coincidir con communication_to_peer_lost events [true or false]
cluster_peer_panicked
Boolean
El filtro debe coincidir con cluster_peer_panicked events [true or false]
failed_to_set_s p_root_password_on_cluster_peer
Boolean
El filtro debe coincidir con failed_to_set_sp_root_password_on_cluster_peer events [true or false]
cluster_rejoin_failed_on_peer
Boolean
El filtro debe coincidir con cluster_rejoin_failed_on_peer events [true or false]
cluster_rejoin_mismatch_on_peer
Boolean
El filtro debe coincidir con cluster_rejoin_mismatch_on_peer events [true or false]
cluster_rejoin_completed_on_peer
Boolean
El filtro debe coincidir con cluster_rejoin_completed_on_peer events [true or false]
cluster_peer_lost_communication_token
Boolean
El filtro debe coincidir con cluster_peer_lost_communication_token events [true or false]
cluster_rejoin _failed
Boolean
El filtro debe coincidir con cluster_rejoin_failed events [true or false]
cluster_rejoin_mismatch
Boolean
El filtro debe coincidir con cluster_rejoin_mismatch events [true or false]
cluster_rejoin_completed
Boolean
El filtro debe coincidir con cluster_rejoin_completed events [true or false]
cluster_takeover_complete
Boolean
El filtro debe coincidir con cluster_takeover_complete events [true or false]
resource_import_failed_during_cluster_takeover
Boolean
El filtro debe coincidir con resource_import_failed_during_cluster_takeover events [true or false]
local_cluster_communication_token_lost
Boolean
El filtro debe coincidir con local_cluster_communication_token_lost events [true or false]
Tabla 3-8  Acciones de alerta "custom"
Propiedad
Tipo
Descripción
patterns
Default
Patrones de eventos FMA
Tabla 3-9  Acciones de alerta "hardware"
Propiedad
Tipo
Descripción
fibre_channel_port_down
Boolean
El filtro debe coincidir con fibre_channel_port_down events [true or false]
multiple_transient_fibre_channel_port_status _changes
Boolean
El filtro debe coincidir con multiple_transient_fibre_channel_port _status_changes events [true or false]
transient_fibre_channel_port_status_change
Boolean
El filtro debe coincidir con transient_fibre_channel_port_status_change events [true or false]
fibre_channel_port_up
Boolean
El filtro debe coincidir con fibre_channel_port_up events [true or false]
network_port_down
Boolean
El filtro debe coincidir con network_port_down events [true or false]
network_port_up
Boolean
El filtro debe coincidir con network_port_up events [true or false]
chassis_connected_to_system
Boolean
El filtro debe coincidir con chassis_connected_to_system events [true or false]
chassis_removed
Boolean
El filtro debe coincidir con chassis_removed events [true or false]
hardware_component_inserted
Boolean
El filtro debe coincidir con hardware_component_inserted events [true or false]
hardware_component_removed
Boolean
El filtro debe coincidir con hardware_component_removed events [true or false]
disk_inserted
Boolean
El filtro debe coincidir con disk_inserted events [true or false]
disk_removed
Boolean
El filtro debe coincidir con disk_removed events [true or false]
i/o_path_added
Boolean
El filtro debe coincidir con i/o_path_added events [true or false]
i/o_path_removed
Boolean
El filtro debe coincidir con i/o_path_removed events [true or false]
service_processor_offline_or_unavailable
Boolean
El filtro debe coincidir con service_processor_offline_or_unavailable events [true or false]
service_processor_online_after_outage
Boolean
El filtro debe coincidir con service_processor_online_after_outage events [true or false]
failed_to_set_root_password_on_service_processor
Boolean
El filtro debe coincidir con failed_to_set_root_password_on_service_processor events [true or false]
Tabla 3-10  Acciones de alerta "hardware_faults"
Propiedad
Tipo
Descripción
all_hardware_faults
Boolean
El filtro debe coincidir con all_hardware_faults events [true or false]
Tabla 3-11  Acciones de alerta "ndmp"
Propiedad
Tipo
Descripción
invalid_ndmp_restore
Boolean
El filtro debe coincidir con invalid_ndmp_restore events [true or false]
backup_finished
Boolean
El filtro debe coincidir con backup_finished events [true or false]
backup_started
Boolean
El filtro debe coincidir con backup_started events [true or false]
restore_finished
Boolean
El filtro debe coincidir con restore_finished events [true or false]
restore_started
Boolean
El filtro debe coincidir con restore_started events [true or false]
Tabla 3-12  Acciones de alerta "network"
Propiedad
Tipo
Descripción
datalink_failed
Boolean
El filtro debe coincidir con datalink_failed events [true or false]
datalink_ok
Boolean
El filtro debe coincidir con datalink_ok events [true or false]
network_port_down
Boolean
El filtro debe coincidir con network_port_down events [true or false]
network_port_up
Boolean
El filtro debe coincidir con network_port_up events [true or false]
ip_address_conflict
Boolean
El filtro debe coincidir con ip_address_conflict events [true or false]
ip_address_conflict_resolved
Boolean
El filtro debe coincidir con ip_address_conflict_resolved events [true or false]
ip_interface_degraded
Boolean
El filtro debe coincidir con ip_interface_degraded events [true or false]
ip_interface_failed
Boolean
El filtro debe coincidir con ip_interface_failed events [true or false]
ip_interface_ok
Boolean
El filtro debe coincidir con ip_interface_ok events [true or false]
Tabla 3-13  Acciones de alerta "replication"
Propiedad
Tipo
Descripción
receive_failed_(unsupported _version)
Boolean
El filtro debe coincidir con receive_failed_(unsupported_version) events [true or false]
receive_failed_(cancelled)
Boolean
El filtro debe coincidir con receive_failed_(cancelled) events [true or false]
receive_failed_(all_others)
Boolean
El filtro debe coincidir con receive_failed_(all_others) events [true or false]
receive_failed_(out_of_space)
Boolean
El filtro debe coincidir con receive_failed_(out_of_space) events [true or false]
receive_failed_(package_not _upgraded)
Boolean
El filtro debe coincidir con receive_failed_(package_not_upgraded) events [true or false]
receive_finished
Boolean
El filtro debe coincidir con receive_finished events [true or false]
receive_started
Boolean
El filtro debe coincidir con receive_started events [true or false]
send_failed_(unsupported_version)
Boolean
El filtro debe coincidir con send_failed_(unsupported_version) events [true or false]
send_failed_(cancelled)
Boolean
El filtro debe coincidir con send_failed_(cancelled) events [true or false]
send_failed_(all_others)
Boolean
El filtro debe coincidir con send_failed_(all_others) events [true or false]
send_failed_(connectivity)
Boolean
El filtro debe coincidir con send_failed_(connectivity) events [true or false]
send_failed_(out_of_space)
Boolean
El filtro debe coincidir con send_failed_(out_of_space) events [true or false]
send_failed_(remote _verification)
Boolean
El filtro debe coincidir con send_failed_(remote_verification) events [true or false]
send_finished
Boolean
El filtro debe coincidir con send_finished events [true or false]
send_skipped_(already_running)
Boolean
El filtro debe coincidir con send_skipped_(already_running) events [true or false]
send_started
Boolean
El filtro debe coincidir con send_started events [true or false]
Tabla 3-14  Acciones de alerta "replication_source"
Propiedad
Tipo
Descripción
send_failed_(unsupported_version)
Boolean
El filtro debe coincidir con send_failed_(unsupported_version) events [true or false]
send_failed_(cancelled)
Boolean
El filtro debe coincidir con send_failed_(cancelled) events [true or false]
send_failed_(all_others)
Boolean
El filtro debe coincidir con send_failed_(all_others) events [true or false]
send_failed_(connectivity)
Boolean
El filtro debe coincidir con send_failed_(connectivity) events [true or false]
send_failed_(out_of_space)
Boolean
El filtro debe coincidir con send_failed_(out_of_space) events [true or false]
send_failed_(remote_verification)
Boolean
El filtro debe coincidir con send_failed_(remote_verification) events [true or false]
send_finished
Boolean
El filtro debe coincidir con send_finished events [true or false]
send_skipped_(already_running)
Boolean
El filtro debe coincidir con send_skipped_(already_running) events [true or false]
send_started
Boolean
El filtro debe coincidir con send_started events [true or false]
Tabla 3-15  Acciones de alerta "replication_target"
Propiedad
Tipo
Descripción
receive_failed_(unsupported_verrsion)
Boolean
El filtro debe coincidir con receive_failed_(unsupported_version) events [true or false]
receive_failed_(cancelled)
Boolean
El filtro debe coincidir con receive_failed_(cancelled) events [true or false]
receive_failed _(all_others)
Boolean
El filtro debe coincidir con receive_failed_(all_others) events [true or false]
receive_failed _(out_of_space)
Boolean
El filtro debe coincidir con receive_failed_(out_of_space) events [true or false]
receive_failed_(package_not_upgraded)
Boolean
El filtro debe coincidir con receive_failed_(package_not_upgraded) events [true or false]
receive_finished
Boolean
El filtro debe coincidir con receive_finished events [true or false]
receive_started
Boolean
El filtro debe coincidir con receive_started events [true or false]
Tabla 3-16  Acciones de alerta "restore"
Propiedad
Tipo
Descripción
restore_finished
Boolean
El filtro debe coincidir con restore_finished events [true or false]
restore_started
Boolean
El filtro debe coincidir con restore_started events [true or false]
Tabla 3-17  Acciones de alerta "scrk"
Propiedad
Tipo
Descripción
support_bundle_build_failed
Boolean
El filtro debe coincidir con support_bundle_build_failed events [true or false]
support_bundle_sent
Boolean
El filtro debe coincidir con support_bundle_sent events [true or false]
support_bundle _upload_failed
Boolean
El filtro debe coincidir con support_bundle_upload_failed events [true or false]
an_update_is_available_on_my_oracle_support.
Boolean
El filtro debe coincidir con an_update_is_available_on_my_oracle_support. events [true or false]
no_updates_available.
Boolean
El filtro debe coincidir con no_updates_available. events [true or false]
the_appliance_failed_to_verify _if_an_update_i s_available.
Boolean
El filtro debe coincidir con the_appliance_failed_to_verify_if_an_update_is_available. events [true or false]
Tabla 3-18  Acciones de alerta "shadow"
Propiedad
Tipo
Descripción
shadow_migration_complete
Boolean
El filtro debe coincidir con shadow_migration_complete events [true or false]
Tabla 3-19  Acciones de alerta "smf"
Propiedad
Tipo
Descripción
service_failures
Boolean
El filtro debe coincidir con service_failures events [true or false]
Tabla 3-20  Acciones de alerta "thresholds"
Propiedad
Tipo
Descripción
thresholdid
Default
UUID de observación cuyas alertas deben coincidir
Tabla 3-21  Acciones de alerta "zfs_pool"
Propiedad
Tipo
Descripción
resilver_finished
Boolean
El filtro debe coincidir con resilver_finished events [true or false]
resilver_started
Boolean
El filtro debe coincidir con resilver_started events [true or false]
scrub_finished
Boolean
El filtro debe coincidir con scrub_finished events [true or false]
scrub_started
Boolean
El filtro debe coincidir con scrub_started events [true or false]
hot_spare_activated
Boolean
El filtro debe coincidir con hot_spare_activated events [true or false]

Mostrar acciones de alertas

El comando mostrar acciones de alerta muestra todas las acciones de alerta. Para obtener datos a partir de un solo recurso, envíe una solicitud HTTP GET a la propiedad href del recurso de acción dado.

Ejemplo de solicitud para obtener acciones de alerta:

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

Ejemplo de respuesta:

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

Obtener acción de alerta

Este comando es similar a List Alert Action (Mostrar acción de alerta), pero devuelve solamente la acción de alerta especificada.

Ejemplo de solicitud:

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

Ejemplo de respuesta:

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

Crear acción de alerta

Cuando crea una solicitud de acción de alerta POST que contiene un objeto JSON, las propiedades de acción deben enviarse a /api/alert/v1/alerts/actions. La propiedad de la categoría debe configurarse para seleccionar el tipo de acción a crear. Consulte la documentación de CLI para todos los valores de categoría disponibles en un sistema determinado.

Los valores de la categoría típicamente incluyen:

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

Ejemplo de solicitud:

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

Ejemplo de respuesta:

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

Modificar acción de alerta

Algunas de las propiedades devueltas por el comando list se pueden modificar enviando una solicitud HTTP PUT.

Ejemplo de solicitud:

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}

Ejemplo de respuesta:

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

Suprimir acción de alerta

Enviar una solicitud de HTTP DELETE a cualquier href de acción de alerta o href de acción suprime el recurso especificado. HTTP 204 (sin contenido) es una respuesta de supresión satisfactoria.

Ejemplo de solicitud:

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

Ejemplo de respuesta:

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