DataCollector

DataCollector
DataCollector

State object representing a data collector.
The data collector is an OVA tool that contains the credentials and protocols needed to create a connection between a data collector appliance on a host vCenter and a vCenter-based cloud account.

Filtering is currently possible for some of the data collector fields via $filter.
Supported fields:
services
proxyId
creationTimeMicros
customProperties

Supported operators: eq, ne, lt, gt, and, or.

By default, the obtained list contains the enabled data collectors. A query parameter "disabled=true" can be added to obtain disabled data collectors.

Special case: If the user specifies $filter=((services.item ne 'cloud_assembly_extensibility') and (services.item ne 'cloud_assembly')), which is equivalent to disabled=true, and does not specify the "disabled" parameter, the resulting query will be equivalent to ((disabled=true) and (disabled=false)). This call will return an empty list.

JSON Example
{
    "dcId": "d5316b00-f3b8-4895-9e9a-c4b98649c2ca",
    "ipAddress": "10.0.0.1",
    "name": "Datacollector1",
    "hostName": "dc1-lnd.mycompany.com",
    "status": "ACTIVE, INACTIVE"
}
string
dcId
Required

Data collector identifier

string
ipAddress
Required

Ip Address of the data collector VM

string
name
Required

Data collector name

string
hostName
Required

Data collector host name

string
status
Required

Current status of the data collector

Property Of
Returned By