diff options
| author | Zuul <zuul@review.opendev.org> | 2019-08-15 23:39:50 +0000 |
|---|---|---|
| committer | Gerrit Code Review <review@openstack.org> | 2019-08-15 23:39:50 +0000 |
| commit | 35485eacfbd444ddbb7f2d1e8637bcecb295b485 (patch) | |
| tree | 8ec348bb79d214d65c55daf72b989a1bad49b908 /api-ref | |
| parent | 872a823d9a02f31e266882bfb499673c51fb4075 (diff) | |
| parent | 62f6a0a1bc6c4b24621e1c2e927177f99501bef3 (diff) | |
| download | nova-35485eacfbd444ddbb7f2d1e8637bcecb295b485.tar.gz | |
Merge "API microversion 2.76: Add 'power-update' external event"
Diffstat (limited to 'api-ref')
| -rw-r--r-- | api-ref/source/os-server-external-events.inc | 6 | ||||
| -rw-r--r-- | api-ref/source/parameters.yaml | 20 |
2 files changed, 19 insertions, 7 deletions
diff --git a/api-ref/source/os-server-external-events.inc b/api-ref/source/os-server-external-events.inc index b31c38116f..f04c98839f 100644 --- a/api-ref/source/os-server-external-events.inc +++ b/api-ref/source/os-server-external-events.inc @@ -7,11 +7,11 @@ .. warning:: This is an ``admin`` level service API only designed to be used by other OpenStack services. The point of this API is to coordinate - between Nova and Neutron, Nova and Cinder (and potentially future - services) on activities they both need to be involved in, + between Nova and Neutron, Nova and Cinder, Nova and Ironic (and potentially + future services) on activities they both need to be involved in, such as network hotplugging. - Unless you are writing Neutron or Cinder code you **should not** + Unless you are writing Neutron, Cinder or Ironic code you **should not** be using this API. Creates one or more external events. The API dispatches each event to a diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index f2df3193ff..34fb3d1679 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -2587,9 +2587,15 @@ event_hostId: type: string event_name: description: | - The event name. A valid value is ``network-changed``, ``network-vif-plugged``, - ``network-vif-unplugged``, ``network-vif-deleted``, or ``volume-extended``. - The event name ``volume-extended`` is added since microversion ``2.51``. + The event name. A valid value is: + + - ``network-changed`` + - ``network-vif-plugged`` + - ``network-vif-unplugged`` + - ``network-vif-deleted`` + - ``volume-extended`` (since microversion ``2.51``) + - ``power-update`` (since microversion ``2.76``) + in: body required: true type: string @@ -2623,7 +2629,13 @@ event_status: type: string event_tag: description: | - A string value that identifies the event. + A string value that identifies the event. Certain types of events require + specific tags: + + - For the ``power-update`` event the tag must be either be ``POWER_ON`` + or ``POWER_OFF``. + - For the ``volume-extended`` event the tag must be the volume id. + in: body required: false type: string |