Vcenter EnvironmentBrowser ConfigOptions get
Query for the vim.vm.ConfigOption from the hosts in the specified clusters. The filter spec may be optionally used to narrow the result to a specific config option by the key returned from GET /vcenter/environment-browser/config-option-descriptors as well as one or more guest OS identifier(s). If the config option key is not specified, then the default config option for the specified cluster(s) is returned.
This operation requires additional api_release request parameter which must be used to guarantee compatibility with future releases of the API. Consult the vSphere Automation SDKs Programming Guide for more information.
This operation was added in vSphere API 8.0.2.00300.
Returns an authorization error if you do not have all of the privileges described as follows:
- The resource
ClusterComputeResourcereferenced by the property Vcenter EnvironmentBrowser ConfigOptions GetParams.clusters requiresSystem.View.
The query specification used to provide key, guest OS identifier(s), clusters.
The clusters whose config option are requested.
This property was added in vSphere API 8.0.2.00300.
if missing or null or empty an InvalidArgument error is returned. missing or null is allowed for future extensibility e.g. generating options for hosts, VM etc.
When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: ClusterComputeResource. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: ClusterComputeResource.
Filter the set of Guest OSs for which descriptors will be returned.
This property was added in vSphere API 8.0.2.00300.
if missing or null all guest OS descriptors are returned.
Success!
"Vcenter EnvironmentBrowser ConfigOptions Info Object"A vim.vm.ConfigOption data structure.
This property was added in vSphere API 8.0.2.00300.
may be missing or null if none of the clusters specified in the #get operation contained a vim.vm.ConfigOption that matched the requested key and/or guest IDs.
if invalid input is passed like invalid key, OS or cluster.
"Vapi Std Errors InvalidArgument Object"if the user cannot be authenticated.
"Vapi Std Errors Unauthenticated Object"Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.
For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"
This property was added in vSphere API 7.0.0.0.
This property is optional because it was added in a newer version than its parent node.
if the user doesn't have the required privileges for all the specified clusters.
"Vapi Std Errors Unauthorized Object"if at least one of the specified clusters cannot be located.
"Vapi Std Errors NotFound Object"if the system reports an error while responding to the request.
"Vapi Std Errors Error Object"Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
curl -H 'Authorization: <value>' https://{api_host}/api/vcenter/environment-browser/config-options?params=v