Update Adapter Instance

The request body can accept a collectorId or a collectorGroupId, but not both.

Request

URI

PUT

https://{api_host}/suite-api/api/adapters

COPY

Request Body

The adapter instance request for the update

adapter-instance of type(s) application/json

Required

Show optional properties

{
    "resourceKey": {
        "name": "string",
        "adapterKindKey": "string",
        "resourceKindKey": "string"
    },
    "adapter-certificates": [
        {}
    ]
}

"{\n  \"resourceKey\" : {\n    \"name\" : \"Adapter for VC@https://ip/sdk\",\n    \"adapterKindKey\" : \"VMWARE\",\n    \"resourceKindKey\" : \"VMwareAdapter Instance\",\n    \"resourceIdentifiers\" : [ {\n      \"identifierType\" : {\n        \"name\" : \"AUTODISCOVERY\",\n        \"dataType\" : \"STRING\",\n        \"isPartOfUniqueness\" : true\n      },\n      \"value\" : \"true\"\n    }, {\n      \"identifierType\" : {\n        \"name\" : \"PROCESSCHANGEEVENTS\",\n        \"dataType\" : \"STRING\",\n        \"isPartOfUniqueness\" : true\n      },\n      \"value\" : \"true\"\n    }, {\n      \"identifierType\" : {\n        \"name\" : \"VCURL\",\n        \"dataType\" : \"STRING\",\n        \"isPartOfUniqueness\" : true\n      },\n      \"value\" : \"https://ip/sdk\"\n    } ]\n  },\n  \"description\" : \"This is an updated description for the adapter instance...\",\n  \"physicalDatacenterId\" : \"42a99ced-c0f9-4981-af37-2edaed1aa34d\",\n  \"id\" : \"bdf24d28-59d3-4989-befb-9bfa5f781b2c\"\n}"

object

resourceKey

Required

Represents a composite key for uniquely identifying a Resource.

string

description

Optional

Optional description of the Adapter instance

integer As int32 As int32

collectorId

Optional

The ID of the Collector that manages this adapter instance. This is optional and if not specified, system will choose an appropriate collector.

string As uuid As uuid

collectorGroupId

Optional

The ID of the collector group. If not specified, the system will choose an appropriate Collector group for you

string As uuid As uuid

credentialInstanceId

Optional

The Credential Instance identifier used by this adapter instance

integer As int32 As int32

monitoringInterval

Optional

Constraints: minimum: 0

Minutes part of the monitoring Interval of the Adapter Instance.

integer As int32 As int32

monitoringIntervalSeconds

Optional

Constraints: minimum: 0

Seconds part of the monitoring Interval of the Adapter Instance

integer As int32 As int32

numberOfMetricsCollected

Optional

The number of metrics reported by this adapter instance.

integer As int32 As int32

numberOfResourcesCollected

Optional

The number of resources being monitored by this resource.

integer As int64 As int64

lastHeartbeat

Optional

Last time when this adapter instance communicated with VMware Cloud Foundation Operations Server.

integer As int64 As int64

lastCollected

Optional

Last time adapter instance reported collection of resources/stats.

string

messageFromAdapterInstance

Optional

Any message from the adapter instance.

array of object

adapter-certificates

Required

The set of untrusted certificates returned by the adapter source

array of object

links

Optional

Represents a HTTP 'link' element.
It is implicit that all the link tags support http 'GET' method.

string As uuid As uuid

physicalDatacenterId

Optional

The Physical Datacenter ID to be used for this Adapter Instance.It is Optional

string As uuid As uuid

Optional

The UUID of the adapter instance

Authentication

This operation uses the following authentication methods.

Token-based-authorization

Responses

200

The adapter instance that was updated

Returns adapter-instance of type(s) application/json

"{\n  \"resourceKey\" : {\n    \"name\" : \"VC Adapter for 10.20.88.111\",\n    \"adapterKindKey\" : \"VMWARE\",\n    \"resourceKindKey\" : \"Adapter\",\n    \"resourceIdentifiers\" : [ ]\n  },\n  \"description\" : \"A vCenter Adapter Instance\",\n  \"collectorId\" : 1,\n  \"credentialInstanceId\" : \"e47045a5-cda2-411d-8a56-77fce8bee51b\",\n  \"id\" : \"0ffcfcaa-a4ac-424e-ac27-40ba8b057581\"\n}"

object

resourceKey

Required

Represents a composite key for uniquely identifying a Resource.

string

description

Optional

Optional description of the Adapter instance

integer As int32 As int32

collectorId

Optional

The ID of the Collector that manages this adapter instance. This is optional and if not specified, system will choose an appropriate collector.

string As uuid As uuid

collectorGroupId

Optional

The ID of the collector group. If not specified, the system will choose an appropriate Collector group for you

string As uuid As uuid

credentialInstanceId

Optional

The Credential Instance identifier used by this adapter instance

integer As int32 As int32

monitoringInterval

Optional

Constraints: minimum: 0

Minutes part of the monitoring Interval of the Adapter Instance.

integer As int32 As int32

monitoringIntervalSeconds

Optional

Constraints: minimum: 0

Seconds part of the monitoring Interval of the Adapter Instance

integer As int32 As int32

numberOfMetricsCollected

Optional

The number of metrics reported by this adapter instance.

integer As int32 As int32

numberOfResourcesCollected

Optional

The number of resources being monitored by this resource.

integer As int64 As int64

lastHeartbeat

Optional

Last time when this adapter instance communicated with VMware Cloud Foundation Operations Server.

integer As int64 As int64

lastCollected

Optional

Last time adapter instance reported collection of resources/stats.

string

messageFromAdapterInstance

Optional

Any message from the adapter instance.

array of object

adapter-certificates

Required

The set of untrusted certificates returned by the adapter source

array of object

links

Optional

Represents a HTTP 'link' element.
It is implicit that all the link tags support http 'GET' method.

string As uuid As uuid

physicalDatacenterId

Optional

The Physical Datacenter ID to be used for this Adapter Instance.It is Optional

string As uuid As uuid

Optional

The UUID of the adapter instance

400

If update 'adapter instance' failed. Typically the service will return extra information as to why update failed.

Operation doesn't return any data structure

Code Samples

COPY

                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"adapter-certificates":["object"],"resourceKey:"object"}' https://{api_host}/suite-api/api/adapters

On This Page

Description

Request

Request Body

Authentication

Response

200 Response Body

Errors

Adapters Operations

GET

Enumerate Adapter Instances

PUT