Esx Settings Repository Software checkRepository
Check if the provided software specification or name already exists in the repository. If any of the properties provided in spec by the user matches exactly with a software specification in the repository, the software specification is said to already exist. If the software specification exists in the repository, this operation will return a summary of the software specification.
This operation was added in vSphere API 9.0.0.0.
The specification that describes what data needs to be checked in the repository.
{
"display_name": "string",
"software_spec": {
"base_image": {
"version": "string"
},
"add_on": {
"name": "string",
"version": "string"
},
"components": {
"components": "string"
},
"solutions": {
"solutions": {
"version": "string",
"components": [
{
"component": "string"
}
]
}
},
"hardware_support": {
"packages": {
"packages": {
"pkg": "string",
"version": "string"
}
}
},
"removed_components": [
"string"
],
"alternative_images": {
"alternative_images": {
"base_image": {
"version": "string"
},
"add_on": {
"name": "string",
"version": "string"
},
"components": {
"components": "string"
},
"solutions": {
"solutions": {
"version": "string",
"components": [
{
"component": "string"
}
]
}
},
"hardware_support": {
"packages": {
"packages": {
"pkg": "string",
"version": "string"
}
}
},
"removed_components": [
"string"
],
"display_name": "string",
"selection_criteria": {
"selection_type": "string",
"host_uuids": [
"string"
],
"host_hardware_spec": {
"vendor": "string",
"models": [
"string"
],
"families": [
"string"
],
"oem_strings": [
"string"
]
}
}
}
}
}
}The displayName to check in the repository.
This property was added in vSphere API 9.0.0.0.
If missing or null, display names are not checked.
The software spec to check in the repository.
This property was added in vSphere API 9.0.0.0.
If missing or null, software specs are not checked.
Complete summary of all the matching software specifications in the repository along with the type of match.
"Esx Settings Repository Software CheckResult Object"The type of match and the summary of one or more software specification in the repository if the check found a match. If the list is empty, a match was not found for the inputs specified by the user.
This property was added in vSphere API 9.0.0.0.
If spec is empty.
"Vapi Std Errors InvalidArgument Object"If the caller is not 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 caller does not have the necessary privileges.
"Vapi Std Errors Unauthorized Object"If there is unknown internal error. The accompanying error message will give more details about the failure.
"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.
If the service is not available.
"Vapi Std Errors ServiceUnavailable Object" curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/esx/settings/repository/software?action=check-repository