alertservice.test
=================

Send a test alert using `type` of Alert Service.

.. examples(websocket)::

  Send a test alert using Alert Service of Mail `type`.

    :::javascript {
        "id": "6841f242-840a-11e6-a437-00e04d680384", "msg": "method", "method": "alertservice.test", "params": [{ "name": "Test Email Alert", "enabled": true, "type": "Mail", "attributes": { "email": "dev@ixsystems.com" }, "settings": {} }] }

.. raw:: html

    <div id="json-schema"> <span class="badge badge-dark value-type">Type: object</span><br/> <div class="accordion" id="accordionCall_parameters"> <div class="card"> <div class="card-header" id="headingCall_parameters"> <h2 class="mb-0"> <button aria-controls="Call_parameters" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters" data-toggle="collapse" onclick="setAnchor('#Call_parameters')" type="button"><span class="property-name">Call parameters</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters" class="collapse property-definition-div" data-parent="#accordionCall_parameters" id="Call_parameters"> <div class="card-body pl-5"> <span class="badge badge-dark value-type">Type: array</span><br/> <span class="badge badge-info no-additional">No Additional Items</span><h4>Tuple Validation</h4> <h5>Parameter 1: alert_service_create</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i0"> <h4>alert_service_create</h4><span class="badge badge-dark value-type">Type: object</span><br/> <span class="badge badge-info no-additional">No Additional Properties</span> <div class="accordion" id="accordionCall_parameters_items_i0_name"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_name"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_name" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_name')" type="button"><span class="property-name">name</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_name" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_name" id="Call_parameters_items_i0_name"> <div class="card-body pl-5"> <h4>Name</h4><span class="badge badge-dark value-type">Type: string</span><br/> <p><span class="badge badge-light restriction min-length-restriction" id="Call_parameters_items_i0_name_minLength">Must be at least <code>1</code> characters long</span></p> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_type"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_type"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_type" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_type" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_type')" type="button"><span class="property-name">type</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_type" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_type" id="Call_parameters_items_i0_type"> <div class="card-body pl-5"> <h4>Type</h4><span class="badge badge-dark value-type">Type: string</span><br/> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_attributes"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_attributes"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_attributes" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_attributes" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_attributes')" type="button"><span class="property-name">attributes</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_attributes" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_attributes" id="Call_parameters_items_i0_attributes"> <div class="card-body pl-5"> <h4>Attributes</h4><span class="badge badge-dark value-type">Type: object</span><br/> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_level"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_level"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_level" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_level" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_level')" type="button"><span class="property-name">level</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_level" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_level" id="Call_parameters_items_i0_level"> <div class="card-body pl-5"> <h4>Level</h4><span class="badge badge-dark value-type">Type: string</span><br/> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_enabled"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_enabled"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_enabled" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_enabled" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_enabled')" type="button"><span class="property-name">enabled</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_enabled" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_enabled" id="Call_parameters_items_i0_enabled"> <div class="card-body pl-5"> <h4>Enabled</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: true</span><br/> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value"> <div class="card"> <div class="card-header" id="headingReturn_value"> <h2 class="mb-0"> <button aria-controls="Return_value" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value" data-toggle="collapse" onclick="setAnchor('#Return_value')" type="button"><span class="property-name">Return value</span></button> </h2> </div> <div aria-labelledby="headingReturn_value" class="collapse property-definition-div" data-parent="#accordionReturn_value" id="Return_value"> <div class="card-body pl-5"> <h4>Result</h4><span class="badge badge-dark value-type">Type: boolean</span><br/> </div> </div> </div> </div> </div><br><br>

*Required roles:* ALERT_WRITE