Update Virtual Function Properties

The Update Virtual Function Properties operation modifies an existing virtual function that is designated by its element ID and the object ID of the owning partition.

HTTP method and URI

POST /api/partitions/{partition-id}/virtual-functions/{virtual-function-id}

URI variables:

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

Request body contents

The request body is expected to contain a JSON object that provides the new values of any writable property that is to be updated by this operation. Field names and data types in this JSON object are expected to match the corresponding property names and data types defined by the data model for this object type. The JSON object can and should omit fields for properties whose values are not to be changed by this operation.

Description

This operation modifies an existing virtual function specified by the request URI.

If this operation changes the value of any property for which property-change notifications are due, those notifications are issued asynchronously to this operation.

A 404 (Not Found) status code is returned if the request URI does not designate an existing virtual function element of an existing partition, or if the API user does not have object-access permission to that partition. If the API user doesn't have action/task permission to Partition Details task 403 (Forbidden) status code is returned. If the partition is in one of the transitional states ("starting" or "stopping"), or if the CPC is not in a valid state, a 409 (Conflict) status code is returned.

Authorization requirements

This operation has the following authorization requirements:
  • Object-access permission to the partition.
  • Action/task permission to the Partition Details task.
  • When updating adapter-uri, object-access permission to the adapter identified in that URI.

HTTP status and reason codes

On success, HTTP status code 204 (No Content) is returned and no response body is provided.

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. Update Virtual Function 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.
8 The virtual function name provided by the user is already in use by another virtual function of the partition, or the provided device-number is already in use by another Virtual Function element or by a NIC element of type "roce" of the partition.
403 (Forbidden) 1 The API user does not have the required permission for this operation.
404 (Not Found) 1 The request URI does not designate an existing resource or designates a resource for which the API user does not have object-access permission.
2 The adapter-uri in the request body does not designated an existing resource of the expected type, or designates a resource for which the API user does not have object-access permission.
5 The request URI does not designate an existing virtual function element of an existing partition.
409 (Conflict) 1 Partition status is not valid to perform the operation
2 Partition object with ID {partition-id} was busy and request timed out.
6 The state of the CPC hosting the partition is not valid to perform the operation (must be in one of the following states: "active", "service-required", "degraded" or "exceptions".)
10 The operation cannot be performed because the affected SE is in the process of being shut down.
503 (Service Unavailable 1 The request could not be processed because the HMC is not currently communicating with an SE needed to perform the requested operation.

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

Example HTTP interaction

Figure 1. Update Virtual Function Properties: Request
POST /api/partitions/b4c4bf9e-97e0-11e5-9d1f-020000000192/virtual-functions/621c6430-
   97e6-11e5-9e1e-020000000192 HTTP/1.1
x-api-session: 1chtesqt42ehx99ayericoofm6gz1gt85wedt8piouotf6doyh
content-type: application/json
content-length: 46
{
   "name":"Virtual Function Name after update"
}
Figure 2. Update Virtual Function Properties: Response
204 No Content
server: zSeries management console API web server / 2.0
cache-control: no-cache
date: Tue, 01 Dec 2015 04:50:36 GMT
<No response body>