@xen-orchestra/rest-api 0.9.0 → 0.10.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.
@@ -323,6 +323,60 @@
323
323
  }
324
324
  ]
325
325
  },
326
+ "vmsStatus": {
327
+ "properties": {
328
+ "total": {
329
+ "type": "number",
330
+ "format": "double"
331
+ },
332
+ "unknown": {
333
+ "type": "number",
334
+ "format": "double"
335
+ },
336
+ "inactive": {
337
+ "type": "number",
338
+ "format": "double"
339
+ },
340
+ "active": {
341
+ "type": "number",
342
+ "format": "double"
343
+ }
344
+ },
345
+ "required": [
346
+ "total",
347
+ "unknown",
348
+ "inactive",
349
+ "active"
350
+ ],
351
+ "type": "object"
352
+ },
353
+ "hostsStatus": {
354
+ "properties": {
355
+ "total": {
356
+ "type": "number",
357
+ "format": "double"
358
+ },
359
+ "unknown": {
360
+ "type": "number",
361
+ "format": "double"
362
+ },
363
+ "halted": {
364
+ "type": "number",
365
+ "format": "double"
366
+ },
367
+ "running": {
368
+ "type": "number",
369
+ "format": "double"
370
+ }
371
+ },
372
+ "required": [
373
+ "total",
374
+ "unknown",
375
+ "halted",
376
+ "running"
377
+ ],
378
+ "type": "object"
379
+ },
326
380
  "nHostsEol": {
327
381
  "type": "number",
328
382
  "format": "double"
@@ -341,6 +395,8 @@
341
395
  "resourcesOverview",
342
396
  "storageRepositories",
343
397
  "missingPatches",
398
+ "vmsStatus",
399
+ "hostsStatus",
344
400
  "nHosts",
345
401
  "nPools"
346
402
  ],
@@ -4077,6 +4133,9 @@
4077
4133
  "parent": {
4078
4134
  "type": "string"
4079
4135
  },
4136
+ "image_format": {
4137
+ "type": "string"
4138
+ },
4080
4139
  "size": {
4081
4140
  "type": "number",
4082
4141
  "format": "double"
@@ -4195,6 +4254,9 @@
4195
4254
  "parent": {
4196
4255
  "type": "string"
4197
4256
  },
4257
+ "image_format": {
4258
+ "type": "string"
4259
+ },
4198
4260
  "size": {
4199
4261
  "type": "number",
4200
4262
  "format": "double"
@@ -4296,6 +4358,9 @@
4296
4358
  "parent": {
4297
4359
  "type": "string"
4298
4360
  },
4361
+ "image_format": {
4362
+ "type": "string"
4363
+ },
4299
4364
  "size": {
4300
4365
  "type": "number",
4301
4366
  "format": "double"
@@ -4421,6 +4486,9 @@
4421
4486
  "parent": {
4422
4487
  "type": "string"
4423
4488
  },
4489
+ "image_format": {
4490
+ "type": "string"
4491
+ },
4424
4492
  "size": {
4425
4493
  "type": "number",
4426
4494
  "format": "double"
@@ -5009,6 +5077,187 @@
5009
5077
  ],
5010
5078
  "type": "object"
5011
5079
  },
5080
+ "Record_string.number_": {
5081
+ "properties": {},
5082
+ "type": "object",
5083
+ "description": "Construct a type with a set of properties K of type T"
5084
+ },
5085
+ "Partial_Unbrand_XoSm__": {
5086
+ "properties": {
5087
+ "$pool": {
5088
+ "type": "string"
5089
+ },
5090
+ "$poolId": {
5091
+ "type": "string",
5092
+ "deprecated": true
5093
+ },
5094
+ "_xapiRef": {
5095
+ "type": "string"
5096
+ },
5097
+ "uuid": {
5098
+ "type": "string"
5099
+ },
5100
+ "id": {
5101
+ "type": "string"
5102
+ },
5103
+ "SM_type": {
5104
+ "type": "string"
5105
+ },
5106
+ "vendor": {
5107
+ "type": "string"
5108
+ },
5109
+ "name_label": {
5110
+ "type": "string"
5111
+ },
5112
+ "name_description": {
5113
+ "type": "string"
5114
+ },
5115
+ "configuration": {
5116
+ "$ref": "#/components/schemas/Record_string.string_"
5117
+ },
5118
+ "features": {
5119
+ "$ref": "#/components/schemas/Record_string.number_"
5120
+ },
5121
+ "driver_filename": {
5122
+ "type": "string"
5123
+ },
5124
+ "required_cluster_stack": {
5125
+ "items": {
5126
+ "type": "string"
5127
+ },
5128
+ "type": "array"
5129
+ },
5130
+ "supported_image_formats": {
5131
+ "items": {
5132
+ "type": "string"
5133
+ },
5134
+ "type": "array"
5135
+ },
5136
+ "type": {
5137
+ "type": "string",
5138
+ "enum": [
5139
+ "SM"
5140
+ ]
5141
+ }
5142
+ },
5143
+ "type": "object",
5144
+ "description": "Make all properties in T optional"
5145
+ },
5146
+ "WithHref_Partial_Unbrand_XoSm___": {
5147
+ "allOf": [
5148
+ {
5149
+ "$ref": "#/components/schemas/Partial_Unbrand_XoSm__"
5150
+ },
5151
+ {
5152
+ "properties": {
5153
+ "href": {
5154
+ "type": "string"
5155
+ }
5156
+ },
5157
+ "required": [
5158
+ "href"
5159
+ ],
5160
+ "type": "object"
5161
+ }
5162
+ ]
5163
+ },
5164
+ "SendObjects_Partial_Unbrand_XoSm___": {
5165
+ "anyOf": [
5166
+ {
5167
+ "items": {
5168
+ "type": "string"
5169
+ },
5170
+ "type": "array"
5171
+ },
5172
+ {
5173
+ "items": {
5174
+ "$ref": "#/components/schemas/WithHref_Partial_Unbrand_XoSm___"
5175
+ },
5176
+ "type": "array"
5177
+ },
5178
+ {
5179
+ "$ref": "#/components/schemas/NdjsonStream"
5180
+ }
5181
+ ]
5182
+ },
5183
+ "Unbrand_XoSm_": {
5184
+ "properties": {
5185
+ "$pool": {
5186
+ "type": "string"
5187
+ },
5188
+ "$poolId": {
5189
+ "type": "string",
5190
+ "deprecated": true
5191
+ },
5192
+ "_xapiRef": {
5193
+ "type": "string"
5194
+ },
5195
+ "uuid": {
5196
+ "type": "string"
5197
+ },
5198
+ "id": {
5199
+ "type": "string"
5200
+ },
5201
+ "SM_type": {
5202
+ "type": "string"
5203
+ },
5204
+ "vendor": {
5205
+ "type": "string"
5206
+ },
5207
+ "name_label": {
5208
+ "type": "string"
5209
+ },
5210
+ "name_description": {
5211
+ "type": "string"
5212
+ },
5213
+ "configuration": {
5214
+ "$ref": "#/components/schemas/Record_string.string_"
5215
+ },
5216
+ "features": {
5217
+ "$ref": "#/components/schemas/Record_string.number_"
5218
+ },
5219
+ "driver_filename": {
5220
+ "type": "string"
5221
+ },
5222
+ "required_cluster_stack": {
5223
+ "items": {
5224
+ "type": "string"
5225
+ },
5226
+ "type": "array"
5227
+ },
5228
+ "supported_image_formats": {
5229
+ "items": {
5230
+ "type": "string"
5231
+ },
5232
+ "type": "array"
5233
+ },
5234
+ "type": {
5235
+ "type": "string",
5236
+ "enum": [
5237
+ "SM"
5238
+ ],
5239
+ "nullable": false
5240
+ }
5241
+ },
5242
+ "required": [
5243
+ "$pool",
5244
+ "$poolId",
5245
+ "_xapiRef",
5246
+ "uuid",
5247
+ "id",
5248
+ "SM_type",
5249
+ "vendor",
5250
+ "name_label",
5251
+ "name_description",
5252
+ "configuration",
5253
+ "features",
5254
+ "driver_filename",
5255
+ "required_cluster_stack",
5256
+ "supported_image_formats",
5257
+ "type"
5258
+ ],
5259
+ "type": "object"
5260
+ },
5012
5261
  "Record_string.unknown_": {
5013
5262
  "properties": {},
5014
5263
  "type": "object",
@@ -5582,63 +5831,256 @@
5582
5831
  "type": "object",
5583
5832
  "additionalProperties": false
5584
5833
  },
5585
- "Branded_PIF_": {
5586
- "allOf": [
5587
- {
5588
- "type": "string"
5589
- },
5590
- {
5591
- "properties": {
5592
- "undefined": {
5593
- "type": "string",
5594
- "enum": [
5595
- "PIF"
5596
- ],
5597
- "nullable": false
5598
- }
5599
- },
5600
- "required": [
5601
- null
5602
- ],
5603
- "type": "object"
5604
- }
5605
- ]
5606
- },
5607
- "IPV6_CONFIGURATION_MODE": {
5608
- "type": "string",
5609
- "enum": [
5610
- "DHCP",
5611
- "Autoconf",
5612
- "None",
5613
- "Static"
5614
- ]
5615
- },
5616
- "IP_CONFIGURATION_MODE": {
5617
- "type": "string",
5618
- "enum": [
5619
- "DHCP",
5620
- "None",
5621
- "Static"
5622
- ]
5623
- },
5624
- "PRIMARY_ADDRESS_TYPE": {
5625
- "type": "string",
5626
- "enum": [
5627
- "IPv4",
5628
- "IPv6"
5629
- ]
5630
- },
5631
- "Partial_UnbrandedXoPif_": {
5834
+ "Unbrand_CreateVmBody_": {
5632
5835
  "properties": {
5633
- "$pool": {
5836
+ "name_label": {
5634
5837
  "type": "string"
5635
5838
  },
5636
- "$poolId": {
5637
- "type": "string",
5638
- "deprecated": true
5839
+ "clone": {
5840
+ "type": "boolean"
5639
5841
  },
5640
- "_xapiRef": {
5641
- "type": "string"
5842
+ "vifs": {
5843
+ "items": {
5844
+ "anyOf": [
5845
+ {
5846
+ "properties": {
5847
+ "network": {
5848
+ "type": "string"
5849
+ },
5850
+ "mtu": {
5851
+ "type": "number",
5852
+ "format": "double"
5853
+ },
5854
+ "mac": {
5855
+ "type": "string"
5856
+ },
5857
+ "ipv6_allowed": {
5858
+ "items": {
5859
+ "type": "string"
5860
+ },
5861
+ "type": "array"
5862
+ },
5863
+ "ipv4_allowed": {
5864
+ "items": {
5865
+ "type": "string"
5866
+ },
5867
+ "type": "array"
5868
+ },
5869
+ "device": {
5870
+ "type": "string"
5871
+ }
5872
+ },
5873
+ "required": [
5874
+ "network"
5875
+ ],
5876
+ "type": "object"
5877
+ },
5878
+ {
5879
+ "properties": {
5880
+ "device": {
5881
+ "type": "string"
5882
+ },
5883
+ "destroy": {
5884
+ "type": "boolean",
5885
+ "enum": [
5886
+ true
5887
+ ],
5888
+ "nullable": false
5889
+ }
5890
+ },
5891
+ "required": [
5892
+ "device",
5893
+ "destroy"
5894
+ ],
5895
+ "type": "object"
5896
+ }
5897
+ ]
5898
+ },
5899
+ "type": "array"
5900
+ },
5901
+ "vgpuType": {
5902
+ "type": "string"
5903
+ },
5904
+ "gpuGroup": {
5905
+ "type": "string"
5906
+ },
5907
+ "copyHostBiosStrings": {
5908
+ "type": "boolean"
5909
+ },
5910
+ "template": {
5911
+ "type": "string",
5912
+ "description": "template UUID"
5913
+ },
5914
+ "affinity": {
5915
+ "type": "string"
5916
+ },
5917
+ "vdis": {
5918
+ "items": {
5919
+ "anyOf": [
5920
+ {
5921
+ "properties": {
5922
+ "name_description": {
5923
+ "type": "string"
5924
+ },
5925
+ "sr": {
5926
+ "type": "string"
5927
+ },
5928
+ "size": {
5929
+ "type": "number",
5930
+ "format": "double"
5931
+ },
5932
+ "name_label": {
5933
+ "type": "string"
5934
+ }
5935
+ },
5936
+ "required": [
5937
+ "size",
5938
+ "name_label"
5939
+ ],
5940
+ "type": "object"
5941
+ },
5942
+ {
5943
+ "properties": {
5944
+ "name_description": {
5945
+ "type": "string"
5946
+ },
5947
+ "sr": {
5948
+ "type": "string"
5949
+ },
5950
+ "size": {
5951
+ "type": "number",
5952
+ "format": "double"
5953
+ },
5954
+ "name_label": {
5955
+ "type": "string"
5956
+ },
5957
+ "userdevice": {
5958
+ "type": "string"
5959
+ }
5960
+ },
5961
+ "required": [
5962
+ "userdevice"
5963
+ ],
5964
+ "type": "object"
5965
+ },
5966
+ {
5967
+ "properties": {
5968
+ "userdervice": {
5969
+ "type": "string"
5970
+ },
5971
+ "destroy": {
5972
+ "type": "boolean",
5973
+ "enum": [
5974
+ true
5975
+ ],
5976
+ "nullable": false
5977
+ }
5978
+ },
5979
+ "required": [
5980
+ "userdervice",
5981
+ "destroy"
5982
+ ],
5983
+ "type": "object"
5984
+ }
5985
+ ]
5986
+ },
5987
+ "type": "array"
5988
+ },
5989
+ "install": {
5990
+ "properties": {
5991
+ "repository": {
5992
+ "type": "string"
5993
+ },
5994
+ "method": {
5995
+ "type": "string",
5996
+ "enum": [
5997
+ "network",
5998
+ "cdrom"
5999
+ ]
6000
+ }
6001
+ },
6002
+ "required": [
6003
+ "repository",
6004
+ "method"
6005
+ ],
6006
+ "type": "object"
6007
+ },
6008
+ "cloud_config": {
6009
+ "type": "string"
6010
+ },
6011
+ "network_config": {
6012
+ "type": "string"
6013
+ },
6014
+ "boot": {
6015
+ "type": "boolean"
6016
+ },
6017
+ "destroy_cloud_config_vdi": {
6018
+ "type": "boolean"
6019
+ }
6020
+ },
6021
+ "required": [
6022
+ "name_label",
6023
+ "template"
6024
+ ],
6025
+ "type": "object"
6026
+ },
6027
+ "Branded_PIF_": {
6028
+ "allOf": [
6029
+ {
6030
+ "type": "string"
6031
+ },
6032
+ {
6033
+ "properties": {
6034
+ "undefined": {
6035
+ "type": "string",
6036
+ "enum": [
6037
+ "PIF"
6038
+ ],
6039
+ "nullable": false
6040
+ }
6041
+ },
6042
+ "required": [
6043
+ null
6044
+ ],
6045
+ "type": "object"
6046
+ }
6047
+ ]
6048
+ },
6049
+ "IPV6_CONFIGURATION_MODE": {
6050
+ "type": "string",
6051
+ "enum": [
6052
+ "DHCP",
6053
+ "Autoconf",
6054
+ "None",
6055
+ "Static"
6056
+ ]
6057
+ },
6058
+ "IP_CONFIGURATION_MODE": {
6059
+ "type": "string",
6060
+ "enum": [
6061
+ "DHCP",
6062
+ "None",
6063
+ "Static"
6064
+ ]
6065
+ },
6066
+ "PRIMARY_ADDRESS_TYPE": {
6067
+ "type": "string",
6068
+ "enum": [
6069
+ "IPv4",
6070
+ "IPv6"
6071
+ ]
6072
+ },
6073
+ "Partial_UnbrandedXoPif_": {
6074
+ "properties": {
6075
+ "$pool": {
6076
+ "type": "string"
6077
+ },
6078
+ "$poolId": {
6079
+ "type": "string",
6080
+ "deprecated": true
6081
+ },
6082
+ "_xapiRef": {
6083
+ "type": "string"
5642
6084
  },
5643
6085
  "uuid": {
5644
6086
  "type": "string"
@@ -6539,20 +6981,21 @@
6539
6981
  "VM",
6540
6982
  "VM-snapshot",
6541
6983
  "SR",
6542
- "vgpu",
6543
- "message",
6544
- "gpuGroup",
6545
- "network",
6546
- "PCI",
6547
- "PGPU",
6548
- "PIF",
6984
+ "VM-template",
6549
6985
  "VDI",
6550
- "VDI-snapshot",
6986
+ "VM-controller",
6987
+ "network",
6551
6988
  "VDI-unmanaged",
6989
+ "VDI-snapshot",
6990
+ "unknown",
6991
+ "SM",
6552
6992
  "vgpuType",
6553
- "VM-controller",
6554
- "VM-template",
6555
- "unknown"
6993
+ "gpuGroup",
6994
+ "PIF",
6995
+ "PGPU",
6996
+ "PCI",
6997
+ "message",
6998
+ "vgpu"
6556
6999
  ]
6557
7000
  }
6558
7001
  },
@@ -6669,20 +7112,21 @@
6669
7112
  "VM",
6670
7113
  "VM-snapshot",
6671
7114
  "SR",
6672
- "vgpu",
6673
- "message",
6674
- "gpuGroup",
6675
- "network",
6676
- "PCI",
6677
- "PGPU",
6678
- "PIF",
7115
+ "VM-template",
6679
7116
  "VDI",
6680
- "VDI-snapshot",
7117
+ "VM-controller",
7118
+ "network",
6681
7119
  "VDI-unmanaged",
7120
+ "VDI-snapshot",
7121
+ "unknown",
7122
+ "SM",
6682
7123
  "vgpuType",
6683
- "VM-controller",
6684
- "VM-template",
6685
- "unknown"
7124
+ "gpuGroup",
7125
+ "PIF",
7126
+ "PGPU",
7127
+ "PCI",
7128
+ "message",
7129
+ "vgpu"
6686
7130
  ]
6687
7131
  }
6688
7132
  },
@@ -7820,7 +8264,7 @@
7820
8264
  },
7821
8265
  "info": {
7822
8266
  "title": "@xen-orchestra/rest-api",
7823
- "version": "0.9.0",
8267
+ "version": "0.10.0",
7824
8268
  "description": "REST API to manage your XOA",
7825
8269
  "license": {
7826
8270
  "name": "AGPL-3.0-or-later"
@@ -7830,6 +8274,11 @@
7830
8274
  "url": "https://vates.fr"
7831
8275
  }
7832
8276
  },
8277
+ "servers": [
8278
+ {
8279
+ "url": "/rest/v0"
8280
+ }
8281
+ ],
7833
8282
  "paths": {
7834
8283
  "/dashboard": {
7835
8284
  "get": {
@@ -7922,7 +8371,16 @@
7922
8371
  "*": []
7923
8372
  }
7924
8373
  ],
7925
- "parameters": []
8374
+ "parameters": [
8375
+ {
8376
+ "in": "query",
8377
+ "name": "ndjson",
8378
+ "required": false,
8379
+ "schema": {
8380
+ "type": "boolean"
8381
+ }
8382
+ }
8383
+ ]
7926
8384
  }
7927
8385
  },
7928
8386
  "/vms": {
@@ -9551,7 +10009,14 @@
9551
10009
  "description": "Action executed asynchronously",
9552
10010
  "content": {
9553
10011
  "text/plain": {
9554
- "schema": {},
10012
+ "schema": {
10013
+ "anyOf": [
10014
+ {
10015
+ "type": "string"
10016
+ },
10017
+ {}
10018
+ ]
10019
+ },
9555
10020
  "examples": {
9556
10021
  "Example 1": {
9557
10022
  "value": "/rest/v0/tasks/0m7kl0j9l"
@@ -9573,6 +10038,7 @@
9573
10038
  "description": "Internal server error, XenServer/XCP-ng error"
9574
10039
  }
9575
10040
  },
10041
+ "description": "The VM must be halted",
9576
10042
  "tags": [
9577
10043
  "vms"
9578
10044
  ],
@@ -9599,12 +10065,30 @@
9599
10065
  "type": "boolean"
9600
10066
  }
9601
10067
  }
9602
- ]
9603
- }
9604
- },
9605
- "/vms/{id}/actions/clean_shutdown": {
9606
- "post": {
9607
- "operationId": "CleanShutdownVm",
10068
+ ],
10069
+ "requestBody": {
10070
+ "required": false,
10071
+ "content": {
10072
+ "application/json": {
10073
+ "schema": {
10074
+ "properties": {
10075
+ "hostId": {
10076
+ "type": "string"
10077
+ }
10078
+ },
10079
+ "type": "object"
10080
+ },
10081
+ "example": {
10082
+ "hostId": "b61a5c92-700e-4966-a13b-00633f03eea8"
10083
+ }
10084
+ }
10085
+ }
10086
+ }
10087
+ }
10088
+ },
10089
+ "/vms/{id}/actions/clean_shutdown": {
10090
+ "post": {
10091
+ "operationId": "CleanShutdownVm",
9608
10092
  "responses": {
9609
10093
  "202": {
9610
10094
  "description": "Action executed asynchronously",
@@ -9859,6 +10343,274 @@
9859
10343
  ]
9860
10344
  }
9861
10345
  },
10346
+ "/vms/{id}/actions/pause": {
10347
+ "post": {
10348
+ "operationId": "PauseVm",
10349
+ "responses": {
10350
+ "202": {
10351
+ "description": "Action executed asynchronously",
10352
+ "content": {
10353
+ "text/plain": {
10354
+ "schema": {
10355
+ "anyOf": [
10356
+ {},
10357
+ {
10358
+ "type": "string"
10359
+ }
10360
+ ]
10361
+ },
10362
+ "examples": {
10363
+ "Example 1": {
10364
+ "value": "/rest/v0/tasks/0m7kl0j9l"
10365
+ }
10366
+ }
10367
+ }
10368
+ }
10369
+ },
10370
+ "204": {
10371
+ "description": "No content"
10372
+ },
10373
+ "401": {
10374
+ "description": "Authentication required"
10375
+ },
10376
+ "404": {
10377
+ "description": "Resource not found"
10378
+ },
10379
+ "500": {
10380
+ "description": "Internal server error, XenServer/XCP-ng error"
10381
+ }
10382
+ },
10383
+ "description": "The VM must be running",
10384
+ "tags": [
10385
+ "vms"
10386
+ ],
10387
+ "security": [
10388
+ {
10389
+ "*": []
10390
+ }
10391
+ ],
10392
+ "parameters": [
10393
+ {
10394
+ "in": "path",
10395
+ "name": "id",
10396
+ "required": true,
10397
+ "schema": {
10398
+ "type": "string"
10399
+ },
10400
+ "example": "f07ab729-c0e8-721c-45ec-f11276377030"
10401
+ },
10402
+ {
10403
+ "in": "query",
10404
+ "name": "sync",
10405
+ "required": false,
10406
+ "schema": {
10407
+ "type": "boolean"
10408
+ }
10409
+ }
10410
+ ]
10411
+ }
10412
+ },
10413
+ "/vms/{id}/actions/suspend": {
10414
+ "post": {
10415
+ "operationId": "SuspendVm",
10416
+ "responses": {
10417
+ "202": {
10418
+ "description": "Action executed asynchronously",
10419
+ "content": {
10420
+ "text/plain": {
10421
+ "schema": {
10422
+ "anyOf": [
10423
+ {},
10424
+ {
10425
+ "type": "string"
10426
+ }
10427
+ ]
10428
+ },
10429
+ "examples": {
10430
+ "Example 1": {
10431
+ "value": "/rest/v0/tasks/0m7kl0j9l"
10432
+ }
10433
+ }
10434
+ }
10435
+ }
10436
+ },
10437
+ "204": {
10438
+ "description": "No content"
10439
+ },
10440
+ "401": {
10441
+ "description": "Authentication required"
10442
+ },
10443
+ "404": {
10444
+ "description": "Resource not found"
10445
+ },
10446
+ "500": {
10447
+ "description": "Internal server error, XenServer/XCP-ng error"
10448
+ }
10449
+ },
10450
+ "description": "The VM must be running",
10451
+ "tags": [
10452
+ "vms"
10453
+ ],
10454
+ "security": [
10455
+ {
10456
+ "*": []
10457
+ }
10458
+ ],
10459
+ "parameters": [
10460
+ {
10461
+ "in": "path",
10462
+ "name": "id",
10463
+ "required": true,
10464
+ "schema": {
10465
+ "type": "string"
10466
+ },
10467
+ "example": "f07ab729-c0e8-721c-45ec-f11276377030"
10468
+ },
10469
+ {
10470
+ "in": "query",
10471
+ "name": "sync",
10472
+ "required": false,
10473
+ "schema": {
10474
+ "type": "boolean"
10475
+ }
10476
+ }
10477
+ ]
10478
+ }
10479
+ },
10480
+ "/vms/{id}/actions/resume": {
10481
+ "post": {
10482
+ "operationId": "ResumeVm",
10483
+ "responses": {
10484
+ "202": {
10485
+ "description": "Action executed asynchronously",
10486
+ "content": {
10487
+ "text/plain": {
10488
+ "schema": {
10489
+ "anyOf": [
10490
+ {},
10491
+ {
10492
+ "type": "string"
10493
+ }
10494
+ ]
10495
+ },
10496
+ "examples": {
10497
+ "Example 1": {
10498
+ "value": "/rest/v0/tasks/0m7kl0j9l"
10499
+ }
10500
+ }
10501
+ }
10502
+ }
10503
+ },
10504
+ "204": {
10505
+ "description": "No content"
10506
+ },
10507
+ "401": {
10508
+ "description": "Authentication required"
10509
+ },
10510
+ "404": {
10511
+ "description": "Resource not found"
10512
+ },
10513
+ "500": {
10514
+ "description": "Internal server error, XenServer/XCP-ng error"
10515
+ }
10516
+ },
10517
+ "description": "The VM must be suspended",
10518
+ "tags": [
10519
+ "vms"
10520
+ ],
10521
+ "security": [
10522
+ {
10523
+ "*": []
10524
+ }
10525
+ ],
10526
+ "parameters": [
10527
+ {
10528
+ "in": "path",
10529
+ "name": "id",
10530
+ "required": true,
10531
+ "schema": {
10532
+ "type": "string"
10533
+ },
10534
+ "example": "f07ab729-c0e8-721c-45ec-f11276377030"
10535
+ },
10536
+ {
10537
+ "in": "query",
10538
+ "name": "sync",
10539
+ "required": false,
10540
+ "schema": {
10541
+ "type": "boolean"
10542
+ }
10543
+ }
10544
+ ]
10545
+ }
10546
+ },
10547
+ "/vms/{id}/actions/unpause": {
10548
+ "post": {
10549
+ "operationId": "UnpauseVm",
10550
+ "responses": {
10551
+ "202": {
10552
+ "description": "Action executed asynchronously",
10553
+ "content": {
10554
+ "text/plain": {
10555
+ "schema": {
10556
+ "anyOf": [
10557
+ {},
10558
+ {
10559
+ "type": "string"
10560
+ }
10561
+ ]
10562
+ },
10563
+ "examples": {
10564
+ "Example 1": {
10565
+ "value": "/rest/v0/tasks/0m7kl0j9l"
10566
+ }
10567
+ }
10568
+ }
10569
+ }
10570
+ },
10571
+ "204": {
10572
+ "description": "No content"
10573
+ },
10574
+ "401": {
10575
+ "description": "Authentication required"
10576
+ },
10577
+ "404": {
10578
+ "description": "Resource not found"
10579
+ },
10580
+ "500": {
10581
+ "description": "Internal server error, XenServer/XCP-ng error"
10582
+ }
10583
+ },
10584
+ "description": "The VM must be paused",
10585
+ "tags": [
10586
+ "vms"
10587
+ ],
10588
+ "security": [
10589
+ {
10590
+ "*": []
10591
+ }
10592
+ ],
10593
+ "parameters": [
10594
+ {
10595
+ "in": "path",
10596
+ "name": "id",
10597
+ "required": true,
10598
+ "schema": {
10599
+ "type": "string"
10600
+ },
10601
+ "example": "f07ab729-c0e8-721c-45ec-f11276377030"
10602
+ },
10603
+ {
10604
+ "in": "query",
10605
+ "name": "sync",
10606
+ "required": false,
10607
+ "schema": {
10608
+ "type": "boolean"
10609
+ }
10610
+ }
10611
+ ]
10612
+ }
10613
+ },
9862
10614
  "/vms/{id}/actions/snapshot": {
9863
10615
  "post": {
9864
10616
  "operationId": "SnapshotVm",
@@ -11492,7 +12244,208 @@
11492
12244
  }
11493
12245
  },
11494
12246
  "tags": [
11495
- "users"
12247
+ "users"
12248
+ ],
12249
+ "security": [
12250
+ {
12251
+ "*": []
12252
+ }
12253
+ ],
12254
+ "parameters": [
12255
+ {
12256
+ "in": "path",
12257
+ "name": "id",
12258
+ "required": true,
12259
+ "schema": {
12260
+ "type": "string"
12261
+ },
12262
+ "example": "722d17b9-699b-49d2-8193-be1ac573d3de"
12263
+ }
12264
+ ]
12265
+ }
12266
+ },
12267
+ "/srs": {
12268
+ "get": {
12269
+ "operationId": "GetSrs",
12270
+ "responses": {
12271
+ "200": {
12272
+ "description": "Ok",
12273
+ "content": {
12274
+ "application/json": {
12275
+ "schema": {
12276
+ "$ref": "#/components/schemas/SendObjects_Partial_Unbrand_XoSr___"
12277
+ },
12278
+ "examples": {
12279
+ "Example 1": {
12280
+ "value": [
12281
+ "/rest/v0/srs/e46e7ea5-1bbe-e499-69a5-6bfb395eb146",
12282
+ "/rest/v0/srs/3d1227f3-7d40-a104-efc6-fb797b58f258"
12283
+ ]
12284
+ },
12285
+ "Example 2": {
12286
+ "value": [
12287
+ {
12288
+ "uuid": "4cb0d74e-a7c1-0b7d-46e3-09382c012abb",
12289
+ "name_label": "Local storage",
12290
+ "allocationStrategy": "thin",
12291
+ "href": "/rest/v0/srs/4cb0d74e-a7c1-0b7d-46e3-09382c012abb"
12292
+ },
12293
+ {
12294
+ "uuid": "c4284e12-37c9-7967-b9e8-83ef229c3e03",
12295
+ "name_label": "Local storage",
12296
+ "allocationStrategy": "thin",
12297
+ "href": "/rest/v0/srs/c4284e12-37c9-7967-b9e8-83ef229c3e03"
12298
+ },
12299
+ {
12300
+ "uuid": "8aa2fb4a-143e-c2bc-05d4-c68bbb101d41",
12301
+ "name_label": "Local storage",
12302
+ "allocationStrategy": "thin",
12303
+ "href": "/rest/v0/srs/8aa2fb4a-143e-c2bc-05d4-c68bbb101d41"
12304
+ },
12305
+ {
12306
+ "uuid": "c787b75c-3e0d-70fa-d0c3-cbfd382d7e33",
12307
+ "name_label": "XOSTOR NVME",
12308
+ "allocationStrategy": "thin",
12309
+ "href": "/rest/v0/srs/c787b75c-3e0d-70fa-d0c3-cbfd382d7e33"
12310
+ }
12311
+ ]
12312
+ }
12313
+ }
12314
+ }
12315
+ }
12316
+ },
12317
+ "401": {
12318
+ "description": "Authentication required"
12319
+ }
12320
+ },
12321
+ "tags": [
12322
+ "srs"
12323
+ ],
12324
+ "security": [
12325
+ {
12326
+ "*": []
12327
+ }
12328
+ ],
12329
+ "parameters": [
12330
+ {
12331
+ "in": "query",
12332
+ "name": "fields",
12333
+ "required": false,
12334
+ "schema": {
12335
+ "type": "string"
12336
+ },
12337
+ "example": "uuid,name_label,allocationStrategy"
12338
+ },
12339
+ {
12340
+ "in": "query",
12341
+ "name": "ndjson",
12342
+ "required": false,
12343
+ "schema": {
12344
+ "type": "boolean"
12345
+ }
12346
+ },
12347
+ {
12348
+ "in": "query",
12349
+ "name": "filter",
12350
+ "required": false,
12351
+ "schema": {
12352
+ "type": "string"
12353
+ },
12354
+ "example": "allocationStrategy:thin"
12355
+ },
12356
+ {
12357
+ "in": "query",
12358
+ "name": "limit",
12359
+ "required": false,
12360
+ "schema": {
12361
+ "format": "double",
12362
+ "type": "number"
12363
+ },
12364
+ "example": 42
12365
+ }
12366
+ ]
12367
+ }
12368
+ },
12369
+ "/srs/{id}": {
12370
+ "get": {
12371
+ "operationId": "GetSr",
12372
+ "responses": {
12373
+ "200": {
12374
+ "description": "Ok",
12375
+ "content": {
12376
+ "application/json": {
12377
+ "schema": {
12378
+ "$ref": "#/components/schemas/Unbrand_XoSr_"
12379
+ },
12380
+ "examples": {
12381
+ "Example 1": {
12382
+ "value": {
12383
+ "type": "SR",
12384
+ "content_type": "user",
12385
+ "physical_usage": 16423866368,
12386
+ "allocationStrategy": "thin",
12387
+ "current_operations": {},
12388
+ "inMaintenanceMode": false,
12389
+ "name_description": "",
12390
+ "name_label": "Local storage",
12391
+ "size": 73682485248,
12392
+ "shared": false,
12393
+ "SR_type": "ext",
12394
+ "tags": [],
12395
+ "usage": 112759681168,
12396
+ "VDIs": [
12397
+ "7192fab6-e985-42a5-9d23-62deca4b8823",
12398
+ "a2caa5f0-b7c9-4ac3-8a65-a9829a39bd98",
12399
+ "f8e3da31-4556-4922-b7ce-76429fa88d5e",
12400
+ "4b737630-2958-46f0-a997-c9dc8f4457b4",
12401
+ "882e52c5-afd5-44b5-a218-e4f7d1aa68b3",
12402
+ "d636a574-ebe4-42b8-9456-790e111c60f0",
12403
+ "55860d04-cf0a-4cc3-8295-e537ad4a9687",
12404
+ "fbda4d74-9017-460a-8a4c-bb5c39795ec4",
12405
+ "0e63828c-5a37-429d-b28f-9172424a541a",
12406
+ "fc3ff36a-3f08-4999-a3ea-7944e44a2e9b",
12407
+ "b4661cb7-6b3f-46e4-b2b7-1acb9d3a28be",
12408
+ "656052a2-2e3e-467b-88ba-63a9ea5e4a54",
12409
+ "82182c28-9883-4aa4-8807-7cd781e6ca5b",
12410
+ "daafd3d5-3c8d-42d1-8f3d-100341b1d0b4",
12411
+ "6b4d50c0-e6e3-4126-b658-e98a8001588a",
12412
+ "802bdb62-11bc-4a31-9e71-cef8dad121ea",
12413
+ "c0dea89f-4ea8-45a3-856d-cad1d5bbe374",
12414
+ "1d8129a2-6f29-4966-abfd-763ecd07d4bc",
12415
+ "1c5c13c8-30b4-4935-8116-6b0d878cf02d",
12416
+ "499e9da8-c26a-4179-b929-69dc49f46ad1"
12417
+ ],
12418
+ "other_config": {
12419
+ "i18n-original-value-name_label": "Local storage",
12420
+ "i18n-key": "local-storage"
12421
+ },
12422
+ "sm_config": {
12423
+ "devserial": "scsi-35707c181005e11cd"
12424
+ },
12425
+ "$container": "84e555d8-267a-4720-aa5f-fd19035aadae",
12426
+ "$PBDs": [
12427
+ "387a2513-e835-baba-5684-e4a104acd78b"
12428
+ ],
12429
+ "id": "c4284e12-37c9-7967-b9e8-83ef229c3e03",
12430
+ "uuid": "c4284e12-37c9-7967-b9e8-83ef229c3e03",
12431
+ "$pool": "b7569d99-30f8-178a-7d94-801de3e29b5b",
12432
+ "$poolId": "b7569d99-30f8-178a-7d94-801de3e29b5b",
12433
+ "_xapiRef": "OpaqueRef:a7bf6969-0e15-9fa5-f987-8515fee801c5"
12434
+ }
12435
+ }
12436
+ }
12437
+ }
12438
+ }
12439
+ },
12440
+ "401": {
12441
+ "description": "Authentication required"
12442
+ },
12443
+ "404": {
12444
+ "description": "Resource not found"
12445
+ }
12446
+ },
12447
+ "tags": [
12448
+ "srs"
11496
12449
  ],
11497
12450
  "security": [
11498
12451
  {
@@ -11507,12 +12460,12 @@
11507
12460
  "schema": {
11508
12461
  "type": "string"
11509
12462
  },
11510
- "example": "722d17b9-699b-49d2-8193-be1ac573d3de"
12463
+ "example": "c4284e12-37c9-7967-b9e8-83ef229c3e03"
11511
12464
  }
11512
12465
  ]
11513
12466
  }
11514
12467
  },
11515
- "/srs": {
12468
+ "/sms": {
11516
12469
  "get": {
11517
12470
  "operationId": "GetSrs",
11518
12471
  "responses": {
@@ -11521,40 +12474,28 @@
11521
12474
  "content": {
11522
12475
  "application/json": {
11523
12476
  "schema": {
11524
- "$ref": "#/components/schemas/SendObjects_Partial_Unbrand_XoSr___"
12477
+ "$ref": "#/components/schemas/SendObjects_Partial_Unbrand_XoSm___"
11525
12478
  },
11526
12479
  "examples": {
11527
12480
  "Example 1": {
11528
12481
  "value": [
11529
- "/rest/v0/srs/e46e7ea5-1bbe-e499-69a5-6bfb395eb146",
11530
- "/rest/v0/srs/3d1227f3-7d40-a104-efc6-fb797b58f258"
12482
+ "/rest/v0/sms/5bfb2f8a-70f3-8cff-1748-3cd4de2153da",
12483
+ "/rest/v0/sms/d3df5d0f-bac8-ed31-22e9-b7d89fb39e0e"
11531
12484
  ]
11532
12485
  },
11533
12486
  "Example 2": {
11534
12487
  "value": [
11535
12488
  {
11536
- "uuid": "4cb0d74e-a7c1-0b7d-46e3-09382c012abb",
11537
- "name_label": "Local storage",
11538
- "allocationStrategy": "thin",
11539
- "href": "/rest/v0/srs/4cb0d74e-a7c1-0b7d-46e3-09382c012abb"
11540
- },
11541
- {
11542
- "uuid": "c4284e12-37c9-7967-b9e8-83ef229c3e03",
11543
- "name_label": "Local storage",
11544
- "allocationStrategy": "thin",
11545
- "href": "/rest/v0/srs/c4284e12-37c9-7967-b9e8-83ef229c3e03"
11546
- },
11547
- {
11548
- "uuid": "8aa2fb4a-143e-c2bc-05d4-c68bbb101d41",
11549
- "name_label": "Local storage",
11550
- "allocationStrategy": "thin",
11551
- "href": "/rest/v0/srs/8aa2fb4a-143e-c2bc-05d4-c68bbb101d41"
12489
+ "uuid": "5bfb2f8a-70f3-8cff-1748-3cd4de2153da",
12490
+ "name_label": "Local EXT4 VHD and QCOW2",
12491
+ "SM_type": "ext",
12492
+ "href": "/rest/v0/sms/5bfb2f8a-70f3-8cff-1748-3cd4de2153da"
11552
12493
  },
11553
12494
  {
11554
- "uuid": "c787b75c-3e0d-70fa-d0c3-cbfd382d7e33",
11555
- "name_label": "XOSTOR NVME",
11556
- "allocationStrategy": "thin",
11557
- "href": "/rest/v0/srs/c787b75c-3e0d-70fa-d0c3-cbfd382d7e33"
12495
+ "uuid": "0d48516d-f7ad-1c36-39ea-17cfb16e04ab",
12496
+ "name_label": "Local EXT4 VHD and QCOW2",
12497
+ "SM_type": "ext",
12498
+ "href": "/rest/v0/sms/0d48516d-f7ad-1c36-39ea-17cfb16e04ab"
11558
12499
  }
11559
12500
  ]
11560
12501
  }
@@ -11567,7 +12508,7 @@
11567
12508
  }
11568
12509
  },
11569
12510
  "tags": [
11570
- "srs"
12511
+ "sms"
11571
12512
  ],
11572
12513
  "security": [
11573
12514
  {
@@ -11582,7 +12523,7 @@
11582
12523
  "schema": {
11583
12524
  "type": "string"
11584
12525
  },
11585
- "example": "uuid,name_label,allocationStrategy"
12526
+ "example": "uuid,name_label,SM_type"
11586
12527
  },
11587
12528
  {
11588
12529
  "in": "query",
@@ -11599,7 +12540,7 @@
11599
12540
  "schema": {
11600
12541
  "type": "string"
11601
12542
  },
11602
- "example": "allocationStrategy:thin"
12543
+ "example": "SM_type:ext"
11603
12544
  },
11604
12545
  {
11605
12546
  "in": "query",
@@ -11614,7 +12555,7 @@
11614
12555
  ]
11615
12556
  }
11616
12557
  },
11617
- "/srs/{id}": {
12558
+ "/sms/{id}": {
11618
12559
  "get": {
11619
12560
  "operationId": "GetSr",
11620
12561
  "responses": {
@@ -11623,62 +12564,49 @@
11623
12564
  "content": {
11624
12565
  "application/json": {
11625
12566
  "schema": {
11626
- "$ref": "#/components/schemas/Unbrand_XoSr_"
12567
+ "$ref": "#/components/schemas/Unbrand_XoSm_"
11627
12568
  },
11628
12569
  "examples": {
11629
12570
  "Example 1": {
11630
12571
  "value": {
11631
- "type": "SR",
11632
- "content_type": "user",
11633
- "physical_usage": 16423866368,
11634
- "allocationStrategy": "thin",
11635
- "current_operations": {},
11636
- "inMaintenanceMode": false,
11637
- "name_description": "",
11638
- "name_label": "Local storage",
11639
- "size": 73682485248,
11640
- "shared": false,
11641
- "SR_type": "ext",
11642
- "tags": [],
11643
- "usage": 112759681168,
11644
- "VDIs": [
11645
- "7192fab6-e985-42a5-9d23-62deca4b8823",
11646
- "a2caa5f0-b7c9-4ac3-8a65-a9829a39bd98",
11647
- "f8e3da31-4556-4922-b7ce-76429fa88d5e",
11648
- "4b737630-2958-46f0-a997-c9dc8f4457b4",
11649
- "882e52c5-afd5-44b5-a218-e4f7d1aa68b3",
11650
- "d636a574-ebe4-42b8-9456-790e111c60f0",
11651
- "55860d04-cf0a-4cc3-8295-e537ad4a9687",
11652
- "fbda4d74-9017-460a-8a4c-bb5c39795ec4",
11653
- "0e63828c-5a37-429d-b28f-9172424a541a",
11654
- "fc3ff36a-3f08-4999-a3ea-7944e44a2e9b",
11655
- "b4661cb7-6b3f-46e4-b2b7-1acb9d3a28be",
11656
- "656052a2-2e3e-467b-88ba-63a9ea5e4a54",
11657
- "82182c28-9883-4aa4-8807-7cd781e6ca5b",
11658
- "daafd3d5-3c8d-42d1-8f3d-100341b1d0b4",
11659
- "6b4d50c0-e6e3-4126-b658-e98a8001588a",
11660
- "802bdb62-11bc-4a31-9e71-cef8dad121ea",
11661
- "c0dea89f-4ea8-45a3-856d-cad1d5bbe374",
11662
- "1d8129a2-6f29-4966-abfd-763ecd07d4bc",
11663
- "1c5c13c8-30b4-4935-8116-6b0d878cf02d",
11664
- "499e9da8-c26a-4179-b929-69dc49f46ad1"
11665
- ],
11666
- "other_config": {
11667
- "i18n-original-value-name_label": "Local storage",
11668
- "i18n-key": "local-storage"
12572
+ "type": "SM",
12573
+ "uuid": "5bfb2f8a-70f3-8cff-1748-3cd4de2153da",
12574
+ "name_description": "SR plugin which represents disks as VHD and QCOW2 files stored on a local EXT4 filesystem, created inside an LVM volume",
12575
+ "name_label": "Local EXT4 VHD and QCOW2",
12576
+ "SM_type": "ext",
12577
+ "configuration": {
12578
+ "device": "local device path (required) (e.g. /dev/sda3)"
11669
12579
  },
11670
- "sm_config": {
11671
- "devserial": "scsi-35707c181005e11cd"
12580
+ "vendor": "Citrix Systems Inc",
12581
+ "features": {
12582
+ "SR_PROBE": 1,
12583
+ "SR_SUPPORTS_LOCAL_CACHING": 1,
12584
+ "SR_UPDATE": 1,
12585
+ "THIN_PROVISIONING": 1,
12586
+ "VDI_ACTIVATE": 1,
12587
+ "VDI_ATTACH": 1,
12588
+ "VDI_CLONE": 1,
12589
+ "VDI_CONFIG_CBT": 1,
12590
+ "VDI_CREATE": 1,
12591
+ "VDI_DEACTIVATE": 1,
12592
+ "VDI_DELETE": 1,
12593
+ "VDI_DETACH": 1,
12594
+ "VDI_GENERATE_CONFIG": 1,
12595
+ "VDI_MIRROR": 1,
12596
+ "VDI_READ_CACHING": 1,
12597
+ "VDI_RESET_ON_BOOT": 2,
12598
+ "VDI_RESIZE": 1,
12599
+ "VDI_SNAPSHOT": 1,
12600
+ "VDI_UPDATE": 1
11672
12601
  },
11673
- "$container": "84e555d8-267a-4720-aa5f-fd19035aadae",
11674
- "$PBDs": [
11675
- "387a2513-e835-baba-5684-e4a104acd78b"
11676
- ],
11677
- "id": "c4284e12-37c9-7967-b9e8-83ef229c3e03",
11678
- "uuid": "c4284e12-37c9-7967-b9e8-83ef229c3e03",
11679
- "$pool": "b7569d99-30f8-178a-7d94-801de3e29b5b",
11680
- "$poolId": "b7569d99-30f8-178a-7d94-801de3e29b5b",
11681
- "_xapiRef": "OpaqueRef:a7bf6969-0e15-9fa5-f987-8515fee801c5"
12602
+ "driver_filename": "/opt/xensource/sm/EXTSR",
12603
+ "required_cluster_stack": [],
12604
+ "supported_image_formats": [],
12605
+ "id": "5bfb2f8a-70f3-8cff-1748-3cd4de2153da",
12606
+ "pool": "d6ba2603-7f16-0261-a33f-6e91d3aa0ec7",
12607
+ "poolId": "d6ba2603-7f16-0261-a33f-6e91d3aa0ec7",
12608
+ "_xapiRef": "OpaqueRef:27086ace-74d7-9f68-7465-346c7249b799",
12609
+ "href": "/rest/v0/sms/5bfb2f8a-70f3-8cff-1748-3cd4de2153da"
11682
12610
  }
11683
12611
  }
11684
12612
  }
@@ -11693,7 +12621,7 @@
11693
12621
  }
11694
12622
  },
11695
12623
  "tags": [
11696
- "srs"
12624
+ "sms"
11697
12625
  ],
11698
12626
  "security": [
11699
12627
  {
@@ -12789,6 +13717,103 @@
12789
13717
  ]
12790
13718
  }
12791
13719
  },
13720
+ "/pools/{id}/actions/create_vm": {
13721
+ "post": {
13722
+ "operationId": "CreateVm",
13723
+ "responses": {
13724
+ "201": {
13725
+ "description": "Resource created",
13726
+ "content": {
13727
+ "application/json": {
13728
+ "schema": {
13729
+ "anyOf": [
13730
+ {
13731
+ "type": "string"
13732
+ },
13733
+ {
13734
+ "properties": {
13735
+ "id": {
13736
+ "type": "string"
13737
+ }
13738
+ },
13739
+ "required": [
13740
+ "id"
13741
+ ],
13742
+ "type": "object"
13743
+ }
13744
+ ]
13745
+ },
13746
+ "examples": {
13747
+ "Example 1": {
13748
+ "value": "/rest/v0/tasks/0m7kl0j9l"
13749
+ },
13750
+ "Example 2": {
13751
+ "value": {
13752
+ "id": "8279e670-cb58-c048-7007-230f075becfb"
13753
+ }
13754
+ }
13755
+ }
13756
+ }
13757
+ }
13758
+ },
13759
+ "202": {
13760
+ "description": "Action executed asynchronously"
13761
+ },
13762
+ "401": {
13763
+ "description": "Authentication required"
13764
+ },
13765
+ "404": {
13766
+ "description": "Resource not found"
13767
+ },
13768
+ "500": {
13769
+ "description": "Internal server error, XenServer/XCP-ng error"
13770
+ }
13771
+ },
13772
+ "tags": [
13773
+ "vms",
13774
+ "pools"
13775
+ ],
13776
+ "security": [
13777
+ {
13778
+ "*": []
13779
+ }
13780
+ ],
13781
+ "parameters": [
13782
+ {
13783
+ "in": "path",
13784
+ "name": "id",
13785
+ "required": true,
13786
+ "schema": {
13787
+ "type": "string"
13788
+ },
13789
+ "example": "355ee47d-ff4c-4924-3db2-fd86ae629677"
13790
+ },
13791
+ {
13792
+ "in": "query",
13793
+ "name": "sync",
13794
+ "required": false,
13795
+ "schema": {
13796
+ "type": "boolean"
13797
+ }
13798
+ }
13799
+ ],
13800
+ "requestBody": {
13801
+ "required": true,
13802
+ "content": {
13803
+ "application/json": {
13804
+ "schema": {
13805
+ "$ref": "#/components/schemas/Unbrand_CreateVmBody_"
13806
+ },
13807
+ "example": {
13808
+ "name_label": "new VM from REST API",
13809
+ "template": "9bbcc5d1-ad4b-06f1-18f6-03125e809c38",
13810
+ "boot": true
13811
+ }
13812
+ }
13813
+ }
13814
+ }
13815
+ }
13816
+ },
12792
13817
  "/pifs": {
12793
13818
  "get": {
12794
13819
  "operationId": "GetPifs",
@@ -20500,11 +21525,88 @@
20500
21525
  }
20501
21526
  ]
20502
21527
  }
21528
+ },
21529
+ "/pools/{id}/vms": {
21530
+ "post": {
21531
+ "operationId": "ImportVm",
21532
+ "responses": {
21533
+ "201": {
21534
+ "description": "VM imported",
21535
+ "content": {
21536
+ "application/json": {
21537
+ "schema": {
21538
+ "properties": {
21539
+ "id": {
21540
+ "type": "string"
21541
+ }
21542
+ },
21543
+ "required": [
21544
+ "id"
21545
+ ],
21546
+ "type": "object"
21547
+ },
21548
+ "examples": {
21549
+ "Example 1": {
21550
+ "value": {
21551
+ "id": "9fe12ca3-d75d-cfb0-492e-cfd2bc6c568f"
21552
+ }
21553
+ }
21554
+ }
21555
+ }
21556
+ }
21557
+ },
21558
+ "401": {
21559
+ "description": "Authentication required"
21560
+ },
21561
+ "404": {
21562
+ "description": "Resource not found"
21563
+ },
21564
+ "500": {
21565
+ "description": "Internal server error, XenServer/XCP-ng error"
21566
+ }
21567
+ },
21568
+ "description": "Import an XVA VM into a pool",
21569
+ "tags": [
21570
+ "vms",
21571
+ "pools"
21572
+ ],
21573
+ "security": [
21574
+ {
21575
+ "*": []
21576
+ }
21577
+ ],
21578
+ "parameters": [
21579
+ {
21580
+ "in": "path",
21581
+ "name": "id",
21582
+ "required": true,
21583
+ "schema": {
21584
+ "type": "string"
21585
+ },
21586
+ "example": "355ee47d-ff4c-4924-3db2-fd86ae629677"
21587
+ },
21588
+ {
21589
+ "in": "query",
21590
+ "name": "sr",
21591
+ "required": false,
21592
+ "schema": {
21593
+ "type": "string"
21594
+ },
21595
+ "example": "c787b75c-3e0d-70fa-d0c3-cbfd382d7e33"
21596
+ }
21597
+ ],
21598
+ "requestBody": {
21599
+ "required": true,
21600
+ "content": {
21601
+ "application/octet-stream": {
21602
+ "schema": {
21603
+ "type": "string",
21604
+ "format": "binary"
21605
+ }
21606
+ }
21607
+ }
21608
+ }
21609
+ }
20503
21610
  }
20504
- },
20505
- "servers": [
20506
- {
20507
- "url": "/rest/v0"
20508
- }
20509
- ]
21611
+ }
20510
21612
  }