@openshift-migration-advisor/agent-sdk 0.16.0 → 0.17.0-fa395f816b50
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 +6 -0
- package/README.md +12 -7
- package/dist/apis/DefaultApi.d.ts +74 -0
- package/dist/apis/DefaultApi.js +80 -0
- package/dist/esm/apis/DefaultApi.d.ts +74 -0
- package/dist/esm/apis/DefaultApi.js +80 -0
- package/dist/esm/models/BatchUpdateExclusionRequest.d.ts +38 -0
- package/dist/esm/models/BatchUpdateExclusionRequest.js +47 -0
- package/dist/esm/models/CollectorStartRequest.d.ts +12 -12
- package/dist/esm/models/CollectorStartRequest.js +5 -11
- package/dist/esm/models/Datastore.js +1 -1
- package/dist/esm/models/ExportInventory400Response.d.ts +32 -0
- package/dist/esm/models/ExportInventory400Response.js +41 -0
- package/dist/esm/models/ExportInventory500Response.d.ts +32 -0
- package/dist/esm/models/ExportInventory500Response.js +41 -0
- package/dist/esm/models/Host.js +3 -3
- package/dist/esm/models/OsInfo.d.ts +16 -0
- package/dist/esm/models/OsInfo.js +11 -0
- package/dist/esm/models/index.d.ts +3 -0
- package/dist/esm/models/index.js +3 -0
- package/dist/esm/runtime.d.ts +1 -0
- package/dist/esm/runtime.js +4 -0
- package/dist/models/BatchUpdateExclusionRequest.d.ts +38 -0
- package/dist/models/BatchUpdateExclusionRequest.js +54 -0
- package/dist/models/CollectorStartRequest.d.ts +12 -12
- package/dist/models/CollectorStartRequest.js +5 -11
- package/dist/models/Datastore.js +1 -1
- package/dist/models/ExportInventory400Response.d.ts +32 -0
- package/dist/models/ExportInventory400Response.js +48 -0
- package/dist/models/ExportInventory500Response.d.ts +32 -0
- package/dist/models/ExportInventory500Response.js +48 -0
- package/dist/models/Host.js +3 -3
- package/dist/models/OsInfo.d.ts +16 -0
- package/dist/models/OsInfo.js +12 -0
- package/dist/models/index.d.ts +3 -0
- package/dist/models/index.js +3 -0
- package/dist/runtime.d.ts +1 -0
- package/dist/runtime.js +5 -0
- package/docs/BatchUpdateExclusionRequest.md +36 -0
- package/docs/CollectorStartRequest.md +3 -2
- package/docs/DefaultApi.md +139 -0
- package/docs/ExportInventory400Response.md +34 -0
- package/docs/ExportInventory500Response.md +34 -0
- package/docs/OsInfo.md +2 -0
- package/package.json +1 -1
- package/src/apis/DefaultApi.ts +159 -0
- package/src/models/BatchUpdateExclusionRequest.ts +75 -0
- package/src/models/CollectorStartRequest.ts +17 -20
- package/src/models/Datastore.ts +1 -1
- package/src/models/ExportInventory400Response.ts +65 -0
- package/src/models/ExportInventory500Response.ts +65 -0
- package/src/models/Host.ts +3 -3
- package/src/models/OsInfo.ts +21 -0
- package/src/models/index.ts +3 -0
- package/src/runtime.ts +5 -0
- package/tsconfig.json +1 -1
|
@@ -0,0 +1,32 @@
|
|
|
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 ExportInventory500Response
|
|
16
|
+
*/
|
|
17
|
+
export interface ExportInventory500Response {
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof ExportInventory500Response
|
|
22
|
+
*/
|
|
23
|
+
error?: string;
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* Check if a given object implements the ExportInventory500Response interface.
|
|
27
|
+
*/
|
|
28
|
+
export declare function instanceOfExportInventory500Response(value: object): value is ExportInventory500Response;
|
|
29
|
+
export declare function ExportInventory500ResponseFromJSON(json: any): ExportInventory500Response;
|
|
30
|
+
export declare function ExportInventory500ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ExportInventory500Response;
|
|
31
|
+
export declare function ExportInventory500ResponseToJSON(json: any): ExportInventory500Response;
|
|
32
|
+
export declare function ExportInventory500ResponseToJSONTyped(value?: ExportInventory500Response | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,48 @@
|
|
|
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.instanceOfExportInventory500Response = instanceOfExportInventory500Response;
|
|
17
|
+
exports.ExportInventory500ResponseFromJSON = ExportInventory500ResponseFromJSON;
|
|
18
|
+
exports.ExportInventory500ResponseFromJSONTyped = ExportInventory500ResponseFromJSONTyped;
|
|
19
|
+
exports.ExportInventory500ResponseToJSON = ExportInventory500ResponseToJSON;
|
|
20
|
+
exports.ExportInventory500ResponseToJSONTyped = ExportInventory500ResponseToJSONTyped;
|
|
21
|
+
/**
|
|
22
|
+
* Check if a given object implements the ExportInventory500Response interface.
|
|
23
|
+
*/
|
|
24
|
+
function instanceOfExportInventory500Response(value) {
|
|
25
|
+
return true;
|
|
26
|
+
}
|
|
27
|
+
function ExportInventory500ResponseFromJSON(json) {
|
|
28
|
+
return ExportInventory500ResponseFromJSONTyped(json, false);
|
|
29
|
+
}
|
|
30
|
+
function ExportInventory500ResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
31
|
+
if (json == null) {
|
|
32
|
+
return json;
|
|
33
|
+
}
|
|
34
|
+
return {
|
|
35
|
+
'error': json['error'] == null ? undefined : json['error'],
|
|
36
|
+
};
|
|
37
|
+
}
|
|
38
|
+
function ExportInventory500ResponseToJSON(json) {
|
|
39
|
+
return ExportInventory500ResponseToJSONTyped(json, false);
|
|
40
|
+
}
|
|
41
|
+
function ExportInventory500ResponseToJSONTyped(value, ignoreDiscriminator = false) {
|
|
42
|
+
if (value == null) {
|
|
43
|
+
return value;
|
|
44
|
+
}
|
|
45
|
+
return {
|
|
46
|
+
'error': value['error'],
|
|
47
|
+
};
|
|
48
|
+
}
|
package/dist/models/Host.js
CHANGED
|
@@ -39,9 +39,9 @@ function HostFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
39
39
|
'id': json['id'] == null ? undefined : json['id'],
|
|
40
40
|
'vendor': json['vendor'],
|
|
41
41
|
'model': json['model'],
|
|
42
|
-
'cpuCores': json['cpuCores']
|
|
43
|
-
'cpuSockets': json['cpuSockets']
|
|
44
|
-
'memoryMB': json['memoryMB']
|
|
42
|
+
'cpuCores': json['cpuCores'] === undefined ? undefined : json['cpuCores'] === null ? null : json['cpuCores'],
|
|
43
|
+
'cpuSockets': json['cpuSockets'] === undefined ? undefined : json['cpuSockets'] === null ? null : json['cpuSockets'],
|
|
44
|
+
'memoryMB': json['memoryMB'] === undefined ? undefined : json['memoryMB'] === null ? null : json['memoryMB'],
|
|
45
45
|
};
|
|
46
46
|
}
|
|
47
47
|
function HostToJSON(json) {
|
package/dist/models/OsInfo.d.ts
CHANGED
|
@@ -27,6 +27,12 @@ export interface OsInfo {
|
|
|
27
27
|
* @memberof OsInfo
|
|
28
28
|
*/
|
|
29
29
|
supported: boolean;
|
|
30
|
+
/**
|
|
31
|
+
* OS support tier per Red Hat KCS article 4234591
|
|
32
|
+
* @type {OsInfoSupportTierEnum}
|
|
33
|
+
* @memberof OsInfo
|
|
34
|
+
*/
|
|
35
|
+
supportTier?: OsInfoSupportTierEnum;
|
|
30
36
|
/**
|
|
31
37
|
* Recommended OS upgrade for MTV unsupported OS that can be upgraded to a supported OS
|
|
32
38
|
* @type {string}
|
|
@@ -34,6 +40,16 @@ export interface OsInfo {
|
|
|
34
40
|
*/
|
|
35
41
|
upgradeRecommendation?: string;
|
|
36
42
|
}
|
|
43
|
+
/**
|
|
44
|
+
* @export
|
|
45
|
+
*/
|
|
46
|
+
export declare const OsInfoSupportTierEnum: {
|
|
47
|
+
readonly Certified: "certified";
|
|
48
|
+
readonly VendorSupported: "vendor_supported";
|
|
49
|
+
readonly CommunitySupported: "community_supported";
|
|
50
|
+
readonly SpecialHandling: "special_handling";
|
|
51
|
+
};
|
|
52
|
+
export type OsInfoSupportTierEnum = typeof OsInfoSupportTierEnum[keyof typeof OsInfoSupportTierEnum];
|
|
37
53
|
/**
|
|
38
54
|
* Check if a given object implements the OsInfo interface.
|
|
39
55
|
*/
|
package/dist/models/OsInfo.js
CHANGED
|
@@ -13,11 +13,21 @@
|
|
|
13
13
|
* Do not edit the class manually.
|
|
14
14
|
*/
|
|
15
15
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.OsInfoSupportTierEnum = void 0;
|
|
16
17
|
exports.instanceOfOsInfo = instanceOfOsInfo;
|
|
17
18
|
exports.OsInfoFromJSON = OsInfoFromJSON;
|
|
18
19
|
exports.OsInfoFromJSONTyped = OsInfoFromJSONTyped;
|
|
19
20
|
exports.OsInfoToJSON = OsInfoToJSON;
|
|
20
21
|
exports.OsInfoToJSONTyped = OsInfoToJSONTyped;
|
|
22
|
+
/**
|
|
23
|
+
* @export
|
|
24
|
+
*/
|
|
25
|
+
exports.OsInfoSupportTierEnum = {
|
|
26
|
+
Certified: 'certified',
|
|
27
|
+
VendorSupported: 'vendor_supported',
|
|
28
|
+
CommunitySupported: 'community_supported',
|
|
29
|
+
SpecialHandling: 'special_handling'
|
|
30
|
+
};
|
|
21
31
|
/**
|
|
22
32
|
* Check if a given object implements the OsInfo interface.
|
|
23
33
|
*/
|
|
@@ -38,6 +48,7 @@ function OsInfoFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
38
48
|
return {
|
|
39
49
|
'count': json['count'],
|
|
40
50
|
'supported': json['supported'],
|
|
51
|
+
'supportTier': json['supportTier'] == null ? undefined : json['supportTier'],
|
|
41
52
|
'upgradeRecommendation': json['upgradeRecommendation'] == null ? undefined : json['upgradeRecommendation'],
|
|
42
53
|
};
|
|
43
54
|
}
|
|
@@ -51,6 +62,7 @@ function OsInfoToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
51
62
|
return {
|
|
52
63
|
'count': value['count'],
|
|
53
64
|
'supported': value['supported'],
|
|
65
|
+
'supportTier': value['supportTier'],
|
|
54
66
|
'upgradeRecommendation': value['upgradeRecommendation'],
|
|
55
67
|
};
|
|
56
68
|
}
|
package/dist/models/index.d.ts
CHANGED
|
@@ -3,6 +3,7 @@ export * from './AgentStatus.js';
|
|
|
3
3
|
export * from './ApplicationListResponse.js';
|
|
4
4
|
export * from './ApplicationOverview.js';
|
|
5
5
|
export * from './ApplicationVM.js';
|
|
6
|
+
export * from './BatchUpdateExclusionRequest.js';
|
|
6
7
|
export * from './BenchmarkRun.js';
|
|
7
8
|
export * from './CapabilityStatus.js';
|
|
8
9
|
export * from './CapabilityStatusCapabilities.js';
|
|
@@ -19,6 +20,8 @@ export * from './DeleteLabelGloballyResponse.js';
|
|
|
19
20
|
export * from './DiskSizeTierSummary.js';
|
|
20
21
|
export * from './DiskTypeSummary.js';
|
|
21
22
|
export * from './EstimateRange.js';
|
|
23
|
+
export * from './ExportInventory400Response.js';
|
|
24
|
+
export * from './ExportInventory500Response.js';
|
|
22
25
|
export * from './ForecastStats.js';
|
|
23
26
|
export * from './ForecasterDatastoresRequest.js';
|
|
24
27
|
export * from './ForecasterPairStatus.js';
|
package/dist/models/index.js
CHANGED
|
@@ -21,6 +21,7 @@ __exportStar(require("./AgentStatus.js"), exports);
|
|
|
21
21
|
__exportStar(require("./ApplicationListResponse.js"), exports);
|
|
22
22
|
__exportStar(require("./ApplicationOverview.js"), exports);
|
|
23
23
|
__exportStar(require("./ApplicationVM.js"), exports);
|
|
24
|
+
__exportStar(require("./BatchUpdateExclusionRequest.js"), exports);
|
|
24
25
|
__exportStar(require("./BenchmarkRun.js"), exports);
|
|
25
26
|
__exportStar(require("./CapabilityStatus.js"), exports);
|
|
26
27
|
__exportStar(require("./CapabilityStatusCapabilities.js"), exports);
|
|
@@ -37,6 +38,8 @@ __exportStar(require("./DeleteLabelGloballyResponse.js"), exports);
|
|
|
37
38
|
__exportStar(require("./DiskSizeTierSummary.js"), exports);
|
|
38
39
|
__exportStar(require("./DiskTypeSummary.js"), exports);
|
|
39
40
|
__exportStar(require("./EstimateRange.js"), exports);
|
|
41
|
+
__exportStar(require("./ExportInventory400Response.js"), exports);
|
|
42
|
+
__exportStar(require("./ExportInventory500Response.js"), exports);
|
|
40
43
|
__exportStar(require("./ForecastStats.js"), exports);
|
|
41
44
|
__exportStar(require("./ForecasterDatastoresRequest.js"), exports);
|
|
42
45
|
__exportStar(require("./ForecasterPairStatus.js"), exports);
|
package/dist/runtime.d.ts
CHANGED
|
@@ -127,6 +127,7 @@ export declare function exists(json: any, key: string): boolean;
|
|
|
127
127
|
export declare function mapValues(data: any, fn: (item: any) => any): {
|
|
128
128
|
[key: string]: any;
|
|
129
129
|
};
|
|
130
|
+
export declare function anyToJSON(value: any): any;
|
|
130
131
|
export declare function canConsumeForm(consumes: Consume[]): boolean;
|
|
131
132
|
export interface Consume {
|
|
132
133
|
contentType: string;
|
package/dist/runtime.js
CHANGED
|
@@ -26,6 +26,7 @@ exports.TextApiResponse = exports.BlobApiResponse = exports.VoidApiResponse = ex
|
|
|
26
26
|
exports.querystring = querystring;
|
|
27
27
|
exports.exists = exists;
|
|
28
28
|
exports.mapValues = mapValues;
|
|
29
|
+
exports.anyToJSON = anyToJSON;
|
|
29
30
|
exports.canConsumeForm = canConsumeForm;
|
|
30
31
|
exports.BASE_PATH = "https://raw.githubusercontent.com/api/v1".replace(/\/+$/, "");
|
|
31
32
|
class Configuration {
|
|
@@ -308,6 +309,10 @@ function mapValues(data, fn) {
|
|
|
308
309
|
}
|
|
309
310
|
return result;
|
|
310
311
|
}
|
|
312
|
+
// Pass-through serializer for `any`-typed properties in form data. See #1877.
|
|
313
|
+
function anyToJSON(value) {
|
|
314
|
+
return value;
|
|
315
|
+
}
|
|
311
316
|
function canConsumeForm(consumes) {
|
|
312
317
|
var _a;
|
|
313
318
|
for (const consume of consumes) {
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
|
|
2
|
+
# BatchUpdateExclusionRequest
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`vmIds` | Array<string>
|
|
10
|
+
`migrationExcluded` | boolean
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { BatchUpdateExclusionRequest } from '@openshift-migration-advisor/agent-sdk'
|
|
16
|
+
|
|
17
|
+
// TODO: Update the object below with actual values
|
|
18
|
+
const example = {
|
|
19
|
+
"vmIds": null,
|
|
20
|
+
"migrationExcluded": null,
|
|
21
|
+
} satisfies BatchUpdateExclusionRequest
|
|
22
|
+
|
|
23
|
+
console.log(example)
|
|
24
|
+
|
|
25
|
+
// Convert the instance to a JSON string
|
|
26
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
27
|
+
console.log(exampleJSON)
|
|
28
|
+
|
|
29
|
+
// Parse the JSON string back to an object
|
|
30
|
+
const exampleParsed = JSON.parse(exampleJSON) as BatchUpdateExclusionRequest
|
|
31
|
+
console.log(exampleParsed)
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
35
|
+
|
|
36
|
+
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
|
|
2
2
|
# CollectorStartRequest
|
|
3
3
|
|
|
4
|
+
Start collection. Credentials are optional if previously stored via PUT /credentials.
|
|
4
5
|
|
|
5
6
|
## Properties
|
|
6
7
|
|
|
@@ -9,8 +10,8 @@ Name | Type
|
|
|
9
10
|
`url` | string
|
|
10
11
|
`username` | string
|
|
11
12
|
`password` | string
|
|
12
|
-
`cacert` | string
|
|
13
13
|
`skipTls` | boolean
|
|
14
|
+
`cacert` | string
|
|
14
15
|
|
|
15
16
|
## Example
|
|
16
17
|
|
|
@@ -22,8 +23,8 @@ const example = {
|
|
|
22
23
|
"url": null,
|
|
23
24
|
"username": null,
|
|
24
25
|
"password": null,
|
|
25
|
-
"cacert": null,
|
|
26
26
|
"skipTls": null,
|
|
27
|
+
"cacert": null,
|
|
27
28
|
} satisfies CollectorStartRequest
|
|
28
29
|
|
|
29
30
|
console.log(example)
|
package/docs/DefaultApi.md
CHANGED
|
@@ -4,11 +4,13 @@ All URIs are relative to *https://raw.githubusercontent.com/api/v1*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
+
| [**batchUpdateVMExclusion**](DefaultApi.md#batchupdatevmexclusion) | **POST** /vms/batch-update-exclusion | Batch update VM exclusion status |
|
|
7
8
|
| [**createGroup**](DefaultApi.md#creategroupoperation) | **POST** /groups | Create a new group |
|
|
8
9
|
| [**deleteCredentials**](DefaultApi.md#deletecredentials) | **DELETE** /credentials | Delete stored credentials |
|
|
9
10
|
| [**deleteForecasterRun**](DefaultApi.md#deleteforecasterrun) | **DELETE** /forecaster/runs/{id} | Delete a benchmark run |
|
|
10
11
|
| [**deleteGroup**](DefaultApi.md#deletegroup) | **DELETE** /groups/{id} | Delete group |
|
|
11
12
|
| [**deleteLabelGlobally**](DefaultApi.md#deletelabelglobally) | **DELETE** /vms/labels/{label} | Delete label from all VMs |
|
|
13
|
+
| [**exportInventory**](DefaultApi.md#exportinventory) | **GET** /export | Export VM inventory and migration planning data |
|
|
12
14
|
| [**getAgentStatus**](DefaultApi.md#getagentstatus) | **GET** /agent | Get agent status |
|
|
13
15
|
| [**getApplications**](DefaultApi.md#getapplications) | **GET** /applications | List detected applications running on VMs |
|
|
14
16
|
| [**getClusterUtilization**](DefaultApi.md#getclusterutilization) | **GET** /clusters/{cluster_id}/utilization | Get latest cluster utilization by cluster ID |
|
|
@@ -57,6 +59,74 @@ All URIs are relative to *https://raw.githubusercontent.com/api/v1*
|
|
|
57
59
|
|
|
58
60
|
|
|
59
61
|
|
|
62
|
+
## batchUpdateVMExclusion
|
|
63
|
+
|
|
64
|
+
> batchUpdateVMExclusion(batchUpdateExclusionRequest)
|
|
65
|
+
|
|
66
|
+
Batch update VM exclusion status
|
|
67
|
+
|
|
68
|
+
### Example
|
|
69
|
+
|
|
70
|
+
```ts
|
|
71
|
+
import {
|
|
72
|
+
Configuration,
|
|
73
|
+
DefaultApi,
|
|
74
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
75
|
+
import type { BatchUpdateVMExclusionRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
76
|
+
|
|
77
|
+
async function example() {
|
|
78
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
79
|
+
const api = new DefaultApi();
|
|
80
|
+
|
|
81
|
+
const body = {
|
|
82
|
+
// BatchUpdateExclusionRequest
|
|
83
|
+
batchUpdateExclusionRequest: ...,
|
|
84
|
+
} satisfies BatchUpdateVMExclusionRequest;
|
|
85
|
+
|
|
86
|
+
try {
|
|
87
|
+
const data = await api.batchUpdateVMExclusion(body);
|
|
88
|
+
console.log(data);
|
|
89
|
+
} catch (error) {
|
|
90
|
+
console.error(error);
|
|
91
|
+
}
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
// Run the test
|
|
95
|
+
example().catch(console.error);
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
### Parameters
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
| Name | Type | Description | Notes |
|
|
102
|
+
|------------- | ------------- | ------------- | -------------|
|
|
103
|
+
| **batchUpdateExclusionRequest** | [BatchUpdateExclusionRequest](BatchUpdateExclusionRequest.md) | | |
|
|
104
|
+
|
|
105
|
+
### Return type
|
|
106
|
+
|
|
107
|
+
`void` (Empty response body)
|
|
108
|
+
|
|
109
|
+
### Authorization
|
|
110
|
+
|
|
111
|
+
No authorization required
|
|
112
|
+
|
|
113
|
+
### HTTP request headers
|
|
114
|
+
|
|
115
|
+
- **Content-Type**: `application/json`
|
|
116
|
+
- **Accept**: Not defined
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
### HTTP response details
|
|
120
|
+
| Status code | Description | Response headers |
|
|
121
|
+
|-------------|-------------|------------------|
|
|
122
|
+
| **200** | All VMs updated successfully | - |
|
|
123
|
+
| **400** | Invalid request | - |
|
|
124
|
+
| **404** | One or more VMs not found | - |
|
|
125
|
+
| **500** | Internal server error | - |
|
|
126
|
+
|
|
127
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
128
|
+
|
|
129
|
+
|
|
60
130
|
## createGroup
|
|
61
131
|
|
|
62
132
|
> Group createGroup(createGroupRequest)
|
|
@@ -385,6 +455,75 @@ No authorization required
|
|
|
385
455
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
386
456
|
|
|
387
457
|
|
|
458
|
+
## exportInventory
|
|
459
|
+
|
|
460
|
+
> Blob exportInventory(scope)
|
|
461
|
+
|
|
462
|
+
Export VM inventory and migration planning data
|
|
463
|
+
|
|
464
|
+
Exports selected data scopes as CSV files packaged in a ZIP archive. Supports flexible scope selection for offline analysis in Excel or custom tools.
|
|
465
|
+
|
|
466
|
+
### Example
|
|
467
|
+
|
|
468
|
+
```ts
|
|
469
|
+
import {
|
|
470
|
+
Configuration,
|
|
471
|
+
DefaultApi,
|
|
472
|
+
} from '@openshift-migration-advisor/agent-sdk';
|
|
473
|
+
import type { ExportInventoryRequest } from '@openshift-migration-advisor/agent-sdk';
|
|
474
|
+
|
|
475
|
+
async function example() {
|
|
476
|
+
console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
|
|
477
|
+
const api = new DefaultApi();
|
|
478
|
+
|
|
479
|
+
const body = {
|
|
480
|
+
// string | Comma-separated list of scopes to export (default: overview). Available scopes: overview, hosts, clusters, datastores, vms, network, utilization, storage-forecast, applications, groups, inspection (optional)
|
|
481
|
+
scope: overview,hosts,vms,
|
|
482
|
+
} satisfies ExportInventoryRequest;
|
|
483
|
+
|
|
484
|
+
try {
|
|
485
|
+
const data = await api.exportInventory(body);
|
|
486
|
+
console.log(data);
|
|
487
|
+
} catch (error) {
|
|
488
|
+
console.error(error);
|
|
489
|
+
}
|
|
490
|
+
}
|
|
491
|
+
|
|
492
|
+
// Run the test
|
|
493
|
+
example().catch(console.error);
|
|
494
|
+
```
|
|
495
|
+
|
|
496
|
+
### Parameters
|
|
497
|
+
|
|
498
|
+
|
|
499
|
+
| Name | Type | Description | Notes |
|
|
500
|
+
|------------- | ------------- | ------------- | -------------|
|
|
501
|
+
| **scope** | `string` | Comma-separated list of scopes to export (default: overview). Available scopes: overview, hosts, clusters, datastores, vms, network, utilization, storage-forecast, applications, groups, inspection | [Optional] [Defaults to `undefined`] |
|
|
502
|
+
|
|
503
|
+
### Return type
|
|
504
|
+
|
|
505
|
+
**Blob**
|
|
506
|
+
|
|
507
|
+
### Authorization
|
|
508
|
+
|
|
509
|
+
No authorization required
|
|
510
|
+
|
|
511
|
+
### HTTP request headers
|
|
512
|
+
|
|
513
|
+
- **Content-Type**: Not defined
|
|
514
|
+
- **Accept**: `application/zip`, `application/json`
|
|
515
|
+
|
|
516
|
+
|
|
517
|
+
### HTTP response details
|
|
518
|
+
| Status code | Description | Response headers |
|
|
519
|
+
|-------------|-------------|------------------|
|
|
520
|
+
| **200** | ZIP archive containing CSV files for requested scopes | - |
|
|
521
|
+
| **400** | Invalid scope name | - |
|
|
522
|
+
| **500** | Internal server error | - |
|
|
523
|
+
|
|
524
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
525
|
+
|
|
526
|
+
|
|
388
527
|
## getAgentStatus
|
|
389
528
|
|
|
390
529
|
> AgentStatus getAgentStatus()
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# ExportInventory400Response
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`error` | string
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { ExportInventory400Response } from '@openshift-migration-advisor/agent-sdk'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"error": invalid scope: unknown,
|
|
19
|
+
} satisfies ExportInventory400Response
|
|
20
|
+
|
|
21
|
+
console.log(example)
|
|
22
|
+
|
|
23
|
+
// Convert the instance to a JSON string
|
|
24
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
25
|
+
console.log(exampleJSON)
|
|
26
|
+
|
|
27
|
+
// Parse the JSON string back to an object
|
|
28
|
+
const exampleParsed = JSON.parse(exampleJSON) as ExportInventory400Response
|
|
29
|
+
console.log(exampleParsed)
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
33
|
+
|
|
34
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# ExportInventory500Response
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`error` | string
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { ExportInventory500Response } from '@openshift-migration-advisor/agent-sdk'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"error": null,
|
|
19
|
+
} satisfies ExportInventory500Response
|
|
20
|
+
|
|
21
|
+
console.log(example)
|
|
22
|
+
|
|
23
|
+
// Convert the instance to a JSON string
|
|
24
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
25
|
+
console.log(exampleJSON)
|
|
26
|
+
|
|
27
|
+
// Parse the JSON string back to an object
|
|
28
|
+
const exampleParsed = JSON.parse(exampleJSON) as ExportInventory500Response
|
|
29
|
+
console.log(exampleParsed)
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
33
|
+
|
|
34
|
+
|
package/docs/OsInfo.md
CHANGED
|
@@ -8,6 +8,7 @@ Name | Type
|
|
|
8
8
|
------------ | -------------
|
|
9
9
|
`count` | number
|
|
10
10
|
`supported` | boolean
|
|
11
|
+
`supportTier` | string
|
|
11
12
|
`upgradeRecommendation` | string
|
|
12
13
|
|
|
13
14
|
## Example
|
|
@@ -19,6 +20,7 @@ import type { OsInfo } from '@openshift-migration-advisor/agent-sdk'
|
|
|
19
20
|
const example = {
|
|
20
21
|
"count": null,
|
|
21
22
|
"supported": null,
|
|
23
|
+
"supportTier": null,
|
|
22
24
|
"upgradeRecommendation": null,
|
|
23
25
|
} satisfies OsInfo
|
|
24
26
|
|
package/package.json
CHANGED