VMware Usage Meter Appliance API Data Structures
400InvalidRequest
Invalid data for one or more fields in the request
This data structure has no properties.
400InvalidRequestValidationIssues
Invalid data for one or more fields in the request, or the validation of the data does not passed.
This data structure has no properties.
400ManagedProductAddRequest
Invalid object provided in request payload
This data structure has no properties.
400ManagedProductDeleteRequest
Attempt to delete a managed product using the DELETE API
This data structure has no properties.
401Unauthorized_sessionID
Unauthorized - Invalid or expired session id
This data structure has no properties.
Returned By
409Conflict
Conflict - Object already exists
This data structure has no properties.
AddProductRequest_DAAS
This data structure has no properties.
AddProductRequest_DAAS
This data structure has no properties.
AddProductRequest_HORIZON
This data structure has no properties.
AddProductRequest_HORIZON
This data structure has no properties.
AddProductRequest_NSX-T
This data structure has no properties.
AddProductRequest_NSX-T
This data structure has no properties.
AddProductRequest_NSX-V
This data structure has no properties.
AddProductRequest_NSX-V
This data structure has no properties.
AddProductRequest_NSXALB
This data structure has no properties.
AddProductRequest_NSXALB
This data structure has no properties.
AddProductRequest_TKGM
This data structure has no properties.
AddProductRequest_TKGM
This data structure has no properties.
AddProductRequest_VCAV
This data structure has no properties.
AddProductRequest_VCAV
This data structure has no properties.
AddProductRequest_VCD
This data structure has no properties.
AddProductRequest_VCD
This data structure has no properties.
AddProductRequest_VRNI
AllOf
JSON Example
{
"host": "string",
"port": "integer",
"authorizationType": "string",
"user": "string",
"password": "string",
"domainLDAP": "string",
"vidmToken": "string",
"licenseEdition": "string",
"licenseKey": "string",
"version": "string",
"productType": "string"
}
AddProductRequest_VRNI_authLDAP
This data structure has no properties.
AddProductRequest_VRNI_authLOCAL
This data structure has no properties.
AddProductRequest_VRNI_auth_vIDM
This data structure has no properties.
AddProductRequest_VROPS
This data structure has no properties.
AddProductRequest_VROPS
This data structure has no properties.
AddProductRequest_VRSLCM
This data structure has no properties.
AddProductRequest_VRSLCM
This data structure has no properties.
AddProductRequest_vCenter
AllOf
This class requires all of the following:
JSON Example
{
"host": "string",
"port": "integer",
"user": "string",
"password": "string",
"productType": "string",
"vcfManaged": "boolean",
"vcfEdition": "string",
"externalSSO": "boolean",
"extSSOhost": "string",
"extSSOport": "integer",
"srmMetered": "boolean",
"k8sMetric": "string"
}
AddProductRequest_vCenter_VCFManaged
This data structure has no properties.
AddProductRequest_vCenter_extSSOFalse
This data structure has no properties.
AddProductRequest_vCenter_extSSOTrue
This data structure has no properties.
AddProductRequest_vRA
This data structure has no properties.
AddProductRequest_vRA
This data structure has no properties.
AnonDataPath
JSON Example
{
"stream": "string",
"who": "string",
"path": "string",
"description": "string",
"enabled": "boolean"
}string
stream
Optional
The collector stream that is being anonymized. Can be empty, meaning for all streams.
string
who
Required
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.
string
path
Required
The path in a object to be anonymized.
string
description
Required
The key that will be used to retrieve translated description in the GUI.
boolean
enabled
Required
True if this path element is enabled, false if you want to disable anonymization for it.
AnonGroup
JSON Example
{
"group": "string",
"description": "string",
"enabled": "boolean",
"dataPath": [
{
"stream": "string",
"who": "string",
"path": "string",
"description": "string",
"enabled": "boolean"
}
]
}string
group
Required
The name of the anonymization group.
string
description
Required
The key that will be used to retrieve translated description in the GUI.
boolean
enabled
Required
True if this anonymization group is enabled, false if you want to disable anonymization for it.
array of AnonDataPath
dataPath
Optional
Data path elements that will get anonymized from this anonymization group. Leaving it empty is the same as marking it as enabled == false.
AnonSettings
This data structure has no properties.
AnonSettings
This data structure has no properties.
BooleanDefaultFalse
This data structure has no properties.
DAAS
This data structure has no properties.
DAAS
This data structure has no properties.
DAASdomain
This data structure has no properties.
Error
JSON Example
{
"errCode": "string",
"errMessage": "string"
}string
errCode
Optional
errCode
string
errMessage
Optional
errMessage
Property Of
GetAgentInfoResponse
JSON Example
{
"build_number": "integer",
"major_version": "integer",
"minor_version": "integer",
"patch_version": "integer",
"hotfix_version": "integer",
"uuid": "string",
"login_banner": "string"
}integer As int32 As int32
build_number
Optional
build_number
integer As int16 As int16
major_version
Optional
major_version
integer As int16 As int16
minor_version
Optional
minor_version
integer As int16 As int16
patch_version
Optional
patch_version
integer As int16 As int16
hotfix_version
Optional
hotfix_version
string As uuid As uuid
uuid
Optional
uuid
string
login_banner
Optional
login_banner
GetAuditMappedVMsResponse
This class is array of
JSON Example
[
{
"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"
}
}
]
GetAuditMissingTargetsResponse
This class is array of
JSON Example
[
{
"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"
}
}
]
GetAuditNotMappedVMsResponse
This class is array of
JSON Example
[
{
"productId": "integer",
"moref": "string",
"vmId": "string",
"inventoryData": {
"name": "string",
"moref": "string"
}
}
]
GetAuditOverlapsResponse
This class is array of
JSON Example
[
{
"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"
}
}
]
GetLoginResponse
JSON Example
{
"data_usage_acceptance": "boolean",
"http_proxy": "boolean",
"user": "string"
}boolean
data_usage_acceptance
Optional
data_usage_acceptance
boolean
http_proxy
Optional
http_proxy
string
user
Optional
user
GetRuleResponse
JSON Example
{
"productType": "string",
"productId": "integer",
"name": "string",
"targetId": "string",
"targetType": "string",
"id": "string"
}string
name
Optional
name
string
targetId
Optional
targetId
GetRulesResponse
JSON Example
{
"rules": [
{
"productType": "string",
"productId": "integer",
"name": "string",
"targetId": "string",
"targetType": "string",
"id": "string"
}
]
}
GetSecuritySettings500
Unable to read security settings due to internal execution failure.
This data structure has no properties.
GetSecuritySettings502
Error in security settings.
This data structure has no properties.
HORIZON
This data structure has no properties.
HORIZON
This data structure has no properties.
HORIZONdomain
This data structure has no properties.
Host
This data structure has no properties.
InlineAddProductRequest_DAAS1
This data structure has no properties.
InlineAddProductRequest_HORIZON1
This data structure has no properties.
InlineAddProductRequest_NSX-T1
This data structure has no properties.
InlineAddProductRequest_NSX-V1
This data structure has no properties.
InlineAddProductRequest_NSXALB1
This data structure has no properties.
InlineAddProductRequest_TKGM1
This data structure has no properties.
InlineAddProductRequest_VCAV1
This data structure has no properties.
InlineAddProductRequest_VCD1
This data structure has no properties.
InlineAddProductRequest_VRNI1
This data structure has no properties.
InlineAddProductRequest_VROPS1
This data structure has no properties.
InlineAddProductRequest_VRSLCM1
This data structure has no properties.
InlineAddProductRequest_vCenter2
This data structure has no properties.
InlineAddProductRequest_vRA0
This data structure has no properties.
InlineDAAS1
This data structure has no properties.
InlineHORIZON1
This data structure has no properties.
InlineNSX-T1
This data structure has no properties.
InlineNSX-V1
This data structure has no properties.
integer
vcId
Required
ID of the referenced vCenter
InlineNSXALB1
This data structure has no properties.
InlinePutProductRequest_DAAS1
This data structure has no properties.
InlinePutProductRequest_HORIZON1
This data structure has no properties.
InlinePutProductRequest_NSX-T1
This data structure has no properties.
InlinePutProductRequest_NSX-V1
This data structure has no properties.
InlinePutProductRequest_NSXALB1
This data structure has no properties.
InlinePutProductRequest_TKGM1
This data structure has no properties.
InlinePutProductRequest_VCAV1
This data structure has no properties.
InlinePutProductRequest_VCD1
This data structure has no properties.
InlinePutProductRequest_VRNI1
This data structure has no properties.
string
domainLDAP
Optional
domainLDAP
string
vidmToken
Optional
vidmToken
string
licenseEdition
Optional
licenseEdition
string
licenseKey
Optional
licenseKey
string
version
Optional
version
InlinePutProductRequest_VROPS1
This data structure has no properties.
InlinePutProductRequest_VRSLCM1
This data structure has no properties.
InlinePutProductRequest_VRSVRA1
This data structure has no properties.
InlinePutProductRequest_vCenter1
This data structure has no properties.
InlinePutProductRequest_vRA0
This data structure has no properties.
InlineTKGM1
This data structure has no properties.
string As uuid As uuid
instanceUuid
Optional
instanceUuid
string
version
Optional
version
InlineVCAV1
This data structure has no properties.
InlineVRNI3
This data structure has no properties.
InlineVROPS2
This data structure has no properties.
InlineVRSLCM1
This data structure has no properties.
InlineVRSLCM2
This data structure has no properties.
InlineVRSVRA2
This data structure has no properties.
InlinevCenter1
This data structure has no properties.
string As uuid As uuid
instanceUUID
Optional
instanceUUID
string
version
Optional
version
string
fullName
Optional
fullName
InlinevRA0
This data structure has no properties.
InventoryData
JSON Example
{
"name": "string",
"moref": "string"
}string
name
Optional
name
string
moref
Optional
moref
JournalLogLevel
This data structure has no properties.
Enumeration: Info, Warn, Err,
JournalResponse
This class is array of
JSON Example
[
{
"journalId": "integer",
"level": "string",
"productType": "string",
"productId": "integer",
"message": "string",
"data": "string",
"time": "integer"
}
]
MailNotifications
JSON Example
{
"notificationSettings": {
"fromEmail": "string",
"notifyEmails": [
"string"
],
"notificationFrequency": "integer"
},
"alertsSubscriptions": [
"string"
],
"lastModificationTime": "integer",
"paused": "boolean",
"smtpSettings": {
"smtpHost": "string",
"smtpPort": "integer",
"smtpUser": "string",
"smtpPassword": "string",
"smtpUseSsl": "boolean"
}
}array of string
alertsSubscriptions
Required
alertsSubscriptions
integer
lastModificationTime
Optional
lastModificationTime
boolean
paused
Optional
paused
NSX-T
This data structure has no properties.
NSX-T
This data structure has no properties.
NSX-V
This data structure has no properties.
NSX-V
This data structure has no properties.
NSX-VvcId
ID of the referenced vCenter
This data structure has no properties.
NSXALB
This data structure has no properties.
NSXALB
This data structure has no properties.
Name_CMR
This data structure has no properties.
NotificationSettings
Notification settings options.
JSON Example
{
"fromEmail": "string",
"notifyEmails": [
"string"
],
"notificationFrequency": "integer"
}string As ^[a-z0-9._%+-]+@[a-z0-9.-]+\\.[a-z]{2,4}$
fromEmail
Required
Email from which the notifications will be send.
array of string
notifyEmails
Required
Notification recipients's email addresses.
integer
notificationFrequency
Required
Default frequency for sending the mail notifications.
NotificationSettings
Notification settings options.
JSON Example
{
"fromEmail": "string",
"notifyEmails": [
"string"
],
"notificationFrequency": "integer"
}string As ^[a-z0-9._%+-]+@[a-z0-9.-]+\\.[a-z]{2,4}$
fromEmail
Required
Email from which the notifications will be send.
array of string
notifyEmails
Required
Notification recipients's email addresses.
integer
notificationFrequency
Required
Default frequency for sending the mail notifications.
Password
This data structure has no properties.
PatchInstruction
A object, represent the JSON PATCH operations, as defined by RFC-6902 (https://www.rfc-editor.org/rfc/rfc6902).
JSON Example
{
"op": "string",
"path": "string",
"from": "string"
}string
op
Required
The patch operation to be performed over the target entity.
string
path
Required
A JSON pointer to the target property.
object
value
Optional
The value to be used within the operations
string
from
Optional
A string containing a JSON Pointer value. Typically used with move operation.
PatchRequest
A collection of patch instructions to be applied against the existing object.
This class is array of
JSON Example
[
{
"op": "string",
"path": "string",
"from": "string"
}
]
PatchRuleResponse
JSON Example
{
"productType": "string",
"productId": "integer",
"name": "string",
"targetId": "string",
"targetType": "string",
"id": "string"
}string
name
Optional
name
string
targetId
Optional
targetId
PatchRulesRequest
JSON Example
{
"rules": [
{
"name": "string",
"id": "string"
}
]
}array of object
rules
Optional
rules
PatchRulesResponse
JSON Example
{
"rules": [
{
"productType": "string",
"productId": "integer",
"name": "string",
"targetId": "string",
"targetType": "string",
"id": "string"
}
]
}
Port
This data structure has no properties.
PostDeanonymize
JSON Example
{
"text": "string"
}string
text
Required
The content of the usage report to be deanonymized.
PostLoginRequest
JSON Example
{
"user": "string",
"password": "string"
}string
user
Required
user
string As password As password
password
Required
password
PostLoginResponse
JSON Example
{
"data_usage_acceptance": "boolean",
"http_proxy": "boolean",
"sessionid": "string"
}boolean
data_usage_acceptance
Optional
Specifies whether the user licenese agreement has been accepted
boolean
http_proxy
Optional
Specifies whether HTTP proxy is setup
string
sessionid
Optional
The token that identifies this session of the user's login. This must be used as a header paramater for all other operations.
PostRulesRequest
JSON Example
{
"rules": [
{
"productType": "string",
"productId": "integer",
"name": "string",
"targetId": "string",
"targetType": "string"
}
]
}array of object
rules
Optional
rules
PostRulesResponse
JSON Example
{
"rules": [
{
"productType": "string",
"productId": "integer",
"name": "string",
"targetId": "string",
"targetType": "string",
"id": "string"
}
]
}
ProductType
This data structure has no properties.
Enumeration: vCenter, NSX-V, NSX-T, NSXALB, VRNI, VCD, DAAS, VCAV, VROPS, VRA, HORIZON, TKGM, VRSLCM,
ProductType_CMR
This data structure has no properties.
Enumeration: vCenter, VCD,
ProductType_DAAS
This data structure has no properties.
ProductType_GetSupported
This data structure has no properties.
Enumeration: vCenter, NSX-V, NSX-T, NSXALB, VRNI, VCD, DAAS, VCAV, VROPS, VRA, HORIZON, TKGM, VRSLCM, VRS-VRA,
ProductType_HORIZON
This data structure has no properties.
ProductType_NSX-T
This data structure has no properties.
ProductType_NSX-V
This data structure has no properties.
ProductType_NSXALB
This data structure has no properties.
ProductType_TKGM
This data structure has no properties.
ProductType_VCAV
This data structure has no properties.
ProductType_VCD
This data structure has no properties.
ProductType_VRNI
This data structure has no properties.
ProductType_VROPS
This data structure has no properties.
ProductType_VRSLCM
This data structure has no properties.
ProductType_VRSVRA
This data structure has no properties.
ProductType_vCenter
This data structure has no properties.
ProductType_vRA
This data structure has no properties.
Product_Basic
JSON Example
{
"host": "string",
"port": "integer",
"user": "string",
"active": "boolean",
"metered": "boolean",
"id": "integer",
"lastChanged": "integer",
"status": {
"code": "string",
"lastChanged": "integer",
"text": "string"
}
}boolean
active
Required
Specifies whether the product is active - newly added products are by default active.
boolean
metered
Required
Specifies whether the product is being metered - metering starts when product certificates are accepted.
integer
id
Required
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.
integer As int64 As int64
lastChanged
Required
lastChanged
Product_ID
This data structure has no properties.
Product_Managed
JSON Example
{
"managerType": "string",
"managedBy": "integer",
"managerEndpoint": "string"
}string
managerType
Optional
Type of the product managing the product
integer
managedBy
Optional
ID of the product managing the product
string
managerEndpoint
Optional
Endpoint of the product managing the product. Is of the format <IP/FQDN>:
Product_Status
JSON Example
{
"code": "string",
"lastChanged": "integer",
"text": "string"
}string
code
Required
code
integer As int64 As int64
lastChanged
Required
lastChanged
string
text
Required
Product status information
PutAcceptCertificateRequest
JSON Example
{
"certificateId": "string",
"accepted": "boolean",
"productType": "string",
"productId": "integer"
}string
certificateId
Required
Obtained from /user_action API response
boolean
accepted
Required
accepted
integer
productId
Required
Obtained from Add /product API response
PutProductRequest_Basic
JSON Example
{
"id": "integer",
"host": "string",
"port": "integer",
"user": "string",
"password": "string"
}
PutProductRequest_DAAS
AllOf
JSON Example
{
"id": "integer",
"host": "string",
"port": "integer",
"user": "string",
"password": "string",
"productType": "string",
"domain": "string"
}
PutProductRequest_HORIZON
AllOf
JSON Example
{
"id": "integer",
"host": "string",
"port": "integer",
"user": "string",
"password": "string",
"productType": "string",
"domain": "string"
}
PutProductRequest_NSX-T
AllOf
JSON Example
{
"id": "integer",
"host": "string",
"port": "integer",
"user": "string",
"password": "string",
"productType": "string"
}
PutProductRequest_NSX-V
AllOf
JSON Example
{
"id": "integer",
"host": "string",
"port": "integer",
"user": "string",
"password": "string",
"productType": "string",
"vcId": "integer"
}
PutProductRequest_NSXALB
AllOf
JSON Example
{
"id": "integer",
"host": "string",
"port": "integer",
"user": "string",
"password": "string",
"productType": "string"
}
PutProductRequest_TKGM
AllOf
JSON Example
{
"id": "integer",
"host": "string",
"port": "integer",
"user": "string",
"password": "string",
"productType": "string",
"tkgmToken": "string",
"tkgmEdition": "string",
"tkgmMetric": "string"
}
PutProductRequest_VCAV
AllOf
JSON Example
{
"id": "integer",
"host": "string",
"port": "integer",
"user": "string",
"password": "string",
"productType": "string"
}
PutProductRequest_VCD
AllOf
JSON Example
{
"id": "integer",
"host": "string",
"port": "integer",
"user": "string",
"password": "string",
"productType": "string"
}
PutProductRequest_VRNI
AllOf
JSON Example
{
"id": "integer",
"host": "string",
"port": "integer",
"user": "string",
"password": "string",
"productType": "string",
"authorizationType": "string",
"domainLDAP": "string",
"vidmToken": "string",
"licenseEdition": "string",
"licenseKey": "string",
"version": "string"
}
PutProductRequest_VROPS
AllOf
JSON Example
{
"id": "integer",
"host": "string",
"port": "integer",
"user": "string",
"password": "string",
"productType": "string"
}
PutProductRequest_VRSLCM
AllOf
JSON Example
{
"id": "integer",
"host": "string",
"port": "integer",
"user": "string",
"password": "string",
"productType": "string"
}
PutProductRequest_VRSVRA
AllOf
JSON Example
{
"id": "integer",
"host": "string",
"port": "integer",
"user": "string",
"password": "string",
"productType": "string"
}
PutProductRequest_vCenter
AllOf
JSON Example
{
"id": "integer",
"host": "string",
"port": "integer",
"user": "string",
"password": "string",
"productType": "string",
"externalSSO": "boolean",
"extSSOhost": "string",
"extSSOport": "integer",
"srmMetered": "boolean",
"k8sMetric": "string"
}
PutProductRequest_vRA
AllOf
This class requires all of the following:
JSON Example
{
"host": "string",
"port": "integer",
"user": "string",
"password": "string",
"productType": "string",
"iaasHost": "string",
"iaasPort": "integer",
"iaasUser": "string",
"iaasPassword": "string",
"iaasDomain": "string"
}
ReportType_CMR
This data structure has no properties.
Enumeration: mappedVMs, unmappedVMs, unmappedRules, overlappedRules,
Rule_Audit_MappedVMs
This data structure has no properties.
Rule_Audit_MissingTargets
This data structure has no properties.
Rule_Audit_NotMappedVMs
This data structure has no properties.
Rule_Audit_Overlaps
This data structure has no properties.
Rule_Data
This data structure has no properties.
Rules_Array_Data
This data structure has no properties.
SearchInventoryRequest
JSON Example
{
"productId": "integer",
"productType": "string",
"criteria": {
"targetType": "string",
"ruleName": "string"
}
}object
criteria
Optional
criteria
SearchInventoryResponse
This class is array of
JSON Example
[
{
"productType": "string",
"productId": "integer",
"ruleName": "string",
"targetName": "string",
"targetId": "string",
"targetType": "string",
"deleted": "boolean"
}
]
Search_Inventory
This data structure has no properties.
Search_Inventory_Data
This data structure has no properties.
SecuritySettings
This data structure has no properties.
SecuritySettings
This data structure has no properties.
SmtpSettings
SMTP configuration settings representation.
JSON Example
{
"smtpHost": "string",
"smtpPort": "integer",
"smtpUser": "string",
"smtpPassword": "string",
"smtpUseSsl": "boolean"
}string
smtpHost
Required
SMTP server host.
integer
smtpPort
Required
SMTP server port.
string
smtpUser
Optional
The SMTP user, used for authentication against the configured SMTP server.
string As password As password
smtpPassword
Optional
SMTP password used with conjunction with smtpUser to form authentication credentials. Note: This property will be always null when read.
boolean
smtpUseSsl
Optional
Force using SMTP over SSL/TLS for communication with configured SMTP server.
TKGM
This data structure has no properties.
TKGM
This data structure has no properties.
TanzuEdition
Specifies the Tanzu edition
This data structure has no properties.
Enumeration: Basic, Standard, Advanced,
TargetType_CMR
This data structure has no properties.
Enumeration: vCenter, VCD, Datacenter, ClusterComputeResource, ResourcePool, HostSystem, Folder, vcd_organization,
TkgmEdition
Specifies the TKGm edition
This data structure has no properties.
Enumeration: Basic, Standard, Advanced,
TkgmMetric
Specifies the TKGm metric - vRAM or cpu-cores
This data structure has no properties.
Enumeration: vRAM, cpu-cores,
TkgmToken
Bearer token used to authenticate to TKGm Management endpoint
This data structure has no properties.
TkgmVcId
ID of the referenced vCenter
This data structure has no properties.
UUID
This data structure has no properties.
UsageDataStorageResponse
JSON Example
{
"availableStorageMB": "integer"
}integer As int32 As int32
availableStorageMB
Optional
availableStorageMB
User
This data structure has no properties.
UserActionResponse
This class is array of
JSON Example
[
{
"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"
}
}
]
VCAV
This data structure has no properties.
VCAV
This data structure has no properties.
VCD
This data structure has no properties.
VCD
This data structure has no properties.
VCFEdition
Specifies the VMware Cloud Foundation edition
This data structure has no properties.
Enumeration: None, Standard, Advanced, Enterprise, Standard w/o vSAN, Advanced w/o vSAN, Enterprise w/o vSAN, SDDC,
VC_VCF
JSON Example
{
"productType": "string",
"vcfManaged": "boolean",
"vcfEdition": "string"
}boolean
vcfManaged
Optional
Specifies whether this vCenter is managed by VMware Cloud Foundation
VRNI
This data structure has no properties.
VRNI
This data structure has no properties.
VRNIAuthorizationType
VRNI Authorization Type
This data structure has no properties.
Enumeration: LOCAL, LDAP, vIDM,
VRNIFields
JSON Example
{
"host": "string",
"port": "integer",
"authorizationType": "string",
"user": "string",
"password": "string",
"domainLDAP": "string",
"vidmToken": "string",
"licenseEdition": "string",
"licenseKey": "string",
"version": "string"
}string
user
Optional
Required for authorizationType 'LOCAL' and 'LDAP'
string As password As password
password
Optional
Required for authorizationType 'LOCAL' and 'LDAP'
string
domainLDAP
Optional
Required for authorizationType 'LDAP'
string
vidmToken
Optional
Required for authorizationType 'vIDM'
string
licenseEdition
Optional
Required for authorizationType 'vIDM'
string
licenseKey
Optional
Required for authorizationType 'vIDM'
string
version
Optional
Required for authorizationType 'vIDM'
VROPS
This data structure has no properties.
VROPS
This data structure has no properties.
VROPSvcHosts
Array of vCenter hosts this VROPS is mapped to
This class is array of
JSON Example
[
{}
]
VRSLCM
This data structure has no properties.
VRSLCM
This data structure has no properties.
VRSLCM_Environment
This class is array of
JSON Example
[
{
"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"
}
]
}
]
VRSVRA
AllOf
JSON Example
{
"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"
}
ValidationErrors
JSON Example
{
"messages": [
{
"errCode": "string",
"errMessage": "string"
}
]
}
acceptType
The client Accept type - json data or tsv file
This data structure has no properties.
active
Include only the active products - newly added products are by default active.
This data structure has no properties.
cafeHost
host name or IP address of the vRealize Automation appliance instance
This data structure has no properties.
cafePassword
the user's password
This data structure has no properties.
cafePort
port of the vRealize Automation appliance instance
This data structure has no properties.
cafeUser
user of a vRealize Automation appliance instance. User must belong to sphere.domain
This data structure has no properties.
extSSOhost
External Platform Services Controller (PSC) host. Required, if externalSSO is true.
This data structure has no properties.
extSSOport
External Platform Services Controller (PSC) port. Required, if externalSSO is true.
This data structure has no properties.
externalSSO
Specifies whether this vCenter uses external Platform Services Controller (PSC) host
This data structure has no properties.
force
Force product creation by skipping conflict validations.
This data structure has no properties.
iaasDomain
IaaS Domain of the vRealize Automation appliance instance
This data structure has no properties.
iaasHost
IaaS Web Server of the vRealize Automation appliance instance
This data structure has no properties.
iaasPassword
user's password to the IaaS Web Server
This data structure has no properties.
iaasPort
IaaS Web Server port
This data structure has no properties.
iaasUser
user of the IaaS Web Server
This data structure has no properties.
id
Product ID, obtained from Add /product API response
This data structure has no properties.
id_deleteProduct
ID of the product to delete, obtained from Add /product API response
This data structure has no properties.
k8sMetric
Indicates whether K8S metering is vRAM or cpu-cores
This data structure has no properties.
Enumeration: vRAM, cpu-cores,
meter
Include only the products being metered - metering starts when product certificates are accepted.
This data structure has no properties.
ruleId
The id(UUID) of a customer rule
This data structure has no properties.
ruleName
The name of a customer rule
This data structure has no properties.
ruleName_required
The name of a customer rule
This data structure has no properties.
ruleProductId
The audit product id of customer rules.
This data structure has no properties.
ruleProductType
The audit product type of customer rules.
This data structure has no properties.
ruleReportLimit
The audit report result limit.
This data structure has no properties.
ruleReportType
The audit report type of customer rules.
This data structure has no properties.
sessionid
The authentication token obtained from login API response
This data structure has no properties.
srmMetered
Indicates whether SRM metering is turned on or off in the web UI
This data structure has no properties.
vCenter
This data structure has no properties.
vCenter
This data structure has no properties.
vRA
This data structure has no properties.
vRA
This data structure has no properties.
vsanClusterCount
Indicates number of clusters where vSAN is enabled
This data structure has no properties.
vsanEnabled
Indicates whether vSAN is enabled or not
This data structure has no properties.
vsanVersions
Indicates vSAN versions
This data structure has no properties.
Node: apidepo-liferay-dxp-v1-be-w-1:8080: