File: port_bindings.inc

package info (click to toggle)
python-neutron-lib 3.18.2-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 7,652 kB
  • sloc: python: 22,800; sh: 145; makefile: 24
file content (156 lines) | stat: -rw-r--r-- 3,161 bytes parent folder | download
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
.. -*- rst -*-

============
Port Binding
============

Expose port bindings of a virtual port to external application.

Port Bindings Extended
======================

The ``Port Bindings Extended`` extension adds extra fields to ``Port Binding``
like ``status`` and ``project id``, and allows the ``activation`` of the
binding.

Show Port Binding of a Port
===========================

.. rest_method:: GET /v2.0/ports/{port_id}/bindings

.. include:: filtering-show.inc

Normal response codes: 200

Error response codes: 401, 404

Request
-------

.. rest_parameters:: parameters.yaml

    - port_id: port_id-path

Response Parameters
-------------------

.. rest_parameters:: parameters.yaml

    - bindings: bindings
    - host: host
    - profile: binding:profile
    - vif_details: binding:vif_details
    - vif_type: binding:vif_type
    - vnic_type: binding:vnic_type

Response Example (Admin user)
-----------------------------

.. literalinclude:: samples/port_bindings/port-binding-list-response.json
   :language: javascript

Create Port binding
===================

.. rest_method:: POST /v2.0/ports/{port_id}/bindings/

Normal response codes: 201

Error response codes: 400, 401, 403, 404

Request
-------

.. rest_parameters:: parameters.yaml

   - port_id: port_id-path
   - bindings: bindings
   - host: host
   - profile: binding:profile
   - vif_details: binding:vif_details
   - vif_type: binding:vif_type
   - vnic_type: binding:vnic_type

Request Example (Admin user)
----------------------------

.. literalinclude:: samples/port_bindings/port-binding-create-request.json
   :language: javascript

Response Parameters
-------------------

.. rest_parameters:: parameters.yaml

   - port_id: port_id-path
   - bindings: bindings
   - host: host
   - profile: binding:profile
   - vif_details: binding:vif_details
   - vif_type: binding:vif_type
   - vnic_type: binding:vnic_type

Response Example (admin user)
-----------------------------

.. literalinclude:: samples/port_bindings/port-binding-create-response.json
   :language: javascript

Activate Port binding
=====================

.. rest_method:: PUT /v2.0/ports/{port_id}/bindings/{host}/activate

Normal response codes: 200

Error response codes: 400, 401, 404, 412

Request
-------

.. rest_parameters:: parameters.yaml

   - port_id: port_id-path
   - host: host

Response Parameters
-------------------

.. rest_parameters:: parameters.yaml

   - port_id: port_id-path
   - bindings: bindings
   - host: host
   - profile: binding:profile
   - vif_details: binding:vif_details
   - vif_type: binding:vif_type
   - vnic_type: binding:vnic_type

Response Example (admin user)
-----------------------------

.. literalinclude:: samples/port_bindings/port-binding-activate-response.json
   :language: javascript

Delete Port Binding
===================

.. rest_method:: DELETE /v2.0/ports/{port_id}/bindings/{host}

Normal response codes: 204

Error response codes: 401, 403, 404, 412

Request
-------

.. rest_parameters:: parameters.yaml

   - port_id: port_id-path
   - host: host

Response
--------

There is no body content for the response of a successful DELETE request.