Esx Settings Depots Offline create$Task
Imports a new offline software depot. This will also import the metadata and payloads from this offline depot. The returned task will fail and no offline depot would be created if there are any issues during import. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.
Warning: Using HTTP is not secure. Please use HTTPS URLs instead.
This operation was added in vSphere API 7.0.0.0.
Returns an authorization error if you do not have all of the privileges described as follows:
- Operation execution requires
VcIntegrity.lifecycleSettings.Write.
Specification to import an offline depot.
Show optional properties
{
"source_type": "string"
}{
"authentication_spec": {
"method": "string",
"authentication_key": "string",
"authentication_value": "string"
},
"description": "string",
"source_type": "string",
"location": "string",
"file_id": "string",
"ownerdata": "string"
}Describe the authentication to be used for connecting to the remote depot.
This property was added in vSphere API 9.0.0.0.
If missing or null, no authentication will be done.
Description of the depot.
This property was added in vSphere API 7.0.0.0.
If missing or null, the description will be empty.
Type of the source from which offline bundle is obtained.
For more information see: Esx Settings Depots Offline SourceType.
This property was added in vSphere API 7.0.0.0.
Location of the depot from which content should be retrieved.
This property was added in vSphere API 7.0.0.0.
This property is optional and it is only relevant when the value of source_type is Esx Settings Depots Offline SourceType.PULL.
File identifier returned by the file upload endpoint after file is uploaded.
This property was added in vSphere API 7.0.0.0.
This property is optional and it is only relevant when the value of source_type is Esx Settings Depots Offline SourceType.PUSH.
Private data saved by the Esx Settings Depots Offline Info.owner of the depot. It is opaque to vLCM.
This property was added in vSphere API 7.0.3.0.
If missing or null, no ownerdata will be saved.
Identifier of the imported depot as part of result structure.
Vapi Std Errors InvalidArgument If an invalid Esx Settings Depots Offline CreateSpec.location is provided.
Vapi Std Errors AlreadyExists If the depot content already exists. The value of the data property of Vapi Std Errors Error will be a schema that contains existing depot identifier as part of depot property defined in Esx Settings Depots Offline CreateResult.
"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 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 there is some 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 '{"source_type:"string"}' https://{api_host}/api/esx/settings/depots/offline?vmw-task=true