Test Connection Using POST

Test Connection Using POST

Test Adapter Instance connection

Request
URI
POST
https://{api_host}/api/adapters/testConnection
COPY
Request Body

The adapter instance connection request

create-adapter-instance of type(s) application/json
Required

Show optional properties

{
    "adapterKindKey": "string",
    "name": "string"
}
{
    "adapterKindKey": "string",
    "collectorGroupId": "string",
    "collectorId": "string",
    "credential": {
        "adapterKindKey": "string",
        "credentialKindKey": "string",
        "fields": [
            {
                "name": "string",
                "value": "string"
            }
        ],
        "id": "string",
        "name": "string"
    },
    "description": "string",
    "monitoringInterval": 0,
    "monitoringIntervalSeconds": 0,
    "name": "string",
    "resourceIdentifiers": [
        {
            "name": "string",
            "value": "string"
        }
    ]
}
string
adapterKindKey
Required

The Adapter Kind key

string As uuid As uuid
collectorGroupId
Optional

The Collector Group ID to be used for this Adapter Instance. If not specified, the system will choose an appropriate Collector group for you

string
collectorId
Optional

The Collector instance used by this adapter instance. If not specified, the system will choose an appropriate Collector for you

credential
credential
Optional

The Credential Instance information

string
description
Optional

Optional description of the Adapter instance

integer As int32 As int32
monitoringInterval
Optional

Minutes part of the monitoring Interval of the Adapter Instance, where the monitoring Interval is the frequency of data source query for stats and properties.

integer As int32 As int32
monitoringIntervalSeconds
Optional

Seconds part of the monitoring Interval of the Adapter Instance, where the monitoring Interval is the frequency of data source query for stats and properties.

string
name
Required

The name of the Adapter instance

array of name-value
resourceIdentifiers
Optional

Adapter instance specific resource identifiers

Authentication
This operation uses the following authentication methods.
Responses
201

The adapter instance that was created

Returns adapter-instance of type(s) application/json 
{
    "adapter-certificates": [
        {
            "certificateDetails": "string",
            "expires": "string",
            "issuedBy": "string",
            "issuedTo": "string",
            "thumbprint": "string"
        }
    ],
    "collectorGroupId": "string",
    "collectorId": 0,
    "credentialInstanceId": "string",
    "description": "string",
    "id": "string",
    "lastCollected": "string",
    "lastHeartbeat": "string",
    "links": [
        {
            "description": "string",
            "href": "string",
            "name": "string",
            "rel": "string"
        }
    ],
    "messageFromAdapterInstance": "string",
    "monitoringInterval": 0,
    "monitoringIntervalMinutes": 0,
    "monitoringIntervalSeconds": 0,
    "numberOfMetricsCollected": 0,
    "numberOfResourcesCollected": 0,
    "resourceKey": {
        "adapterKindKey": "string",
        "extension": {
            "anyObjects": [
                {}
            ]
        },
        "links": [
            {
                "description": "string",
                "href": "string",
                "name": "string",
                "rel": "string"
            }
        ],
        "name": "string",
        "resourceIdentifiers": [
            {
                "identifierType": {
                    "dataType": "string",
                    "extension": {
                        "anyObjects": [
                            {}
                        ]
                    },
                    "isPartOfUniqueness": false,
                    "links": [
                        {
                            "description": "string",
                            "href": "string",
                            "name": "string",
                            "rel": "string"
                        }
                    ],
                    "name": "string"
                },
                "key": "string",
                "links": [
                    {
                        "description": "string",
                        "href": "string",
                        "name": "string",
                        "rel": "string"
                    }
                ],
                "name": "string",
                "uniquelyIdentifying": false,
                "value": "string"
            }
        ],
        "resourceKindKey": "string"
    }
}
array of certificate
adapter-certificates
Optional

The set of untrusted certificates returned by the adapter source

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

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
credentialInstanceId
Optional

The Credential Instance identifier used by this adapter instance

string
description
Optional

Optional description of the Adapter instance

string As uuid As uuid
id
Optional

The UUID of the adapter instance

string As date-time As date-time
lastCollected
Optional

Last time adapter instance reported collection of resources/stats.

string As date-time As date-time
lastHeartbeat
Optional

When was the last time this adapter instance communicated with vRealize Operations Manager Server.

array of link
links
Optional

links

string
messageFromAdapterInstance
Optional

Any message from the adapter instance.

integer As int32 As int32
monitoringInterval
Optional

Minutes part of the monitoring Interval of the Adapter Instance.

integer As int32 As int32
monitoringIntervalMinutes
Optional

monitoringIntervalMinutes

integer As int32 As int32
monitoringIntervalSeconds
Optional

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.

resource-key
resourceKey
Optional

Represents a composite key for uniquely identifying a Resource.


400

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

Operation doesn't return any data structure

On This Page
Adapters Operations
POST
Create Adapter Instance Using POST
DELETE
Delete Adapter Instance Using DELETE
GET
Enumerate Adapter Instances Using GET
GET
Get Adapter Instance Using GET
GET
Get Resources Of Adapter Instance Using GET
PUT
Mark Adapter Instance As Being Maintained Using PUT
PATCH
Patch Adapter Instance Using PATCH
PATCH
Patch Test Connection Using PATCH
PUT
Start Monitoring Resources Of Adapter Instance Using PUT
PUT
Stop Monitoring Resources Of Adapter Instance Using PUT
POST
Test Connection Using POST
DELETE
Unmark Adapter Instance As Being Maintained Using DELETE
PUT
Update Adapter Instance Using PUT