Vcenter Phm HardwareSupportManagers create

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 com.vmware.vcenter.phm.HardwareSupportManager referenced by the property Vcenter Phm HardwareSupportManagers CreateSpec.key requires Global.VCServer.

Request

URI

POST

https://{api_host}/api/vcenter/phm/hardware-support-managers

COPY

Request Body

Registration creation spec

Vcenter Phm HardwareSupportManagers CreateSpec of type(s) application/json

Required

Show optional properties

{
    "key": "string",
    "base_url": "string",
    "server_certificate": "string",
    "health_update_info_default_configs": [
        {
            "health_update_info": {},
            "default_enabled": false
        }
    ]
}

{
    "key": "string",
    "base_url": "string",
    "server_certificate": "string",
    "health_update_info_default_configs": [
        {
            "health_update_info": {
                "id": "string",
                "description": "string",
                "severity": "string",
                "purpose": "string",
                "component_category": "string"
            },
            "default_enabled": false
        }
    ]
}

string

key

Required

Globally unique key identifier of the HSM registered with PHM

This property was added in vSphere API 8.0.3.0.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vcenter.phm.HardwareSupportManager. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vcenter.phm.HardwareSupportManager.

string

base_url

Required

The full URL path for all HSM endpoints. (e.g. https://{hsm_api_host}/vsphere-proactive-hw-mgmt)

This property was added in vSphere API 8.0.3.0.

string

server_certificate

Required

The full unabbreviated certificate used by HSM API host in PEM format. The PEM string must contain only the end-entity (leaf) certificate of the certificate chain of trust. It must NOT contain any private keys or anything else except a single x509 certificate.

This property was added in vSphere API 8.0.3.0.

array of object

health_update_info_default_configs

Required

The default configuration on a list of supported Vcenter Phm HardwareSupportManagers HealthUpdateInfo and their enablements.

This property was added in vSphere API 8.0.3.0.

Authentication

This operation uses the following authentication methods.

api_key_auth

Responses

204

Success!

Operation doesn't return any data structure

400

Vapi Std Errors InvalidArgument if PHM fails to process input spec.

Vapi Std Errors AlreadyExists if the HSM is already registered.

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.

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.

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.

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 POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"base_url:"string","health_update_info_default_configs":["object"],"key:"string","server_certificate:"string"}' https://{api_host}/api/vcenter/phm/hardware-support-managers

On This Page

Description

Request

Request Body

Authentication

Response

204 Response Body

Errors

Vcenter Phm Operations

GET

Vcenter Phm HardwareSupportManagers list

POST