| Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |
A lease is in one of four states:
Properties
Name | Type | Description |
---|---|---|
capabilities | HttpNfcLeaseCapabilities |
Current supported capabilities by this lease
See Capabilities
Since vSphere API 6.7 |
error* | LocalizedMethodFault |
If the lease is in the error state, this property contains the
error that caused the lease to be aborted.
|
info* | HttpNfcLeaseInfo |
Provides information on the objects contained in this lease. The
info property is only valid when the lease is in the ready state.
|
initializeProgress | xsd:int |
Provides progress information (0-100 percent) for the initializing state
of the lease. Clients can use this to track overall progress.
|
mode | xsd:string |
Current mode of the lease.
See Mode for possible values.
Since vSphere API 6.7 |
state | HttpNfcLeaseState |
The current state of the lease.
|
transferProgress | xsd:int |
Provides progress information (0-100 percent) for current transfer.
Transfer covers download, upload and pull scenario.
Can be externally updated by progress method.
Since vSphere API 6.7 |
Methods
Methods defined in this Managed Object |
---|
HttpNfcLeaseAbort, HttpNfcLeaseComplete, HttpNfcLeaseGetManifest, HttpNfcLeaseProbeUrls, HttpNfcLeaseProgress, HttpNfcLeasePullFromUrls_Task, HttpNfcLeaseSetManifestChecksumType |
Clients should call this method if an error occurs while accessing the disks, or if the operation is cancelled. The client can report the cause of the abort to other clients listening on the task with the fault parameter.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HttpNfcLease used to make the method call. |
fault* P | MethodFault |
[in] The fault that caused the abort, if any.
Since vSphere API 4.0 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
InvalidState | Thrown if the lease has already been aborted. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Timedout | Thrown if the lease has timed out before this call. |
Events
Type | |
---|---|
None |
Clients should call this method when they are done accessing the disks for the VirtualMachines in this lease. The status of the corresponding task will be set to success.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HttpNfcLease used to make the method call. |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
InvalidState | Thrown if the lease has already been completed or aborted. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Timedout | Thrown if the lease has timed out before this call. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HttpNfcLease used to make the method call. |
Return Value
Type | Description |
---|---|
HttpNfcLeaseManifestEntry[] |
Faults
Type | Description |
---|---|
InvalidState | |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Timedout |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HttpNfcLease used to make the method call. |
files* P | HttpNfcLeaseSourceFile[] |
[in] List of remote source file descriptors
There should be the same number of SourceFile
as DeviceUrl provided by this lease.
Since vSphere API 7.0.2.0 |
timeout* P | xsd:int |
[in] time in seconds for each url validation.
Maximum timeout is 60.
Since vSphere API 7.0.2.0 |
Return Value
Type | Description |
---|---|
HttpNfcLeaseProbeResult[] |
Faults
Type | Description |
---|---|
InvalidState | Thrown if the lease has already been aborted. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HttpNfcLease used to make the method call. |
percent P | xsd:int |
[in] Completion status represented as an integer
in the 0-100 range.
Since vSphere API 4.0 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Timedout | Thrown if the lease has timed out or vSphere has not detected data transfer progress. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HttpNfcLease used to make the method call. |
files* P | HttpNfcLeaseSourceFile[] |
[in] List of remote source file descriptors
There should be the same number of SourceFile
as DeviceUrl provided by this lease.
Privilege VApp.PullFromUrls is required.
Since vSphere API 6.7 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task |
Faults
Type | Description |
---|---|
HttpFault | |
InvalidState | Thrown if the lease has already been aborted. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
SSLVerifyFault |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HttpNfcLease used to make the method call. |
deviceUrlsToChecksumTypes* P | KeyValue[] |
[in] Should contain key value pairs:
where key is DeviceUrl#key returned in this lease info and value
is desired algorithm from ChecksumType.
Since vSphere API 6.7 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
InvalidState | |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Top of page | Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |