VMware Usage Meter Appliance API Data Structures
Invalid data for one or more fields in the request
Invalid data for one or more fields in the request, or the validation of the data does not passed.
Invalid object provided in request payload
Attempt to delete a managed product using the DELETE API
Unauthorized - Invalid or expired session id
Conflict - Object already exists
{
"host": "string",
"port": "integer",
"authorizationType": "string",
"user": "string",
"password": "string",
"domainLDAP": "string",
"vidmToken": "string",
"licenseEdition": "string",
"licenseKey": "string",
"version": "string",
"productType": "string"
}
{
"host": "string",
"port": "integer",
"user": "string",
"password": "string",
"productType": "string",
"vcfManaged": "boolean",
"vcfEdition": "string",
"externalSSO": "boolean",
"extSSOhost": "string",
"extSSOport": "integer",
"srmMetered": "boolean",
"k8sMetric": "string"
}
{
"stream": "string",
"who": "string",
"path": "string",
"description": "string",
"enabled": "boolean"
}
The collector stream that is being anonymized. Can be empty, meaning for all streams.
The class of objects in the stream that are being anonymized, A stream is sent broken in multiple files depending on the class of events, either metering, product data or product history data.
The path in a object to be anonymized.
The key that will be used to retrieve translated description in the GUI.
True if this path element is enabled, false if you want to disable anonymization for it.
{
"group": "string",
"description": "string",
"enabled": "boolean",
"dataPath": [
{
"stream": "string",
"who": "string",
"path": "string",
"description": "string",
"enabled": "boolean"
}
]
}
The name of the anonymization group.
The key that will be used to retrieve translated description in the GUI.
True if this anonymization group is enabled, false if you want to disable anonymization for it.
Data path elements that will get anonymized from this anonymization group. Leaving it empty is the same as marking it as enabled == false.
{
"errCode": "string",
"errMessage": "string"
}
errCode
errMessage
{
"build_number": "integer",
"major_version": "integer",
"minor_version": "integer",
"patch_version": "integer",
"hotfix_version": "integer",
"uuid": "string",
"login_banner": "string"
}
build_number
major_version
minor_version
patch_version
hotfix_version
uuid
login_banner
[
{
"productId": "integer",
"moref": "string",
"vmId": "string",
"ruleId": "string",
"overlaps": [
"string"
],
"inventoryData": {
"name": "string",
"moref": "string"
},
"ruleData": {
"productType": "string",
"productId": "integer",
"name": "string",
"targetId": "string",
"targetType": "string",
"id": "string"
}
}
]
[
{
"productId": "integer",
"targetId": "string",
"productType": "string",
"ruleId": "string",
"targetType": "string",
"inventoryData": {
"name": "string",
"moref": "string"
},
"ruleData": {
"productType": "string",
"productId": "integer",
"name": "string",
"targetId": "string",
"targetType": "string",
"id": "string"
}
}
]
[
{
"productId": "integer",
"moref": "string",
"vmId": "string",
"inventoryData": {
"name": "string",
"moref": "string"
}
}
]
[
{
"productId": "integer",
"moref": "string",
"vmId": "string",
"ruleId": "string",
"overlaps": [
{
"productType": "string",
"productId": "integer",
"name": "string",
"targetId": "string",
"targetType": "string",
"id": "string"
}
],
"inventoryData": {
"name": "string",
"moref": "string"
},
"ruleData": {
"productType": "string",
"productId": "integer",
"name": "string",
"targetId": "string",
"targetType": "string",
"id": "string"
}
}
]
{
"data_usage_acceptance": "boolean",
"http_proxy": "boolean",
"user": "string"
}
data_usage_acceptance
http_proxy
user
{
"productType": "string",
"productId": "integer",
"name": "string",
"targetId": "string",
"targetType": "string",
"id": "string"
}
name
targetId
{
"rules": [
{
"productType": "string",
"productId": "integer",
"name": "string",
"targetId": "string",
"targetType": "string",
"id": "string"
}
]
}
Unable to read security settings due to internal execution failure.
Error in security settings.
ID of the referenced vCenter
domainLDAP
vidmToken
licenseEdition
licenseKey
version
instanceUuid
version
instanceUUID
version
fullName
{
"name": "string",
"moref": "string"
}
name
moref
[
{
"journalId": "integer",
"level": "string",
"productType": "string",
"productId": "integer",
"message": "string",
"data": "string",
"time": "integer"
}
]
{
"notificationSettings": {
"fromEmail": "string",
"notifyEmails": [
"string"
],
"notificationFrequency": "integer"
},
"alertsSubscriptions": [
"string"
],
"lastModificationTime": "integer",
"paused": "boolean",
"smtpSettings": {
"smtpHost": "string",
"smtpPort": "integer",
"smtpUser": "string",
"smtpPassword": "string",
"smtpUseSsl": "boolean"
}
}
alertsSubscriptions
lastModificationTime
paused
ID of the referenced vCenter
Notification settings options.
{
"fromEmail": "string",
"notifyEmails": [
"string"
],
"notificationFrequency": "integer"
}
Email from which the notifications will be send.
Notification recipients's email addresses.
Default frequency for sending the mail notifications.
Notification settings options.
{
"fromEmail": "string",
"notifyEmails": [
"string"
],
"notificationFrequency": "integer"
}
Email from which the notifications will be send.
Notification recipients's email addresses.
Default frequency for sending the mail notifications.
A object, represent the JSON PATCH operations, as defined by RFC-6902 (https://www.rfc-editor.org/rfc/rfc6902).
{
"op": "string",
"path": "string",
"from": "string"
}
The patch operation to be performed over the target entity.
A JSON pointer to the target property.
The value to be used within the operations
A string containing a JSON Pointer value. Typically used with move operation.
A collection of patch instructions to be applied against the existing object.
[
{
"op": "string",
"path": "string",
"from": "string"
}
]
{
"productType": "string",
"productId": "integer",
"name": "string",
"targetId": "string",
"targetType": "string",
"id": "string"
}
name
targetId
{
"rules": [
{
"name": "string",
"id": "string"
}
]
}
rules
{
"rules": [
{
"productType": "string",
"productId": "integer",
"name": "string",
"targetId": "string",
"targetType": "string",
"id": "string"
}
]
}
{
"text": "string"
}
The content of the usage report to be deanonymized.
{
"user": "string",
"password": "string"
}
user
password
{
"data_usage_acceptance": "boolean",
"http_proxy": "boolean",
"sessionid": "string"
}
Specifies whether the user licenese agreement has been accepted
Specifies whether HTTP proxy is setup
The token that identifies this session of the user's login. This must be used as a header paramater for all other operations.
{
"rules": [
{
"productType": "string",
"productId": "integer",
"name": "string",
"targetId": "string",
"targetType": "string"
}
]
}
rules
{
"rules": [
{
"productType": "string",
"productId": "integer",
"name": "string",
"targetId": "string",
"targetType": "string",
"id": "string"
}
]
}
{
"host": "string",
"port": "integer",
"user": "string",
"active": "boolean",
"metered": "boolean",
"id": "integer",
"lastChanged": "integer",
"status": {
"code": "string",
"lastChanged": "integer",
"text": "string"
}
}
Specifies whether the product is active - newly added products are by default active.
Specifies whether the product is being metered - metering starts when product certificates are accepted.
ID of the newly added product. Please note - This ID must be provided for operations like update/delete the product, accept certificates or retrieve notification messages.
lastChanged
{
"managerType": "string",
"managedBy": "integer",
"managerEndpoint": "string"
}
Type of the product managing the product
ID of the product managing the product
Endpoint of the product managing the product. Is of the format <IP/FQDN>:
{
"code": "string",
"lastChanged": "integer",
"text": "string"
}
code
lastChanged
Product status information
{
"certificateId": "string",
"accepted": "boolean",
"productType": "string",
"productId": "integer"
}
Obtained from /user_action API response
accepted
Obtained from Add /product API response
{
"id": "integer",
"host": "string",
"port": "integer",
"user": "string",
"password": "string"
}
{
"id": "integer",
"host": "string",
"port": "integer",
"user": "string",
"password": "string",
"productType": "string",
"domain": "string"
}
{
"id": "integer",
"host": "string",
"port": "integer",
"user": "string",
"password": "string",
"productType": "string",
"domain": "string"
}
{
"id": "integer",
"host": "string",
"port": "integer",
"user": "string",
"password": "string",
"productType": "string"
}
{
"id": "integer",
"host": "string",
"port": "integer",
"user": "string",
"password": "string",
"productType": "string",
"vcId": "integer"
}
{
"id": "integer",
"host": "string",
"port": "integer",
"user": "string",
"password": "string",
"productType": "string"
}
{
"id": "integer",
"host": "string",
"port": "integer",
"user": "string",
"password": "string",
"productType": "string",
"tkgmToken": "string",
"tkgmEdition": "string",
"tkgmMetric": "string"
}
{
"id": "integer",
"host": "string",
"port": "integer",
"user": "string",
"password": "string",
"productType": "string"
}
{
"id": "integer",
"host": "string",
"port": "integer",
"user": "string",
"password": "string",
"productType": "string"
}
{
"id": "integer",
"host": "string",
"port": "integer",
"user": "string",
"password": "string",
"productType": "string",
"authorizationType": "string",
"domainLDAP": "string",
"vidmToken": "string",
"licenseEdition": "string",
"licenseKey": "string",
"version": "string"
}
{
"id": "integer",
"host": "string",
"port": "integer",
"user": "string",
"password": "string",
"productType": "string"
}
{
"id": "integer",
"host": "string",
"port": "integer",
"user": "string",
"password": "string",
"productType": "string"
}
{
"id": "integer",
"host": "string",
"port": "integer",
"user": "string",
"password": "string",
"productType": "string"
}
{
"id": "integer",
"host": "string",
"port": "integer",
"user": "string",
"password": "string",
"productType": "string",
"externalSSO": "boolean",
"extSSOhost": "string",
"extSSOport": "integer",
"srmMetered": "boolean",
"k8sMetric": "string"
}
{
"host": "string",
"port": "integer",
"user": "string",
"password": "string",
"productType": "string",
"iaasHost": "string",
"iaasPort": "integer",
"iaasUser": "string",
"iaasPassword": "string",
"iaasDomain": "string"
}
{
"productId": "integer",
"productType": "string",
"criteria": {
"targetType": "string",
"ruleName": "string"
}
}
criteria
[
{
"productType": "string",
"productId": "integer",
"ruleName": "string",
"targetName": "string",
"targetId": "string",
"targetType": "string",
"deleted": "boolean"
}
]
SMTP configuration settings representation.
{
"smtpHost": "string",
"smtpPort": "integer",
"smtpUser": "string",
"smtpPassword": "string",
"smtpUseSsl": "boolean"
}
SMTP server host.
SMTP server port.
The SMTP user, used for authentication against the configured SMTP server.
SMTP password used with conjunction with smtpUser to form authentication credentials. Note: This property will be always null when read.
Force using SMTP over SSL/TLS for communication with configured SMTP server.
Specifies the Tanzu edition
Specifies the TKGm edition
Specifies the TKGm metric - vRAM or cpu-cores
Bearer token used to authenticate to TKGm Management endpoint
ID of the referenced vCenter
{
"availableStorageMB": "integer"
}
availableStorageMB
[
{
"code": "string",
"data": {
"productId": "integer",
"host": "string",
"ip": "string",
"port": "integer",
"certificateId": "string",
"certData": {
"notAfter": "integer",
"signature": "string",
"issuerDN": "string",
"sn": "string",
"publicKey": "string",
"version": "integer",
"notBefore": "integer",
"subjectDN": "string",
"sigAlgName": "string",
"fingerprint_sha256": "string"
},
"productType": "string"
}
}
]
Specifies the VMware Cloud Foundation edition
{
"productType": "string",
"vcfManaged": "boolean",
"vcfEdition": "string"
}
Specifies whether this vCenter is managed by VMware Cloud Foundation
VRNI Authorization Type
{
"host": "string",
"port": "integer",
"authorizationType": "string",
"user": "string",
"password": "string",
"domainLDAP": "string",
"vidmToken": "string",
"licenseEdition": "string",
"licenseKey": "string",
"version": "string"
}
Required for authorizationType 'LOCAL' and 'LDAP'
Required for authorizationType 'LOCAL' and 'LDAP'
Required for authorizationType 'LDAP'
Required for authorizationType 'vIDM'
Required for authorizationType 'vIDM'
Required for authorizationType 'vIDM'
Required for authorizationType 'vIDM'
Array of vCenter hosts this VROPS is mapped to
[
{}
]
[
{
"name": "string",
"id": "string",
"status": "string",
"datacenter": {
"datacenterId": "string",
"datacenterName": "string"
},
"products": [
{
"productId": "integer",
"host": "string",
"ip": "string",
"port": "integer",
"productType": "string",
"registered": "boolean",
"version": "string",
"sslCertificateFingerprint": "string"
}
]
}
]
{
"host": "string",
"port": "integer",
"user": "string",
"active": "boolean",
"metered": "boolean",
"id": "integer",
"lastChanged": "integer",
"status": {
"code": "string",
"lastChanged": "integer",
"text": "string"
},
"managerType": "string",
"managedBy": "integer",
"managerEndpoint": "string",
"productType": "string"
}
{
"messages": [
{
"errCode": "string",
"errMessage": "string"
}
]
}
The client Accept type - json data or tsv file
Include only the active products - newly added products are by default active.
host name or IP address of the vRealize Automation appliance instance
the user's password
port of the vRealize Automation appliance instance
user of a vRealize Automation appliance instance. User must belong to sphere.domain
External Platform Services Controller (PSC) host. Required, if externalSSO is true.
External Platform Services Controller (PSC) port. Required, if externalSSO is true.
Specifies whether this vCenter uses external Platform Services Controller (PSC) host
Force product creation by skipping conflict validations.
IaaS Domain of the vRealize Automation appliance instance
IaaS Web Server of the vRealize Automation appliance instance
user's password to the IaaS Web Server
IaaS Web Server port
user of the IaaS Web Server
Product ID, obtained from Add /product API response
ID of the product to delete, obtained from Add /product API response
Indicates whether K8S metering is vRAM or cpu-cores
Include only the products being metered - metering starts when product certificates are accepted.
The id(UUID) of a customer rule
The name of a customer rule
The name of a customer rule
The audit product id of customer rules.
The audit product type of customer rules.
The audit report result limit.
The audit report type of customer rules.
The authentication token obtained from login API response
Indicates whether SRM metering is turned on or off in the web UI
Indicates number of clusters where vSAN is enabled
Indicates whether vSAN is enabled or not
Indicates vSAN versions