Followup to 0335e81a8787
This change fixes issues pointed out in the last patch set of the referenced change request. Apart from that, 406 error code is removed from expected error codes, as currently .*/portgroups.* resources do not return it. Change-Id: Ib5fccb3a4d1d2c1c7dd1095b86199536db87da4c
This commit is contained in:
Vladyslav Drok
parent
0335e81a87
commit
7d736d1697
@ -7,8 +7,9 @@ Listing Portgroups by Node (nodes, portgroups)
|
||||
Given a Node identifier (``uuid`` or ``name``), the API exposes the list of,
|
||||
and details of, all Portgroups associated with that Node.
|
||||
|
||||
These endpoints do not allow modification of the Portgroups; that should be done
|
||||
by accessing the Portgroup resources under the ``/v1/portgroups`` endpoint.
|
||||
These endpoints do not allow modification of the Portgroups; that should be
|
||||
done by accessing the Portgroup resources under the ``/v1/portgroups``
|
||||
endpoint.
|
||||
|
||||
Portgroup resource was added in API microversion 1.24, if using older
|
||||
version, all the requests return ``Not Found (404)`` error code.
|
||||
@ -23,7 +24,7 @@ Return a list of bare metal Portgroups associated with ``node_ident``.
|
||||
|
||||
Normal response code: 200
|
||||
|
||||
Error codes: 400,401,403,404,406
|
||||
Error codes: 400,401,403,404
|
||||
|
||||
Request
|
||||
-------
|
||||
@ -62,7 +63,7 @@ Return a detailed list of bare metal Portgroups associated with ``node_ident``.
|
||||
|
||||
Normal response code: 200
|
||||
|
||||
Error codes: 400,401,403,404,406
|
||||
Error codes: 400,401,403,404
|
||||
|
||||
Request
|
||||
-------
|
||||
@ -88,7 +89,7 @@ Response
|
||||
- standalone_ports_supported: standalone_ports_supported
|
||||
- internal_info: portgroup_internal_info
|
||||
- extra: extra
|
||||
- ports: n_ports
|
||||
- ports: pg_ports
|
||||
- created_at: created_at
|
||||
- updated_at: updated_at
|
||||
- links: links
|
||||
|
||||
@ -79,14 +79,15 @@ API microversion 1.12 introduced support for the ``raid_config`` and
|
||||
API microversion 1.20 introduced the ``network_interface`` field. If this field
|
||||
is not supplied when creating the Node, the default value will be used.
|
||||
|
||||
API microversion 1.21 introduced the ``resource_class`` field, which may be used to
|
||||
store a resource designation for the proposed OpenStack Placement Engine. This
|
||||
field has no effect within Ironic.
|
||||
API microversion 1.21 introduced the ``resource_class`` field, which may be
|
||||
used to store a resource designation for the proposed OpenStack Placement
|
||||
Engine. This field has no effect within Ironic.
|
||||
|
||||
API microversion 1.24 introduced the ``/nodes/{node_ident}/portgroups`` endpoint.
|
||||
API microversion 1.24 introduced the ``/nodes/{node_ident}/portgroups``
|
||||
endpoint.
|
||||
|
||||
|
||||
The list and example below are representative of the response as of API microversion 1.22.
|
||||
The list and example below are representative of the response as of API
|
||||
microversion 1.24.
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
|
||||
@ -4,8 +4,8 @@
|
||||
Listing Ports by Portgroup (portgroup, ports)
|
||||
=============================================
|
||||
|
||||
Given a Portgroup identifier (``uuid`` or ``name``), the API exposes the list of,
|
||||
and details of, all Ports associated with that Portgroup.
|
||||
Given a Portgroup identifier (``uuid`` or ``name``), the API exposes the list
|
||||
of, and details of, all Ports associated with that Portgroup.
|
||||
|
||||
These endpoints do not allow modification of the Ports; that should be done
|
||||
by accessing the Port resources under the ``/v1/ports`` endpoint.
|
||||
@ -24,7 +24,7 @@ Return a list of bare metal Ports associated with ``portgroup_ident``.
|
||||
|
||||
Normal response code: 200
|
||||
|
||||
Error codes: 400,401,403,404,406
|
||||
Error codes: 400,401,403,404
|
||||
|
||||
Request
|
||||
-------
|
||||
@ -62,7 +62,7 @@ Return a detailed list of bare metal Ports associated with ``portgroup_ident``.
|
||||
|
||||
Normal response code: 200
|
||||
|
||||
Error codes: 400,401,403,404,406
|
||||
Error codes: 400,401,403,404
|
||||
|
||||
Request
|
||||
-------
|
||||
@ -88,7 +88,7 @@ Response
|
||||
- pxe_enabled: pxe_enabled
|
||||
- internal_info: internal_info
|
||||
- extra: extra
|
||||
- portgroup_uuid: uuid
|
||||
- portgroup_uuid: portgroup_uuid
|
||||
- created_at: created_at
|
||||
- updated_at: updated_at
|
||||
- links: links
|
||||
|
||||
@ -5,9 +5,9 @@ Portgroups (portgroups)
|
||||
=======================
|
||||
|
||||
Starting with API version 1.23 ports can be combined into portgroups to support
|
||||
static LAG or MLAG configurations.
|
||||
Listing, Searching, Creating, Updating, and Deleting of bare metal Portgroup
|
||||
resources are done through the ``v1/portgroups`` resource.
|
||||
static link aggregation group (LAG) or multi-chassis link aggregation group
|
||||
(MLAG) configurations. Listing, Searching, Creating, Updating, and Deleting of
|
||||
bare metal Portgroup resources are done through the ``v1/portgroups`` resource.
|
||||
|
||||
All Portgroups must be associated with a Node when created. This association
|
||||
can be changed, though the request may be rejected if either the current
|
||||
@ -28,6 +28,8 @@ By default, this query will return the UUID, name and address for each Portgroup
|
||||
|
||||
Normal response code: 200
|
||||
|
||||
Error codes: 400,401,403,404
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
@ -70,6 +72,8 @@ Portgroup (MAC address in most cases).
|
||||
|
||||
Normal response code: 201
|
||||
|
||||
Error codes: 400,401,403,404
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
@ -98,6 +102,7 @@ Response
|
||||
- created_at: created_at
|
||||
- updated_at: updated_at
|
||||
- links: links
|
||||
- ports: pg_ports
|
||||
|
||||
**Example Portgroup creation response:**
|
||||
|
||||
@ -114,6 +119,8 @@ Return a list of bare metal Portgroups, with detailed information.
|
||||
|
||||
Normal response code: 200
|
||||
|
||||
Error codes: 400,401,403,404
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
@ -142,6 +149,7 @@ Response
|
||||
- created_at: created_at
|
||||
- updated_at: updated_at
|
||||
- links: links
|
||||
- ports: pg_ports
|
||||
|
||||
**Example detailed Portgroup list response:**
|
||||
|
||||
@ -158,6 +166,8 @@ Show details for the given Portgroup.
|
||||
|
||||
Normal response code: 200
|
||||
|
||||
Error codes: 400,401,403,404
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
@ -181,6 +191,7 @@ Response
|
||||
- created_at: created_at
|
||||
- updated_at: updated_at
|
||||
- links: links
|
||||
- ports: pg_ports
|
||||
|
||||
**Example Portgroup details:**
|
||||
|
||||
@ -197,6 +208,8 @@ Update a Portgroup.
|
||||
|
||||
Normal response code: 200
|
||||
|
||||
Error codes: 400,401,403,404
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
@ -227,6 +240,7 @@ Response
|
||||
- created_at: created_at
|
||||
- updated_at: updated_at
|
||||
- links: links
|
||||
- ports: pg_ports
|
||||
|
||||
**Example Portgroup update response:**
|
||||
|
||||
@ -243,6 +257,8 @@ Delete a Portgroup.
|
||||
|
||||
Normal response code: 204
|
||||
|
||||
Error codes: 400,401,403,404
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
|
||||
@ -202,14 +202,6 @@ r_port_portgroup_ident:
|
||||
in: query
|
||||
required: false
|
||||
type: string
|
||||
r_port_portgroup_uuid:
|
||||
description: |
|
||||
Filter the list of returned Ports, and only return the ones associated
|
||||
with this specific Portgroup UUID, or an empty set if not found.
|
||||
Added in API microversion 1.24.
|
||||
in: query
|
||||
required: false
|
||||
type: string
|
||||
r_portgroup_address:
|
||||
description: |
|
||||
Filter the list of returned Portgroups, and only return the ones with the
|
||||
@ -226,14 +218,6 @@ r_portgroup_node_ident:
|
||||
in: query
|
||||
required: false
|
||||
type: string
|
||||
r_portgroup_node_uuid:
|
||||
description: |
|
||||
Filter the list of returned Portgroups, and only return the ones associated
|
||||
with this specific node UUID, or an empty set if not found. Added in API
|
||||
microversion 1.23.
|
||||
in: query
|
||||
required: false
|
||||
type: string
|
||||
r_provision_state:
|
||||
description: |
|
||||
Filter the list of returned nodes, and only return those with the specified
|
||||
@ -571,6 +555,13 @@ persistent:
|
||||
in: body
|
||||
required: true
|
||||
type: boolean
|
||||
pg_ports:
|
||||
description: |
|
||||
Links to the collection of ports belonging to this portgroup. Added in
|
||||
API microversion 1.24.
|
||||
in: body
|
||||
required: true
|
||||
type: array
|
||||
port_address:
|
||||
description: |
|
||||
Physical hardware address of this network Port, typically the hardware
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user