Overview
This article documents the fields included in management service objects returned by API responses.
It covers both stored management services available for deployment and deployed management service instances, providing detailed field descriptions and a JSON example for JetPatch management services.
When an API response includes one or more objects of stored management services (available for deployment to endpoints) or of deployed management service instances, each such object includes some or all of the following fields, in JSON format:
| Field | Type | Description |
| url | URL | Only for deployed management service instances: The resource URL for the management service. The provided URL is referred to in this guide as <service-url> |
| links | object list | List of link objects, each of which includes an href field containing a URL and a rel field containing a descriptive name for that URL.The resource URL for this management service instance's management server registration appears here as a link href with a rel value of registration. This resource URL is referred to in this guide as <registration-url>. |
| serverUrl | URL | Only for deployed management service instances: The resource URL for the endpoint on which this management service is deployed. |
| state | string | Only for deployed management service instances: Indicates the status of this management service's managed agent. One of: |
| name | string | Agent name |
| version | string | Agent version |
| configpackage | string | Management service name |
| configpackageversion | string | Management service version |
| packageUniqueName | string | Unique identifying name for the management service |
For example:
Content-Type: vnd.intigua.vmanager.VAgentInstance+json { "url":"/vmanage-server/rest/rest-api/servers/330/deployments/3931" "links":[ { "href":"/vmanage-server/rest/rest-api/vagents/hyperic_4.6.6/config-packages/hyp/revisions/0.1", "rel":"configpackage" }, { "href":"/vmanage-server/rest/rest-api/servers/330/deployments/3939/registration", "rel":"registration" }, { "href":"/vmanage-server/rest/rest-api/servers/330", "rel":"server" } ], "name":"lce", "version":"3.6.2.1", "configpackage":"default", "configpackageversion":"0.1", "packageUniqueName":"hyperic_Linux_x64_4.6.6_2.6.1.16.vai" "serverUrl":"/vmanage-server/rest/rest-api/servers/330", "state":"STOPPED", } |
When a single management service instance object is returned (not a list), the response also includes an ETag that can be used to condition certain management service actions.
Comments
0 comments
Please sign in to leave a comment.