@xen-orchestra/rest-api 0.26.0 → 0.28.0

package/open-api/spec/swagger.json

@@ -1750,9 +1750,9 @@
 									"host",
 									"VIF",
 									"VTPM",
-									"VM",
 									"VM-snapshot",
 									"SR",
+									"VM",
 									"message",
 									"vgpu",
 									"gpuGroup",
@@ -2381,9 +2381,9 @@
 									"host",
 									"VIF",
 									"VTPM",
-									"VM",
 									"VM-snapshot",
 									"SR",
+									"VM",
 									"message",
 									"vgpu",
 									"gpuGroup",
@@ -2531,9 +2531,9 @@
 									"host",
 									"VIF",
 									"VTPM",
-									"VM",
 									"VM-snapshot",
 									"SR",
+									"VM",
 									"message",
 									"vgpu",
 									"gpuGroup",
@@ -6540,9 +6540,9 @@
 									"host",
 									"VIF",
 									"VTPM",
-									"VM",
 									"VM-snapshot",
 									"SR",
+									"VM",
 									"message",
 									"vgpu",
 									"gpuGroup",
@@ -7886,7 +7886,7 @@
 					}
 				]
 			},
-			"CreateNetworkBody": {
+			"Unbrand_CreateNetworkBody_": {
 				"properties": {
 					"name": {
 						"type": "string"
@@ -7894,14 +7894,17 @@
 					"description": {
 						"type": "string"
 					},
-					"pif": {
-						"type": "string"
-					},
 					"mtu": {
 						"type": "number",
 						"format": "double",
 						"default": 1500
 					},
+					"nbd": {
+						"type": "boolean"
+					},
+					"pif": {
+						"type": "string"
+					},
 					"vlan": {
 						"type": "number",
 						"format": "double",
@@ -7914,8 +7917,73 @@
 					"pif",
 					"vlan"
 				],
-				"type": "object",
-				"additionalProperties": false
+				"type": "object"
+			},
+			"BOND_MODE": {
+				"type": "string",
+				"enum": [
+					"active-backup",
+					"balance-slb",
+					"lacp"
+				]
+			},
+			"Unbrand_CreateBondedNetworkBody_": {
+				"properties": {
+					"name": {
+						"type": "string"
+					},
+					"description": {
+						"type": "string"
+					},
+					"mtu": {
+						"type": "number",
+						"format": "double",
+						"default": 1500
+					},
+					"nbd": {
+						"type": "boolean"
+					},
+					"pifIds": {
+						"items": {
+							"type": "string"
+						},
+						"type": "array"
+					},
+					"bondMode": {
+						"$ref": "#/components/schemas/BOND_MODE"
+					}
+				},
+				"required": [
+					"name",
+					"pifIds",
+					"bondMode"
+				],
+				"type": "object"
+			},
+			"BaseCreateNetworkBody": {
+				"properties": {
+					"nbd": {
+						"type": "boolean"
+					},
+					"mtu": {
+						"type": "number",
+						"format": "double",
+						"default": 1500
+					},
+					"description": {
+						"type": "string"
+					},
+					"name": {
+						"type": "string"
+					}
+				},
+				"required": [
+					"name"
+				],
+				"type": "object"
+			},
+			"CreateInternalNetworkBody": {
+				"$ref": "#/components/schemas/BaseCreateNetworkBody"
 			},
 			"CreateActionReturnType__id-Unbrand_XoVm__91_id_93___": {
 				"anyOf": [
@@ -7967,6 +8035,10 @@
 					"vgpuType": {
 						"type": "string"
 					},
+					"cpus": {
+						"type": "number",
+						"format": "double"
+					},
 					"autoPoweron": {
 						"type": "boolean"
 					},
@@ -10925,9 +10997,9 @@
 					"host",
 					"VIF",
 					"VTPM",
-					"VM",
 					"VM-snapshot",
 					"SR",
+					"VM",
 					"message",
 					"vgpu",
 					"gpuGroup",
@@ -12154,9 +12226,9 @@
 									"host",
 									"VIF",
 									"VTPM",
-									"VM",
 									"VM-snapshot",
 									"SR",
+									"VM",
 									"message",
 									"vgpu",
 									"gpuGroup",
@@ -12285,9 +12357,9 @@
 									"host",
 									"VIF",
 									"VTPM",
-									"VM",
 									"VM-snapshot",
 									"SR",
+									"VM",
 									"message",
 									"vgpu",
 									"gpuGroup",
@@ -12346,7 +12418,7 @@
 	},
 	"info": {
 		"title": "@xen-orchestra/rest-api",
-		"version": "0.26.0",
+		"version": "0.28.0",
 		"description": "REST API to manage your XOA",
 		"license": {
 			"name": "AGPL-3.0-or-later"
@@ -14965,6 +15037,120 @@
 				}
 			}
 		},
+		"/vms/{id}/actions/clone": {
+			"post": {
+				"operationId": "CloneVm",
+				"responses": {
+					"201": {
+						"description": "Resource created"
+					},
+					"202": {
+						"description": "Action executed asynchronously",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/CreateActionReturnType__id-XenApiVm-at-uuid__"
+								},
+								"examples": {
+									"Example 1": {
+										"value": {
+											"taskId": "0m7kl0j9l"
+										}
+									}
+								}
+							}
+						}
+					},
+					"400": {
+						"description": "Bad request"
+					},
+					"401": {
+						"description": "Authentication required"
+					},
+					"404": {
+						"description": "Resource not found"
+					},
+					"422": {
+						"description": "Invalid parameters"
+					},
+					"500": {
+						"description": "Internal server error, XenServer/XCP-ng error"
+					}
+				},
+				"description": "\n- For fast clone on the same SR, omit `srId` and set `fast` to `true`.\n- For full copy on the same SR, omit `srId` and set `fast` to `false`.\n- To copy the VM to a different SR (always a full copy), provide `srId`. Supports cross-pool copy. Optionally use `compress: \"gzip\"` or `compress: \"zstd\"` to compress the export stream during cross-pool copy.",
+				"tags": [
+					"vms"
+				],
+				"security": [
+					{
+						"*": []
+					}
+				],
+				"parameters": [
+					{
+						"in": "path",
+						"name": "id",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"example": "f07ab729-c0e8-721c-45ec-f11276377030"
+					},
+					{
+						"in": "query",
+						"name": "sync",
+						"required": false,
+						"schema": {
+							"type": "boolean"
+						}
+					}
+				],
+				"requestBody": {
+					"required": false,
+					"content": {
+						"application/json": {
+							"schema": {
+								"anyOf": [
+									{
+										"properties": {
+											"fast": {
+												"type": "boolean"
+											},
+											"name_label": {
+												"type": "string"
+											}
+										},
+										"type": "object"
+									},
+									{
+										"properties": {
+											"compress": {
+												"type": "string",
+												"enum": [
+													"gzip",
+													"zstd"
+												]
+											},
+											"srId": {
+												"type": "string"
+											},
+											"name_label": {
+												"type": "string"
+											}
+										},
+										"type": "object"
+									}
+								]
+							},
+							"example": {
+								"name_label": "cloned_vm",
+								"fast": true
+							}
+						}
+					}
+				}
+			}
+		},
 		"/vms/{id}/alarms": {
 			"get": {
 				"operationId": "GetVmAlarms",
@@ -23152,6 +23338,75 @@
 				]
 			}
 		},
+		"/srs/{id}/actions/forget": {
+			"post": {
+				"operationId": "ForgetSr",
+				"responses": {
+					"202": {
+						"description": "Action executed asynchronously",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/CreateActionReturnType_void_"
+								},
+								"examples": {
+									"Example 1": {
+										"value": {
+											"taskId": "0m7kl0j9l"
+										}
+									}
+								}
+							}
+						}
+					},
+					"204": {
+						"description": "No content"
+					},
+					"400": {
+						"description": "Bad request"
+					},
+					"401": {
+						"description": "Authentication required"
+					},
+					"404": {
+						"description": "Resource not found"
+					},
+					"422": {
+						"description": "Invalid parameters"
+					},
+					"500": {
+						"description": "Internal server error, XenServer/XCP-ng error"
+					}
+				},
+				"tags": [
+					"srs"
+				],
+				"security": [
+					{
+						"*": []
+					}
+				],
+				"parameters": [
+					{
+						"in": "path",
+						"name": "id",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"example": "c4284e12-37c9-7967-b9e8-83ef229c3e03"
+					},
+					{
+						"in": "query",
+						"name": "sync",
+						"required": false,
+						"schema": {
+							"type": "boolean"
+						}
+					}
+				]
+			}
+		},
 		"/sms": {
 			"get": {
 				"operationId": "GetSrs",
@@ -24798,6 +25053,100 @@
 					"404": {
 						"description": "Resource not found"
 					},
+					"422": {
+						"description": "Invalid parameters"
+					},
+					"500": {
+						"description": "Internal server error, XenServer/XCP-ng error"
+					}
+				},
+				"tags": [
+					"networks",
+					"pools"
+				],
+				"security": [
+					{
+						"*": []
+					}
+				],
+				"parameters": [
+					{
+						"in": "path",
+						"name": "id",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"example": "355ee47d-ff4c-4924-3db2-fd86ae629676"
+					},
+					{
+						"in": "query",
+						"name": "sync",
+						"required": false,
+						"schema": {
+							"type": "boolean"
+						}
+					}
+				],
+				"requestBody": {
+					"required": true,
+					"content": {
+						"application/json": {
+							"schema": {
+								"$ref": "#/components/schemas/Unbrand_CreateNetworkBody_"
+							},
+							"example": {
+								"name": "awes0me_network",
+								"description": "random description",
+								"pif": "ad15b2c8-3d9a-194e-c43a-e3dcda74b256",
+								"vlan": 0
+							}
+						}
+					}
+				}
+			}
+		},
+		"/pools/{id}/actions/create_bonded_network": {
+			"post": {
+				"operationId": "CreateBondedNetwork",
+				"responses": {
+					"201": {
+						"description": "Resource created",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/CreateActionReturnType__id-Unbrand_XoNetwork__91_id_93___"
+								},
+								"examples": {
+									"Example 1": {
+										"value": {
+											"taskId": "0m7kl0j9l"
+										}
+									},
+									"Example 2": {
+										"value": {
+											"id": "9fe12ca3-d75d-cfb0-492e-cfd2bc6c568f"
+										}
+									}
+								}
+							}
+						}
+					},
+					"202": {
+						"description": "Action executed asynchronously"
+					},
+					"400": {
+						"description": "Bad request"
+					},
+					"401": {
+						"description": "Authentication required"
+					},
+					"404": {
+						"description": "Resource not found"
+					},
+					"422": {
+						"description": "Invalid parameters"
+					},
 					"500": {
 						"description": "Internal server error, XenServer/XCP-ng error"
 					}
@@ -24835,13 +25184,105 @@
 					"content": {
 						"application/json": {
 							"schema": {
-								"$ref": "#/components/schemas/CreateNetworkBody"
+								"$ref": "#/components/schemas/Unbrand_CreateBondedNetworkBody_"
 							},
 							"example": {
-								"name": "awes0me_network",
+								"name": "awes0me_bonded_network",
 								"description": "random description",
-								"pif": "ad15b2c8-3d9a-194e-c43a-e3dcda74b256",
-								"vlan": 0
+								"pifIds": [
+									"ad15b2c8-3d9a-194e-c43a-e3dcda74b256",
+									"7b6bed50-26b2-bd27-8f3a-1b5a81989a92"
+								],
+								"bondMode": "lacp"
+							}
+						}
+					}
+				}
+			}
+		},
+		"/pools/{id}/actions/create_internal_network": {
+			"post": {
+				"operationId": "CreateInternalNetwork",
+				"responses": {
+					"201": {
+						"description": "Resource created",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/CreateActionReturnType__id-Unbrand_XoNetwork__91_id_93___"
+								},
+								"examples": {
+									"Example 1": {
+										"value": {
+											"taskId": "0m7kl0j9l"
+										}
+									},
+									"Example 2": {
+										"value": {
+											"id": "9fe12ca3-d75d-cfb0-492e-cfd2bc6c568f"
+										}
+									}
+								}
+							}
+						}
+					},
+					"202": {
+						"description": "Action executed asynchronously"
+					},
+					"400": {
+						"description": "Bad request"
+					},
+					"401": {
+						"description": "Authentication required"
+					},
+					"404": {
+						"description": "Resource not found"
+					},
+					"422": {
+						"description": "Invalid parameters"
+					},
+					"500": {
+						"description": "Internal server error, XenServer/XCP-ng error"
+					}
+				},
+				"tags": [
+					"networks",
+					"pools"
+				],
+				"security": [
+					{
+						"*": []
+					}
+				],
+				"parameters": [
+					{
+						"in": "path",
+						"name": "id",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"example": "355ee47d-ff4c-4924-3db2-fd86ae629676"
+					},
+					{
+						"in": "query",
+						"name": "sync",
+						"required": false,
+						"schema": {
+							"type": "boolean"
+						}
+					}
+				],
+				"requestBody": {
+					"required": true,
+					"content": {
+						"application/json": {
+							"schema": {
+								"$ref": "#/components/schemas/CreateInternalNetworkBody"
+							},
+							"example": {
+								"name": "awes0me_internal_network",
+								"description": "random description"
 							}
 						}
 					}
@@ -37259,6 +37700,196 @@
 				}
 			}
 		},
+		"/hosts/{id}/actions/disable": {
+			"post": {
+				"operationId": "Disable",
+				"responses": {
+					"202": {
+						"description": "Action executed asynchronously",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/CreateActionReturnType_void_"
+								},
+								"examples": {
+									"Example 1": {
+										"value": {
+											"taskId": "0m7kl0j9l"
+										}
+									}
+								}
+							}
+						}
+					},
+					"204": {
+						"description": "No content"
+					},
+					"400": {
+						"description": "Bad request"
+					},
+					"401": {
+						"description": "Authentication required"
+					},
+					"404": {
+						"description": "Resource not found"
+					},
+					"422": {
+						"description": "Invalid parameters"
+					},
+					"500": {
+						"description": "Internal server error, XenServer/XCP-ng error"
+					}
+				},
+				"description": "Disable a host.\n\nSet `evacuate` to `true` to also evacuate all running VMs to other hosts in the pool.\n\nUse `vmIdsToForceMigrate` to unblock VMs whose migration is currently blocked (e.g. by `pool_migrate` or `migrate_send` blocked operations).\n\nUse `force` to ignore evacuation errors.",
+				"tags": [
+					"hosts"
+				],
+				"security": [
+					{
+						"*": []
+					}
+				],
+				"parameters": [
+					{
+						"in": "path",
+						"name": "id",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"example": "b61a5c92-700e-4966-a13b-00633f03eea8"
+					},
+					{
+						"in": "query",
+						"name": "sync",
+						"required": false,
+						"schema": {
+							"type": "boolean"
+						}
+					}
+				],
+				"requestBody": {
+					"required": false,
+					"content": {
+						"application/json": {
+							"schema": {
+								"anyOf": [
+									{
+										"properties": {
+											"evacuate": {
+												"type": "boolean",
+												"enum": [
+													false
+												],
+												"nullable": false
+											}
+										},
+										"type": "object"
+									},
+									{
+										"properties": {
+											"vmIdsToForceMigrate": {
+												"items": {
+													"type": "string"
+												},
+												"type": "array"
+											},
+											"force": {
+												"type": "boolean"
+											},
+											"evacuate": {
+												"type": "boolean",
+												"enum": [
+													true
+												],
+												"nullable": false
+											}
+										},
+										"required": [
+											"evacuate"
+										],
+										"type": "object"
+									}
+								]
+							},
+							"example": {
+								"evacuate": true,
+								"vmIdsToForceMigrate": [
+									"f07ab729-c0e8-721c-45ec-f11276377030"
+								]
+							}
+						}
+					}
+				}
+			}
+		},
+		"/hosts/{id}/actions/enable": {
+			"post": {
+				"operationId": "Enable",
+				"responses": {
+					"202": {
+						"description": "Action executed asynchronously",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/CreateActionReturnType_void_"
+								},
+								"examples": {
+									"Example 1": {
+										"value": {
+											"taskId": "0m7kl0j9l"
+										}
+									}
+								}
+							}
+						}
+					},
+					"204": {
+						"description": "No content"
+					},
+					"400": {
+						"description": "Bad request"
+					},
+					"401": {
+						"description": "Authentication required"
+					},
+					"404": {
+						"description": "Resource not found"
+					},
+					"500": {
+						"description": "Internal server error, XenServer/XCP-ng error"
+					}
+				},
+				"description": "Enable a host, taking it out of disabled state.",
+				"tags": [
+					"hosts"
+				],
+				"security": [
+					{
+						"*": []
+					}
+				],
+				"parameters": [
+					{
+						"in": "path",
+						"name": "id",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"example": "b61a5c92-700e-4966-a13b-00633f03eea8"
+					},
+					{
+						"in": "query",
+						"name": "sync",
+						"required": false,
+						"schema": {
+							"type": "boolean"
+						}
+					}
+				]
+			}
+		},
 		"/groups": {
 			"get": {
 				"operationId": "GetGroups",