Vcenter Phm HardwareSupportManagers ManagedHosts update

Vcenter Phm HardwareSupportManagers ManagedHosts update

Modify the list of HSM managed hosts stored at PHM side. The managed hosts are the resources created and owned by HSM. Whenever there is any change in the managed host list, HSM uses this API to inform PHM.

This operation was added in vSphere API 8.0.3.0.

Returns an authorization error if you do not have all of the privileges described as follows:

  • Operation execution requires Global.VCServer.
  • The resource HostSystem referenced by the property Vcenter Phm HardwareSupportManagers ManagedHosts UpdateSpec.hosts_to_add requires System.View.
  • The resource com.vmware.vcenter.phm.HardwareSupportManager referenced by the parameter key requires Global.VCServer.
  • The resource HostSystem referenced by the property Vcenter Phm HardwareSupportManagers ManagedHosts UpdateSpec.hosts_to_remove requires Global.VCServer.
Request
URI
PATCH
https://{api_host}/api/vcenter/phm/hardware-support-managers/{key}/managed-hosts
COPY
Path Parameters
string
key
Required

HSM key of the targeted hardware support manager

The parameter must be an identifier for the resource type: com.vmware.vcenter.phm.HardwareSupportManager.

Request Body

update spec on the change of managed host list

Vcenter Phm HardwareSupportManagers ManagedHosts UpdateSpec of type(s) application/json
Required 
{
    "hosts_to_add": [
        "string"
    ],
    "hosts_to_remove": [
        "string"
    ]
}
array of string
hosts_to_add
Optional

A list of managed hosts added by an HSM.

This property was added in vSphere API 8.0.3.0.

This property may be missing or null meaning this update does not contain any newly added managed hosts.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: HostSystem. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: HostSystem.

array of string
hosts_to_remove
Optional

A list of managed hosts removed by an HSM.

This property was added in vSphere API 8.0.3.0.

This property may be missing or null meaning this update does not contain any removed managed hosts.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: HostSystem. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: HostSystem.

Authentication
This operation uses the following authentication methods.
Responses
204

Success!

Operation doesn't return any data structure

400

if the specified spec is invalid.

Returns Vapi Std Errors InvalidArgument of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors InvalidArgument0 
"Vapi Std Errors InvalidArgument Object"

401

if user has not provided adequate credentials.

Returns Vapi Std Errors Unauthenticated of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors Unauthenticated0 
"Vapi Std Errors Unauthenticated Object"
string
challenge
Optional

Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.

For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"

This property was added in vSphere API 7.0.0.0.

This property is optional because it was added in a newer version than its parent node.


404

if the specified key does not exist.

Returns Vapi Std Errors NotFound of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors NotFound0 
"Vapi Std Errors NotFound Object"

500

if PHM service hits an internal error.

Returns Vapi Std Errors Error of type(s) application/json 
"Vapi Std Errors Error Object"
array of object
messages
Required

Stack of one or more localizable messages for human error consumers.

The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.

Each subsequent message in the stack describes the "cause" of the prior message.

object
data
Optional

Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.

Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.

The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.

Some operations will not set this property when reporting errors.

string
error_type
Required

Discriminator field to help API consumers identify the structure type.

For more information see: Vapi Std Errors Error Type.

This property was added in vSphere API 6.7.2.

Can be missing or null for compatibility with preceding implementations.


503

if PHM service is not able to handle request.

Returns Vapi Std Errors ServiceUnavailable of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors ServiceUnavailable0 
"Vapi Std Errors ServiceUnavailable Object"

Code Samples
COPY
                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}'
On This Page
Vcenter Phm Operations
GET
Vcenter Phm HardwareSupportManagers ManagedHosts list
PATCH
Vcenter Phm HardwareSupportManagers ManagedHosts update