Files
d929b9fc7666d601894771c8f39f95c04d79fbd1
nova /api-ref /source /servers-action-fixed-ip.inc
Sean Dague d929b9fc76 add tags to files for the content verification phase 
This adds a set of tags in comments to the beginning of files so that
we can process them according to the documentation here:
https://wiki.openstack.org/wiki/NovaAPIRef
Part of bp:api-ref-in-rst
Change-Id: I17cf584dafb5bd969c12f51b7e7185d92365bf93
2016年04月20日 16:21:58 -04:00

73 lines
2.2 KiB
ReStructuredText

.. -*- rst -*-
.. needs:method_verification
.. needs:parameter_verification
.. needs:example_verification
.. needs:body_verification
Add (Associate) Fixed Ip (Addfixedip Action)
============================================
.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action
Adds a fixed IP address to a server instance, which associates that address with the server. The fixed IP address is retrieved from the network that you specify in the request.
Specify the ``addFixedIp`` action and the network ID in the request body.
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
- addFixedIp: addFixedIp
**Example Add (Associate) Fixed Ip (Addfixedip Action): JSON request**
.. literalinclude:: ../../doc/api_samples/os-multinic/multinic-add-fixed-ip-req.json
:language: javascript
Response
--------
Remove (Disassociate) Fixed Ip (Removefixedip Action)
=====================================================
.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action
Removes, or disassociates, a fixed IP address from a server.
Specify the ``removeFixedIp`` action in the request body.
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
- removeFixedIp: removeFixedIp
**Example Remove (Disassociate) Fixed Ip (Removefixedip Action): JSON request**
.. literalinclude:: ../../doc/api_samples/os-multinic/multinic-remove-fixed-ip-req.json
:language: javascript
Response
--------