ServiceManagerServiceInfo

ServiceManagerServiceInfo
ServiceManagerServiceInfo

This data object represents essential information about a particular service.

The information is sufficient to be able to identify the service and retrieve the object implementing it.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "serviceName": "string",
    "location": [
        "string"
    ],
    "service": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "description": "string"
}
string
serviceName
Required

A service name.

Each service is expected to create a unique name for itself that can be used to locate the service. This name does not need to be unique across hosts or other such locations though.

array of string
location
Optional

A list of data that can be used to uniquely identify a particular instance of a service.

Multiple instances of a service can exist across different domains (for instance, a service that is associated with a particular virtual machine or a particular host). In such cases, the service name is insufficient to identify the service and location data can be used to identify the instance of interest. A service may publish as much location data as is needed to identify it (e.g, vmware.host.<hostname> or vmware.vm.<uuid> or both). The particular choice of locations have to be agreed upon by the client and the service.

service
Required

The managed object that presents this service.

string
description
Required

A description of the service.

Provides help text on how to use the service.

Property Of
Returned By