Property Collector Retrieve Properties

Deprecated as of vSphere API 4.1, use RetrievePropertiesEx.

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://{vcenter-host}/sdk/vim25/{release}/PropertyCollector/{moId}/RetrieveProperties

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 8.0.3.0 APIs.

Request Body

RetrievePropertiesRequestType of type(s) application/json

Required

Show optional properties

{
    "specSet": [
        {
            "propSet": [
                {
                    "type": "string"
                }
            ],
            "objectSet": [
                {
                    "obj": {
                        "type": "string",
                        "value": "string"
                    }
                }
            ]
        }
    ]
}

{
    "specSet": [
        {
            "_typeName": "string",
            "propSet": [
                {
                    "_typeName": "string",
                    "type": "string",
                    "all": false,
                    "pathSet": [
                        "string"
                    ]
                }
            ],
            "objectSet": [
                {
                    "_typeName": "string",
                    "obj": {
                        "_typeName": "string",
                        "type": "string",
                        "value": "string"
                    },
                    "skip": false,
                    "selectSet": [
                        {
                            "_typeName": "string",
                            "name": "string"
                        }
                    ]
                }
            ],
            "reportMissingObjectsInResults": false
        }
    ]
}

array of PropertyFilterSpec

specSet

Required

Specifies the properties to retrieve.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

The data contents of the specified objects.

Returns Array of ObjectContent of type(s) application/json

[
    {
        "_typeName": "string",
        "obj": {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        },
        "propSet": [
            {
                "_typeName": "string",
                "name": "string",
                "val": {
                    "_typeName": "string"
                }
            }
        ],
        "missingSet": [
            {
                "_typeName": "string",
                "path": "string",
                "fault": {
                    "_typeName": "string",
                    "faultCause": "MethodFault Object",
                    "faultMessage": [
                        {
                            "_typeName": "string",
                            "key": "string",
                            "arg": [
                                {
                                    "_typeName": "string",
                                    "key": "string",
                                    "value": {
                                        "_typeName": "string"
                                    }
                                }
                            ],
                            "message": "string"
                        }
                    ]
                }
            }
        ]
    }
]

500

InvalidArgument: 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: MethodFault

{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ],
    "name": "string"
}

string

name

Required

The property name that generated the error.

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body