7d736d1697
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
99 lines
2.2 KiB
ReStructuredText
99 lines
2.2 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
=============================================
|
|
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.
|
|
|
|
These endpoints do not allow modification of the Ports; that should be done
|
|
by accessing the Port resources under the ``/v1/ports`` endpoint.
|
|
|
|
``/v1/portgroups/{portgroup_ident}/ports`` endpoint was added in API
|
|
microversion 1.24, if using older version, all the requests return
|
|
``Not Found (404)`` error code.
|
|
|
|
|
|
List Ports by Portgroup
|
|
=======================
|
|
|
|
.. rest_method:: GET /v1/portgroups/{portgroup_ident}/ports
|
|
|
|
Return a list of bare metal Ports associated with ``portgroup_ident``.
|
|
|
|
Normal response code: 200
|
|
|
|
Error codes: 400,401,403,404
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- portgroup_ident: portgroup_ident
|
|
- fields: fields
|
|
- limit: limit
|
|
- marker: marker
|
|
- sort_dir: sort_dir
|
|
- sort_key: sort_key
|
|
|
|
Response
|
|
--------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- ports: ports
|
|
- uuid: uuid
|
|
- address: port_address
|
|
- links: links
|
|
|
|
**Example list of a Portgroup's Ports:**
|
|
|
|
.. literalinclude:: samples/portgroup-port-list-response.json
|
|
|
|
|
|
List detailed Ports by Portgroup
|
|
================================
|
|
|
|
.. rest_method:: GET /v1/portgroups/{portgroup_ident}/ports/detail
|
|
|
|
Return a detailed list of bare metal Ports associated with ``portgroup_ident``.
|
|
|
|
Normal response code: 200
|
|
|
|
Error codes: 400,401,403,404
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- portgroup_ident: portgroup_ident
|
|
- limit: limit
|
|
- marker: marker
|
|
- sort_dir: sort_dir
|
|
- sort_key: sort_key
|
|
|
|
Response
|
|
--------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- ports: ports
|
|
- uuid: uuid
|
|
- address: port_address
|
|
- node_uuid: node_uuid
|
|
- local_link_connection: local_link_connection
|
|
- pxe_enabled: pxe_enabled
|
|
- internal_info: internal_info
|
|
- extra: extra
|
|
- portgroup_uuid: portgroup_uuid
|
|
- created_at: created_at
|
|
- updated_at: updated_at
|
|
- links: links
|
|
|
|
**Example details of a Portgroup's Ports:**
|
|
|
|
.. literalinclude:: samples/portgroup-port-detail-response.json
|