Get NIC Properties

The Get NIC Properties operation retrieves the properties of a single NIC object that is designated by its element ID and the object ID of the owning partition.

HTTP method and URI

GET /api/partitions/{partition-id}/nics/{nic-id}

URI variables:

Name Type Description
{partition-id} String Object ID of the Partition object.
{nic-id} String Element ID of the NIC.

Response body contents

On successful completion, the response body contains a JSON object that provides the current values of the properties for the NIC object as defined in the Data model - NIC element object. Field names and data types in the JSON object are the same as the property names and data types defined in the Data model.

Description

This operation returns the current properties for the NIC object that is specified by the request URI.

On successful execution, all of the current properties as defined by the Data model - NIC element object are provided in the response body and HTTP status code 200 (OK) is returned.

A 404 (Not Found) status code is returned if the request URI does not designate an existing NIC element of an existing partition, or if the API user does not have object-access permission to that partition.

Authorization requirements

This operation has the following authorization requirement:
  • Object-access permission to the Partition object designated by {partition-id}.

HTTP status and reason codes

On success, HTTP status code 200 (OK) is returned and the response body is provided as described in Response body contents.

The following HTTP status codes are returned for the indicated errors, and the response body is a standard error response body providing the reason code indicated and associated error message.

Table 1. Get NIC Properties: HTTP status and reason codes
HTTP error status code Reason code Description
400 (Bad Request) Various Errors were detected during common request validation. See Common request validation reason codes for a list of the possible reason codes.
404 (Not Found) 1 The object-id in the URI {partition-id} does not designated an existing Partition object, or the API user does not have object-access permission to it.
5 The request URI does not designate an existing NIC of an existing partition.

Additional standard status and reason codes can be returned, as described in Invoking API operations.

Example HTTP interaction

Figure 1. Get NIC Properties: Request
GET /api/partitions/fd93be7e-e928-11e6-bcc9-42f2e9cfe851/nics/9ff431cc-e92d-11e6-
  9563-42f2e9cfe851 HTTP/1.1
x-api-session: 14ort688m7f2j5yi4tp1eedxo78x7d0ko7qrm7evk5h28p7bzc
Figure 2. Get NIC Properties: Response
200 OK
server: zSeries management console API web server / 2.0
cache-control: no-cache
date: Mon, 06 Feb 2017 09:11:27 GMT
content-type: application/json;charset=UTF-8
content-length: 551
{
 "class":"nic",
 "description":"",
 "device-number":"0004",
 "element-id":"9ff431cc-e92d-11e6-9563-42f2e9cfe851",
 "element-uri":"/api/partitions/fd93be7e-e928-11e6-bcc9-42f2e9cfe851/nics/
    9ff431cc-e92d-11e6-9563-42f2e9cfe851",
 "mac-address":"12:34:56:78:9a:bc",
 "name":"ttt",
 "parent":"/api/partitions/fd93be7e-e928-11e6-bcc9-42f2e9cfe851",
 "ssc-ip-address":"2001:0db8:1234:1234::3",
 "ssc-ip-address-type":"ipv6",
 "ssc-management-nic":true,
 "ssc-mask-prefix":"/24",
 "type":"osd",
 "virtual-switch-uri":"/api/virtual-switches/2b0d93e8-b64d-11e6-99ee-42f2e9cfe851",
 "vlan-id":10
 "vlan-type":"enforced"
}