Simple Command Get Entity

Simple Command Get Entity

A description of the service.

Request
URI
GET
https://{vcenter-host}/sdk/vim25/{release}/SimpleCommand/{moId}/entity
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the property attaches; the serialized managed object reference for a request has the form moType/moId, in this case SimpleCommand/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns ServiceManagerServiceInfo of type(s) application/json
This response body class contains all of the following: DataObject
{
    "_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 ManagedObjectReference data object type is a special-purpose data object. Commonly referred to as simply a "reference", "MoRef", "MOR", or other variations of this theme, instances of managed object references contain data that identifies specific server-side managed objects. Managed object references are typically one of the return types from a method invocation.

Managed object references are client application references to server-side managed objects. The client application uses ManagedObjectReference objects when it invokes operations on a server. A ManagedObjectReference is guaranteed to be unique and persistent during an object's lifetime. The reference persists after an object has moved within the inventory, across sessions, and across server restarts. If you remove an object, for example, a virtual machine, from the inventory, and then put it back, the reference changes.

string
description
Required

A description of the service.

Provides help text on how to use the service.