1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245
|
.. -*- rst -*-
==============================
Router NDP proxy (ndp_proxies)
==============================
A ``ndp_proxy`` is a logical entity for annunciate a unique IPv6 address to
external network. It depends on a ``router`` entity on which external gateway
is enabled.
List ndp proxies
================
.. rest_method:: GET /v2.0/ndp_proxies
Lists logical ndp_proxies that the project who submits the request can
access.
Default policy settings return only those ndp_proxies that the project
who submits the request owns, unless an administrative user submits
the request.
.. include:: filtering-list.inc
Normal response codes: 200
Error response codes: 401
Request
-------
.. rest_parameters:: parameters.yaml
- id: id-query
- tenant_id: project_id-query
- project_id: project_id-query
- name: name-query
- description: description-query
- router_id: ndp_proxy-router-id-query
- port_id: ndp_proxy-port-id-query
- ip_address: ndp_proxy-ip-address-query
- revision_number: revision_number-query
- sort_dir: sort_dir
- sort_key: ndp_proxy-sort_key
- fields: fields
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- ndp_proxies: ndp_proxies
- name: name
- id: ndp_proxy_id-body
- description: description
- tenant_id: project_id
- project_id: project_id
- revision_number: revision_number
- router_id: ndp_proxy_router_id-body
- port_id: ndp_proxy_port_id-body
- ip_address: ndp_proxy_ip_address-body
- created_at: created_at_resource
- updated_at: updated_at_resource
Response Example
----------------
.. literalinclude:: samples/ndp_proxies/ndp-proxies-list-response.json
:language: javascript
Show ndp proxy details
======================
.. rest_method:: GET /v2.0/ndp_proxies/{ndp_proxy_id}
Shows information for a ndp proxy
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: 401, 404
Request
-------
.. rest_parameters:: parameters.yaml
- ndp_proxy_id: ndp_proxy_id-path
- fields: fields
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- ndp_proxy: ndp_proxy
- name: name
- id: ndp_proxy_id-body
- description: description
- tenant_id: project_id
- project_id: project_id
- revision_number: revision_number
- router_id: ndp_proxy_router_id-body
- port_id: ndp_proxy_port_id-body
- ip_address: ndp_proxy_ip_address-body
- created_at: created_at_resource
- updated_at: updated_at_resource
Response Example
----------------
.. literalinclude:: samples/ndp_proxies/ndp-proxy-show-response.json
:language: javascript
Update a ndp proxy
==================
.. rest_method:: PUT /v2.0/ndp_proxies/{ndp_proxy_id}
Updates a ndp proxy
Normal response codes: 200
Error response codes: 400, 401, 404
Request
-------
.. rest_parameters:: parameters.yaml
- ndp_proxy_id: ndp_proxy_id-path
- ndp_proxy: ndp_proxy
- name: name
- description: description-request-put
Request Example
---------------
.. literalinclude:: samples/ndp_proxies/ndp-proxy-update-request.json
:language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- ndp_proxy: ndp_proxy
- name: name
- id: ndp_proxy_id-body
- description: description
- tenant_id: project_id
- project_id: project_id
- revision_number: revision_number
- router_id: ndp_proxy_router_id-body
- port_id: ndp_proxy_port_id-body
- ip_address: ndp_proxy_ip_address-body
- created_at: created_at_resource
- updated_at: updated_at_resource
Response Example
----------------
.. literalinclude:: samples/ndp_proxies/ndp-proxy-update-response.json
:language: javascript
Create ndp proxy
================
.. rest_method:: POST /v2.0/ndp_proxies
Creates a ndp proxy
Normal response codes: 201
Error response codes: 400, 401
Request
-------
.. rest_parameters:: parameters.yaml
- ndp_proxy: ndp_proxy
- name: name-request
- router_id: ndp_proxy_router_id-body
- port_id: ndp_proxy_port_id-body
- ip_address: ndp_proxy_ip_address-body-request
- description: description-request
Request Example
---------------
.. literalinclude:: samples/ndp_proxies/ndp-proxy-create-request.json
:language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- ndp_proxy: ndp_proxy
- name: name
- id: ndp_proxy_id-body
- description: description
- tenant_id: project_id
- project_id: project_id
- revision_number: revision_number
- router_id: ndp_proxy_router_id-body
- port_id: ndp_proxy_port_id-body
- ip_address: ndp_proxy_ip_address-body
- created_at: created_at_resource
- updated_at: updated_at_resource
Response Example
----------------
.. literalinclude:: samples/ndp_proxies/ndp-proxy-create-response.json
:language: javascript
Delete a ndp proxy
==================
.. rest_method:: DELETE /v2.0/ndp_proxies/{ndp_proxy_id}
Deletes a ndp proxy.
Normal response codes: 204
Error response codes: 404
Request
-------
.. rest_parameters:: parameters.yaml
- ndp_proxy_id: ndp_proxy_id-path
Response
--------
There is no body content for the response of a successful DELETE request.
|