@openshift-migration-advisor/agent-sdk 0.7.0 → 0.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +2 -2
- package/README.md +9 -8
- package/dist/apis/DefaultApi.d.ts +35 -5
- package/dist/apis/DefaultApi.js +41 -6
- package/dist/esm/apis/DefaultApi.d.ts +35 -5
- package/dist/esm/apis/DefaultApi.js +42 -7
- package/dist/esm/models/AgentStatus.d.ts +2 -2
- package/dist/esm/models/AgentStatus.js +2 -2
- package/dist/esm/models/CollectorStatus.d.ts +6 -7
- package/dist/esm/models/CollectorStatus.js +6 -7
- package/dist/esm/models/InspectorStatus.d.ts +7 -7
- package/dist/esm/models/InspectorStatus.js +7 -7
- package/dist/esm/models/VMIssue.d.ts +6 -6
- package/dist/esm/models/VMIssue.js +6 -6
- package/dist/esm/models/VddkProperties.d.ts +44 -0
- package/dist/esm/models/{VddkPost200Response.js → VddkProperties.js} +13 -11
- package/dist/esm/models/index.d.ts +1 -1
- package/dist/esm/models/index.js +1 -1
- package/dist/models/AgentStatus.d.ts +2 -2
- package/dist/models/AgentStatus.js +2 -2
- package/dist/models/CollectorStatus.d.ts +6 -7
- package/dist/models/CollectorStatus.js +6 -7
- package/dist/models/InspectorStatus.d.ts +7 -7
- package/dist/models/InspectorStatus.js +7 -7
- package/dist/models/VMIssue.d.ts +6 -6
- package/dist/models/VMIssue.js +6 -6
- package/dist/models/VddkProperties.d.ts +44 -0
- package/dist/models/VddkProperties.js +56 -0
- package/dist/models/index.d.ts +1 -1
- package/dist/models/index.js +1 -1
- package/docs/DefaultApi.md +68 -7
- package/docs/{VddkPost200Response.md → VddkProperties.md} +6 -4
- package/package.json +1 -1
- package/src/apis/DefaultApi.ts +71 -13
- package/src/models/AgentStatus.ts +2 -2
- package/src/models/CollectorStatus.ts +6 -7
- package/src/models/InspectorStatus.ts +7 -7
- package/src/models/VMIssue.ts +6 -6
- package/src/models/VddkProperties.ts +83 -0
- package/src/models/index.ts +1 -1
- package/dist/esm/models/VddkPost200Response.d.ts +0 -38
- package/dist/models/VddkPost200Response.d.ts +0 -38
- package/dist/models/VddkPost200Response.js +0 -54
- package/src/models/VddkPost200Response.ts +0 -75
|
@@ -12,35 +12,37 @@
|
|
|
12
12
|
* Do not edit the class manually.
|
|
13
13
|
*/
|
|
14
14
|
/**
|
|
15
|
-
* Check if a given object implements the
|
|
15
|
+
* Check if a given object implements the VddkProperties interface.
|
|
16
16
|
*/
|
|
17
|
-
export function
|
|
18
|
-
if (!('
|
|
17
|
+
export function instanceOfVddkProperties(value) {
|
|
18
|
+
if (!('version' in value) || value['version'] === undefined)
|
|
19
19
|
return false;
|
|
20
|
-
if (!('
|
|
20
|
+
if (!('md5' in value) || value['md5'] === undefined)
|
|
21
21
|
return false;
|
|
22
22
|
return true;
|
|
23
23
|
}
|
|
24
|
-
export function
|
|
25
|
-
return
|
|
24
|
+
export function VddkPropertiesFromJSON(json) {
|
|
25
|
+
return VddkPropertiesFromJSONTyped(json, false);
|
|
26
26
|
}
|
|
27
|
-
export function
|
|
27
|
+
export function VddkPropertiesFromJSONTyped(json, ignoreDiscriminator) {
|
|
28
28
|
if (json == null) {
|
|
29
29
|
return json;
|
|
30
30
|
}
|
|
31
31
|
return {
|
|
32
|
+
'version': json['version'],
|
|
32
33
|
'md5': json['md5'],
|
|
33
|
-
'bytes': json['bytes'],
|
|
34
|
+
'bytes': json['bytes'] == null ? undefined : json['bytes'],
|
|
34
35
|
};
|
|
35
36
|
}
|
|
36
|
-
export function
|
|
37
|
-
return
|
|
37
|
+
export function VddkPropertiesToJSON(json) {
|
|
38
|
+
return VddkPropertiesToJSONTyped(json, false);
|
|
38
39
|
}
|
|
39
|
-
export function
|
|
40
|
+
export function VddkPropertiesToJSONTyped(value, ignoreDiscriminator = false) {
|
|
40
41
|
if (value == null) {
|
|
41
42
|
return value;
|
|
42
43
|
}
|
|
43
44
|
return {
|
|
45
|
+
'version': value['version'],
|
|
44
46
|
'md5': value['md5'],
|
|
45
47
|
'bytes': value['bytes'],
|
|
46
48
|
};
|
|
@@ -31,7 +31,7 @@ export * from './VMNIC.js';
|
|
|
31
31
|
export * from './VMResourceBreakdown.js';
|
|
32
32
|
export * from './VMs.js';
|
|
33
33
|
export * from './VcenterCredentials.js';
|
|
34
|
-
export * from './
|
|
34
|
+
export * from './VddkProperties.js';
|
|
35
35
|
export * from './VersionInfo.js';
|
|
36
36
|
export * from './VirtualMachine.js';
|
|
37
37
|
export * from './VirtualMachineDetail.js';
|
package/dist/esm/models/index.js
CHANGED
|
@@ -33,7 +33,7 @@ export * from './VMNIC.js';
|
|
|
33
33
|
export * from './VMResourceBreakdown.js';
|
|
34
34
|
export * from './VMs.js';
|
|
35
35
|
export * from './VcenterCredentials.js';
|
|
36
|
-
export * from './
|
|
36
|
+
export * from './VddkProperties.js';
|
|
37
37
|
export * from './VersionInfo.js';
|
|
38
38
|
export * from './VirtualMachine.js';
|
|
39
39
|
export * from './VirtualMachineDetail.js';
|
|
@@ -38,8 +38,8 @@ export interface AgentStatus {
|
|
|
38
38
|
* @export
|
|
39
39
|
*/
|
|
40
40
|
export declare const AgentStatusModeEnum: {
|
|
41
|
-
readonly
|
|
42
|
-
readonly
|
|
41
|
+
readonly AgentStatusModeConnected: "connected";
|
|
42
|
+
readonly AgentStatusModeDisconnected: "disconnected";
|
|
43
43
|
};
|
|
44
44
|
export type AgentStatusModeEnum = typeof AgentStatusModeEnum[keyof typeof AgentStatusModeEnum];
|
|
45
45
|
/**
|
|
@@ -23,8 +23,8 @@ exports.AgentStatusToJSONTyped = AgentStatusToJSONTyped;
|
|
|
23
23
|
* @export
|
|
24
24
|
*/
|
|
25
25
|
exports.AgentStatusModeEnum = {
|
|
26
|
-
|
|
27
|
-
|
|
26
|
+
AgentStatusModeConnected: 'connected',
|
|
27
|
+
AgentStatusModeDisconnected: 'disconnected'
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* @export
|
|
@@ -32,13 +32,12 @@ export interface CollectorStatus {
|
|
|
32
32
|
* @export
|
|
33
33
|
*/
|
|
34
34
|
export declare const CollectorStatusStatusEnum: {
|
|
35
|
-
readonly
|
|
36
|
-
readonly
|
|
37
|
-
readonly
|
|
38
|
-
readonly
|
|
39
|
-
readonly
|
|
40
|
-
readonly
|
|
41
|
-
readonly Error: "error";
|
|
35
|
+
readonly CollectorStatusStatusReady: "ready";
|
|
36
|
+
readonly CollectorStatusStatusConnecting: "connecting";
|
|
37
|
+
readonly CollectorStatusStatusCollecting: "collecting";
|
|
38
|
+
readonly CollectorStatusStatusParsing: "parsing";
|
|
39
|
+
readonly CollectorStatusStatusCollected: "collected";
|
|
40
|
+
readonly CollectorStatusStatusError: "error";
|
|
42
41
|
};
|
|
43
42
|
export type CollectorStatusStatusEnum = typeof CollectorStatusStatusEnum[keyof typeof CollectorStatusStatusEnum];
|
|
44
43
|
/**
|
|
@@ -23,13 +23,12 @@ exports.CollectorStatusToJSONTyped = CollectorStatusToJSONTyped;
|
|
|
23
23
|
* @export
|
|
24
24
|
*/
|
|
25
25
|
exports.CollectorStatusStatusEnum = {
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
Error: 'error'
|
|
26
|
+
CollectorStatusStatusReady: 'ready',
|
|
27
|
+
CollectorStatusStatusConnecting: 'connecting',
|
|
28
|
+
CollectorStatusStatusCollecting: 'collecting',
|
|
29
|
+
CollectorStatusStatusParsing: 'parsing',
|
|
30
|
+
CollectorStatusStatusCollected: 'collected',
|
|
31
|
+
CollectorStatusStatusError: 'error'
|
|
33
32
|
};
|
|
34
33
|
/**
|
|
35
34
|
* Check if a given object implements the CollectorStatus interface.
|
|
@@ -32,13 +32,13 @@ export interface InspectorStatus {
|
|
|
32
32
|
* @export
|
|
33
33
|
*/
|
|
34
34
|
export declare const InspectorStatusStateEnum: {
|
|
35
|
-
readonly
|
|
36
|
-
readonly
|
|
37
|
-
readonly
|
|
38
|
-
readonly
|
|
39
|
-
readonly
|
|
40
|
-
readonly
|
|
41
|
-
readonly
|
|
35
|
+
readonly InspectorStatusStateCanceled: "ready";
|
|
36
|
+
readonly InspectorStatusStateCanceling: "Initiating";
|
|
37
|
+
readonly InspectorStatusStateCompleted: "running";
|
|
38
|
+
readonly InspectorStatusStateError: "canceling";
|
|
39
|
+
readonly InspectorStatusStateInitiating: "canceled";
|
|
40
|
+
readonly InspectorStatusStateReady: "completed";
|
|
41
|
+
readonly InspectorStatusStateRunning: "error";
|
|
42
42
|
};
|
|
43
43
|
export type InspectorStatusStateEnum = typeof InspectorStatusStateEnum[keyof typeof InspectorStatusStateEnum];
|
|
44
44
|
/**
|
|
@@ -23,13 +23,13 @@ exports.InspectorStatusToJSONTyped = InspectorStatusToJSONTyped;
|
|
|
23
23
|
* @export
|
|
24
24
|
*/
|
|
25
25
|
exports.InspectorStatusStateEnum = {
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
26
|
+
InspectorStatusStateCanceled: 'ready',
|
|
27
|
+
InspectorStatusStateCanceling: 'Initiating',
|
|
28
|
+
InspectorStatusStateCompleted: 'running',
|
|
29
|
+
InspectorStatusStateError: 'canceling',
|
|
30
|
+
InspectorStatusStateInitiating: 'canceled',
|
|
31
|
+
InspectorStatusStateReady: 'completed',
|
|
32
|
+
InspectorStatusStateRunning: 'error'
|
|
33
33
|
};
|
|
34
34
|
/**
|
|
35
35
|
* Check if a given object implements the InspectorStatus interface.
|
package/dist/models/VMIssue.d.ts
CHANGED
|
@@ -38,12 +38,12 @@ export interface VMIssue {
|
|
|
38
38
|
* @export
|
|
39
39
|
*/
|
|
40
40
|
export declare const VMIssueCategoryEnum: {
|
|
41
|
-
readonly
|
|
42
|
-
readonly
|
|
43
|
-
readonly
|
|
44
|
-
readonly
|
|
45
|
-
readonly
|
|
46
|
-
readonly
|
|
41
|
+
readonly VMIssueCategoryCritical: "Critical";
|
|
42
|
+
readonly VMIssueCategoryWarning: "Warning";
|
|
43
|
+
readonly VMIssueCategoryInformation: "Information";
|
|
44
|
+
readonly VMIssueCategoryAdvisory: "Advisory";
|
|
45
|
+
readonly VMIssueCategoryError: "Error";
|
|
46
|
+
readonly VMIssueCategoryOther: "Other";
|
|
47
47
|
};
|
|
48
48
|
export type VMIssueCategoryEnum = typeof VMIssueCategoryEnum[keyof typeof VMIssueCategoryEnum];
|
|
49
49
|
/**
|
package/dist/models/VMIssue.js
CHANGED
|
@@ -23,12 +23,12 @@ exports.VMIssueToJSONTyped = VMIssueToJSONTyped;
|
|
|
23
23
|
* @export
|
|
24
24
|
*/
|
|
25
25
|
exports.VMIssueCategoryEnum = {
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
26
|
+
VMIssueCategoryCritical: 'Critical',
|
|
27
|
+
VMIssueCategoryWarning: 'Warning',
|
|
28
|
+
VMIssueCategoryInformation: 'Information',
|
|
29
|
+
VMIssueCategoryAdvisory: 'Advisory',
|
|
30
|
+
VMIssueCategoryError: 'Error',
|
|
31
|
+
VMIssueCategoryOther: 'Other'
|
|
32
32
|
};
|
|
33
33
|
/**
|
|
34
34
|
* Check if a given object implements the VMIssue interface.
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Assisted Migration Agent API
|
|
3
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: v1
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface VddkProperties
|
|
16
|
+
*/
|
|
17
|
+
export interface VddkProperties {
|
|
18
|
+
/**
|
|
19
|
+
* The matching vSphere Client version
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof VddkProperties
|
|
22
|
+
*/
|
|
23
|
+
version: string;
|
|
24
|
+
/**
|
|
25
|
+
* md5 sum of the uploaded tarball
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof VddkProperties
|
|
28
|
+
*/
|
|
29
|
+
md5: string;
|
|
30
|
+
/**
|
|
31
|
+
* provided tarball bytes
|
|
32
|
+
* @type {number}
|
|
33
|
+
* @memberof VddkProperties
|
|
34
|
+
*/
|
|
35
|
+
bytes?: number;
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* Check if a given object implements the VddkProperties interface.
|
|
39
|
+
*/
|
|
40
|
+
export declare function instanceOfVddkProperties(value: object): value is VddkProperties;
|
|
41
|
+
export declare function VddkPropertiesFromJSON(json: any): VddkProperties;
|
|
42
|
+
export declare function VddkPropertiesFromJSONTyped(json: any, ignoreDiscriminator: boolean): VddkProperties;
|
|
43
|
+
export declare function VddkPropertiesToJSON(json: any): VddkProperties;
|
|
44
|
+
export declare function VddkPropertiesToJSONTyped(value?: VddkProperties | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Assisted Migration Agent API
|
|
6
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: v1
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.instanceOfVddkProperties = instanceOfVddkProperties;
|
|
17
|
+
exports.VddkPropertiesFromJSON = VddkPropertiesFromJSON;
|
|
18
|
+
exports.VddkPropertiesFromJSONTyped = VddkPropertiesFromJSONTyped;
|
|
19
|
+
exports.VddkPropertiesToJSON = VddkPropertiesToJSON;
|
|
20
|
+
exports.VddkPropertiesToJSONTyped = VddkPropertiesToJSONTyped;
|
|
21
|
+
/**
|
|
22
|
+
* Check if a given object implements the VddkProperties interface.
|
|
23
|
+
*/
|
|
24
|
+
function instanceOfVddkProperties(value) {
|
|
25
|
+
if (!('version' in value) || value['version'] === undefined)
|
|
26
|
+
return false;
|
|
27
|
+
if (!('md5' in value) || value['md5'] === undefined)
|
|
28
|
+
return false;
|
|
29
|
+
return true;
|
|
30
|
+
}
|
|
31
|
+
function VddkPropertiesFromJSON(json) {
|
|
32
|
+
return VddkPropertiesFromJSONTyped(json, false);
|
|
33
|
+
}
|
|
34
|
+
function VddkPropertiesFromJSONTyped(json, ignoreDiscriminator) {
|
|
35
|
+
if (json == null) {
|
|
36
|
+
return json;
|
|
37
|
+
}
|
|
38
|
+
return {
|
|
39
|
+
'version': json['version'],
|
|
40
|
+
'md5': json['md5'],
|
|
41
|
+
'bytes': json['bytes'] == null ? undefined : json['bytes'],
|
|
42
|
+
};
|
|
43
|
+
}
|
|
44
|
+
function VddkPropertiesToJSON(json) {
|
|
45
|
+
return VddkPropertiesToJSONTyped(json, false);
|
|
46
|
+
}
|
|
47
|
+
function VddkPropertiesToJSONTyped(value, ignoreDiscriminator = false) {
|
|
48
|
+
if (value == null) {
|
|
49
|
+
return value;
|
|
50
|
+
}
|
|
51
|
+
return {
|
|
52
|
+
'version': value['version'],
|
|
53
|
+
'md5': value['md5'],
|
|
54
|
+
'bytes': value['bytes'],
|
|
55
|
+
};
|
|
56
|
+
}
|
package/dist/models/index.d.ts
CHANGED
|
@@ -31,7 +31,7 @@ export * from './VMNIC.js';
|
|
|
31
31
|
export * from './VMResourceBreakdown.js';
|
|
32
32
|
export * from './VMs.js';
|
|
33
33
|
export * from './VcenterCredentials.js';
|
|
34
|
-
export * from './
|
|
34
|
+
export * from './VddkProperties.js';
|
|
35
35
|
export * from './VersionInfo.js';
|
|
36
36
|
export * from './VirtualMachine.js';
|
|
37
37
|
export * from './VirtualMachineDetail.js';
|
package/dist/models/index.js
CHANGED
|
@@ -49,7 +49,7 @@ __exportStar(require("./VMNIC.js"), exports);
|
|
|
49
49
|
__exportStar(require("./VMResourceBreakdown.js"), exports);
|
|
50
50
|
__exportStar(require("./VMs.js"), exports);
|
|
51
51
|
__exportStar(require("./VcenterCredentials.js"), exports);
|
|
52
|
-
__exportStar(require("./
|
|
52
|
+
__exportStar(require("./VddkProperties.js"), exports);
|
|
53
53
|
__exportStar(require("./VersionInfo.js"), exports);
|
|
54
54
|
__exportStar(require("./VirtualMachine.js"), exports);
|
|
55
55
|
__exportStar(require("./VirtualMachineDetail.js"), exports);
|
package/docs/DefaultApi.md
CHANGED
|
@@ -5,25 +5,26 @@ All URIs are relative to *https://raw.githubusercontent.com/api/v1*
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
| [**addVMsToInspection**](DefaultApi.md#addvmstoinspection) | **PATCH** /vms/inspector | Add more VMs to inspection queue |
|
|
8
|
-
| [**createGroup**](DefaultApi.md#creategroupoperation) | **POST** /
|
|
9
|
-
| [**deleteGroup**](DefaultApi.md#deletegroup) | **DELETE** /
|
|
8
|
+
| [**createGroup**](DefaultApi.md#creategroupoperation) | **POST** /groups | Create a new group |
|
|
9
|
+
| [**deleteGroup**](DefaultApi.md#deletegroup) | **DELETE** /groups/{id} | Delete group |
|
|
10
10
|
| [**getAgentStatus**](DefaultApi.md#getagentstatus) | **GET** /agent | Get agent status |
|
|
11
11
|
| [**getCollectorStatus**](DefaultApi.md#getcollectorstatus) | **GET** /collector | Get collector status |
|
|
12
|
-
| [**getGroup**](DefaultApi.md#getgroup) | **GET** /
|
|
12
|
+
| [**getGroup**](DefaultApi.md#getgroup) | **GET** /groups/{id} | Get group by ID with its VMs |
|
|
13
13
|
| [**getInspectorStatus**](DefaultApi.md#getinspectorstatus) | **GET** /vms/inspector | Get inspector status |
|
|
14
14
|
| [**getInventory**](DefaultApi.md#getinventory) | **GET** /inventory | Get collected inventory |
|
|
15
15
|
| [**getVM**](DefaultApi.md#getvm) | **GET** /vms/{id} | Get details about a vm |
|
|
16
16
|
| [**getVMInspectionStatus**](DefaultApi.md#getvminspectionstatus) | **GET** /vms/{id}/inspector | Get inspection status for a specific VirtualMachine |
|
|
17
17
|
| [**getVMs**](DefaultApi.md#getvms) | **GET** /vms | Get list of VMs with filtering and pagination |
|
|
18
|
+
| [**getVddkStatus**](DefaultApi.md#getvddkstatus) | **GET** /vddk | Get VDDK status |
|
|
18
19
|
| [**getVersion**](DefaultApi.md#getversion) | **GET** /version | Get agent version information |
|
|
19
|
-
| [**listGroups**](DefaultApi.md#listgroups) | **GET** /
|
|
20
|
+
| [**listGroups**](DefaultApi.md#listgroups) | **GET** /groups | List all groups |
|
|
20
21
|
| [**removeVMFromInspection**](DefaultApi.md#removevmfrominspection) | **DELETE** /vms/{id}/inspector | Remove VirtualMachine from inspection queue |
|
|
21
22
|
| [**setAgentMode**](DefaultApi.md#setagentmode) | **POST** /agent | Change agent mode |
|
|
22
23
|
| [**startCollector**](DefaultApi.md#startcollector) | **POST** /collector | Start inventory collection |
|
|
23
24
|
| [**startInspection**](DefaultApi.md#startinspection) | **POST** /vms/inspector | Start inspection for VMs |
|
|
24
25
|
| [**stopCollector**](DefaultApi.md#stopcollector) | **DELETE** /collector | Stop collection |
|
|
25
26
|
| [**stopInspection**](DefaultApi.md#stopinspection) | **DELETE** /vms/inspector | Stop inspector entirely |
|
|
26
|
-
| [**updateGroup**](DefaultApi.md#updategroupoperation) | **PATCH** /
|
|
27
|
+
| [**updateGroup**](DefaultApi.md#updategroupoperation) | **PATCH** /groups/{id} | Update group |
|
|
27
28
|
| [**vddkPost**](DefaultApi.md#vddkpost) | **POST** /vddk | Upload VDDK tarball |
|
|
28
29
|
|
|
29
30
|
|
|
@@ -759,6 +760,65 @@ No authorization required
|
|
|
759
760
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
760
761
|
|
|
761
762
|
|
|
763
|
+
## getVddkStatus
|
|
764
|
+
|
|
765
|
+
> VddkProperties getVddkStatus()
|
|
766
|
+
|
|
767
|
+
Get VDDK status
|
|
768
|
+
|
|
769
|
+
### Example
|
|
770
|
+
|
|
771
|
+
```ts
|
|
772
|
+
import {
|
|
773
|
+
Configuration,
|
|
774
|
+
DefaultApi,
|
|
775
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
776
|
+
import type { GetVddkStatusRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
777
|
+
|
|
778
|
+
async function example() {
|
|
779
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
780
|
+
const api = new DefaultApi();
|
|
781
|
+
|
|
782
|
+
try {
|
|
783
|
+
const data = await api.getVddkStatus();
|
|
784
|
+
console.log(data);
|
|
785
|
+
} catch (error) {
|
|
786
|
+
console.error(error);
|
|
787
|
+
}
|
|
788
|
+
}
|
|
789
|
+
|
|
790
|
+
// Run the test
|
|
791
|
+
example().catch(console.error);
|
|
792
|
+
```
|
|
793
|
+
|
|
794
|
+
### Parameters
|
|
795
|
+
|
|
796
|
+
This endpoint does not need any parameter.
|
|
797
|
+
|
|
798
|
+
### Return type
|
|
799
|
+
|
|
800
|
+
[**VddkProperties**](VddkProperties.md)
|
|
801
|
+
|
|
802
|
+
### Authorization
|
|
803
|
+
|
|
804
|
+
No authorization required
|
|
805
|
+
|
|
806
|
+
### HTTP request headers
|
|
807
|
+
|
|
808
|
+
- **Content-Type**: Not defined
|
|
809
|
+
- **Accept**: `application/json`
|
|
810
|
+
|
|
811
|
+
|
|
812
|
+
### HTTP response details
|
|
813
|
+
| Status code | Description | Response headers |
|
|
814
|
+
|-------------|-------------|------------------|
|
|
815
|
+
| **200** | Returns the current properties of the uploaded VMware VDDK tar. If the VDDK package has not been uploaded, a 404 response is returned. | - |
|
|
816
|
+
| **404** | Vddk not found | - |
|
|
817
|
+
| **500** | Internal server error | - |
|
|
818
|
+
|
|
819
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
820
|
+
|
|
821
|
+
|
|
762
822
|
## getVersion
|
|
763
823
|
|
|
764
824
|
> VersionInfo getVersion()
|
|
@@ -1352,7 +1412,7 @@ No authorization required
|
|
|
1352
1412
|
|
|
1353
1413
|
## vddkPost
|
|
1354
1414
|
|
|
1355
|
-
>
|
|
1415
|
+
> VddkProperties vddkPost(file)
|
|
1356
1416
|
|
|
1357
1417
|
Upload VDDK tarball
|
|
1358
1418
|
|
|
@@ -1395,7 +1455,7 @@ example().catch(console.error);
|
|
|
1395
1455
|
|
|
1396
1456
|
### Return type
|
|
1397
1457
|
|
|
1398
|
-
[**
|
|
1458
|
+
[**VddkProperties**](VddkProperties.md)
|
|
1399
1459
|
|
|
1400
1460
|
### Authorization
|
|
1401
1461
|
|
|
@@ -1411,6 +1471,7 @@ No authorization required
|
|
|
1411
1471
|
| Status code | Description | Response headers |
|
|
1412
1472
|
|-------------|-------------|------------------|
|
|
1413
1473
|
| **200** | Upload successful | - |
|
|
1474
|
+
| **409** | Conflict | - |
|
|
1414
1475
|
| **413** | File exceeds 64MB limit | - |
|
|
1415
1476
|
| **400** | Bad request | - |
|
|
1416
1477
|
| **500** | Internal server error | - |
|
|
@@ -1,24 +1,26 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# VddkProperties
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
+
`version` | string
|
|
9
10
|
`md5` | string
|
|
10
11
|
`bytes` | number
|
|
11
12
|
|
|
12
13
|
## Example
|
|
13
14
|
|
|
14
15
|
```typescript
|
|
15
|
-
import type {
|
|
16
|
+
import type { VddkProperties } from '@openshift-migration-advisor/agent-sdk'
|
|
16
17
|
|
|
17
18
|
// TODO: Update the object below with actual values
|
|
18
19
|
const example = {
|
|
20
|
+
"version": null,
|
|
19
21
|
"md5": null,
|
|
20
22
|
"bytes": null,
|
|
21
|
-
} satisfies
|
|
23
|
+
} satisfies VddkProperties
|
|
22
24
|
|
|
23
25
|
console.log(example)
|
|
24
26
|
|
|
@@ -27,7 +29,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
27
29
|
console.log(exampleJSON)
|
|
28
30
|
|
|
29
31
|
// Parse the JSON string back to an object
|
|
30
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
32
|
+
const exampleParsed = JSON.parse(exampleJSON) as VddkProperties
|
|
31
33
|
console.log(exampleParsed)
|
|
32
34
|
```
|
|
33
35
|
|