Property Collector Retrieve Properties Ex

Retrieves the specified properties of the specified managed objects.

This method is similar to creating the filters, receiving the property values, and destroying the filters. The main difference is that the output blends the results from all the filters and reports a given managed object at most once no matter how many filters apply.

The method isn't requiring any privilege, because it's used to access properties that are publicly available, without authenticated session. That isn't sequrity isse, because the property collector is doing another explicit access evaluation and it's returning data only from objects to which the user has access.

The filter creation step can throw all of the same faults as CreateFilter.

Required privileges: System.Anonymous

Request

URI

POST

https://{api_host}/sdk/vim25/{release}/PropertyCollector/{moId}/RetrievePropertiesEx

COPY

Path Parameters

string

moId

Required

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

string

release

Required

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

Request Body

RetrievePropertiesExRequestType of type(s) application/json

Required

"RetrievePropertiesExRequestType Object"

array of object

specSet

Required

Specifies the properties to retrieve.

options

Required

Additional method options. If omitted, equivalent to an options argument with no fields set.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

retrieved objects or null if there are no matching objects.

This response body class contains all of the following: RetrieveResult

{
    "0": "R",
    "1": "e",
    "2": "t",
    "3": "r",
    "4": "i",
    "5": "e",
    "6": "v",
    "7": "e",
    "8": "R",
    "9": "e",
    "10": "s",
    "11": "u",
    "12": "l",
    "13": "t",
    "14": " ",
    "15": "O",
    "16": "b",
    "17": "j",
    "18": "e",
    "19": "c",
    "20": "t"
}

500

InvalidArgument: if any of the following is true: See CreateFilter

InvalidProperty: See CreateFilter

InvalidType: See CreateFilter

ManagedObjectNotFound: See CreateFilter

Returns InvalidProperty of type(s) application/json

This response body class contains all of the following: InlineInvalidProperty0

"InvalidProperty Object"

string

name

Required

The property name that generated the error.

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/PropertyCollector/{moId}/RetrievePropertiesEx

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Virtual Infrastructure Operations

POST

Property Collector Cancel Retrieve Properties Ex