nova/api-ref/source/servers-action-crash-dump.inc
Sean Dague 9526462326 move sphinx h3 to '-' instead of '^'
In the sphinx document h3 is supposed to be '-' not '^':

=, for sections
-, for subsections
^, for subsubsections

We have to enforce consistency here because we're processing included
files which all have to agree, otherwise it's a sphinx error.

Part of bp:api-ref-in-rst

Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc
2016-04-15 07:43:06 -04:00

38 lines
1.3 KiB
ReStructuredText

.. -*- rst -*-
Trigger Crash Dump In Server (Trigger_Crash_Dump Action)
========================================================
.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action
Trigger a crash dump in a server.
Specify the ``trigger_crash_dump`` action in the request body.
When a crash dump is triggered for a virtual server, it causes a system reboot. This action can cause data loss. Also, network connectivity can be lost. Once the server comes back online, you can find a Kernel Crash Dump file in a certain location of the filesystem. For example, for Ubuntu you can find it in the ``/var/crash`` directory.
Policy defaults enable only users with the administrative role or the owner of the server to perform this operation. Cloud providers can change these permissions through the ``policy.json`` file.
Normal response codes: 202
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- server_id: server_id
- trigger_crash_dump: trigger_crash_dump
**Example Trigger crash dump: JSON request**
.. literalinclude:: ../../doc/api_samples/servers-action/server-action-trigger-crash-.json
:language: javascript
Response
--------