@openshift-migration-advisor/agent-sdk 0.7.0 → 0.8.0-7c64128a18e3
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 +19 -19
- package/dist/apis/DefaultApi.d.ts +51 -56
- package/dist/apis/DefaultApi.js +58 -63
- package/dist/esm/apis/DefaultApi.d.ts +51 -56
- package/dist/esm/apis/DefaultApi.js +59 -64
- 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 +6 -7
- package/dist/esm/models/InspectorStatus.js +6 -7
- package/dist/esm/models/VMIssue.d.ts +6 -6
- package/dist/esm/models/VMIssue.js +6 -6
- package/dist/esm/models/VMs.d.ts +9 -0
- package/dist/esm/models/VMs.js +2 -0
- package/dist/esm/models/VddkProperties.d.ts +44 -0
- package/dist/esm/models/{VddkPost200Response.js → VddkProperties.js} +13 -11
- package/dist/esm/models/VmInspectionStatus.d.ts +1 -1
- package/dist/esm/models/VmInspectionStatus.js +1 -1
- 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 +6 -7
- package/dist/models/InspectorStatus.js +6 -7
- package/dist/models/VMIssue.d.ts +6 -6
- package/dist/models/VMIssue.js +6 -6
- package/dist/models/VMs.d.ts +9 -0
- package/dist/models/VMs.js +2 -0
- package/dist/models/VddkProperties.d.ts +44 -0
- package/dist/models/VddkProperties.js +56 -0
- package/dist/models/VmInspectionStatus.d.ts +1 -1
- package/dist/models/VmInspectionStatus.js +1 -1
- package/dist/models/index.d.ts +1 -1
- package/dist/models/index.js +1 -1
- package/docs/DefaultApi.md +61 -67
- package/docs/VMs.md +2 -0
- package/docs/{VddkPost200Response.md → VddkProperties.md} +6 -4
- package/package.json +1 -1
- package/src/apis/DefaultApi.ts +97 -113
- package/src/models/AgentStatus.ts +2 -2
- package/src/models/CollectorStatus.ts +6 -7
- package/src/models/InspectorStatus.ts +6 -7
- package/src/models/VMIssue.ts +6 -6
- package/src/models/VMs.ts +9 -0
- package/src/models/VddkProperties.ts +83 -0
- package/src/models/VmInspectionStatus.ts +1 -1
- 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
package/docs/DefaultApi.md
CHANGED
|
@@ -4,35 +4,35 @@ All URIs are relative to *https://raw.githubusercontent.com/api/v1*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
| [**
|
|
8
|
-
| [**createGroup**](DefaultApi.md#creategroupoperation) | **POST** /
|
|
9
|
-
| [**deleteGroup**](DefaultApi.md#deletegroup) | **DELETE** /
|
|
7
|
+
| [**addVMToInspection**](DefaultApi.md#addvmtoinspection) | **POST** /vms/{id}/inspection | Add VirtualMachine to inspection queue |
|
|
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** /
|
|
13
|
-
| [**getInspectorStatus**](DefaultApi.md#getinspectorstatus) | **GET** /
|
|
12
|
+
| [**getGroup**](DefaultApi.md#getgroup) | **GET** /groups/{id} | Get group by ID with its VMs |
|
|
13
|
+
| [**getInspectorStatus**](DefaultApi.md#getinspectorstatus) | **GET** /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
|
-
| [**getVMInspectionStatus**](DefaultApi.md#getvminspectionstatus) | **GET** /vms/{id}/inspector | Get inspection status for a specific VirtualMachine |
|
|
17
16
|
| [**getVMs**](DefaultApi.md#getvms) | **GET** /vms | Get list of VMs with filtering and pagination |
|
|
17
|
+
| [**getVddkStatus**](DefaultApi.md#getvddkstatus) | **GET** /vddk | Get VDDK status |
|
|
18
18
|
| [**getVersion**](DefaultApi.md#getversion) | **GET** /version | Get agent version information |
|
|
19
|
-
| [**listGroups**](DefaultApi.md#listgroups) | **GET** /
|
|
20
|
-
| [**removeVMFromInspection**](DefaultApi.md#removevmfrominspection) | **DELETE** /vms/{id}/
|
|
19
|
+
| [**listGroups**](DefaultApi.md#listgroups) | **GET** /groups | List all groups |
|
|
20
|
+
| [**removeVMFromInspection**](DefaultApi.md#removevmfrominspection) | **DELETE** /vms/{id}/inspection | Remove VirtualMachine from inspection queue |
|
|
21
21
|
| [**setAgentMode**](DefaultApi.md#setagentmode) | **POST** /agent | Change agent mode |
|
|
22
22
|
| [**startCollector**](DefaultApi.md#startcollector) | **POST** /collector | Start inventory collection |
|
|
23
|
-
| [**startInspection**](DefaultApi.md#startinspection) | **POST** /
|
|
23
|
+
| [**startInspection**](DefaultApi.md#startinspection) | **POST** /inspector | Start inspection for VMs |
|
|
24
24
|
| [**stopCollector**](DefaultApi.md#stopcollector) | **DELETE** /collector | Stop collection |
|
|
25
|
-
| [**stopInspection**](DefaultApi.md#stopinspection) | **DELETE** /
|
|
26
|
-
| [**updateGroup**](DefaultApi.md#updategroupoperation) | **PATCH** /
|
|
25
|
+
| [**stopInspection**](DefaultApi.md#stopinspection) | **DELETE** /inspector | Stop inspector entirely |
|
|
26
|
+
| [**updateGroup**](DefaultApi.md#updategroupoperation) | **PATCH** /groups/{id} | Update group |
|
|
27
27
|
| [**vddkPost**](DefaultApi.md#vddkpost) | **POST** /vddk | Upload VDDK tarball |
|
|
28
28
|
|
|
29
29
|
|
|
30
30
|
|
|
31
|
-
##
|
|
31
|
+
## addVMToInspection
|
|
32
32
|
|
|
33
|
-
>
|
|
33
|
+
> VmInspectionStatus addVMToInspection(id)
|
|
34
34
|
|
|
35
|
-
Add
|
|
35
|
+
Add VirtualMachine to inspection queue
|
|
36
36
|
|
|
37
37
|
### Example
|
|
38
38
|
|
|
@@ -41,19 +41,19 @@ import {
|
|
|
41
41
|
Configuration,
|
|
42
42
|
DefaultApi,
|
|
43
43
|
} from '@openshift-migration-advisor/agent-sdk';
|
|
44
|
-
import type {
|
|
44
|
+
import type { AddVMToInspectionRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
45
45
|
|
|
46
46
|
async function example() {
|
|
47
47
|
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
48
48
|
const api = new DefaultApi();
|
|
49
49
|
|
|
50
50
|
const body = {
|
|
51
|
-
//
|
|
52
|
-
|
|
53
|
-
} satisfies
|
|
51
|
+
// string
|
|
52
|
+
id: id_example,
|
|
53
|
+
} satisfies AddVMToInspectionRequest;
|
|
54
54
|
|
|
55
55
|
try {
|
|
56
|
-
const data = await api.
|
|
56
|
+
const data = await api.addVMToInspection(body);
|
|
57
57
|
console.log(data);
|
|
58
58
|
} catch (error) {
|
|
59
59
|
console.error(error);
|
|
@@ -69,11 +69,11 @@ example().catch(console.error);
|
|
|
69
69
|
|
|
70
70
|
| Name | Type | Description | Notes |
|
|
71
71
|
|------------- | ------------- | ------------- | -------------|
|
|
72
|
-
| **
|
|
72
|
+
| **id** | `string` | | [Defaults to `undefined`] |
|
|
73
73
|
|
|
74
74
|
### Return type
|
|
75
75
|
|
|
76
|
-
[**
|
|
76
|
+
[**VmInspectionStatus**](VmInspectionStatus.md)
|
|
77
77
|
|
|
78
78
|
### Authorization
|
|
79
79
|
|
|
@@ -81,16 +81,17 @@ No authorization required
|
|
|
81
81
|
|
|
82
82
|
### HTTP request headers
|
|
83
83
|
|
|
84
|
-
- **Content-Type**:
|
|
84
|
+
- **Content-Type**: Not defined
|
|
85
85
|
- **Accept**: `application/json`
|
|
86
86
|
|
|
87
87
|
|
|
88
88
|
### HTTP response details
|
|
89
89
|
| Status code | Description | Response headers |
|
|
90
90
|
|-------------|-------------|------------------|
|
|
91
|
-
| **202** |
|
|
92
|
-
| **400** |
|
|
93
|
-
| **404** |
|
|
91
|
+
| **202** | VM added to inspection queue | - |
|
|
92
|
+
| **400** | Inspector not running | - |
|
|
93
|
+
| **404** | VirtualMachine not found | - |
|
|
94
|
+
| **409** | VM already in inspection queue | - |
|
|
94
95
|
| **500** | Internal server error | - |
|
|
95
96
|
|
|
96
97
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
@@ -616,11 +617,11 @@ No authorization required
|
|
|
616
617
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
617
618
|
|
|
618
619
|
|
|
619
|
-
##
|
|
620
|
+
## getVMs
|
|
620
621
|
|
|
621
|
-
>
|
|
622
|
+
> VirtualMachineListResponse getVMs(byExpression, sort, page, pageSize)
|
|
622
623
|
|
|
623
|
-
Get
|
|
624
|
+
Get list of VMs with filtering and pagination
|
|
624
625
|
|
|
625
626
|
### Example
|
|
626
627
|
|
|
@@ -629,19 +630,25 @@ import {
|
|
|
629
630
|
Configuration,
|
|
630
631
|
DefaultApi,
|
|
631
632
|
} from '@openshift-migration-advisor/agent-sdk';
|
|
632
|
-
import type {
|
|
633
|
+
import type { GetVMsRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
633
634
|
|
|
634
635
|
async function example() {
|
|
635
636
|
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
636
637
|
const api = new DefaultApi();
|
|
637
638
|
|
|
638
639
|
const body = {
|
|
639
|
-
// string |
|
|
640
|
-
|
|
641
|
-
|
|
640
|
+
// string | Filter by expression (matches VMs with the provided expression) (optional)
|
|
641
|
+
byExpression: exp1,
|
|
642
|
+
// Array<string> | Sort fields with direction (e.g., \"name:asc\" or \"cluster:desc,name:asc\"). Valid fields are name, vCenterState, cluster, diskSize, memory, issues. (optional)
|
|
643
|
+
sort: ["cluster:asc","name:desc"],
|
|
644
|
+
// number | Page number for pagination (optional)
|
|
645
|
+
page: 56,
|
|
646
|
+
// number | Number of items per page (optional)
|
|
647
|
+
pageSize: 56,
|
|
648
|
+
} satisfies GetVMsRequest;
|
|
642
649
|
|
|
643
650
|
try {
|
|
644
|
-
const data = await api.
|
|
651
|
+
const data = await api.getVMs(body);
|
|
645
652
|
console.log(data);
|
|
646
653
|
} catch (error) {
|
|
647
654
|
console.error(error);
|
|
@@ -657,11 +664,14 @@ example().catch(console.error);
|
|
|
657
664
|
|
|
658
665
|
| Name | Type | Description | Notes |
|
|
659
666
|
|------------- | ------------- | ------------- | -------------|
|
|
660
|
-
| **
|
|
667
|
+
| **byExpression** | `string` | Filter by expression (matches VMs with the provided expression) | [Optional] [Defaults to `undefined`] |
|
|
668
|
+
| **sort** | `Array<string>` | Sort fields with direction (e.g., \"name:asc\" or \"cluster:desc,name:asc\"). Valid fields are name, vCenterState, cluster, diskSize, memory, issues. | [Optional] |
|
|
669
|
+
| **page** | `number` | Page number for pagination | [Optional] [Defaults to `1`] |
|
|
670
|
+
| **pageSize** | `number` | Number of items per page | [Optional] [Defaults to `undefined`] |
|
|
661
671
|
|
|
662
672
|
### Return type
|
|
663
673
|
|
|
664
|
-
[**
|
|
674
|
+
[**VirtualMachineListResponse**](VirtualMachineListResponse.md)
|
|
665
675
|
|
|
666
676
|
### Authorization
|
|
667
677
|
|
|
@@ -676,18 +686,18 @@ No authorization required
|
|
|
676
686
|
### HTTP response details
|
|
677
687
|
| Status code | Description | Response headers |
|
|
678
688
|
|-------------|-------------|------------------|
|
|
679
|
-
| **200** |
|
|
680
|
-
| **
|
|
689
|
+
| **200** | List of VMs | - |
|
|
690
|
+
| **400** | Invalid request parameters | - |
|
|
681
691
|
| **500** | Internal server error | - |
|
|
682
692
|
|
|
683
693
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
684
694
|
|
|
685
695
|
|
|
686
|
-
##
|
|
696
|
+
## getVddkStatus
|
|
687
697
|
|
|
688
|
-
>
|
|
698
|
+
> VddkProperties getVddkStatus()
|
|
689
699
|
|
|
690
|
-
Get
|
|
700
|
+
Get VDDK status
|
|
691
701
|
|
|
692
702
|
### Example
|
|
693
703
|
|
|
@@ -696,25 +706,14 @@ import {
|
|
|
696
706
|
Configuration,
|
|
697
707
|
DefaultApi,
|
|
698
708
|
} from '@openshift-migration-advisor/agent-sdk';
|
|
699
|
-
import type {
|
|
709
|
+
import type { GetVddkStatusRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
700
710
|
|
|
701
711
|
async function example() {
|
|
702
712
|
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
703
713
|
const api = new DefaultApi();
|
|
704
714
|
|
|
705
|
-
const body = {
|
|
706
|
-
// string | Filter by expression (matches VMs with the provided expression) (optional)
|
|
707
|
-
byExpression: exp1,
|
|
708
|
-
// Array<string> | Sort fields with direction (e.g., \"name:asc\" or \"cluster:desc,name:asc\"). Valid fields are name, vCenterState, cluster, diskSize, memory, issues. (optional)
|
|
709
|
-
sort: ["cluster:asc","name:desc"],
|
|
710
|
-
// number | Page number for pagination (optional)
|
|
711
|
-
page: 56,
|
|
712
|
-
// number | Number of items per page (optional)
|
|
713
|
-
pageSize: 56,
|
|
714
|
-
} satisfies GetVMsRequest;
|
|
715
|
-
|
|
716
715
|
try {
|
|
717
|
-
const data = await api.
|
|
716
|
+
const data = await api.getVddkStatus();
|
|
718
717
|
console.log(data);
|
|
719
718
|
} catch (error) {
|
|
720
719
|
console.error(error);
|
|
@@ -727,17 +726,11 @@ example().catch(console.error);
|
|
|
727
726
|
|
|
728
727
|
### Parameters
|
|
729
728
|
|
|
730
|
-
|
|
731
|
-
| Name | Type | Description | Notes |
|
|
732
|
-
|------------- | ------------- | ------------- | -------------|
|
|
733
|
-
| **byExpression** | `string` | Filter by expression (matches VMs with the provided expression) | [Optional] [Defaults to `undefined`] |
|
|
734
|
-
| **sort** | `Array<string>` | Sort fields with direction (e.g., \"name:asc\" or \"cluster:desc,name:asc\"). Valid fields are name, vCenterState, cluster, diskSize, memory, issues. | [Optional] |
|
|
735
|
-
| **page** | `number` | Page number for pagination | [Optional] [Defaults to `1`] |
|
|
736
|
-
| **pageSize** | `number` | Number of items per page | [Optional] [Defaults to `undefined`] |
|
|
729
|
+
This endpoint does not need any parameter.
|
|
737
730
|
|
|
738
731
|
### Return type
|
|
739
732
|
|
|
740
|
-
[**
|
|
733
|
+
[**VddkProperties**](VddkProperties.md)
|
|
741
734
|
|
|
742
735
|
### Authorization
|
|
743
736
|
|
|
@@ -752,8 +745,8 @@ No authorization required
|
|
|
752
745
|
### HTTP response details
|
|
753
746
|
| Status code | Description | Response headers |
|
|
754
747
|
|-------------|-------------|------------------|
|
|
755
|
-
| **200** |
|
|
756
|
-
| **
|
|
748
|
+
| **200** | Returns the current properties of the uploaded VMware VDDK tar. If the VDDK package has not been uploaded, a 404 response is returned. | - |
|
|
749
|
+
| **404** | Vddk not found | - |
|
|
757
750
|
| **500** | Internal server error | - |
|
|
758
751
|
|
|
759
752
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
@@ -950,8 +943,8 @@ No authorization required
|
|
|
950
943
|
| Status code | Description | Response headers |
|
|
951
944
|
|-------------|-------------|------------------|
|
|
952
945
|
| **200** | VMs removed from queue | - |
|
|
953
|
-
| **400** |
|
|
954
|
-
| **404** |
|
|
946
|
+
| **400** | Inspector not running or VirtualMachine cannot be canceled | - |
|
|
947
|
+
| **404** | VirtualMachine not found or not in the queue | - |
|
|
955
948
|
| **500** | Internal server error | - |
|
|
956
949
|
|
|
957
950
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
@@ -1352,7 +1345,7 @@ No authorization required
|
|
|
1352
1345
|
|
|
1353
1346
|
## vddkPost
|
|
1354
1347
|
|
|
1355
|
-
>
|
|
1348
|
+
> VddkProperties vddkPost(file)
|
|
1356
1349
|
|
|
1357
1350
|
Upload VDDK tarball
|
|
1358
1351
|
|
|
@@ -1395,7 +1388,7 @@ example().catch(console.error);
|
|
|
1395
1388
|
|
|
1396
1389
|
### Return type
|
|
1397
1390
|
|
|
1398
|
-
[**
|
|
1391
|
+
[**VddkProperties**](VddkProperties.md)
|
|
1399
1392
|
|
|
1400
1393
|
### Authorization
|
|
1401
1394
|
|
|
@@ -1411,6 +1404,7 @@ No authorization required
|
|
|
1411
1404
|
| Status code | Description | Response headers |
|
|
1412
1405
|
|-------------|-------------|------------------|
|
|
1413
1406
|
| **200** | Upload successful | - |
|
|
1407
|
+
| **409** | Conflict | - |
|
|
1414
1408
|
| **413** | File exceeds 64MB limit | - |
|
|
1415
1409
|
| **400** | Bad request | - |
|
|
1416
1410
|
| **500** | Internal server error | - |
|
package/docs/VMs.md
CHANGED
|
@@ -17,6 +17,7 @@ Name | Type
|
|
|
17
17
|
`distributionByMemoryTier` | { [key: string]: number; }
|
|
18
18
|
`distributionByNicCount` | { [key: string]: number; }
|
|
19
19
|
`distributionByComplexity` | { [key: string]: number; }
|
|
20
|
+
`complexityDistribution` | [{ [key: string]: DiskSizeTierSummary; }](DiskSizeTierSummary.md)
|
|
20
21
|
`ramGB` | [VMResourceBreakdown](VMResourceBreakdown.md)
|
|
21
22
|
`diskGB` | [VMResourceBreakdown](VMResourceBreakdown.md)
|
|
22
23
|
`diskCount` | [VMResourceBreakdown](VMResourceBreakdown.md)
|
|
@@ -45,6 +46,7 @@ const example = {
|
|
|
45
46
|
"distributionByMemoryTier": null,
|
|
46
47
|
"distributionByNicCount": null,
|
|
47
48
|
"distributionByComplexity": null,
|
|
49
|
+
"complexityDistribution": null,
|
|
48
50
|
"ramGB": null,
|
|
49
51
|
"diskGB": null,
|
|
50
52
|
"diskCount": null,
|
|
@@ -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
|
|
package/package.json
CHANGED