diff --git a/api-ref/source/baremetal-api-v1-nodes-ports.inc b/api-ref/source/baremetal-api-v1-nodes-ports.inc index 9bfba9be04..58addd24c1 100644 --- a/api-ref/source/baremetal-api-v1-nodes-ports.inc +++ b/api-ref/source/baremetal-api-v1-nodes-ports.inc @@ -81,6 +81,9 @@ Response - 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 - created_at: created_at - updated_at: updated_at diff --git a/api-ref/source/baremetal-api-v1-ports.inc b/api-ref/source/baremetal-api-v1-ports.inc index 390bd3bb15..d2b741167c 100644 --- a/api-ref/source/baremetal-api-v1-ports.inc +++ b/api-ref/source/baremetal-api-v1-ports.inc @@ -102,6 +102,9 @@ Response - 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 - created_at: created_at - updated_at: updated_at @@ -148,6 +151,9 @@ Response - 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 - created_at: created_at - updated_at: updated_at @@ -188,6 +194,9 @@ Response - 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 - created_at: created_at - updated_at: updated_at @@ -231,6 +240,9 @@ Response - 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 - created_at: created_at - updated_at: updated_at diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index 20c9192ac5..128d983383 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -336,6 +336,13 @@ instance_uuid: in: body required: true type: string +internal_info: + description: | + Internal metadata set and stored by the Port. This field is read-only. + Added in API microversion 1.18. + in: body + required: true + type: JSON last_error: description: | Any error from the most recent (last) transaction that started but failed to finish. @@ -349,6 +356,17 @@ links: in: body required: true type: array +local_link_connection: + description: | + The Port binding profile. If specified, must contain ``switch_id`` (only + a MAC address or an OpenFlow based datapath_id of the switch are accepted + in this field) and ``port_id`` (identifier of the physical port on the + switch to which node's port is connected to) fields. ``switch_info`` is an + optional string field to be used to store any vendor-specific information. + Added in API microversion 1.19. + in: body + required: true + type: JSON maintenance: description: | Whether or not this Node is currently in "maintenance mode". Setting a Node @@ -485,6 +503,13 @@ provision_updated_at: in: body required: true type: string +pxe_enabled: + description: | + Indicates whether PXE is enabled or disabled on the Port. Added in API + microversion 1.19. + in: body + required: true + type: boolean r_driver_name: description: | The name of the driver used to manage this Node. diff --git a/api-ref/source/samples/node-port-detail-response.json b/api-ref/source/samples/node-port-detail-response.json index 0cb3367179..1b8e57a4e5 100644 --- a/api-ref/source/samples/node-port-detail-response.json +++ b/api-ref/source/samples/node-port-detail-response.json @@ -16,7 +16,14 @@ } ], "created_at" : "2016-05-05T22:30:57+00:00", - "uuid" : "c933a251-486f-4c27-adb2-8b5f59bd9cd2" + "uuid" : "c933a251-486f-4c27-adb2-8b5f59bd9cd2", + "pxe_enabled": true, + "local_link_connection": { + "switch_id": "0a:1b:2c:3d:4e:5f", + "port_id": "Ethernet3/1", + "switch_info": "switch1" + }, + "internal_info": {} } ] } diff --git a/api-ref/source/samples/port-create-request.json b/api-ref/source/samples/port-create-request.json index b4dad27767..664f20e0d3 100644 --- a/api-ref/source/samples/port-create-request.json +++ b/api-ref/source/samples/port-create-request.json @@ -1,4 +1,9 @@ { "node_uuid": "ecddf26d-8c9c-4ddf-8f45-fd57e09ccddb", - "address": "11:11:11:11:11:11" + "address": "11:11:11:11:11:11", + "local_link_connection": { + "switch_id": "0a:1b:2c:3d:4e:5f", + "port_id": "Ethernet3/1", + "switch_info": "switch1" + } } \ No newline at end of file diff --git a/api-ref/source/samples/port-create-response.json b/api-ref/source/samples/port-create-response.json index 95ccdc6d50..946fbd551a 100644 --- a/api-ref/source/samples/port-create-response.json +++ b/api-ref/source/samples/port-create-response.json @@ -14,5 +14,12 @@ "address" : "11:11:11:11:11:11", "updated_at" : null, "node_uuid" : "ecddf26d-8c9c-4ddf-8f45-fd57e09ccddb", - "uuid" : "c933a251-486f-4c27-adb2-8b5f59bd9cd2" + "uuid" : "c933a251-486f-4c27-adb2-8b5f59bd9cd2", + "pxe_enabled": true, + "local_link_connection": { + "switch_id": "0a:1b:2c:3d:4e:5f", + "port_id": "Ethernet3/1", + "switch_info": "switch1" + }, + "internal_info": {} } diff --git a/api-ref/source/samples/port-list-detail-response.json b/api-ref/source/samples/port-list-detail-response.json index 00b6add816..1decc1af66 100644 --- a/api-ref/source/samples/port-list-detail-response.json +++ b/api-ref/source/samples/port-list-detail-response.json @@ -16,7 +16,14 @@ "rel" : "bookmark" } ], - "created_at" : "2016-05-05T22:30:57+00:00" + "created_at" : "2016-05-05T22:30:57+00:00", + "pxe_enabled": true, + "local_link_connection": { + "switch_id": "0a:1b:2c:3d:4e:5f", + "port_id": "Ethernet3/1", + "switch_info": "switch1" + }, + "internal_info": {} } ] } diff --git a/api-ref/source/samples/port-update-response.json b/api-ref/source/samples/port-update-response.json index 98d135929c..5895e9fe5d 100644 --- a/api-ref/source/samples/port-update-response.json +++ b/api-ref/source/samples/port-update-response.json @@ -14,5 +14,12 @@ "rel" : "bookmark" } ], - "created_at" : "2016-05-05T22:30:57+00:00" + "created_at" : "2016-05-05T22:30:57+00:00", + "pxe_enabled": true, + "local_link_connection": { + "switch_id": "0a:1b:2c:3d:4e:5f", + "port_id": "Ethernet3/1", + "switch_info": "switch1" + }, + "internal_info": {} }