openapi: 3.0.0 info: title: ProxMox VE API version: '2.0' description: ProxMox VE API contact: name: LUMASERV Support Team email: support@lumaserv.com servers: - description: local url: 'https://cluster.local:8006/api2/json' tags: - name: cluster - name: nodes - name: storage - name: access - name: pools - name: version paths: /cluster: get: operationId: getCluster summary: getCluster description: Cluster index. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/GetClusterResponse' /cluster/replication: get: operationId: getClusterReplication summary: getClusterReplication description: List replication jobs. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/GetClusterReplicationResponse' post: operationId: createClusterReplication summary: createClusterReplication description: Create a new replication job tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/CreateClusterReplicationResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateClusterReplicationRequest' '/cluster/replication/{id}': delete: operationId: deleteClusterReplicationSingle summary: deleteClusterReplicationSingle description: Mark replication job for removal. tags: - cluster parameters: - name: id in: path required: true description: id schema: type: string responses: '200': $ref: '#/components/responses/DeleteClusterReplicationSingleResponse' get: operationId: getClusterReplicationSingle summary: getClusterReplicationSingle description: Read replication job configuration. tags: - cluster parameters: - name: id in: path required: true description: id schema: type: string responses: '200': $ref: '#/components/responses/GetClusterReplicationSingleResponse' put: operationId: updateClusterReplicationSingle summary: updateClusterReplicationSingle description: Update replication job configuration. tags: - cluster parameters: - name: id in: path required: true description: id schema: type: string responses: '200': $ref: '#/components/responses/UpdateClusterReplicationSingleResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateClusterReplicationSingleRequest' /cluster/metrics: get: operationId: getClusterMetrics summary: getClusterMetrics description: Metrics index. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/GetClusterMetricsResponse' /cluster/metrics/server: get: operationId: getClusterMetricsServer summary: getClusterMetricsServer description: List configured metric servers. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/GetClusterMetricsServerResponse' '/cluster/metrics/server/{id}': delete: operationId: deleteClusterMetricsServerSingle summary: deleteClusterMetricsServerSingle description: Remove Metric server. tags: - cluster parameters: - name: id in: path required: true description: id schema: type: string responses: '200': $ref: '#/components/responses/DeleteClusterMetricsServerSingleResponse' get: operationId: getClusterMetricsServerSingle summary: getClusterMetricsServerSingle description: Read metric server configuration. tags: - cluster parameters: - name: id in: path required: true description: id schema: type: string responses: '200': $ref: '#/components/responses/GetClusterMetricsServerSingleResponse' post: operationId: createClusterMetricsServerSingle summary: createClusterMetricsServerSingle description: Create a new external metric server config tags: - cluster parameters: - name: id in: path required: true description: id schema: type: string responses: '200': $ref: '#/components/responses/CreateClusterMetricsServerSingleResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateClusterMetricsServerSingleRequest' put: operationId: updateClusterMetricsServerSingle summary: updateClusterMetricsServerSingle description: Update metric server configuration. tags: - cluster parameters: - name: id in: path required: true description: id schema: type: string responses: '200': $ref: '#/components/responses/UpdateClusterMetricsServerSingleResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateClusterMetricsServerSingleRequest' /cluster/config: get: operationId: getClusterConfig summary: getClusterConfig description: Directory index. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/GetClusterConfigResponse' post: operationId: createClusterConfig summary: createClusterConfig description: >- Generate new cluster configuration. If no links given, default to local IP address as link0. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/CreateClusterConfigResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateClusterConfigRequest' /cluster/config/apiversion: get: operationId: getClusterConfigApiversion summary: getClusterConfigApiversion description: Return the version of the cluster join API available on this node. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/GetClusterConfigApiversionResponse' /cluster/config/nodes: get: operationId: getClusterConfigNodes summary: getClusterConfigNodes description: Corosync node list. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/GetClusterConfigNodesResponse' '/cluster/config/nodes/{node}': delete: operationId: deleteClusterConfigNodesSingle summary: deleteClusterConfigNodesSingle description: Removes a node from the cluster configuration. tags: - cluster parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/DeleteClusterConfigNodesSingleResponse' post: operationId: createClusterConfigNodesSingle summary: createClusterConfigNodesSingle description: Adds a node to the cluster configuration. This call is for internal use. tags: - cluster parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/CreateClusterConfigNodesSingleResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateClusterConfigNodesSingleRequest' /cluster/config/join: get: operationId: getClusterConfigJoin summary: getClusterConfigJoin description: Get information needed to join this cluster over the connected node. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/GetClusterConfigJoinResponse' post: operationId: createClusterConfigJoin summary: createClusterConfigJoin description: >- Joins this node into an existing cluster. If no links are given, default to IP resolved by node's hostname on single link (fallback fails for clusters with multiple links). tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/CreateClusterConfigJoinResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateClusterConfigJoinRequest' /cluster/config/totem: get: operationId: getClusterConfigTotem summary: getClusterConfigTotem description: Get corosync totem protocol settings. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/GetClusterConfigTotemResponse' /cluster/config/qdevice: get: operationId: getClusterConfigQdevice summary: getClusterConfigQdevice description: Get QDevice status tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/GetClusterConfigQdeviceResponse' /cluster/firewall: get: operationId: getClusterFirewall summary: getClusterFirewall description: Directory index. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/GetClusterFirewallResponse' /cluster/firewall/groups: get: operationId: getClusterFirewallGroups summary: getClusterFirewallGroups description: List security groups. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/GetClusterFirewallGroupsResponse' post: operationId: createClusterFirewallGroup summary: createClusterFirewallGroup description: Create new security group. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/CreateClusterFirewallGroupResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateClusterFirewallGroupRequest' '/cluster/firewall/groups/{group}': delete: operationId: deleteClusterFirewallGroup summary: deleteClusterFirewallGroup description: Delete security group. tags: - cluster parameters: - name: group in: path required: true description: group schema: type: string responses: '200': $ref: '#/components/responses/DeleteClusterFirewallGroupResponse' get: operationId: getClusterFirewallGroupRules summary: getClusterFirewallGroupRules description: List rules. tags: - cluster parameters: - name: group in: path required: true description: group schema: type: string responses: '200': $ref: '#/components/responses/GetClusterFirewallGroupRulesResponse' post: operationId: addClusterFirewallGroupRule summary: addClusterFirewallGroupRule description: Create new rule. tags: - cluster parameters: - name: group in: path required: true description: group schema: type: string responses: '200': $ref: '#/components/responses/AddClusterFirewallGroupRuleResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/AddClusterFirewallGroupRuleRequest' '/cluster/firewall/groups/{group}/{pos}': delete: operationId: removeClusterFirewallGroupRule summary: removeClusterFirewallGroupRule description: Delete rule. tags: - cluster parameters: - name: group in: path required: true description: group schema: type: string - name: pos in: path required: true description: pos schema: type: integer responses: '200': $ref: '#/components/responses/RemoveClusterFirewallGroupRuleResponse' get: operationId: getClusterFirewallGroupRule summary: getClusterFirewallGroupRule description: Get single rule data. tags: - cluster parameters: - name: group in: path required: true description: group schema: type: string - name: pos in: path required: true description: pos schema: type: integer responses: '200': $ref: '#/components/responses/GetClusterFirewallGroupRuleResponse' put: operationId: updateClusterFirewallGroupRule summary: updateClusterFirewallGroupRule description: Modify rule data. tags: - cluster parameters: - name: group in: path required: true description: group schema: type: string - name: pos in: path required: true description: pos schema: type: integer responses: '200': $ref: '#/components/responses/UpdateClusterFirewallGroupRuleResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateClusterFirewallGroupRuleRequest' /cluster/firewall/rules: get: operationId: getClusterFirewallRules summary: getClusterFirewallRules description: List rules. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/GetClusterFirewallRulesResponse' post: operationId: addClusterFirewallRule summary: addClusterFirewallRule description: Create new rule. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/AddClusterFirewallRuleResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/AddClusterFirewallRuleRequest' '/cluster/firewall/rules/{pos}': delete: operationId: removeClusterFirewallRule summary: removeClusterFirewallRule description: Delete rule. tags: - cluster parameters: - name: pos in: path required: true description: pos schema: type: integer responses: '200': $ref: '#/components/responses/RemoveClusterFirewallRuleResponse' get: operationId: getClusterFirewallRule summary: getClusterFirewallRule description: Get single rule data. tags: - cluster parameters: - name: pos in: path required: true description: pos schema: type: integer responses: '200': $ref: '#/components/responses/GetClusterFirewallRuleResponse' put: operationId: updateClusterFirewallRule summary: updateClusterFirewallRule description: Modify rule data. tags: - cluster parameters: - name: pos in: path required: true description: pos schema: type: integer responses: '200': $ref: '#/components/responses/UpdateClusterFirewallRuleResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateClusterFirewallRuleRequest' /cluster/firewall/ipset: get: operationId: getClusterFirewallIPSets summary: getClusterFirewallIPSets description: List IPSets tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/GetClusterFirewallIPSetsResponse' post: operationId: createClusterFirewallIPSet summary: createClusterFirewallIPSet description: Create new IPSet tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/CreateClusterFirewallIPSetResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateClusterFirewallIPSetRequest' '/cluster/firewall/ipset/{name}': delete: operationId: deleteClusterFirewallIPSet summary: deleteClusterFirewallIPSet description: Delete IPSet tags: - cluster parameters: - name: name in: path required: true description: name schema: type: string responses: '200': $ref: '#/components/responses/DeleteClusterFirewallIPSetResponse' get: operationId: getClusterFirewallIPSet summary: getClusterFirewallIPSet description: List IPSet content tags: - cluster parameters: - name: name in: path required: true description: name schema: type: string responses: '200': $ref: '#/components/responses/GetClusterFirewallIPSetResponse' post: operationId: addClusterFirewallIPSetIP summary: addClusterFirewallIPSetIP description: Add IP or Network to IPSet. tags: - cluster parameters: - name: name in: path required: true description: name schema: type: string responses: '200': $ref: '#/components/responses/AddClusterFirewallIPSetIPResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/AddClusterFirewallIPSetIPRequest' '/cluster/firewall/ipset/{name}/{cidr}': delete: operationId: removeClusterFirewallIPSetIP summary: removeClusterFirewallIPSetIP description: Remove IP or Network from IPSet. tags: - cluster parameters: - name: cidr in: path required: true description: cidr schema: type: string - name: name in: path required: true description: name schema: type: string responses: '200': $ref: '#/components/responses/RemoveClusterFirewallIPSetIPResponse' get: operationId: getClusterFirewallIPSetIP summary: getClusterFirewallIPSetIP description: Read IP or Network settings from IPSet. tags: - cluster parameters: - name: cidr in: path required: true description: cidr schema: type: string - name: name in: path required: true description: name schema: type: string responses: '200': $ref: '#/components/responses/GetClusterFirewallIPSetIPResponse' put: operationId: updateClusterFirewallIPSetIP summary: updateClusterFirewallIPSetIP description: Update IP or Network settings tags: - cluster parameters: - name: cidr in: path required: true description: cidr schema: type: string - name: name in: path required: true description: name schema: type: string responses: '200': $ref: '#/components/responses/UpdateClusterFirewallIPSetIPResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateClusterFirewallIPSetIPRequest' /cluster/firewall/aliases: get: operationId: getClusterFirewallAliases summary: getClusterFirewallAliases description: List aliases tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/GetClusterFirewallAliasesResponse' post: operationId: createClusterFirewallAliases summary: createClusterFirewallAliases description: Create IP or Network Alias. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/CreateClusterFirewallAliasesResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateClusterFirewallAliasesRequest' '/cluster/firewall/aliases/{name}': delete: operationId: deleteClusterFirewallAliasesSingle summary: deleteClusterFirewallAliasesSingle description: Remove IP or Network alias. tags: - cluster parameters: - name: name in: path required: true description: name schema: type: string responses: '200': $ref: '#/components/responses/DeleteClusterFirewallAliasesSingleResponse' get: operationId: getClusterFirewallAliasesSingle summary: getClusterFirewallAliasesSingle description: Read alias. tags: - cluster parameters: - name: name in: path required: true description: name schema: type: string responses: '200': $ref: '#/components/responses/GetClusterFirewallAliasesSingleResponse' put: operationId: updateClusterFirewallAliasesSingle summary: updateClusterFirewallAliasesSingle description: Update IP or Network alias. tags: - cluster parameters: - name: name in: path required: true description: name schema: type: string responses: '200': $ref: '#/components/responses/UpdateClusterFirewallAliasesSingleResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateClusterFirewallAliasesSingleRequest' /cluster/firewall/options: get: operationId: getClusterFirewallOptions summary: getClusterFirewallOptions description: Get Firewall options. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/GetClusterFirewallOptionsResponse' put: operationId: updateClusterFirewallOptions summary: updateClusterFirewallOptions description: Set Firewall options. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/UpdateClusterFirewallOptionsResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateClusterFirewallOptionsRequest' /cluster/firewall/macros: get: operationId: getClusterFirewallMacros summary: getClusterFirewallMacros description: List available macros tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/GetClusterFirewallMacrosResponse' /cluster/firewall/refs: get: operationId: getClusterFirewallRefs summary: getClusterFirewallRefs description: >- Lists possible IPSet/Alias reference which are allowed in source/dest properties. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/GetClusterFirewallRefsResponse' /cluster/backup: get: operationId: getClusterBackup summary: getClusterBackup description: List vzdump backup schedule. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/GetClusterBackupResponse' post: operationId: createClusterBackup summary: createClusterBackup description: Create new vzdump backup job. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/CreateClusterBackupResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateClusterBackupRequest' '/cluster/backup/{id}': delete: operationId: deleteClusterBackupSingle summary: deleteClusterBackupSingle description: Delete vzdump backup job definition. tags: - cluster parameters: - name: id in: path required: true description: id schema: type: string responses: '200': $ref: '#/components/responses/DeleteClusterBackupSingleResponse' get: operationId: getClusterBackupSingle summary: getClusterBackupSingle description: Read vzdump backup job definition. tags: - cluster parameters: - name: id in: path required: true description: id schema: type: string responses: '200': $ref: '#/components/responses/GetClusterBackupSingleResponse' put: operationId: updateClusterBackupSingle summary: updateClusterBackupSingle description: Update vzdump backup job definition. tags: - cluster parameters: - name: id in: path required: true description: id schema: type: string responses: '200': $ref: '#/components/responses/UpdateClusterBackupSingleResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateClusterBackupSingleRequest' '/cluster/backup/{id}/included_volumes': get: operationId: getClusterBackupSingleIncludedvolumes summary: getClusterBackupSingleIncludedvolumes description: >- Returns included guests and the backup status of their disks. Optimized to be used in ExtJS tree views. tags: - cluster parameters: - name: id in: path required: true description: id schema: type: string responses: '200': $ref: '#/components/responses/GetClusterBackupSingleIncludedvolumesResponse' /cluster/backupinfo: get: operationId: getClusterBackupinfo summary: getClusterBackupinfo description: 'Stub, waits for future use.' tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/GetClusterBackupinfoResponse' /cluster/backupinfo/not_backed_up: get: operationId: getClusterBackupinfoNotbackedup summary: getClusterBackupinfoNotbackedup description: Shows all guests which are not covered by any backup job. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/GetClusterBackupinfoNotbackedupResponse' /cluster/ha: get: operationId: getClusterHa summary: getClusterHa description: Directory index. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/GetClusterHaResponse' /cluster/ha/resources: get: operationId: getClusterHaResources summary: getClusterHaResources description: List HA resources. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/GetClusterHaResourcesResponse' post: operationId: createClusterHaResources summary: createClusterHaResources description: Create a new HA resource. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/CreateClusterHaResourcesResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateClusterHaResourcesRequest' '/cluster/ha/resources/{sid}': delete: operationId: deleteClusterHaResourcesSingle summary: deleteClusterHaResourcesSingle description: Delete resource configuration. tags: - cluster parameters: - name: sid in: path required: true description: sid schema: type: string responses: '200': $ref: '#/components/responses/DeleteClusterHaResourcesSingleResponse' get: operationId: getClusterHaResourcesSingle summary: getClusterHaResourcesSingle description: Read resource configuration. tags: - cluster parameters: - name: sid in: path required: true description: sid schema: type: string responses: '200': $ref: '#/components/responses/GetClusterHaResourcesSingleResponse' put: operationId: updateClusterHaResourcesSingle summary: updateClusterHaResourcesSingle description: Update resource configuration. tags: - cluster parameters: - name: sid in: path required: true description: sid schema: type: string responses: '200': $ref: '#/components/responses/UpdateClusterHaResourcesSingleResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateClusterHaResourcesSingleRequest' '/cluster/ha/resources/{sid}/migrate': post: operationId: createClusterHaResourcesSingleMigrate summary: createClusterHaResourcesSingleMigrate description: Request resource migration (online) to another node. tags: - cluster parameters: - name: sid in: path required: true description: sid schema: type: string responses: '200': $ref: '#/components/responses/CreateClusterHaResourcesSingleMigrateResponse' requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateClusterHaResourcesSingleMigrateRequest '/cluster/ha/resources/{sid}/relocate': post: operationId: createClusterHaResourcesSingleRelocate summary: createClusterHaResourcesSingleRelocate description: >- Request resource relocatzion to another node. This stops the service on the old node, and restarts it on the target node. tags: - cluster parameters: - name: sid in: path required: true description: sid schema: type: string responses: '200': $ref: >- #/components/responses/CreateClusterHaResourcesSingleRelocateResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateClusterHaResourcesSingleRelocateRequest /cluster/ha/groups: get: operationId: getClusterHaGroups summary: getClusterHaGroups description: Get HA groups. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/GetClusterHaGroupsResponse' post: operationId: createClusterHaGroups summary: createClusterHaGroups description: Create a new HA group. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/CreateClusterHaGroupsResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateClusterHaGroupsRequest' '/cluster/ha/groups/{group}': delete: operationId: deleteClusterHaGroupsSingle summary: deleteClusterHaGroupsSingle description: Delete ha group configuration. tags: - cluster parameters: - name: group in: path required: true description: group schema: type: string responses: '200': $ref: '#/components/responses/DeleteClusterHaGroupsSingleResponse' get: operationId: getClusterHaGroupsSingle summary: getClusterHaGroupsSingle description: Read ha group configuration. tags: - cluster parameters: - name: group in: path required: true description: group schema: type: string responses: '200': $ref: '#/components/responses/GetClusterHaGroupsSingleResponse' put: operationId: updateClusterHaGroupsSingle summary: updateClusterHaGroupsSingle description: Update ha group configuration. tags: - cluster parameters: - name: group in: path required: true description: group schema: type: string responses: '200': $ref: '#/components/responses/UpdateClusterHaGroupsSingleResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateClusterHaGroupsSingleRequest' /cluster/ha/status: get: operationId: getClusterHaStatus summary: getClusterHaStatus description: Directory index. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/GetClusterHaStatusResponse' /cluster/ha/status/current: get: operationId: getClusterHaStatusCurrent summary: getClusterHaStatusCurrent description: Get HA manger status. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/GetClusterHaStatusCurrentResponse' /cluster/ha/status/manager_status: get: operationId: getClusterHaStatusManagerstatus summary: getClusterHaStatusManagerstatus description: 'Get full HA manger status, including LRM status.' tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/GetClusterHaStatusManagerstatusResponse' /cluster/acme: get: operationId: getClusterAcme summary: getClusterAcme description: ACMEAccount index. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/GetClusterAcmeResponse' /cluster/acme/plugins: get: operationId: getClusterAcmePlugins summary: getClusterAcmePlugins description: ACME plugin index. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/GetClusterAcmePluginsResponse' post: operationId: createClusterAcmePlugins summary: createClusterAcmePlugins description: Add ACME plugin configuration. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/CreateClusterAcmePluginsResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateClusterAcmePluginsRequest' '/cluster/acme/plugins/{id}': delete: operationId: deleteClusterAcmePluginsSingle summary: deleteClusterAcmePluginsSingle description: Delete ACME plugin configuration. tags: - cluster parameters: - name: id in: path required: true description: id schema: type: string responses: '200': $ref: '#/components/responses/DeleteClusterAcmePluginsSingleResponse' get: operationId: getClusterAcmePluginsSingle summary: getClusterAcmePluginsSingle description: Get ACME plugin configuration. tags: - cluster parameters: - name: id in: path required: true description: id schema: type: string responses: '200': $ref: '#/components/responses/GetClusterAcmePluginsSingleResponse' put: operationId: updateClusterAcmePluginsSingle summary: updateClusterAcmePluginsSingle description: Update ACME plugin configuration. tags: - cluster parameters: - name: id in: path required: true description: id schema: type: string responses: '200': $ref: '#/components/responses/UpdateClusterAcmePluginsSingleResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateClusterAcmePluginsSingleRequest' /cluster/acme/account: get: operationId: getClusterAcmeAccount summary: getClusterAcmeAccount description: ACMEAccount index. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/GetClusterAcmeAccountResponse' post: operationId: createClusterAcmeAccount summary: createClusterAcmeAccount description: Register a new ACME account with CA. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/CreateClusterAcmeAccountResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateClusterAcmeAccountRequest' '/cluster/acme/account/{name}': delete: operationId: deleteClusterAcmeAccountSingle summary: deleteClusterAcmeAccountSingle description: Deactivate existing ACME account at CA. tags: - cluster parameters: - name: name in: path required: true description: name schema: type: string responses: '200': $ref: '#/components/responses/DeleteClusterAcmeAccountSingleResponse' get: operationId: getClusterAcmeAccountSingle summary: getClusterAcmeAccountSingle description: Return existing ACME account information. tags: - cluster parameters: - name: name in: path required: true description: name schema: type: string responses: '200': $ref: '#/components/responses/GetClusterAcmeAccountSingleResponse' put: operationId: updateClusterAcmeAccountSingle summary: updateClusterAcmeAccountSingle description: >- Update existing ACME account information with CA. Note: not specifying any new account information triggers a refresh. tags: - cluster parameters: - name: name in: path required: true description: name schema: type: string responses: '200': $ref: '#/components/responses/UpdateClusterAcmeAccountSingleResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateClusterAcmeAccountSingleRequest' /cluster/acme/tos: get: operationId: getClusterAcmeTos summary: getClusterAcmeTos description: Retrieve ACME TermsOfService URL from CA. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/GetClusterAcmeTosResponse' /cluster/acme/directories: get: operationId: getClusterAcmeDirectories summary: getClusterAcmeDirectories description: Get named known ACME directory endpoints. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/GetClusterAcmeDirectoriesResponse' /cluster/acme/challenge-schema: get: operationId: getClusterAcmeChallengeschema summary: getClusterAcmeChallengeschema description: Get schema of ACME challenge types. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/GetClusterAcmeChallengeschemaResponse' /cluster/ceph: get: operationId: getClusterCeph summary: getClusterCeph description: Cluster ceph index. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/GetClusterCephResponse' /cluster/ceph/metadata: get: operationId: getClusterCephMetadata summary: getClusterCephMetadata description: Get ceph metadata. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/GetClusterCephMetadataResponse' /cluster/ceph/status: get: operationId: getClusterCephStatus summary: getClusterCephStatus description: Get ceph status. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/GetClusterCephStatusResponse' /cluster/ceph/flags: get: operationId: getClusterCephFlags summary: getClusterCephFlags description: get the status of all ceph flags tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/GetClusterCephFlagsResponse' put: operationId: updateClusterCephFlags summary: updateClusterCephFlags description: Set/Unset multiple ceph flags at once. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/UpdateClusterCephFlagsResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateClusterCephFlagsRequest' '/cluster/ceph/flags/{flag}': get: operationId: getClusterCephFlagsSingle summary: getClusterCephFlagsSingle description: Get the status of a specific ceph flag. tags: - cluster parameters: - name: flag in: path required: true description: flag schema: type: string responses: '200': $ref: '#/components/responses/GetClusterCephFlagsSingleResponse' put: operationId: updateClusterCephFlagsSingle summary: updateClusterCephFlagsSingle description: Set or clear (unset) a specific ceph flag tags: - cluster parameters: - name: flag in: path required: true description: flag schema: type: string responses: '200': $ref: '#/components/responses/UpdateClusterCephFlagsSingleResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateClusterCephFlagsSingleRequest' /cluster/sdn: get: operationId: getClusterSDN summary: getClusterSDN description: Directory index. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/GetClusterSDNResponse' put: operationId: updateClusterSDN summary: updateClusterSDN description: Apply sdn controller changes && reload. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/UpdateClusterSDNResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateClusterSDNRequest' /cluster/sdn/vnets: get: operationId: getClusterSDNVnets summary: getClusterSDNVnets description: SDN vnets index. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/GetClusterSDNVnetsResponse' post: operationId: createClusterSDNVnet summary: createClusterSDNVnet description: Create a new sdn vnet object. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/CreateClusterSDNVnetResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateClusterSDNVnetRequest' '/cluster/sdn/vnets/{vnet}': delete: operationId: deleteClusterSDNVnet summary: deleteClusterSDNVnet description: Delete sdn vnet object configuration. tags: - cluster parameters: - name: vnet in: path required: true description: vnet schema: type: string responses: '200': $ref: '#/components/responses/DeleteClusterSDNVnetResponse' get: operationId: getClusterSDNVnet summary: getClusterSDNVnet description: Read sdn vnet configuration. tags: - cluster parameters: - name: vnet in: path required: true description: vnet schema: type: string responses: '200': $ref: '#/components/responses/GetClusterSDNVnetResponse' put: operationId: updateClusterSDNVnet summary: updateClusterSDNVnet description: Update sdn vnet object configuration. tags: - cluster parameters: - name: vnet in: path required: true description: vnet schema: type: string responses: '200': $ref: '#/components/responses/UpdateClusterSDNVnetResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateClusterSDNVnetRequest' /cluster/sdn/zones: get: operationId: getClusterSDNZones summary: getClusterSDNZones description: SDN zones index. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/GetClusterSDNZonesResponse' post: operationId: createClusterSDNZone summary: createClusterSDNZone description: Create a new sdn zone object. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/CreateClusterSDNZoneResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateClusterSDNZoneRequest' '/cluster/sdn/zones/{zone}': delete: operationId: deleteClusterSDNZone summary: deleteClusterSDNZone description: Delete sdn zone object configuration. tags: - cluster parameters: - name: zone in: path required: true description: zone schema: type: string responses: '200': $ref: '#/components/responses/DeleteClusterSDNZoneResponse' get: operationId: getClusterSDNZone summary: getClusterSDNZone description: Read sdn zone configuration. tags: - cluster parameters: - name: zone in: path required: true description: zone schema: type: string responses: '200': $ref: '#/components/responses/GetClusterSDNZoneResponse' put: operationId: updateClusterSDNZone summary: updateClusterSDNZone description: Update sdn zone object configuration. tags: - cluster parameters: - name: zone in: path required: true description: zone schema: type: string responses: '200': $ref: '#/components/responses/UpdateClusterSDNZoneResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateClusterSDNZoneRequest' /cluster/sdn/controllers: get: operationId: getClusterSDNControllers summary: getClusterSDNControllers description: SDN controllers index. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/GetClusterSDNControllersResponse' post: operationId: createClusterSDNController summary: createClusterSDNController description: Create a new sdn controller object. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/CreateClusterSDNControllerResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateClusterSDNControllerRequest' '/cluster/sdn/controllers/{controller}': delete: operationId: deleteClusterSDNController summary: deleteClusterSDNController description: Delete sdn controller object configuration. tags: - cluster parameters: - name: controller in: path required: true description: controller schema: type: string responses: '200': $ref: '#/components/responses/DeleteClusterSDNControllerResponse' get: operationId: getClusterSDNController summary: getClusterSDNController description: Read sdn controller configuration. tags: - cluster parameters: - name: controller in: path required: true description: controller schema: type: string responses: '200': $ref: '#/components/responses/GetClusterSDNControllerResponse' put: operationId: updateClusterSDNController summary: updateClusterSDNController description: Update sdn controller object configuration. tags: - cluster parameters: - name: controller in: path required: true description: controller schema: type: string responses: '200': $ref: '#/components/responses/UpdateClusterSDNControllerResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateClusterSDNControllerRequest' /cluster/log: get: operationId: getClusterLog summary: getClusterLog description: Read cluster log tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/GetClusterLogResponse' /cluster/resources: get: operationId: getClusterResources summary: getClusterResources description: Resources index (cluster wide). tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/GetClusterResourcesResponse' /cluster/tasks: get: operationId: getClusterTasks summary: getClusterTasks description: List recent tasks (cluster wide). tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/GetClusterTasksResponse' /cluster/options: get: operationId: getClusterOptions summary: getClusterOptions description: Get datacenter options. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/GetClusterOptionsResponse' put: operationId: updateClusterOptions summary: updateClusterOptions description: Set datacenter options. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/UpdateClusterOptionsResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateClusterOptionsRequest' /cluster/status: get: operationId: getClusterStatus summary: getClusterStatus description: Get cluster status information. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/GetClusterStatusResponse' /cluster/nextid: get: operationId: getClusterNextid summary: getClusterNextid description: >- Get next free VMID. If you pass an VMID it will raise an error if the ID is already used. tags: - cluster parameters: [] responses: '200': $ref: '#/components/responses/GetClusterNextidResponse' /nodes: get: operationId: getNodes summary: getNodes description: Cluster node index. tags: - nodes parameters: [] responses: '200': $ref: '#/components/responses/GetNodesResponse' '/nodes/{node}': get: operationId: getNode summary: getNode description: Node index. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodeResponse' '/nodes/{node}/qemu': get: operationId: getVMs summary: getVMs description: Virtual machine index (per node). tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetVMsResponse' post: operationId: createVM summary: createVM description: Create or restore a virtual machine. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/CreateVMResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateVMRequest' '/nodes/{node}/qemu/{vmid}': delete: operationId: deleteVM summary: deleteVM description: Destroy the vm (also delete all used/owned volumes). tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/DeleteVMResponse' get: operationId: getVM summary: getVM description: Directory index tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/GetVMResponse' '/nodes/{node}/qemu/{vmid}/firewall': get: operationId: getVMFirewall summary: getVMFirewall description: Directory index. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/GetVMFirewallResponse' '/nodes/{node}/qemu/{vmid}/firewall/rules': get: operationId: getVMFirewallRules summary: getVMFirewallRules description: List rules. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/GetVMFirewallRulesResponse' post: operationId: createVMFirewallRule summary: createVMFirewallRule description: Create new rule. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/CreateVMFirewallRuleResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateVMFirewallRuleRequest' '/nodes/{node}/qemu/{vmid}/firewall/rules/{pos}': delete: operationId: deleteVMFirewallRule summary: deleteVMFirewallRule description: Delete rule. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: pos in: path required: true description: pos schema: type: integer - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/DeleteVMFirewallRuleResponse' get: operationId: getVMFirewallRule summary: getVMFirewallRule description: Get single rule data. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: pos in: path required: true description: pos schema: type: integer - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/GetVMFirewallRuleResponse' put: operationId: updateVMFirewallRule summary: updateVMFirewallRule description: Modify rule data. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: pos in: path required: true description: pos schema: type: integer - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/UpdateVMFirewallRuleResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateVMFirewallRuleRequest' '/nodes/{node}/qemu/{vmid}/firewall/aliases': get: operationId: getNodesSingleQemuSingleFirewallAliases summary: getNodesSingleQemuSingleFirewallAliases description: List aliases tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: >- #/components/responses/GetNodesSingleQemuSingleFirewallAliasesResponse post: operationId: createNodesSingleQemuSingleFirewallAliases summary: createNodesSingleQemuSingleFirewallAliases description: Create IP or Network Alias. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: >- #/components/responses/CreateNodesSingleQemuSingleFirewallAliasesResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleQemuSingleFirewallAliasesRequest '/nodes/{node}/qemu/{vmid}/firewall/aliases/{name}': delete: operationId: deleteNodesSingleQemuSingleFirewallAliasesSingle summary: deleteNodesSingleQemuSingleFirewallAliasesSingle description: Remove IP or Network alias. tags: - nodes parameters: - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: >- #/components/responses/DeleteNodesSingleQemuSingleFirewallAliasesSingleResponse get: operationId: getNodesSingleQemuSingleFirewallAliasesSingle summary: getNodesSingleQemuSingleFirewallAliasesSingle description: Read alias. tags: - nodes parameters: - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: >- #/components/responses/GetNodesSingleQemuSingleFirewallAliasesSingleResponse put: operationId: updateNodesSingleQemuSingleFirewallAliasesSingle summary: updateNodesSingleQemuSingleFirewallAliasesSingle description: Update IP or Network alias. tags: - nodes parameters: - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: >- #/components/responses/UpdateNodesSingleQemuSingleFirewallAliasesSingleResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/UpdateNodesSingleQemuSingleFirewallAliasesSingleRequest '/nodes/{node}/qemu/{vmid}/firewall/ipset': get: operationId: getVMFirewallIPSets summary: getVMFirewallIPSets description: List IPSets tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/GetVMFirewallIPSetsResponse' post: operationId: createVMFirewallIPSet summary: createVMFirewallIPSet description: Create new IPSet tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/CreateVMFirewallIPSetResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateVMFirewallIPSetRequest' '/nodes/{node}/qemu/{vmid}/firewall/ipset/{name}': delete: operationId: deleteVMFirewallIPSet summary: deleteVMFirewallIPSet description: Delete IPSet tags: - nodes parameters: - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/DeleteVMFirewallIPSetResponse' get: operationId: getVMFirewallIPSet summary: getVMFirewallIPSet description: List IPSet content tags: - nodes parameters: - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/GetVMFirewallIPSetResponse' post: operationId: addVMFirewallIPSetIP summary: addVMFirewallIPSetIP description: Add IP or Network to IPSet. tags: - nodes parameters: - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/AddVMFirewallIPSetIPResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/AddVMFirewallIPSetIPRequest' '/nodes/{node}/qemu/{vmid}/firewall/ipset/{name}/{cidr}': delete: operationId: removeVMFirewallIPSetIP summary: removeVMFirewallIPSetIP description: Remove IP or Network from IPSet. tags: - nodes parameters: - name: cidr in: path required: true description: cidr schema: type: string - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/RemoveVMFirewallIPSetIPResponse' get: operationId: getVMFirewallIPSetIP summary: getVMFirewallIPSetIP description: Read IP or Network settings from IPSet. tags: - nodes parameters: - name: cidr in: path required: true description: cidr schema: type: string - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/GetVMFirewallIPSetIPResponse' put: operationId: updateVMFirewallIPSetIP summary: updateVMFirewallIPSetIP description: Update IP or Network settings tags: - nodes parameters: - name: cidr in: path required: true description: cidr schema: type: string - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/UpdateVMFirewallIPSetIPResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateVMFirewallIPSetIPRequest' '/nodes/{node}/qemu/{vmid}/firewall/options': get: operationId: getVMFirewallOptions summary: getVMFirewallOptions description: Get VM firewall options. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/GetVMFirewallOptionsResponse' put: operationId: updateVMFirewallOptions summary: updateVMFirewallOptions description: Set Firewall options. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/UpdateVMFirewallOptionsResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateVMFirewallOptionsRequest' '/nodes/{node}/qemu/{vmid}/firewall/log': get: operationId: getNodesSingleQemuSingleFirewallLog summary: getNodesSingleQemuSingleFirewallLog description: Read firewall log tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/GetNodesSingleQemuSingleFirewallLogResponse' '/nodes/{node}/qemu/{vmid}/firewall/refs': get: operationId: getNodesSingleQemuSingleFirewallRefs summary: getNodesSingleQemuSingleFirewallRefs description: >- Lists possible IPSet/Alias reference which are allowed in source/dest properties. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/GetNodesSingleQemuSingleFirewallRefsResponse' '/nodes/{node}/qemu/{vmid}/agent': get: operationId: getNodesSingleQemuSingleAgent summary: getNodesSingleQemuSingleAgent description: Qemu Agent command index. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/GetNodesSingleQemuSingleAgentResponse' post: operationId: createNodesSingleQemuSingleAgent summary: createNodesSingleQemuSingleAgent description: Execute Qemu Guest Agent commands. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/CreateNodesSingleQemuSingleAgentResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleQemuSingleAgentRequest' '/nodes/{node}/qemu/{vmid}/agent/fsfreeze-freeze': post: operationId: createNodesSingleQemuSingleAgentFsfreezefreeze summary: createNodesSingleQemuSingleAgentFsfreezefreeze description: Execute fsfreeze-freeze. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: >- #/components/responses/CreateNodesSingleQemuSingleAgentFsfreezefreezeResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleQemuSingleAgentFsfreezefreezeRequest '/nodes/{node}/qemu/{vmid}/agent/fsfreeze-status': post: operationId: createNodesSingleQemuSingleAgentFsfreezestatus summary: createNodesSingleQemuSingleAgentFsfreezestatus description: Execute fsfreeze-status. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: >- #/components/responses/CreateNodesSingleQemuSingleAgentFsfreezestatusResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleQemuSingleAgentFsfreezestatusRequest '/nodes/{node}/qemu/{vmid}/agent/fsfreeze-thaw': post: operationId: createNodesSingleQemuSingleAgentFsfreezethaw summary: createNodesSingleQemuSingleAgentFsfreezethaw description: Execute fsfreeze-thaw. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: >- #/components/responses/CreateNodesSingleQemuSingleAgentFsfreezethawResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleQemuSingleAgentFsfreezethawRequest '/nodes/{node}/qemu/{vmid}/agent/fstrim': post: operationId: createNodesSingleQemuSingleAgentFstrim summary: createNodesSingleQemuSingleAgentFstrim description: Execute fstrim. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: >- #/components/responses/CreateNodesSingleQemuSingleAgentFstrimResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleQemuSingleAgentFstrimRequest '/nodes/{node}/qemu/{vmid}/agent/get-fsinfo': get: operationId: getNodesSingleQemuSingleAgentGetfsinfo summary: getNodesSingleQemuSingleAgentGetfsinfo description: Execute get-fsinfo. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: >- #/components/responses/GetNodesSingleQemuSingleAgentGetfsinfoResponse '/nodes/{node}/qemu/{vmid}/agent/get-host-name': get: operationId: getNodesSingleQemuSingleAgentGethostname summary: getNodesSingleQemuSingleAgentGethostname description: Execute get-host-name. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: >- #/components/responses/GetNodesSingleQemuSingleAgentGethostnameResponse '/nodes/{node}/qemu/{vmid}/agent/get-memory-block-info': get: operationId: getNodesSingleQemuSingleAgentGetmemoryblockinfo summary: getNodesSingleQemuSingleAgentGetmemoryblockinfo description: Execute get-memory-block-info. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: >- #/components/responses/GetNodesSingleQemuSingleAgentGetmemoryblockinfoResponse '/nodes/{node}/qemu/{vmid}/agent/get-memory-blocks': get: operationId: getNodesSingleQemuSingleAgentGetmemoryblocks summary: getNodesSingleQemuSingleAgentGetmemoryblocks description: Execute get-memory-blocks. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: >- #/components/responses/GetNodesSingleQemuSingleAgentGetmemoryblocksResponse '/nodes/{node}/qemu/{vmid}/agent/get-osinfo': get: operationId: getNodesSingleQemuSingleAgentGetosinfo summary: getNodesSingleQemuSingleAgentGetosinfo description: Execute get-osinfo. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: >- #/components/responses/GetNodesSingleQemuSingleAgentGetosinfoResponse '/nodes/{node}/qemu/{vmid}/agent/get-time': get: operationId: getNodesSingleQemuSingleAgentGettime summary: getNodesSingleQemuSingleAgentGettime description: Execute get-time. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/GetNodesSingleQemuSingleAgentGettimeResponse' '/nodes/{node}/qemu/{vmid}/agent/get-timezone': get: operationId: getNodesSingleQemuSingleAgentGettimezone summary: getNodesSingleQemuSingleAgentGettimezone description: Execute get-timezone. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: >- #/components/responses/GetNodesSingleQemuSingleAgentGettimezoneResponse '/nodes/{node}/qemu/{vmid}/agent/get-users': get: operationId: getNodesSingleQemuSingleAgentGetusers summary: getNodesSingleQemuSingleAgentGetusers description: Execute get-users. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/GetNodesSingleQemuSingleAgentGetusersResponse' '/nodes/{node}/qemu/{vmid}/agent/get-vcpus': get: operationId: getNodesSingleQemuSingleAgentGetvcpus summary: getNodesSingleQemuSingleAgentGetvcpus description: Execute get-vcpus. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/GetNodesSingleQemuSingleAgentGetvcpusResponse' '/nodes/{node}/qemu/{vmid}/agent/info': get: operationId: getNodesSingleQemuSingleAgentInfo summary: getNodesSingleQemuSingleAgentInfo description: Execute info. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/GetNodesSingleQemuSingleAgentInfoResponse' '/nodes/{node}/qemu/{vmid}/agent/network-get-interfaces': get: operationId: getNodesSingleQemuSingleAgentNetworkgetinterfaces summary: getNodesSingleQemuSingleAgentNetworkgetinterfaces description: Execute network-get-interfaces. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: >- #/components/responses/GetNodesSingleQemuSingleAgentNetworkgetinterfacesResponse '/nodes/{node}/qemu/{vmid}/agent/ping': post: operationId: createNodesSingleQemuSingleAgentPing summary: createNodesSingleQemuSingleAgentPing description: Execute ping. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/CreateNodesSingleQemuSingleAgentPingResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleQemuSingleAgentPingRequest' '/nodes/{node}/qemu/{vmid}/agent/shutdown': post: operationId: createNodesSingleQemuSingleAgentShutdown summary: createNodesSingleQemuSingleAgentShutdown description: Execute shutdown. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: >- #/components/responses/CreateNodesSingleQemuSingleAgentShutdownResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleQemuSingleAgentShutdownRequest '/nodes/{node}/qemu/{vmid}/agent/suspend-disk': post: operationId: createNodesSingleQemuSingleAgentSuspenddisk summary: createNodesSingleQemuSingleAgentSuspenddisk description: Execute suspend-disk. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: >- #/components/responses/CreateNodesSingleQemuSingleAgentSuspenddiskResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleQemuSingleAgentSuspenddiskRequest '/nodes/{node}/qemu/{vmid}/agent/suspend-hybrid': post: operationId: createNodesSingleQemuSingleAgentSuspendhybrid summary: createNodesSingleQemuSingleAgentSuspendhybrid description: Execute suspend-hybrid. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: >- #/components/responses/CreateNodesSingleQemuSingleAgentSuspendhybridResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleQemuSingleAgentSuspendhybridRequest '/nodes/{node}/qemu/{vmid}/agent/suspend-ram': post: operationId: createNodesSingleQemuSingleAgentSuspendram summary: createNodesSingleQemuSingleAgentSuspendram description: Execute suspend-ram. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: >- #/components/responses/CreateNodesSingleQemuSingleAgentSuspendramResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleQemuSingleAgentSuspendramRequest '/nodes/{node}/qemu/{vmid}/agent/set-user-password': post: operationId: createNodesSingleQemuSingleAgentSetuserpassword summary: createNodesSingleQemuSingleAgentSetuserpassword description: Sets the password for the given user to the given password tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: >- #/components/responses/CreateNodesSingleQemuSingleAgentSetuserpasswordResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleQemuSingleAgentSetuserpasswordRequest '/nodes/{node}/qemu/{vmid}/agent/exec': post: operationId: createNodesSingleQemuSingleAgentExec summary: createNodesSingleQemuSingleAgentExec description: >- Executes the given command in the vm via the guest-agent and returns an object with the pid. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/CreateNodesSingleQemuSingleAgentExecResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleQemuSingleAgentExecRequest' '/nodes/{node}/qemu/{vmid}/agent/exec-status': get: operationId: getNodesSingleQemuSingleAgentExecstatus summary: getNodesSingleQemuSingleAgentExecstatus description: Gets the status of the given pid started by the guest-agent tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: >- #/components/responses/GetNodesSingleQemuSingleAgentExecstatusResponse '/nodes/{node}/qemu/{vmid}/agent/file-read': get: operationId: getNodesSingleQemuSingleAgentFileread summary: getNodesSingleQemuSingleAgentFileread description: Reads the given file via guest agent. Is limited to 16777216 bytes. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/GetNodesSingleQemuSingleAgentFilereadResponse' '/nodes/{node}/qemu/{vmid}/agent/file-write': post: operationId: createNodesSingleQemuSingleAgentFilewrite summary: createNodesSingleQemuSingleAgentFilewrite description: Writes the given file via guest agent. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: >- #/components/responses/CreateNodesSingleQemuSingleAgentFilewriteResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleQemuSingleAgentFilewriteRequest '/nodes/{node}/qemu/{vmid}/rrd': get: operationId: getVMRRD summary: getVMRRD description: Read VM RRD statistics (returns PNG) tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/GetVMRRDResponse' '/nodes/{node}/qemu/{vmid}/rrddata': get: operationId: getVMRRDData summary: getVMRRDData description: Read VM RRD statistics tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/GetVMRRDDataResponse' '/nodes/{node}/qemu/{vmid}/config': get: operationId: getVMConfig summary: getVMConfig description: >- Get the virtual machine configuration with pending configuration changes applied. Set the 'current' parameter to get the current configuration instead. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/GetVMConfigResponse' post: operationId: updateVMConfig summary: updateVMConfig description: Set virtual machine options (asynchrounous API). tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/UpdateVMConfigResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateVMConfigRequest' put: operationId: updateVMConfigSync summary: updateVMConfigSync description: >- Set virtual machine options (synchrounous API) - You should consider using the POST method instead for any actions involving hotplug or storage allocation. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/UpdateVMConfigSyncResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateVMConfigSyncRequest' '/nodes/{node}/qemu/{vmid}/pending': get: operationId: getVMConfigPending summary: getVMConfigPending description: >- Get the virtual machine configuration with both current and pending values. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/GetVMConfigPendingResponse' '/nodes/{node}/qemu/{vmid}/unlink': put: operationId: unlinkVMDiskImages summary: unlinkVMDiskImages description: Unlink/delete disk images. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/UnlinkVMDiskImagesResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UnlinkVMDiskImagesRequest' '/nodes/{node}/qemu/{vmid}/vncproxy': post: operationId: createNodesSingleQemuSingleVncproxy summary: createNodesSingleQemuSingleVncproxy description: Creates a TCP VNC proxy connections. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/CreateNodesSingleQemuSingleVncproxyResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleQemuSingleVncproxyRequest' '/nodes/{node}/qemu/{vmid}/termproxy': post: operationId: createNodesSingleQemuSingleTermproxy summary: createNodesSingleQemuSingleTermproxy description: Creates a TCP proxy connections. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/CreateNodesSingleQemuSingleTermproxyResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleQemuSingleTermproxyRequest' '/nodes/{node}/qemu/{vmid}/vncwebsocket': get: operationId: getNodesSingleQemuSingleVncwebsocket summary: getNodesSingleQemuSingleVncwebsocket description: Opens a weksocket for VNC traffic. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/GetNodesSingleQemuSingleVncwebsocketResponse' '/nodes/{node}/qemu/{vmid}/spiceproxy': post: operationId: createNodesSingleQemuSingleSpiceproxy summary: createNodesSingleQemuSingleSpiceproxy description: Returns a SPICE configuration to connect to the VM. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/CreateNodesSingleQemuSingleSpiceproxyResponse' requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleQemuSingleSpiceproxyRequest '/nodes/{node}/qemu/{vmid}/status': get: operationId: getVMStatus summary: getVMStatus description: Directory index tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/GetVMStatusResponse' '/nodes/{node}/qemu/{vmid}/status/current': get: operationId: getCurrentVMStatus summary: getCurrentVMStatus description: Get virtual machine status. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/GetCurrentVMStatusResponse' '/nodes/{node}/qemu/{vmid}/status/start': post: operationId: startVM summary: startVM description: Start virtual machine. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/StartVMResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/StartVMRequest' '/nodes/{node}/qemu/{vmid}/status/stop': post: operationId: stopVM summary: stopVM description: >- Stop virtual machine. The qemu process will exit immediately. Thisis akin to pulling the power plug of a running computer and may damage the VM data tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/StopVMResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/StopVMRequest' '/nodes/{node}/qemu/{vmid}/status/reset': post: operationId: resetVM summary: resetVM description: Reset virtual machine. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/ResetVMResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/ResetVMRequest' '/nodes/{node}/qemu/{vmid}/status/shutdown': post: operationId: shutdownVM summary: shutdownVM description: >- Shutdown virtual machine. This is similar to pressing the power button on a physical machine.This will send an ACPI event for the guest OS, which should then proceed to a clean shutdown. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/ShutdownVMResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/ShutdownVMRequest' '/nodes/{node}/qemu/{vmid}/status/reboot': post: operationId: rebootVM summary: rebootVM description: >- Reboot the VM by shutting it down, and starting it again. Applies pending changes. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/RebootVMResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/RebootVMRequest' '/nodes/{node}/qemu/{vmid}/status/suspend': post: operationId: suspendVM summary: suspendVM description: Suspend virtual machine. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/SuspendVMResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/SuspendVMRequest' '/nodes/{node}/qemu/{vmid}/status/resume': post: operationId: resumeVM summary: resumeVM description: Resume virtual machine. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/ResumeVMResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/ResumeVMRequest' '/nodes/{node}/qemu/{vmid}/sendkey': put: operationId: updateNodesSingleQemuSingleSendkey summary: updateNodesSingleQemuSingleSendkey description: Send key event to virtual machine. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/UpdateNodesSingleQemuSingleSendkeyResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateNodesSingleQemuSingleSendkeyRequest' '/nodes/{node}/qemu/{vmid}/feature': get: operationId: getNodesSingleQemuSingleFeature summary: getNodesSingleQemuSingleFeature description: Check if feature for virtual machine is available. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/GetNodesSingleQemuSingleFeatureResponse' '/nodes/{node}/qemu/{vmid}/clone': post: operationId: cloneVM summary: cloneVM description: Create a copy of virtual machine/template. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/CloneVMResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CloneVMRequest' '/nodes/{node}/qemu/{vmid}/move_disk': post: operationId: createNodesSingleQemuSingleMovedisk summary: createNodesSingleQemuSingleMovedisk description: Move volume to different storage. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/CreateNodesSingleQemuSingleMovediskResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleQemuSingleMovediskRequest' '/nodes/{node}/qemu/{vmid}/migrate': get: operationId: migrateVM summary: migrateVM description: Get preconditions for migration. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/MigrateVMResponse' post: operationId: createNodesSingleQemuSingleMigrate summary: createNodesSingleQemuSingleMigrate description: Migrate virtual machine. Creates a new migration task. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/CreateNodesSingleQemuSingleMigrateResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleQemuSingleMigrateRequest' '/nodes/{node}/qemu/{vmid}/monitor': post: operationId: createNodesSingleQemuSingleMonitor summary: createNodesSingleQemuSingleMonitor description: Execute Qemu monitor commands. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/CreateNodesSingleQemuSingleMonitorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleQemuSingleMonitorRequest' '/nodes/{node}/qemu/{vmid}/resize': put: operationId: updateNodesSingleQemuSingleResize summary: updateNodesSingleQemuSingleResize description: Extend volume size. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/UpdateNodesSingleQemuSingleResizeResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateNodesSingleQemuSingleResizeRequest' '/nodes/{node}/qemu/{vmid}/snapshot': get: operationId: getVMSnapshots summary: getVMSnapshots description: List all snapshots. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/GetVMSnapshotsResponse' post: operationId: createVMSnapshot summary: createVMSnapshot description: Snapshot a VM. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/CreateVMSnapshotResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateVMSnapshotRequest' '/nodes/{node}/qemu/{vmid}/snapshot/{snapname}': delete: operationId: deleteVMSnapshot summary: deleteVMSnapshot description: Delete a VM snapshot. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: snapname in: path required: true description: snapname schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/DeleteVMSnapshotResponse' get: operationId: getVMSnapshot summary: getVMSnapshot description: getVMSnapshot tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: snapname in: path required: true description: snapname schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/GetVMSnapshotResponse' '/nodes/{node}/qemu/{vmid}/snapshot/{snapname}/config': get: operationId: getVMSnapshotConfig summary: getVMSnapshotConfig description: Get snapshot configuration tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: snapname in: path required: true description: snapname schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/GetVMSnapshotConfigResponse' put: operationId: updateVMSnapshotConfig summary: updateVMSnapshotConfig description: Update snapshot metadata. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: snapname in: path required: true description: snapname schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/UpdateVMSnapshotConfigResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateVMSnapshotConfigRequest' '/nodes/{node}/qemu/{vmid}/snapshot/{snapname}/rollback': post: operationId: rollbackVMSnapshot summary: rollbackVMSnapshot description: Rollback VM state to specified snapshot. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: snapname in: path required: true description: snapname schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/RollbackVMSnapshotResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/RollbackVMSnapshotRequest' '/nodes/{node}/qemu/{vmid}/template': post: operationId: createNodesSingleQemuSingleTemplate summary: createNodesSingleQemuSingleTemplate description: Create a Template. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/CreateNodesSingleQemuSingleTemplateResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleQemuSingleTemplateRequest' '/nodes/{node}/qemu/{vmid}/cloudinit/dump': get: operationId: getNodesSingleQemuSingleCloudinitDump summary: getNodesSingleQemuSingleCloudinitDump description: Get automatically generated cloudinit config. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/GetNodesSingleQemuSingleCloudinitDumpResponse' '/nodes/{node}/cpu': get: operationId: getNodesSingleCpu summary: getNodesSingleCpu description: List all custom and default CPU models. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleCpuResponse' '/nodes/{node}/lxc': get: operationId: getNodesSingleLxc summary: getNodesSingleLxc description: LXC container index (per node). tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleLxcResponse' post: operationId: createNodesSingleLxc summary: createNodesSingleLxc description: Create or restore a container. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/CreateNodesSingleLxcResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleLxcRequest' '/nodes/{node}/lxc/{vmid}': delete: operationId: deleteNodesSingleLxcSingle summary: deleteNodesSingleLxcSingle description: Destroy the container (also delete all uses files). tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/DeleteNodesSingleLxcSingleResponse' get: operationId: getNodesSingleLxcSingle summary: getNodesSingleLxcSingle description: Directory index tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/GetNodesSingleLxcSingleResponse' '/nodes/{node}/lxc/{vmid}/config': get: operationId: getNodesSingleLxcSingleConfig summary: getNodesSingleLxcSingleConfig description: Get container configuration. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/GetNodesSingleLxcSingleConfigResponse' put: operationId: updateNodesSingleLxcSingleConfig summary: updateNodesSingleLxcSingleConfig description: Set container options. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/UpdateNodesSingleLxcSingleConfigResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateNodesSingleLxcSingleConfigRequest' '/nodes/{node}/lxc/{vmid}/status': get: operationId: getNodesSingleLxcSingleStatus summary: getNodesSingleLxcSingleStatus description: Directory index tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/GetNodesSingleLxcSingleStatusResponse' '/nodes/{node}/lxc/{vmid}/status/current': get: operationId: getNodesSingleLxcSingleStatusCurrent summary: getNodesSingleLxcSingleStatusCurrent description: Get virtual machine status. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/GetNodesSingleLxcSingleStatusCurrentResponse' '/nodes/{node}/lxc/{vmid}/status/start': post: operationId: createNodesSingleLxcSingleStatusStart summary: createNodesSingleLxcSingleStatusStart description: Start the container. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/CreateNodesSingleLxcSingleStatusStartResponse' requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleLxcSingleStatusStartRequest '/nodes/{node}/lxc/{vmid}/status/stop': post: operationId: createNodesSingleLxcSingleStatusStop summary: createNodesSingleLxcSingleStatusStop description: >- Stop the container. This will abruptly stop all processes running in the container. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/CreateNodesSingleLxcSingleStatusStopResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleLxcSingleStatusStopRequest' '/nodes/{node}/lxc/{vmid}/status/shutdown': post: operationId: createNodesSingleLxcSingleStatusShutdown summary: createNodesSingleLxcSingleStatusShutdown description: >- Shutdown the container. This will trigger a clean shutdown of the container, see lxc-stop(1) for details. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: >- #/components/responses/CreateNodesSingleLxcSingleStatusShutdownResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleLxcSingleStatusShutdownRequest '/nodes/{node}/lxc/{vmid}/status/suspend': post: operationId: createNodesSingleLxcSingleStatusSuspend summary: createNodesSingleLxcSingleStatusSuspend description: Suspend the container. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: >- #/components/responses/CreateNodesSingleLxcSingleStatusSuspendResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleLxcSingleStatusSuspendRequest '/nodes/{node}/lxc/{vmid}/status/resume': post: operationId: createNodesSingleLxcSingleStatusResume summary: createNodesSingleLxcSingleStatusResume description: Resume the container. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: >- #/components/responses/CreateNodesSingleLxcSingleStatusResumeResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleLxcSingleStatusResumeRequest '/nodes/{node}/lxc/{vmid}/status/reboot': post: operationId: createNodesSingleLxcSingleStatusReboot summary: createNodesSingleLxcSingleStatusReboot description: >- Reboot the container by shutting it down, and starting it again. Applies pending changes. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: >- #/components/responses/CreateNodesSingleLxcSingleStatusRebootResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleLxcSingleStatusRebootRequest '/nodes/{node}/lxc/{vmid}/snapshot': get: operationId: getNodesSingleLxcSingleSnapshot summary: getNodesSingleLxcSingleSnapshot description: List all snapshots. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/GetNodesSingleLxcSingleSnapshotResponse' post: operationId: createNodesSingleLxcSingleSnapshot summary: createNodesSingleLxcSingleSnapshot description: Snapshot a container. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/CreateNodesSingleLxcSingleSnapshotResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleLxcSingleSnapshotRequest' '/nodes/{node}/lxc/{vmid}/snapshot/{snapname}': delete: operationId: deleteNodesSingleLxcSingleSnapshotSingle summary: deleteNodesSingleLxcSingleSnapshotSingle description: Delete a LXC snapshot. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: snapname in: path required: true description: snapname schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: >- #/components/responses/DeleteNodesSingleLxcSingleSnapshotSingleResponse get: operationId: getNodesSingleLxcSingleSnapshotSingle summary: getNodesSingleLxcSingleSnapshotSingle description: getNodesSingleLxcSingleSnapshotSingle tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: snapname in: path required: true description: snapname schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/GetNodesSingleLxcSingleSnapshotSingleResponse' '/nodes/{node}/lxc/{vmid}/snapshot/{snapname}/rollback': post: operationId: createNodesSingleLxcSingleSnapshotSingleRollback summary: createNodesSingleLxcSingleSnapshotSingleRollback description: Rollback LXC state to specified snapshot. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: snapname in: path required: true description: snapname schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: >- #/components/responses/CreateNodesSingleLxcSingleSnapshotSingleRollbackResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleLxcSingleSnapshotSingleRollbackRequest '/nodes/{node}/lxc/{vmid}/snapshot/{snapname}/config': get: operationId: getNodesSingleLxcSingleSnapshotSingleConfig summary: getNodesSingleLxcSingleSnapshotSingleConfig description: Get snapshot configuration tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: snapname in: path required: true description: snapname schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: >- #/components/responses/GetNodesSingleLxcSingleSnapshotSingleConfigResponse put: operationId: updateNodesSingleLxcSingleSnapshotSingleConfig summary: updateNodesSingleLxcSingleSnapshotSingleConfig description: Update snapshot metadata. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: snapname in: path required: true description: snapname schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: >- #/components/responses/UpdateNodesSingleLxcSingleSnapshotSingleConfigResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/UpdateNodesSingleLxcSingleSnapshotSingleConfigRequest '/nodes/{node}/lxc/{vmid}/firewall': get: operationId: getNodesSingleLxcSingleFirewall summary: getNodesSingleLxcSingleFirewall description: Directory index. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/GetNodesSingleLxcSingleFirewallResponse' '/nodes/{node}/lxc/{vmid}/firewall/rules': get: operationId: getNodesSingleLxcSingleFirewallRules summary: getNodesSingleLxcSingleFirewallRules description: List rules. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/GetNodesSingleLxcSingleFirewallRulesResponse' post: operationId: createNodesSingleLxcSingleFirewallRules summary: createNodesSingleLxcSingleFirewallRules description: Create new rule. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: >- #/components/responses/CreateNodesSingleLxcSingleFirewallRulesResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleLxcSingleFirewallRulesRequest '/nodes/{node}/lxc/{vmid}/firewall/rules/{pos}': delete: operationId: deleteNodesSingleLxcSingleFirewallRulesSingle summary: deleteNodesSingleLxcSingleFirewallRulesSingle description: Delete rule. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: pos in: path required: true description: pos schema: type: integer - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: >- #/components/responses/DeleteNodesSingleLxcSingleFirewallRulesSingleResponse get: operationId: getNodesSingleLxcSingleFirewallRulesSingle summary: getNodesSingleLxcSingleFirewallRulesSingle description: Get single rule data. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: pos in: path required: true description: pos schema: type: integer - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: >- #/components/responses/GetNodesSingleLxcSingleFirewallRulesSingleResponse put: operationId: updateNodesSingleLxcSingleFirewallRulesSingle summary: updateNodesSingleLxcSingleFirewallRulesSingle description: Modify rule data. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: pos in: path required: true description: pos schema: type: integer - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: >- #/components/responses/UpdateNodesSingleLxcSingleFirewallRulesSingleResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/UpdateNodesSingleLxcSingleFirewallRulesSingleRequest '/nodes/{node}/lxc/{vmid}/firewall/aliases': get: operationId: getNodesSingleLxcSingleFirewallAliases summary: getNodesSingleLxcSingleFirewallAliases description: List aliases tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: >- #/components/responses/GetNodesSingleLxcSingleFirewallAliasesResponse post: operationId: createNodesSingleLxcSingleFirewallAliases summary: createNodesSingleLxcSingleFirewallAliases description: Create IP or Network Alias. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: >- #/components/responses/CreateNodesSingleLxcSingleFirewallAliasesResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleLxcSingleFirewallAliasesRequest '/nodes/{node}/lxc/{vmid}/firewall/aliases/{name}': delete: operationId: deleteNodesSingleLxcSingleFirewallAliasesSingle summary: deleteNodesSingleLxcSingleFirewallAliasesSingle description: Remove IP or Network alias. tags: - nodes parameters: - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: >- #/components/responses/DeleteNodesSingleLxcSingleFirewallAliasesSingleResponse get: operationId: getNodesSingleLxcSingleFirewallAliasesSingle summary: getNodesSingleLxcSingleFirewallAliasesSingle description: Read alias. tags: - nodes parameters: - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: >- #/components/responses/GetNodesSingleLxcSingleFirewallAliasesSingleResponse put: operationId: updateNodesSingleLxcSingleFirewallAliasesSingle summary: updateNodesSingleLxcSingleFirewallAliasesSingle description: Update IP or Network alias. tags: - nodes parameters: - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: >- #/components/responses/UpdateNodesSingleLxcSingleFirewallAliasesSingleResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/UpdateNodesSingleLxcSingleFirewallAliasesSingleRequest '/nodes/{node}/lxc/{vmid}/firewall/ipset': get: operationId: getNodesSingleLxcSingleFirewallIpset summary: getNodesSingleLxcSingleFirewallIpset description: List IPSets tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/GetNodesSingleLxcSingleFirewallIpsetResponse' post: operationId: createNodesSingleLxcSingleFirewallIpset summary: createNodesSingleLxcSingleFirewallIpset description: Create new IPSet tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: >- #/components/responses/CreateNodesSingleLxcSingleFirewallIpsetResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleLxcSingleFirewallIpsetRequest '/nodes/{node}/lxc/{vmid}/firewall/ipset/{name}': delete: operationId: deleteNodesSingleLxcSingleFirewallIpsetSingle summary: deleteNodesSingleLxcSingleFirewallIpsetSingle description: Delete IPSet tags: - nodes parameters: - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: >- #/components/responses/DeleteNodesSingleLxcSingleFirewallIpsetSingleResponse get: operationId: getNodesSingleLxcSingleFirewallIpsetSingle summary: getNodesSingleLxcSingleFirewallIpsetSingle description: List IPSet content tags: - nodes parameters: - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: >- #/components/responses/GetNodesSingleLxcSingleFirewallIpsetSingleResponse post: operationId: createNodesSingleLxcSingleFirewallIpsetSingle summary: createNodesSingleLxcSingleFirewallIpsetSingle description: Add IP or Network to IPSet. tags: - nodes parameters: - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: >- #/components/responses/CreateNodesSingleLxcSingleFirewallIpsetSingleResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleLxcSingleFirewallIpsetSingleRequest '/nodes/{node}/lxc/{vmid}/firewall/ipset/{name}/{cidr}': delete: operationId: deleteNodesSingleLxcSingleFirewallIpsetSingleSingle summary: deleteNodesSingleLxcSingleFirewallIpsetSingleSingle description: Remove IP or Network from IPSet. tags: - nodes parameters: - name: cidr in: path required: true description: cidr schema: type: string - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: >- #/components/responses/DeleteNodesSingleLxcSingleFirewallIpsetSingleSingleResponse get: operationId: getNodesSingleLxcSingleFirewallIpsetSingleSingle summary: getNodesSingleLxcSingleFirewallIpsetSingleSingle description: Read IP or Network settings from IPSet. tags: - nodes parameters: - name: cidr in: path required: true description: cidr schema: type: string - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: >- #/components/responses/GetNodesSingleLxcSingleFirewallIpsetSingleSingleResponse put: operationId: updateNodesSingleLxcSingleFirewallIpsetSingleSingle summary: updateNodesSingleLxcSingleFirewallIpsetSingleSingle description: Update IP or Network settings tags: - nodes parameters: - name: cidr in: path required: true description: cidr schema: type: string - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: >- #/components/responses/UpdateNodesSingleLxcSingleFirewallIpsetSingleSingleResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/UpdateNodesSingleLxcSingleFirewallIpsetSingleSingleRequest '/nodes/{node}/lxc/{vmid}/firewall/options': get: operationId: getNodesSingleLxcSingleFirewallOptions summary: getNodesSingleLxcSingleFirewallOptions description: Get VM firewall options. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: >- #/components/responses/GetNodesSingleLxcSingleFirewallOptionsResponse put: operationId: updateNodesSingleLxcSingleFirewallOptions summary: updateNodesSingleLxcSingleFirewallOptions description: Set Firewall options. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: >- #/components/responses/UpdateNodesSingleLxcSingleFirewallOptionsResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/UpdateNodesSingleLxcSingleFirewallOptionsRequest '/nodes/{node}/lxc/{vmid}/firewall/log': get: operationId: getNodesSingleLxcSingleFirewallLog summary: getNodesSingleLxcSingleFirewallLog description: Read firewall log tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/GetNodesSingleLxcSingleFirewallLogResponse' '/nodes/{node}/lxc/{vmid}/firewall/refs': get: operationId: getNodesSingleLxcSingleFirewallRefs summary: getNodesSingleLxcSingleFirewallRefs description: >- Lists possible IPSet/Alias reference which are allowed in source/dest properties. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/GetNodesSingleLxcSingleFirewallRefsResponse' '/nodes/{node}/lxc/{vmid}/rrd': get: operationId: getNodesSingleLxcSingleRrd summary: getNodesSingleLxcSingleRrd description: Read VM RRD statistics (returns PNG) tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/GetNodesSingleLxcSingleRrdResponse' '/nodes/{node}/lxc/{vmid}/rrddata': get: operationId: getNodesSingleLxcSingleRrddata summary: getNodesSingleLxcSingleRrddata description: Read VM RRD statistics tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/GetNodesSingleLxcSingleRrddataResponse' '/nodes/{node}/lxc/{vmid}/vncproxy': post: operationId: createNodesSingleLxcSingleVncproxy summary: createNodesSingleLxcSingleVncproxy description: Creates a TCP VNC proxy connections. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/CreateNodesSingleLxcSingleVncproxyResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleLxcSingleVncproxyRequest' '/nodes/{node}/lxc/{vmid}/termproxy': post: operationId: createNodesSingleLxcSingleTermproxy summary: createNodesSingleLxcSingleTermproxy description: Creates a TCP proxy connection. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/CreateNodesSingleLxcSingleTermproxyResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleLxcSingleTermproxyRequest' '/nodes/{node}/lxc/{vmid}/vncwebsocket': get: operationId: getNodesSingleLxcSingleVncwebsocket summary: getNodesSingleLxcSingleVncwebsocket description: Opens a weksocket for VNC traffic. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/GetNodesSingleLxcSingleVncwebsocketResponse' '/nodes/{node}/lxc/{vmid}/spiceproxy': post: operationId: createNodesSingleLxcSingleSpiceproxy summary: createNodesSingleLxcSingleSpiceproxy description: Returns a SPICE configuration to connect to the CT. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/CreateNodesSingleLxcSingleSpiceproxyResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleLxcSingleSpiceproxyRequest' '/nodes/{node}/lxc/{vmid}/migrate': post: operationId: createNodesSingleLxcSingleMigrate summary: createNodesSingleLxcSingleMigrate description: Migrate the container to another node. Creates a new migration task. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/CreateNodesSingleLxcSingleMigrateResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleLxcSingleMigrateRequest' '/nodes/{node}/lxc/{vmid}/feature': get: operationId: getNodesSingleLxcSingleFeature summary: getNodesSingleLxcSingleFeature description: Check if feature for virtual machine is available. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/GetNodesSingleLxcSingleFeatureResponse' '/nodes/{node}/lxc/{vmid}/template': post: operationId: createNodesSingleLxcSingleTemplate summary: createNodesSingleLxcSingleTemplate description: Create a Template. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/CreateNodesSingleLxcSingleTemplateResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleLxcSingleTemplateRequest' '/nodes/{node}/lxc/{vmid}/clone': post: operationId: createNodesSingleLxcSingleClone summary: createNodesSingleLxcSingleClone description: Create a container clone/copy tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/CreateNodesSingleLxcSingleCloneResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleLxcSingleCloneRequest' '/nodes/{node}/lxc/{vmid}/resize': put: operationId: updateNodesSingleLxcSingleResize summary: updateNodesSingleLxcSingleResize description: Resize a container mount point. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/UpdateNodesSingleLxcSingleResizeResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateNodesSingleLxcSingleResizeRequest' '/nodes/{node}/lxc/{vmid}/move_volume': post: operationId: createNodesSingleLxcSingleMovevolume summary: createNodesSingleLxcSingleMovevolume description: Move a rootfs-/mp-volume to a different storage tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/CreateNodesSingleLxcSingleMovevolumeResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleLxcSingleMovevolumeRequest' '/nodes/{node}/lxc/{vmid}/pending': get: operationId: getNodesSingleLxcSinglePending summary: getNodesSingleLxcSinglePending description: 'Get container configuration, including pending changes.' tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: '200': $ref: '#/components/responses/GetNodesSingleLxcSinglePendingResponse' '/nodes/{node}/ceph': get: operationId: getNodesSingleCeph summary: getNodesSingleCeph description: Directory index. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleCephResponse' '/nodes/{node}/ceph/osd': get: operationId: getNodesSingleCephOsd summary: getNodesSingleCephOsd description: Get Ceph osd list/tree. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleCephOsdResponse' post: operationId: createNodesSingleCephOsd summary: createNodesSingleCephOsd description: Create OSD tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/CreateNodesSingleCephOsdResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleCephOsdRequest' '/nodes/{node}/ceph/osd/{osdid}': delete: operationId: deleteNodesSingleCephOsdSingle summary: deleteNodesSingleCephOsdSingle description: Destroy OSD tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: osdid in: path required: true description: osdid schema: type: integer responses: '200': $ref: '#/components/responses/DeleteNodesSingleCephOsdSingleResponse' '/nodes/{node}/ceph/osd/{osdid}/in': post: operationId: createNodesSingleCephOsdSingleIn summary: createNodesSingleCephOsdSingleIn description: ceph osd in tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: osdid in: path required: true description: osdid schema: type: integer responses: '200': $ref: '#/components/responses/CreateNodesSingleCephOsdSingleInResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleCephOsdSingleInRequest' '/nodes/{node}/ceph/osd/{osdid}/out': post: operationId: createNodesSingleCephOsdSingleOut summary: createNodesSingleCephOsdSingleOut description: ceph osd out tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: osdid in: path required: true description: osdid schema: type: integer responses: '200': $ref: '#/components/responses/CreateNodesSingleCephOsdSingleOutResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleCephOsdSingleOutRequest' '/nodes/{node}/ceph/osd/{osdid}/scrub': post: operationId: createNodesSingleCephOsdSingleScrub summary: createNodesSingleCephOsdSingleScrub description: Instruct the OSD to scrub. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: osdid in: path required: true description: osdid schema: type: integer responses: '200': $ref: '#/components/responses/CreateNodesSingleCephOsdSingleScrubResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleCephOsdSingleScrubRequest' '/nodes/{node}/ceph/mds': get: operationId: getNodesSingleCephMds summary: getNodesSingleCephMds description: MDS directory index. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleCephMdsResponse' '/nodes/{node}/ceph/mds/{name}': delete: operationId: deleteNodesSingleCephMdsSingle summary: deleteNodesSingleCephMdsSingle description: Destroy Ceph Metadata Server tags: - nodes parameters: - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/DeleteNodesSingleCephMdsSingleResponse' post: operationId: createNodesSingleCephMdsSingle summary: createNodesSingleCephMdsSingle description: Create Ceph Metadata Server (MDS) tags: - nodes parameters: - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/CreateNodesSingleCephMdsSingleResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleCephMdsSingleRequest' '/nodes/{node}/ceph/mgr': get: operationId: getNodesSingleCephMgr summary: getNodesSingleCephMgr description: MGR directory index. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleCephMgrResponse' '/nodes/{node}/ceph/mgr/{id}': delete: operationId: deleteNodesSingleCephMgrSingle summary: deleteNodesSingleCephMgrSingle description: Destroy Ceph Manager. tags: - nodes parameters: - name: id in: path required: true description: id schema: type: string - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/DeleteNodesSingleCephMgrSingleResponse' post: operationId: createNodesSingleCephMgrSingle summary: createNodesSingleCephMgrSingle description: Create Ceph Manager tags: - nodes parameters: - name: id in: path required: true description: id schema: type: string - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/CreateNodesSingleCephMgrSingleResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleCephMgrSingleRequest' '/nodes/{node}/ceph/mon': get: operationId: getNodesSingleCephMon summary: getNodesSingleCephMon description: Get Ceph monitor list. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleCephMonResponse' '/nodes/{node}/ceph/mon/{monid}': delete: operationId: deleteNodesSingleCephMonSingle summary: deleteNodesSingleCephMonSingle description: Destroy Ceph Monitor and Manager. tags: - nodes parameters: - name: monid in: path required: true description: monid schema: type: string - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/DeleteNodesSingleCephMonSingleResponse' post: operationId: createNodesSingleCephMonSingle summary: createNodesSingleCephMonSingle description: Create Ceph Monitor and Manager tags: - nodes parameters: - name: monid in: path required: true description: monid schema: type: string - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/CreateNodesSingleCephMonSingleResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleCephMonSingleRequest' '/nodes/{node}/ceph/fs': get: operationId: getNodesSingleCephFs summary: getNodesSingleCephFs description: Directory index. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleCephFsResponse' '/nodes/{node}/ceph/fs/{name}': post: operationId: createNodesSingleCephFsSingle summary: createNodesSingleCephFsSingle description: Create a Ceph filesystem tags: - nodes parameters: - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/CreateNodesSingleCephFsSingleResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleCephFsSingleRequest' '/nodes/{node}/ceph/disks': get: operationId: getNodesSingleCephDisks summary: getNodesSingleCephDisks description: List local disks. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleCephDisksResponse' '/nodes/{node}/ceph/config': get: operationId: getNodesSingleCephConfig summary: getNodesSingleCephConfig description: Get Ceph configuration. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleCephConfigResponse' '/nodes/{node}/ceph/configdb': get: operationId: getNodesSingleCephConfigdb summary: getNodesSingleCephConfigdb description: Get Ceph configuration database. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleCephConfigdbResponse' '/nodes/{node}/ceph/init': post: operationId: createNodesSingleCephInit summary: createNodesSingleCephInit description: Create initial ceph default configuration and setup symlinks. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/CreateNodesSingleCephInitResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleCephInitRequest' '/nodes/{node}/ceph/stop': post: operationId: createNodesSingleCephStop summary: createNodesSingleCephStop description: Stop ceph services. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/CreateNodesSingleCephStopResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleCephStopRequest' '/nodes/{node}/ceph/start': post: operationId: createNodesSingleCephStart summary: createNodesSingleCephStart description: Start ceph services. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/CreateNodesSingleCephStartResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleCephStartRequest' '/nodes/{node}/ceph/restart': post: operationId: createNodesSingleCephRestart summary: createNodesSingleCephRestart description: Restart ceph services. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/CreateNodesSingleCephRestartResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleCephRestartRequest' '/nodes/{node}/ceph/status': get: operationId: getNodesSingleCephStatus summary: getNodesSingleCephStatus description: Get ceph status. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleCephStatusResponse' '/nodes/{node}/ceph/pools': get: operationId: getNodesSingleCephPools summary: getNodesSingleCephPools description: List all pools. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleCephPoolsResponse' post: operationId: createNodesSingleCephPools summary: createNodesSingleCephPools description: Create POOL tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/CreateNodesSingleCephPoolsResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleCephPoolsRequest' '/nodes/{node}/ceph/pools/{name}': delete: operationId: deleteNodesSingleCephPoolsSingle summary: deleteNodesSingleCephPoolsSingle description: Destroy pool tags: - nodes parameters: - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/DeleteNodesSingleCephPoolsSingleResponse' put: operationId: updateNodesSingleCephPoolsSingle summary: updateNodesSingleCephPoolsSingle description: Change POOL settings tags: - nodes parameters: - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/UpdateNodesSingleCephPoolsSingleResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateNodesSingleCephPoolsSingleRequest' '/nodes/{node}/ceph/flags': get: operationId: getNodesSingleCephFlags summary: getNodesSingleCephFlags description: get all set ceph flags tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleCephFlagsResponse' '/nodes/{node}/ceph/flags/{flag}': delete: operationId: deleteNodesSingleCephFlagsSingle summary: deleteNodesSingleCephFlagsSingle description: Unset a ceph flag tags: - nodes parameters: - name: flag in: path required: true description: flag schema: type: string - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/DeleteNodesSingleCephFlagsSingleResponse' post: operationId: createNodesSingleCephFlagsSingle summary: createNodesSingleCephFlagsSingle description: Set a specific ceph flag tags: - nodes parameters: - name: flag in: path required: true description: flag schema: type: string - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/CreateNodesSingleCephFlagsSingleResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleCephFlagsSingleRequest' '/nodes/{node}/ceph/crush': get: operationId: getNodesSingleCephCrush summary: getNodesSingleCephCrush description: Get OSD crush map tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleCephCrushResponse' '/nodes/{node}/ceph/log': get: operationId: getNodesSingleCephLog summary: getNodesSingleCephLog description: Read ceph log tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleCephLogResponse' '/nodes/{node}/ceph/rules': get: operationId: getNodesSingleCephRules summary: getNodesSingleCephRules description: List ceph rules. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleCephRulesResponse' '/nodes/{node}/vzdump': post: operationId: createNodesSingleVzdump summary: createNodesSingleVzdump description: Create backup. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/CreateNodesSingleVzdumpResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleVzdumpRequest' '/nodes/{node}/vzdump/extractconfig': get: operationId: getNodesSingleVzdumpExtractconfig summary: getNodesSingleVzdumpExtractconfig description: Extract configuration from vzdump backup archive. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleVzdumpExtractconfigResponse' '/nodes/{node}/services': get: operationId: getNodesSingleServices summary: getNodesSingleServices description: Service list. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleServicesResponse' '/nodes/{node}/services/{service}': get: operationId: getNodesSingleServicesSingle summary: getNodesSingleServicesSingle description: Directory index tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: service in: path required: true description: service schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleServicesSingleResponse' '/nodes/{node}/services/{service}/state': get: operationId: getNodesSingleServicesSingleState summary: getNodesSingleServicesSingleState description: Read service properties tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: service in: path required: true description: service schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleServicesSingleStateResponse' '/nodes/{node}/services/{service}/start': post: operationId: createNodesSingleServicesSingleStart summary: createNodesSingleServicesSingleStart description: Start service. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: service in: path required: true description: service schema: type: string responses: '200': $ref: '#/components/responses/CreateNodesSingleServicesSingleStartResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleServicesSingleStartRequest' '/nodes/{node}/services/{service}/stop': post: operationId: createNodesSingleServicesSingleStop summary: createNodesSingleServicesSingleStop description: Stop service. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: service in: path required: true description: service schema: type: string responses: '200': $ref: '#/components/responses/CreateNodesSingleServicesSingleStopResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleServicesSingleStopRequest' '/nodes/{node}/services/{service}/restart': post: operationId: createNodesSingleServicesSingleRestart summary: createNodesSingleServicesSingleRestart description: Hard restart service. Use reload if you want to reduce interruptions. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: service in: path required: true description: service schema: type: string responses: '200': $ref: >- #/components/responses/CreateNodesSingleServicesSingleRestartResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleServicesSingleRestartRequest '/nodes/{node}/services/{service}/reload': post: operationId: createNodesSingleServicesSingleReload summary: createNodesSingleServicesSingleReload description: Reload service. Falls back to restart if service cannot be reloaded. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: service in: path required: true description: service schema: type: string responses: '200': $ref: '#/components/responses/CreateNodesSingleServicesSingleReloadResponse' requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleServicesSingleReloadRequest '/nodes/{node}/subscription': delete: operationId: deleteNodesSingleSubscription summary: deleteNodesSingleSubscription description: Delete subscription key of this node. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/DeleteNodesSingleSubscriptionResponse' get: operationId: getNodesSingleSubscription summary: getNodesSingleSubscription description: Read subscription info. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleSubscriptionResponse' post: operationId: createNodesSingleSubscription summary: createNodesSingleSubscription description: Update subscription info. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/CreateNodesSingleSubscriptionResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleSubscriptionRequest' put: operationId: updateNodesSingleSubscription summary: updateNodesSingleSubscription description: Set subscription key. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/UpdateNodesSingleSubscriptionResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateNodesSingleSubscriptionRequest' '/nodes/{node}/network': delete: operationId: deleteNodesSingleNetwork summary: deleteNodesSingleNetwork description: Revert network configuration changes. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/DeleteNodesSingleNetworkResponse' get: operationId: getNodesSingleNetwork summary: getNodesSingleNetwork description: List available networks tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleNetworkResponse' post: operationId: createNodesSingleNetwork summary: createNodesSingleNetwork description: Create network device configuration tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/CreateNodesSingleNetworkResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleNetworkRequest' put: operationId: updateNodesSingleNetwork summary: updateNodesSingleNetwork description: Reload network configuration tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/UpdateNodesSingleNetworkResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateNodesSingleNetworkRequest' '/nodes/{node}/network/{iface}': delete: operationId: deleteNodesSingleNetworkSingle summary: deleteNodesSingleNetworkSingle description: Delete network device configuration tags: - nodes parameters: - name: iface in: path required: true description: iface schema: type: string - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/DeleteNodesSingleNetworkSingleResponse' get: operationId: getNodesSingleNetworkSingle summary: getNodesSingleNetworkSingle description: Read network device configuration tags: - nodes parameters: - name: iface in: path required: true description: iface schema: type: string - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleNetworkSingleResponse' put: operationId: updateNodesSingleNetworkSingle summary: updateNodesSingleNetworkSingle description: Update network device configuration tags: - nodes parameters: - name: iface in: path required: true description: iface schema: type: string - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/UpdateNodesSingleNetworkSingleResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateNodesSingleNetworkSingleRequest' '/nodes/{node}/tasks': get: operationId: getNodeTasks summary: getNodeTasks description: Read task list for one node (finished tasks). tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodeTasksResponse' '/nodes/{node}/tasks/{upid}': delete: operationId: stopNodeTask summary: stopNodeTask description: Stop a task. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: upid in: path required: true description: upid schema: type: string responses: '200': $ref: '#/components/responses/StopNodeTaskResponse' get: operationId: getNodeTask summary: getNodeTask description: getNodeTask tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: upid in: path required: true description: upid schema: type: string responses: '200': $ref: '#/components/responses/GetNodeTaskResponse' '/nodes/{node}/tasks/{upid}/log': get: operationId: getNodeTaskLog summary: getNodeTaskLog description: Read task log. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: upid in: path required: true description: upid schema: type: string responses: '200': $ref: '#/components/responses/GetNodeTaskLogResponse' '/nodes/{node}/tasks/{upid}/status': get: operationId: getNodeTaskStatus summary: getNodeTaskStatus description: Read task status. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: upid in: path required: true description: upid schema: type: string responses: '200': $ref: '#/components/responses/GetNodeTaskStatusResponse' '/nodes/{node}/scan': get: operationId: getNodesSingleScan summary: getNodesSingleScan description: Index of available scan methods tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleScanResponse' '/nodes/{node}/scan/zfs': get: operationId: getNodesSingleScanZfs summary: getNodesSingleScanZfs description: Scan zfs pool list on local node. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleScanZfsResponse' '/nodes/{node}/scan/nfs': get: operationId: getNodesSingleScanNfs summary: getNodesSingleScanNfs description: Scan remote NFS server. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleScanNfsResponse' '/nodes/{node}/scan/cifs': get: operationId: getNodesSingleScanCifs summary: getNodesSingleScanCifs description: Scan remote CIFS server. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleScanCifsResponse' '/nodes/{node}/scan/glusterfs': get: operationId: getNodesSingleScanGlusterfs summary: getNodesSingleScanGlusterfs description: Scan remote GlusterFS server. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleScanGlusterfsResponse' '/nodes/{node}/scan/iscsi': get: operationId: getNodesSingleScanIscsi summary: getNodesSingleScanIscsi description: Scan remote iSCSI server. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleScanIscsiResponse' '/nodes/{node}/scan/lvm': get: operationId: getNodesSingleScanLvm summary: getNodesSingleScanLvm description: List local LVM volume groups. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleScanLvmResponse' '/nodes/{node}/scan/lvmthin': get: operationId: getNodesSingleScanLvmthin summary: getNodesSingleScanLvmthin description: List local LVM Thin Pools. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleScanLvmthinResponse' '/nodes/{node}/scan/usb': get: operationId: getNodesSingleScanUsb summary: getNodesSingleScanUsb description: List local USB devices. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleScanUsbResponse' '/nodes/{node}/hardware': get: operationId: getNodesSingleHardware summary: getNodesSingleHardware description: Index of hardware types tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleHardwareResponse' '/nodes/{node}/hardware/pci': get: operationId: getNodesSingleHardwarePci summary: getNodesSingleHardwarePci description: List local PCI devices. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleHardwarePciResponse' '/nodes/{node}/hardware/pci/{pciid}': get: operationId: getNodesSingleHardwarePciSingle summary: getNodesSingleHardwarePciSingle description: Index of available pci methods tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: pciid in: path required: true description: pciid schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleHardwarePciSingleResponse' '/nodes/{node}/hardware/pci/{pciid}/mdev': get: operationId: getNodesSingleHardwarePciSingleMdev summary: getNodesSingleHardwarePciSingleMdev description: List mediated device types for given PCI device. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: pciid in: path required: true description: pciid schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleHardwarePciSingleMdevResponse' '/nodes/{node}/storage': get: operationId: getNodesSingleStorage summary: getNodesSingleStorage description: Get status for all datastores. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleStorageResponse' '/nodes/{node}/storage/{storage}': get: operationId: getNodesSingleStorageSingle summary: getNodesSingleStorageSingle description: getNodesSingleStorageSingle tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: storage in: path required: true description: storage schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleStorageSingleResponse' '/nodes/{node}/storage/{storage}/prunebackups': delete: operationId: deleteNodesSingleStorageSinglePrunebackups summary: deleteNodesSingleStorageSinglePrunebackups description: >- Prune backups. Only those using the standard naming scheme are considered. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: storage in: path required: true description: storage schema: type: string responses: '200': $ref: >- #/components/responses/DeleteNodesSingleStorageSinglePrunebackupsResponse get: operationId: getNodesSingleStorageSinglePrunebackups summary: getNodesSingleStorageSinglePrunebackups description: >- Get prune information for backups. NOTE: this is only a preview and might not be what a subsequent prune call does if backups are removed/added in the meantime. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: storage in: path required: true description: storage schema: type: string responses: '200': $ref: >- #/components/responses/GetNodesSingleStorageSinglePrunebackupsResponse '/nodes/{node}/storage/{storage}/content': get: operationId: getNodesSingleStorageSingleContent summary: getNodesSingleStorageSingleContent description: List storage content. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: storage in: path required: true description: storage schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleStorageSingleContentResponse' post: operationId: createNodesSingleStorageSingleContent summary: createNodesSingleStorageSingleContent description: Allocate disk images. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: storage in: path required: true description: storage schema: type: string responses: '200': $ref: '#/components/responses/CreateNodesSingleStorageSingleContentResponse' requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleStorageSingleContentRequest '/nodes/{node}/storage/{storage}/content/{volume}': delete: operationId: deleteNodesSingleStorageSingleContentSingle summary: deleteNodesSingleStorageSingleContentSingle description: Delete volume tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: storage in: path required: true description: storage schema: type: string - name: volume in: path required: true description: volume schema: type: string responses: '200': $ref: >- #/components/responses/DeleteNodesSingleStorageSingleContentSingleResponse get: operationId: getNodesSingleStorageSingleContentSingle summary: getNodesSingleStorageSingleContentSingle description: Get volume attributes tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: storage in: path required: true description: storage schema: type: string - name: volume in: path required: true description: volume schema: type: string responses: '200': $ref: >- #/components/responses/GetNodesSingleStorageSingleContentSingleResponse post: operationId: createNodesSingleStorageSingleContentSingle summary: createNodesSingleStorageSingleContentSingle description: Copy a volume. This is experimental code - do not use. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: storage in: path required: true description: storage schema: type: string - name: volume in: path required: true description: volume schema: type: string responses: '200': $ref: >- #/components/responses/CreateNodesSingleStorageSingleContentSingleResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleStorageSingleContentSingleRequest put: operationId: updateNodesSingleStorageSingleContentSingle summary: updateNodesSingleStorageSingleContentSingle description: Update volume attributes tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: storage in: path required: true description: storage schema: type: string - name: volume in: path required: true description: volume schema: type: string responses: '200': $ref: >- #/components/responses/UpdateNodesSingleStorageSingleContentSingleResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/UpdateNodesSingleStorageSingleContentSingleRequest '/nodes/{node}/storage/{storage}/status': get: operationId: getNodesSingleStorageSingleStatus summary: getNodesSingleStorageSingleStatus description: Read storage status. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: storage in: path required: true description: storage schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleStorageSingleStatusResponse' '/nodes/{node}/storage/{storage}/rrd': get: operationId: getNodesSingleStorageSingleRrd summary: getNodesSingleStorageSingleRrd description: Read storage RRD statistics (returns PNG). tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: storage in: path required: true description: storage schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleStorageSingleRrdResponse' '/nodes/{node}/storage/{storage}/rrddata': get: operationId: getNodesSingleStorageSingleRrddata summary: getNodesSingleStorageSingleRrddata description: Read storage RRD statistics. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: storage in: path required: true description: storage schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleStorageSingleRrddataResponse' '/nodes/{node}/storage/{storage}/upload': post: operationId: createNodesSingleStorageSingleUpload summary: createNodesSingleStorageSingleUpload description: Upload templates and ISO images. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: storage in: path required: true description: storage schema: type: string responses: '200': $ref: '#/components/responses/CreateNodesSingleStorageSingleUploadResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleStorageSingleUploadRequest' '/nodes/{node}/disks': get: operationId: getNodesSingleDisks summary: getNodesSingleDisks description: Node index. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleDisksResponse' '/nodes/{node}/disks/lvm': get: operationId: getNodesSingleDisksLvm summary: getNodesSingleDisksLvm description: List LVM Volume Groups tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleDisksLvmResponse' post: operationId: createNodesSingleDisksLvm summary: createNodesSingleDisksLvm description: Create an LVM Volume Group tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/CreateNodesSingleDisksLvmResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleDisksLvmRequest' '/nodes/{node}/disks/lvmthin': get: operationId: getNodesSingleDisksLvmthin summary: getNodesSingleDisksLvmthin description: List LVM thinpools tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleDisksLvmthinResponse' post: operationId: createNodesSingleDisksLvmthin summary: createNodesSingleDisksLvmthin description: Create an LVM thinpool tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/CreateNodesSingleDisksLvmthinResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleDisksLvmthinRequest' '/nodes/{node}/disks/directory': get: operationId: getNodesSingleDisksDirectory summary: getNodesSingleDisksDirectory description: PVE Managed Directory storages. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleDisksDirectoryResponse' post: operationId: createNodesSingleDisksDirectory summary: createNodesSingleDisksDirectory description: >- Create a Filesystem on an unused disk. Will be mounted under '/mnt/pve/NAME'. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/CreateNodesSingleDisksDirectoryResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleDisksDirectoryRequest' '/nodes/{node}/disks/zfs': get: operationId: getNodesSingleDisksZfs summary: getNodesSingleDisksZfs description: List Zpools. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleDisksZfsResponse' post: operationId: createNodesSingleDisksZfs summary: createNodesSingleDisksZfs description: Create a ZFS pool. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/CreateNodesSingleDisksZfsResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleDisksZfsRequest' '/nodes/{node}/disks/zfs/{name}': get: operationId: getNodesSingleDisksZfsSingle summary: getNodesSingleDisksZfsSingle description: Get details about a zpool. tags: - nodes parameters: - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleDisksZfsSingleResponse' '/nodes/{node}/disks/list': get: operationId: getNodesSingleDisksList summary: getNodesSingleDisksList description: List local disks. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleDisksListResponse' '/nodes/{node}/disks/smart': get: operationId: getNodesSingleDisksSmart summary: getNodesSingleDisksSmart description: Get SMART Health of a disk. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleDisksSmartResponse' '/nodes/{node}/disks/initgpt': post: operationId: createNodesSingleDisksInitgpt summary: createNodesSingleDisksInitgpt description: Initialize Disk with GPT tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/CreateNodesSingleDisksInitgptResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleDisksInitgptRequest' '/nodes/{node}/apt': get: operationId: getNodesSingleApt summary: getNodesSingleApt description: Directory index for apt (Advanced Package Tool). tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleAptResponse' '/nodes/{node}/apt/update': get: operationId: getNodesSingleAptUpdate summary: getNodesSingleAptUpdate description: List available updates. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleAptUpdateResponse' post: operationId: createNodesSingleAptUpdate summary: createNodesSingleAptUpdate description: >- This is used to resynchronize the package index files from their sources (apt-get update). tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/CreateNodesSingleAptUpdateResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleAptUpdateRequest' '/nodes/{node}/apt/changelog': get: operationId: getNodesSingleAptChangelog summary: getNodesSingleAptChangelog description: Get package changelogs. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleAptChangelogResponse' '/nodes/{node}/apt/versions': get: operationId: getNodesSingleAptVersions summary: getNodesSingleAptVersions description: Get package information for important Proxmox packages. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleAptVersionsResponse' '/nodes/{node}/firewall': get: operationId: getNodeFirewall summary: getNodeFirewall description: Directory index. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodeFirewallResponse' '/nodes/{node}/firewall/rules': get: operationId: getNodeFirewallRules summary: getNodeFirewallRules description: List rules. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodeFirewallRulesResponse' post: operationId: createNodeFirewallRule summary: createNodeFirewallRule description: Create new rule. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/CreateNodeFirewallRuleResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodeFirewallRuleRequest' '/nodes/{node}/firewall/rules/{pos}': delete: operationId: deleteNodeFirewallRule summary: deleteNodeFirewallRule description: Delete rule. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: pos in: path required: true description: pos schema: type: integer responses: '200': $ref: '#/components/responses/DeleteNodeFirewallRuleResponse' get: operationId: getNodeFirewallRule summary: getNodeFirewallRule description: Get single rule data. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: pos in: path required: true description: pos schema: type: integer responses: '200': $ref: '#/components/responses/GetNodeFirewallRuleResponse' put: operationId: updateNodeFirewallRule summary: updateNodeFirewallRule description: Modify rule data. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: pos in: path required: true description: pos schema: type: integer responses: '200': $ref: '#/components/responses/UpdateNodeFirewallRuleResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateNodeFirewallRuleRequest' '/nodes/{node}/firewall/options': get: operationId: getNodeFirewallOptions summary: getNodeFirewallOptions description: Get host firewall options. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodeFirewallOptionsResponse' put: operationId: updateNodeFirewallOptions summary: updateNodeFirewallOptions description: Set Firewall options. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/UpdateNodeFirewallOptionsResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateNodeFirewallOptionsRequest' '/nodes/{node}/firewall/log': get: operationId: getNodesSingleFirewallLog summary: getNodesSingleFirewallLog description: Read firewall log tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleFirewallLogResponse' '/nodes/{node}/replication': get: operationId: getNodesSingleReplication summary: getNodesSingleReplication description: List status of all replication jobs on this node. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleReplicationResponse' '/nodes/{node}/replication/{id}': get: operationId: getNodesSingleReplicationSingle summary: getNodesSingleReplicationSingle description: Directory index. tags: - nodes parameters: - name: id in: path required: true description: id schema: type: string - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleReplicationSingleResponse' '/nodes/{node}/replication/{id}/status': get: operationId: getNodesSingleReplicationSingleStatus summary: getNodesSingleReplicationSingleStatus description: Get replication job status. tags: - nodes parameters: - name: id in: path required: true description: id schema: type: string - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleReplicationSingleStatusResponse' '/nodes/{node}/replication/{id}/log': get: operationId: getNodesSingleReplicationSingleLog summary: getNodesSingleReplicationSingleLog description: Read replication job log. tags: - nodes parameters: - name: id in: path required: true description: id schema: type: string - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleReplicationSingleLogResponse' '/nodes/{node}/replication/{id}/schedule_now': post: operationId: createNodesSingleReplicationSingleSchedulenow summary: createNodesSingleReplicationSingleSchedulenow description: Schedule replication job to start as soon as possible. tags: - nodes parameters: - name: id in: path required: true description: id schema: type: string - name: node in: path required: true description: node schema: type: string responses: '200': $ref: >- #/components/responses/CreateNodesSingleReplicationSingleSchedulenowResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleReplicationSingleSchedulenowRequest '/nodes/{node}/certificates': get: operationId: getNodesSingleCertificates summary: getNodesSingleCertificates description: Node index. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleCertificatesResponse' '/nodes/{node}/certificates/acme': get: operationId: getNodesSingleCertificatesAcme summary: getNodesSingleCertificatesAcme description: ACME index. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleCertificatesAcmeResponse' '/nodes/{node}/certificates/acme/certificate': delete: operationId: deleteNodesSingleCertificatesAcmeCertificate summary: deleteNodesSingleCertificatesAcmeCertificate description: Revoke existing certificate from CA. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: >- #/components/responses/DeleteNodesSingleCertificatesAcmeCertificateResponse post: operationId: createNodesSingleCertificatesAcmeCertificate summary: createNodesSingleCertificatesAcmeCertificate description: Order a new certificate from ACME-compatible CA. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: >- #/components/responses/CreateNodesSingleCertificatesAcmeCertificateResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleCertificatesAcmeCertificateRequest put: operationId: updateNodesSingleCertificatesAcmeCertificate summary: updateNodesSingleCertificatesAcmeCertificate description: Renew existing certificate from CA. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: >- #/components/responses/UpdateNodesSingleCertificatesAcmeCertificateResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/UpdateNodesSingleCertificatesAcmeCertificateRequest '/nodes/{node}/certificates/info': get: operationId: getNodesSingleCertificatesInfo summary: getNodesSingleCertificatesInfo description: Get information about node's certificates. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleCertificatesInfoResponse' '/nodes/{node}/certificates/custom': delete: operationId: deleteNodesSingleCertificatesCustom summary: deleteNodesSingleCertificatesCustom description: DELETE custom certificate chain and key. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/DeleteNodesSingleCertificatesCustomResponse' post: operationId: createNodesSingleCertificatesCustom summary: createNodesSingleCertificatesCustom description: Upload or update custom certificate chain and key. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/CreateNodesSingleCertificatesCustomResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleCertificatesCustomRequest' '/nodes/{node}/config': get: operationId: getNodesSingleConfig summary: getNodesSingleConfig description: Get node configuration options. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleConfigResponse' put: operationId: updateNodesSingleConfig summary: updateNodesSingleConfig description: Set node configuration options. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/UpdateNodesSingleConfigResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateNodesSingleConfigRequest' '/nodes/{node}/sdn': get: operationId: getNodeSDN summary: getNodeSDN description: SDN index. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodeSDNResponse' '/nodes/{node}/sdn/zones': get: operationId: getNodeSDNZones summary: getNodeSDNZones description: Get status for all zones. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodeSDNZonesResponse' '/nodes/{node}/sdn/zones/{zone}': get: operationId: getNodeSDNZone summary: getNodeSDNZone description: getNodeSDNZone tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: zone in: path required: true description: zone schema: type: string responses: '200': $ref: '#/components/responses/GetNodeSDNZoneResponse' '/nodes/{node}/sdn/zones/{zone}/content': get: operationId: getNodeSDNZoneContent summary: getNodeSDNZoneContent description: List zone content. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: zone in: path required: true description: zone schema: type: string responses: '200': $ref: '#/components/responses/GetNodeSDNZoneContentResponse' '/nodes/{node}/version': get: operationId: getNodesSingleVersion summary: getNodesSingleVersion description: API version details tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleVersionResponse' '/nodes/{node}/status': get: operationId: getNodesSingleStatus summary: getNodesSingleStatus description: Read node status tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleStatusResponse' post: operationId: createNodesSingleStatus summary: createNodesSingleStatus description: Reboot or shutdown a node. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/CreateNodesSingleStatusResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleStatusRequest' '/nodes/{node}/netstat': get: operationId: getNodesSingleNetstat summary: getNodesSingleNetstat description: Read tap/vm network device interface counters tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleNetstatResponse' '/nodes/{node}/execute': post: operationId: createNodesSingleExecute summary: createNodesSingleExecute description: Execute multiple commands in order. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/CreateNodesSingleExecuteResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleExecuteRequest' '/nodes/{node}/wakeonlan': post: operationId: createNodesSingleWakeonlan summary: createNodesSingleWakeonlan description: Try to wake a node via 'wake on LAN' network packet. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/CreateNodesSingleWakeonlanResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleWakeonlanRequest' '/nodes/{node}/rrd': get: operationId: getNodeRRD summary: getNodeRRD description: Read node RRD statistics (returns PNG) tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodeRRDResponse' '/nodes/{node}/rrddata': get: operationId: getNodeRRDData summary: getNodeRRDData description: Read node RRD statistics tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodeRRDDataResponse' '/nodes/{node}/syslog': get: operationId: getNodesSingleSyslog summary: getNodesSingleSyslog description: Read system log tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleSyslogResponse' '/nodes/{node}/journal': get: operationId: getNodesSingleJournal summary: getNodesSingleJournal description: Read Journal tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleJournalResponse' '/nodes/{node}/vncshell': post: operationId: createNodesSingleVncshell summary: createNodesSingleVncshell description: Creates a VNC Shell proxy. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/CreateNodesSingleVncshellResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleVncshellRequest' '/nodes/{node}/termproxy': post: operationId: createNodesSingleTermproxy summary: createNodesSingleTermproxy description: Creates a VNC Shell proxy. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/CreateNodesSingleTermproxyResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleTermproxyRequest' '/nodes/{node}/vncwebsocket': get: operationId: getNodesSingleVncwebsocket summary: getNodesSingleVncwebsocket description: Opens a weksocket for VNC traffic. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleVncwebsocketResponse' '/nodes/{node}/spiceshell': post: operationId: createNodesSingleSpiceshell summary: createNodesSingleSpiceshell description: Creates a SPICE shell. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/CreateNodesSingleSpiceshellResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleSpiceshellRequest' '/nodes/{node}/dns': get: operationId: getNodesSingleDns summary: getNodesSingleDns description: Read DNS settings. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleDnsResponse' put: operationId: updateNodesSingleDns summary: updateNodesSingleDns description: Write DNS settings. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/UpdateNodesSingleDnsResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateNodesSingleDnsRequest' '/nodes/{node}/time': get: operationId: getNodesSingleTime summary: getNodesSingleTime description: Read server time and time zone settings. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleTimeResponse' put: operationId: updateNodesSingleTime summary: updateNodesSingleTime description: Set time zone. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/UpdateNodesSingleTimeResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateNodesSingleTimeRequest' '/nodes/{node}/aplinfo': get: operationId: getNodesSingleAplinfo summary: getNodesSingleAplinfo description: Get list of appliances. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleAplinfoResponse' post: operationId: createNodesSingleAplinfo summary: createNodesSingleAplinfo description: Download appliance templates. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/CreateNodesSingleAplinfoResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleAplinfoRequest' '/nodes/{node}/report': get: operationId: getNodesSingleReport summary: getNodesSingleReport description: Gather various systems information about a node tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleReportResponse' '/nodes/{node}/startall': post: operationId: createNodesSingleStartall summary: createNodesSingleStartall description: >- Start all VMs and containers located on this node (by default only those with onboot=1). tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/CreateNodesSingleStartallResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleStartallRequest' '/nodes/{node}/stopall': post: operationId: createNodesSingleStopall summary: createNodesSingleStopall description: Stop all VMs and Containers. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/CreateNodesSingleStopallResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleStopallRequest' '/nodes/{node}/migrateall': post: operationId: createNodesSingleMigrateall summary: createNodesSingleMigrateall description: Migrate all VMs and Containers. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/CreateNodesSingleMigrateallResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleMigrateallRequest' '/nodes/{node}/hosts': get: operationId: getNodesSingleHosts summary: getNodesSingleHosts description: Get the content of /etc/hosts. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/GetNodesSingleHostsResponse' post: operationId: createNodesSingleHosts summary: createNodesSingleHosts description: Write /etc/hosts. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: '200': $ref: '#/components/responses/CreateNodesSingleHostsResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodesSingleHostsRequest' /storage: get: operationId: getStorage summary: getStorage description: Storage index. tags: - storage parameters: [] responses: '200': $ref: '#/components/responses/GetStorageResponse' post: operationId: createStorage summary: createStorage description: Create a new storage. tags: - storage parameters: [] responses: '200': $ref: '#/components/responses/CreateStorageResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateStorageRequest' '/storage/{storage}': delete: operationId: deleteStorageSingle summary: deleteStorageSingle description: Delete storage configuration. tags: - storage parameters: - name: storage in: path required: true description: storage schema: type: string responses: '200': $ref: '#/components/responses/DeleteStorageSingleResponse' get: operationId: getStorageSingle summary: getStorageSingle description: Read storage configuration. tags: - storage parameters: - name: storage in: path required: true description: storage schema: type: string responses: '200': $ref: '#/components/responses/GetStorageSingleResponse' put: operationId: updateStorageSingle summary: updateStorageSingle description: Update storage configuration. tags: - storage parameters: - name: storage in: path required: true description: storage schema: type: string responses: '200': $ref: '#/components/responses/UpdateStorageSingleResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateStorageSingleRequest' /access: get: operationId: getAccess summary: getAccess description: Directory index. tags: - access parameters: [] responses: '200': $ref: '#/components/responses/GetAccessResponse' /access/users: get: operationId: getAccessUsers summary: getAccessUsers description: User index. tags: - access parameters: [] responses: '200': $ref: '#/components/responses/GetAccessUsersResponse' post: operationId: createAccessUsers summary: createAccessUsers description: Create new user. tags: - access parameters: [] responses: '200': $ref: '#/components/responses/CreateAccessUsersResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAccessUsersRequest' '/access/users/{userid}': delete: operationId: deleteAccessUsersSingle summary: deleteAccessUsersSingle description: Delete user. tags: - access parameters: - name: userid in: path required: true description: userid schema: type: string responses: '200': $ref: '#/components/responses/DeleteAccessUsersSingleResponse' get: operationId: getAccessUsersSingle summary: getAccessUsersSingle description: Get user configuration. tags: - access parameters: - name: userid in: path required: true description: userid schema: type: string responses: '200': $ref: '#/components/responses/GetAccessUsersSingleResponse' put: operationId: updateAccessUsersSingle summary: updateAccessUsersSingle description: Update user configuration. tags: - access parameters: - name: userid in: path required: true description: userid schema: type: string responses: '200': $ref: '#/components/responses/UpdateAccessUsersSingleResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAccessUsersSingleRequest' '/access/users/{userid}/tfa': get: operationId: getAccessUsersSingleTfa summary: getAccessUsersSingleTfa description: Get user TFA types (Personal and Realm). tags: - access parameters: - name: userid in: path required: true description: userid schema: type: string responses: '200': $ref: '#/components/responses/GetAccessUsersSingleTfaResponse' '/access/users/{userid}/token': get: operationId: getAccessUsersSingleToken summary: getAccessUsersSingleToken description: Get user API tokens. tags: - access parameters: - name: userid in: path required: true description: userid schema: type: string responses: '200': $ref: '#/components/responses/GetAccessUsersSingleTokenResponse' '/access/users/{userid}/token/{tokenid}': delete: operationId: deleteAccessUsersSingleTokenSingle summary: deleteAccessUsersSingleTokenSingle description: Remove API token for a specific user. tags: - access parameters: - name: tokenid in: path required: true description: tokenid schema: type: string - name: userid in: path required: true description: userid schema: type: string responses: '200': $ref: '#/components/responses/DeleteAccessUsersSingleTokenSingleResponse' get: operationId: getAccessUsersSingleTokenSingle summary: getAccessUsersSingleTokenSingle description: Get specific API token information. tags: - access parameters: - name: tokenid in: path required: true description: tokenid schema: type: string - name: userid in: path required: true description: userid schema: type: string responses: '200': $ref: '#/components/responses/GetAccessUsersSingleTokenSingleResponse' post: operationId: createAccessUsersSingleTokenSingle summary: createAccessUsersSingleTokenSingle description: >- Generate a new API token for a specific user. NOTE: returns API token value, which needs to be stored as it cannot be retrieved afterwards! tags: - access parameters: - name: tokenid in: path required: true description: tokenid schema: type: string - name: userid in: path required: true description: userid schema: type: string responses: '200': $ref: '#/components/responses/CreateAccessUsersSingleTokenSingleResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAccessUsersSingleTokenSingleRequest' put: operationId: updateAccessUsersSingleTokenSingle summary: updateAccessUsersSingleTokenSingle description: Update API token for a specific user. tags: - access parameters: - name: tokenid in: path required: true description: tokenid schema: type: string - name: userid in: path required: true description: userid schema: type: string responses: '200': $ref: '#/components/responses/UpdateAccessUsersSingleTokenSingleResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAccessUsersSingleTokenSingleRequest' /access/groups: get: operationId: getAccessGroups summary: getAccessGroups description: Group index. tags: - access parameters: [] responses: '200': $ref: '#/components/responses/GetAccessGroupsResponse' post: operationId: createAccessGroups summary: createAccessGroups description: Create new group. tags: - access parameters: [] responses: '200': $ref: '#/components/responses/CreateAccessGroupsResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAccessGroupsRequest' '/access/groups/{groupid}': delete: operationId: deleteAccessGroupsSingle summary: deleteAccessGroupsSingle description: Delete group. tags: - access parameters: - name: groupid in: path required: true description: groupid schema: type: string responses: '200': $ref: '#/components/responses/DeleteAccessGroupsSingleResponse' get: operationId: getAccessGroupsSingle summary: getAccessGroupsSingle description: Get group configuration. tags: - access parameters: - name: groupid in: path required: true description: groupid schema: type: string responses: '200': $ref: '#/components/responses/GetAccessGroupsSingleResponse' put: operationId: updateAccessGroupsSingle summary: updateAccessGroupsSingle description: Update group data. tags: - access parameters: - name: groupid in: path required: true description: groupid schema: type: string responses: '200': $ref: '#/components/responses/UpdateAccessGroupsSingleResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAccessGroupsSingleRequest' /access/roles: get: operationId: getAccessRoles summary: getAccessRoles description: Role index. tags: - access parameters: [] responses: '200': $ref: '#/components/responses/GetAccessRolesResponse' post: operationId: createAccessRoles summary: createAccessRoles description: Create new role. tags: - access parameters: [] responses: '200': $ref: '#/components/responses/CreateAccessRolesResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAccessRolesRequest' '/access/roles/{roleid}': delete: operationId: deleteAccessRolesSingle summary: deleteAccessRolesSingle description: Delete role. tags: - access parameters: - name: roleid in: path required: true description: roleid schema: type: string responses: '200': $ref: '#/components/responses/DeleteAccessRolesSingleResponse' get: operationId: getAccessRolesSingle summary: getAccessRolesSingle description: Get role configuration. tags: - access parameters: - name: roleid in: path required: true description: roleid schema: type: string responses: '200': $ref: '#/components/responses/GetAccessRolesSingleResponse' put: operationId: updateAccessRolesSingle summary: updateAccessRolesSingle description: Update an existing role. tags: - access parameters: - name: roleid in: path required: true description: roleid schema: type: string responses: '200': $ref: '#/components/responses/UpdateAccessRolesSingleResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAccessRolesSingleRequest' /access/acl: get: operationId: getAccessAcl summary: getAccessAcl description: Get Access Control List (ACLs). tags: - access parameters: [] responses: '200': $ref: '#/components/responses/GetAccessAclResponse' put: operationId: updateAccessAcl summary: updateAccessAcl description: Update Access Control List (add or remove permissions). tags: - access parameters: [] responses: '200': $ref: '#/components/responses/UpdateAccessAclResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAccessAclRequest' /access/domains: get: operationId: getAccessDomains summary: getAccessDomains description: Authentication domain index. tags: - access parameters: [] responses: '200': $ref: '#/components/responses/GetAccessDomainsResponse' post: operationId: createAccessDomains summary: createAccessDomains description: Add an authentication server. tags: - access parameters: [] responses: '200': $ref: '#/components/responses/CreateAccessDomainsResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAccessDomainsRequest' '/access/domains/{realm}': delete: operationId: deleteAccessDomainsSingle summary: deleteAccessDomainsSingle description: Delete an authentication server. tags: - access parameters: - name: realm in: path required: true description: realm schema: type: string responses: '200': $ref: '#/components/responses/DeleteAccessDomainsSingleResponse' get: operationId: getAccessDomainsSingle summary: getAccessDomainsSingle description: Get auth server configuration. tags: - access parameters: - name: realm in: path required: true description: realm schema: type: string responses: '200': $ref: '#/components/responses/GetAccessDomainsSingleResponse' put: operationId: updateAccessDomainsSingle summary: updateAccessDomainsSingle description: Update authentication server settings. tags: - access parameters: - name: realm in: path required: true description: realm schema: type: string responses: '200': $ref: '#/components/responses/UpdateAccessDomainsSingleResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAccessDomainsSingleRequest' '/access/domains/{realm}/sync': post: operationId: createAccessDomainsSingleSync summary: createAccessDomainsSingleSync description: >- Syncs users and/or groups from the configured LDAP to user.cfg. NOTE: Synced groups will have the name 'name-$realm', so make sure those groups do not exist to prevent overwriting. tags: - access parameters: - name: realm in: path required: true description: realm schema: type: string responses: '200': $ref: '#/components/responses/CreateAccessDomainsSingleSyncResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAccessDomainsSingleSyncRequest' /access/ticket: get: operationId: getAccessTicket summary: getAccessTicket description: Dummy. Useful for formatters which want to provide a login page. tags: - access parameters: [] responses: '200': $ref: '#/components/responses/GetAccessTicketResponse' post: operationId: createAccessTicket summary: createAccessTicket description: Create or verify authentication ticket. tags: - access parameters: [] responses: '200': $ref: '#/components/responses/CreateAccessTicketResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAccessTicketRequest' /access/password: put: operationId: updateAccessPassword summary: updateAccessPassword description: Change user password. tags: - access parameters: [] responses: '200': $ref: '#/components/responses/UpdateAccessPasswordResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAccessPasswordRequest' /access/tfa: post: operationId: createAccessTfa summary: createAccessTfa description: Finish a u2f challenge. tags: - access parameters: [] responses: '200': $ref: '#/components/responses/CreateAccessTfaResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAccessTfaRequest' put: operationId: updateAccessTfa summary: updateAccessTfa description: Change user u2f authentication. tags: - access parameters: [] responses: '200': $ref: '#/components/responses/UpdateAccessTfaResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAccessTfaRequest' /access/permissions: get: operationId: getAccessPermissions summary: getAccessPermissions description: Retrieve effective permissions of given user/token. tags: - access parameters: [] responses: '200': $ref: '#/components/responses/GetAccessPermissionsResponse' /pools: get: operationId: getPools summary: getPools description: Pool index. tags: - pools parameters: [] responses: '200': $ref: '#/components/responses/GetPoolsResponse' post: operationId: createPool summary: createPool description: Create new pool. tags: - pools parameters: [] responses: '200': $ref: '#/components/responses/CreatePoolResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePoolRequest' '/pools/{poolid}': delete: operationId: deletePool summary: deletePool description: Delete pool. tags: - pools parameters: - name: poolid in: path required: true description: poolid schema: type: string responses: '200': $ref: '#/components/responses/DeletePoolResponse' get: operationId: getPool summary: getPool description: Get pool configuration. tags: - pools parameters: - name: poolid in: path required: true description: poolid schema: type: string responses: '200': $ref: '#/components/responses/GetPoolResponse' put: operationId: updatePool summary: updatePool description: Update pool data. tags: - pools parameters: - name: poolid in: path required: true description: poolid schema: type: string responses: '200': $ref: '#/components/responses/UpdatePoolResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdatePoolRequest' /version: get: operationId: getVersion summary: getVersion description: >- API version details. The result also includes the global datacenter confguration. tags: - version parameters: [] responses: '200': $ref: '#/components/responses/GetVersionResponse' components: schemas: CreateClusterReplicationRequest: title: CreateClusterReplicationRequest type: object properties: comment: type: string disable: type: boolean id: type: string rate: type: number remove_job: type: string schedule: type: string source: type: string target: type: string type: type: string required: - id - target - type UpdateClusterReplicationSingleRequest: title: UpdateClusterReplicationSingleRequest type: object properties: comment: type: string delete: type: string digest: type: string disable: type: boolean rate: type: number remove_job: type: string schedule: type: string source: type: string CreateClusterMetricsServerSingleRequest: title: CreateClusterMetricsServerSingleRequest type: object properties: disable: type: boolean mtu: type: integer path: type: string port: type: integer proto: type: string server: type: string timeout: type: integer type: type: string required: - port - server - type UpdateClusterMetricsServerSingleRequest: title: UpdateClusterMetricsServerSingleRequest type: object properties: delete: type: string digest: type: string disable: type: boolean mtu: type: integer path: type: string port: type: integer proto: type: string server: type: string timeout: type: integer required: - port - server CreateClusterConfigRequest: title: CreateClusterConfigRequest type: object properties: clustername: type: string link0: type: string link1: type: string link2: type: string link3: type: string link4: type: string link5: type: string link6: type: string link7: type: string link8: type: string link9: type: string link10: type: string link11: type: string link12: type: string link13: type: string link14: type: string link15: type: string link16: type: string link17: type: string link18: type: string link19: type: string link20: type: string link21: type: string link22: type: string link23: type: string link24: type: string link25: type: string link26: type: string link27: type: string link28: type: string link29: type: string nodeid: type: integer votes: type: integer required: - clustername CreateClusterConfigNodesSingleRequest: title: CreateClusterConfigNodesSingleRequest type: object properties: apiversion: type: integer force: type: boolean link0: type: string link1: type: string link2: type: string link3: type: string link4: type: string link5: type: string link6: type: string link7: type: string link8: type: string link9: type: string link10: type: string link11: type: string link12: type: string link13: type: string link14: type: string link15: type: string link16: type: string link17: type: string link18: type: string link19: type: string link20: type: string link21: type: string link22: type: string link23: type: string link24: type: string link25: type: string link26: type: string link27: type: string link28: type: string link29: type: string new_node_ip: type: string nodeid: type: integer votes: type: integer CreateClusterConfigJoinRequest: title: CreateClusterConfigJoinRequest type: object properties: fingerprint: type: string force: type: boolean hostname: type: string link0: type: string link1: type: string link2: type: string link3: type: string link4: type: string link5: type: string link6: type: string link7: type: string link8: type: string link9: type: string link10: type: string link11: type: string link12: type: string link13: type: string link14: type: string link15: type: string link16: type: string link17: type: string link18: type: string link19: type: string link20: type: string link21: type: string link22: type: string link23: type: string link24: type: string link25: type: string link26: type: string link27: type: string link28: type: string link29: type: string nodeid: type: integer password: type: string votes: type: integer required: - fingerprint - hostname - password CreateClusterFirewallGroupRequest: title: CreateClusterFirewallGroupRequest type: object properties: comment: type: string digest: type: string group: type: string rename: type: string required: - group AddClusterFirewallGroupRuleRequest: title: AddClusterFirewallGroupRuleRequest type: object properties: action: type: string comment: type: string dest: type: string digest: type: string dport: type: string enable: type: integer icmp-type: type: string iface: type: string log: type: string macro: type: string pos: type: integer proto: type: string source: type: string sport: type: string type: type: string required: - action - type UpdateClusterFirewallGroupRuleRequest: title: UpdateClusterFirewallGroupRuleRequest type: object properties: action: type: string comment: type: string delete: type: string dest: type: string digest: type: string dport: type: string enable: type: integer icmp-type: type: string iface: type: string log: type: string macro: type: string moveto: type: integer proto: type: string source: type: string sport: type: string type: type: string AddClusterFirewallRuleRequest: title: AddClusterFirewallRuleRequest type: object properties: action: type: string comment: type: string dest: type: string digest: type: string dport: type: string enable: type: integer icmp-type: type: string iface: type: string log: type: string macro: type: string pos: type: integer proto: type: string source: type: string sport: type: string type: type: string required: - action - type UpdateClusterFirewallRuleRequest: title: UpdateClusterFirewallRuleRequest type: object properties: action: type: string comment: type: string delete: type: string dest: type: string digest: type: string dport: type: string enable: type: integer icmp-type: type: string iface: type: string log: type: string macro: type: string moveto: type: integer proto: type: string source: type: string sport: type: string type: type: string CreateClusterFirewallIPSetRequest: title: CreateClusterFirewallIPSetRequest type: object properties: comment: type: string digest: type: string name: type: string rename: type: string required: - name AddClusterFirewallIPSetIPRequest: title: AddClusterFirewallIPSetIPRequest type: object properties: cidr: type: string comment: type: string nomatch: type: boolean required: - cidr UpdateClusterFirewallIPSetIPRequest: title: UpdateClusterFirewallIPSetIPRequest type: object properties: comment: type: string digest: type: string nomatch: type: boolean CreateClusterFirewallAliasesRequest: title: CreateClusterFirewallAliasesRequest type: object properties: cidr: type: string comment: type: string name: type: string required: - cidr - name UpdateClusterFirewallAliasesSingleRequest: title: UpdateClusterFirewallAliasesSingleRequest type: object properties: cidr: type: string comment: type: string digest: type: string rename: type: string required: - cidr UpdateClusterFirewallOptionsRequest: title: UpdateClusterFirewallOptionsRequest type: object properties: delete: type: string digest: type: string ebtables: type: boolean enable: type: integer log_ratelimit: type: string policy_in: type: string policy_out: type: string CreateClusterBackupRequest: title: CreateClusterBackupRequest type: object properties: all: type: boolean bwlimit: type: integer compress: type: string dow: type: string dumpdir: type: string enabled: type: boolean exclude: type: string exclude-path: type: string ionice: type: integer lockwait: type: integer mailnotification: type: string mailto: type: string maxfiles: type: integer mode: type: string node: type: string pigz: type: integer pool: type: string prune-backups: type: string quiet: type: boolean remove: type: boolean script: type: string size: type: integer starttime: type: string stdexcludes: type: boolean stop: type: boolean stopwait: type: integer storage: type: string tmpdir: type: string vmid: type: string zstd: type: integer required: - starttime UpdateClusterBackupSingleRequest: title: UpdateClusterBackupSingleRequest type: object properties: all: type: boolean bwlimit: type: integer compress: type: string delete: type: string dow: type: string dumpdir: type: string enabled: type: boolean exclude: type: string exclude-path: type: string ionice: type: integer lockwait: type: integer mailnotification: type: string mailto: type: string maxfiles: type: integer mode: type: string node: type: string pigz: type: integer pool: type: string prune-backups: type: string quiet: type: boolean remove: type: boolean script: type: string size: type: integer starttime: type: string stdexcludes: type: boolean stop: type: boolean stopwait: type: integer storage: type: string tmpdir: type: string vmid: type: string zstd: type: integer required: - starttime CreateClusterHaResourcesRequest: title: CreateClusterHaResourcesRequest type: object properties: comment: type: string group: type: string max_relocate: type: integer max_restart: type: integer sid: type: string state: type: string type: type: string required: - sid UpdateClusterHaResourcesSingleRequest: title: UpdateClusterHaResourcesSingleRequest type: object properties: comment: type: string delete: type: string digest: type: string group: type: string max_relocate: type: integer max_restart: type: integer state: type: string CreateClusterHaResourcesSingleMigrateRequest: title: CreateClusterHaResourcesSingleMigrateRequest type: object properties: node: type: string required: - node CreateClusterHaResourcesSingleRelocateRequest: title: CreateClusterHaResourcesSingleRelocateRequest type: object properties: node: type: string required: - node CreateClusterHaGroupsRequest: title: CreateClusterHaGroupsRequest type: object properties: comment: type: string group: type: string nodes: type: string nofailback: type: boolean restricted: type: boolean type: type: string required: - group - nodes UpdateClusterHaGroupsSingleRequest: title: UpdateClusterHaGroupsSingleRequest type: object properties: comment: type: string delete: type: string digest: type: string nodes: type: string nofailback: type: boolean restricted: type: boolean CreateClusterAcmePluginsRequest: title: CreateClusterAcmePluginsRequest type: object properties: api: type: string data: type: string disable: type: boolean id: type: string nodes: type: string type: type: string validation-delay: type: integer required: - id - type UpdateClusterAcmePluginsSingleRequest: title: UpdateClusterAcmePluginsSingleRequest type: object properties: api: type: string data: type: string delete: type: string digest: type: string disable: type: boolean nodes: type: string validation-delay: type: integer CreateClusterAcmeAccountRequest: title: CreateClusterAcmeAccountRequest type: object properties: contact: type: string directory: type: string name: type: string tos_url: type: string required: - contact UpdateClusterAcmeAccountSingleRequest: title: UpdateClusterAcmeAccountSingleRequest type: object properties: contact: type: string UpdateClusterCephFlagsRequest: title: UpdateClusterCephFlagsRequest type: object properties: nobackfill: type: boolean nodeep-scrub: type: boolean nodown: type: boolean noin: type: boolean noout: type: boolean norebalance: type: boolean norecover: type: boolean noscrub: type: boolean notieragent: type: boolean noup: type: boolean pause: type: boolean UpdateClusterCephFlagsSingleRequest: title: UpdateClusterCephFlagsSingleRequest type: object properties: value: type: boolean required: - value UpdateClusterSDNRequest: title: UpdateClusterSDNRequest type: object properties: {} CreateClusterSDNVnetRequest: title: CreateClusterSDNVnetRequest type: object properties: alias: type: string ipv4: type: string ipv6: type: string mac: type: string tag: type: integer type: type: string vlanaware: type: boolean vnet: type: string zone: type: string required: - vnet - zone UpdateClusterSDNVnetRequest: title: UpdateClusterSDNVnetRequest type: object properties: alias: type: string delete: type: string digest: type: string ipv4: type: string ipv6: type: string mac: type: string tag: type: integer vlanaware: type: boolean zone: type: string CreateClusterSDNZoneRequest: title: CreateClusterSDNZoneRequest type: object properties: bridge: type: string controller: type: string dp-id: type: integer mtu: type: integer nodes: type: string peers: type: string tag: type: integer type: type: string vlan-protocol: type: string vrf-vxlan: type: integer zone: type: string required: - type - zone UpdateClusterSDNZoneRequest: title: UpdateClusterSDNZoneRequest type: object properties: bridge: type: string controller: type: string delete: type: string digest: type: string dp-id: type: integer mtu: type: integer nodes: type: string peers: type: string tag: type: integer vlan-protocol: type: string vrf-vxlan: type: integer CreateClusterSDNControllerRequest: title: CreateClusterSDNControllerRequest type: object properties: asn: type: integer controller: type: string gateway-external-peers: type: string gateway-nodes: type: string peers: type: string type: type: string required: - controller - type UpdateClusterSDNControllerRequest: title: UpdateClusterSDNControllerRequest type: object properties: asn: type: integer delete: type: string digest: type: string gateway-external-peers: type: string gateway-nodes: type: string peers: type: string UpdateClusterOptionsRequest: title: UpdateClusterOptionsRequest type: object properties: bwlimit: type: string console: type: string delete: type: string email_from: type: string fencing: type: string ha: type: string http_proxy: type: string keyboard: type: string language: type: string mac_prefix: type: string max_workers: type: integer migration: type: string migration_unsecure: type: boolean u2f: type: string CreateVMRequest: title: CreateVMRequest type: object properties: acpi: type: boolean agent: type: string arch: type: string archive: type: string args: type: string audio0: type: string autostart: type: boolean balloon: type: integer bios: type: string boot: type: string bootdisk: type: string bwlimit: type: integer cdrom: type: string cicustom: type: string cipassword: type: string citype: type: string ciuser: type: string cores: type: integer cpu: type: string cpulimit: type: number cpuunits: type: integer description: type: string efidisk0: type: string force: type: boolean freeze: type: boolean hookscript: type: string hostpci0: type: string hostpci1: type: string hostpci2: type: string hostpci3: type: string hostpci4: type: string hostpci5: type: string hostpci6: type: string hostpci7: type: string hostpci8: type: string hostpci9: type: string hostpci10: type: string hostpci11: type: string hostpci12: type: string hostpci13: type: string hostpci14: type: string hostpci15: type: string hostpci16: type: string hostpci17: type: string hostpci18: type: string hostpci19: type: string hostpci20: type: string hostpci21: type: string hostpci22: type: string hostpci23: type: string hostpci24: type: string hostpci25: type: string hostpci26: type: string hostpci27: type: string hostpci28: type: string hostpci29: type: string hotplug: type: string hugepages: type: string ide0: type: string ide1: type: string ide2: type: string ide3: type: string ide4: type: string ide5: type: string ide6: type: string ide7: type: string ide8: type: string ide9: type: string ide10: type: string ide11: type: string ide12: type: string ide13: type: string ide14: type: string ide15: type: string ide16: type: string ide17: type: string ide18: type: string ide19: type: string ide20: type: string ide21: type: string ide22: type: string ide23: type: string ide24: type: string ide25: type: string ide26: type: string ide27: type: string ide28: type: string ide29: type: string ipconfig0: type: string ipconfig1: type: string ipconfig2: type: string ipconfig3: type: string ipconfig4: type: string ipconfig5: type: string ipconfig6: type: string ipconfig7: type: string ipconfig8: type: string ipconfig9: type: string ipconfig10: type: string ipconfig11: type: string ipconfig12: type: string ipconfig13: type: string ipconfig14: type: string ipconfig15: type: string ipconfig16: type: string ipconfig17: type: string ipconfig18: type: string ipconfig19: type: string ipconfig20: type: string ipconfig21: type: string ipconfig22: type: string ipconfig23: type: string ipconfig24: type: string ipconfig25: type: string ipconfig26: type: string ipconfig27: type: string ipconfig28: type: string ipconfig29: type: string ivshmem: type: string keephugepages: type: boolean keyboard: type: string kvm: type: boolean localtime: type: boolean lock: type: string machine: type: string memory: type: integer migrate_downtime: type: number migrate_speed: type: integer name: type: string nameserver: type: string net0: type: string net1: type: string net2: type: string net3: type: string net4: type: string net5: type: string net6: type: string net7: type: string net8: type: string net9: type: string net10: type: string net11: type: string net12: type: string net13: type: string net14: type: string net15: type: string net16: type: string net17: type: string net18: type: string net19: type: string net20: type: string net21: type: string net22: type: string net23: type: string net24: type: string net25: type: string net26: type: string net27: type: string net28: type: string net29: type: string numa: type: boolean numa0: type: string numa1: type: string numa2: type: string numa3: type: string numa4: type: string numa5: type: string numa6: type: string numa7: type: string numa8: type: string numa9: type: string numa10: type: string numa11: type: string numa12: type: string numa13: type: string numa14: type: string numa15: type: string numa16: type: string numa17: type: string numa18: type: string numa19: type: string numa20: type: string numa21: type: string numa22: type: string numa23: type: string numa24: type: string numa25: type: string numa26: type: string numa27: type: string numa28: type: string numa29: type: string onboot: type: boolean ostype: type: string parallel0: type: string parallel1: type: string parallel2: type: string parallel3: type: string parallel4: type: string parallel5: type: string parallel6: type: string parallel7: type: string parallel8: type: string parallel9: type: string parallel10: type: string parallel11: type: string parallel12: type: string parallel13: type: string parallel14: type: string parallel15: type: string parallel16: type: string parallel17: type: string parallel18: type: string parallel19: type: string parallel20: type: string parallel21: type: string parallel22: type: string parallel23: type: string parallel24: type: string parallel25: type: string parallel26: type: string parallel27: type: string parallel28: type: string parallel29: type: string pool: type: string protection: type: boolean reboot: type: boolean rng0: type: string sata0: type: string sata1: type: string sata2: type: string sata3: type: string sata4: type: string sata5: type: string sata6: type: string sata7: type: string sata8: type: string sata9: type: string sata10: type: string sata11: type: string sata12: type: string sata13: type: string sata14: type: string sata15: type: string sata16: type: string sata17: type: string sata18: type: string sata19: type: string sata20: type: string sata21: type: string sata22: type: string sata23: type: string sata24: type: string sata25: type: string sata26: type: string sata27: type: string sata28: type: string sata29: type: string scsi0: type: string scsi1: type: string scsi2: type: string scsi3: type: string scsi4: type: string scsi5: type: string scsi6: type: string scsi7: type: string scsi8: type: string scsi9: type: string scsi10: type: string scsi11: type: string scsi12: type: string scsi13: type: string scsi14: type: string scsi15: type: string scsi16: type: string scsi17: type: string scsi18: type: string scsi19: type: string scsi20: type: string scsi21: type: string scsi22: type: string scsi23: type: string scsi24: type: string scsi25: type: string scsi26: type: string scsi27: type: string scsi28: type: string scsi29: type: string scsihw: type: string searchdomain: type: string serial0: type: string serial1: type: string serial2: type: string serial3: type: string serial4: type: string serial5: type: string serial6: type: string serial7: type: string serial8: type: string serial9: type: string serial10: type: string serial11: type: string serial12: type: string serial13: type: string serial14: type: string serial15: type: string serial16: type: string serial17: type: string serial18: type: string serial19: type: string serial20: type: string serial21: type: string serial22: type: string serial23: type: string serial24: type: string serial25: type: string serial26: type: string serial27: type: string serial28: type: string serial29: type: string shares: type: integer smbios1: type: string smp: type: integer sockets: type: integer spice_enhancements: type: string sshkeys: type: string start: type: boolean startdate: type: string startup: type: string storage: type: string tablet: type: boolean tags: type: string tdf: type: boolean template: type: boolean unique: type: boolean unused0: type: string unused1: type: string unused2: type: string unused3: type: string unused4: type: string unused5: type: string unused6: type: string unused7: type: string unused8: type: string unused9: type: string unused10: type: string unused11: type: string unused12: type: string unused13: type: string unused14: type: string unused15: type: string unused16: type: string unused17: type: string unused18: type: string unused19: type: string unused20: type: string unused21: type: string unused22: type: string unused23: type: string unused24: type: string unused25: type: string unused26: type: string unused27: type: string unused28: type: string unused29: type: string usb0: type: string usb1: type: string usb2: type: string usb3: type: string usb4: type: string usb5: type: string usb6: type: string usb7: type: string usb8: type: string usb9: type: string usb10: type: string usb11: type: string usb12: type: string usb13: type: string usb14: type: string usb15: type: string usb16: type: string usb17: type: string usb18: type: string usb19: type: string usb20: type: string usb21: type: string usb22: type: string usb23: type: string usb24: type: string usb25: type: string usb26: type: string usb27: type: string usb28: type: string usb29: type: string vcpus: type: integer vga: type: string virtio0: type: string virtio1: type: string virtio2: type: string virtio3: type: string virtio4: type: string virtio5: type: string virtio6: type: string virtio7: type: string virtio8: type: string virtio9: type: string virtio10: type: string virtio11: type: string virtio12: type: string virtio13: type: string virtio14: type: string virtio15: type: string virtio16: type: string virtio17: type: string virtio18: type: string virtio19: type: string virtio20: type: string virtio21: type: string virtio22: type: string virtio23: type: string virtio24: type: string virtio25: type: string virtio26: type: string virtio27: type: string virtio28: type: string virtio29: type: string vmgenid: type: string vmid: type: integer vmstatestorage: type: string watchdog: type: string required: - vmid CreateVMFirewallRuleRequest: title: CreateVMFirewallRuleRequest type: object properties: action: type: string comment: type: string dest: type: string digest: type: string dport: type: string enable: type: integer icmp-type: type: string iface: type: string log: type: string macro: type: string pos: type: integer proto: type: string source: type: string sport: type: string type: type: string required: - action - type UpdateVMFirewallRuleRequest: title: UpdateVMFirewallRuleRequest type: object properties: action: type: string comment: type: string delete: type: string dest: type: string digest: type: string dport: type: string enable: type: integer icmp-type: type: string iface: type: string log: type: string macro: type: string moveto: type: integer proto: type: string source: type: string sport: type: string type: type: string CreateNodesSingleQemuSingleFirewallAliasesRequest: title: CreateNodesSingleQemuSingleFirewallAliasesRequest type: object properties: cidr: type: string comment: type: string name: type: string required: - cidr - name UpdateNodesSingleQemuSingleFirewallAliasesSingleRequest: title: UpdateNodesSingleQemuSingleFirewallAliasesSingleRequest type: object properties: cidr: type: string comment: type: string digest: type: string rename: type: string required: - cidr CreateVMFirewallIPSetRequest: title: CreateVMFirewallIPSetRequest type: object properties: comment: type: string digest: type: string name: type: string rename: type: string required: - name AddVMFirewallIPSetIPRequest: title: AddVMFirewallIPSetIPRequest type: object properties: cidr: type: string comment: type: string nomatch: type: boolean required: - cidr UpdateVMFirewallIPSetIPRequest: title: UpdateVMFirewallIPSetIPRequest type: object properties: comment: type: string digest: type: string nomatch: type: boolean UpdateVMFirewallOptionsRequest: title: UpdateVMFirewallOptionsRequest type: object properties: delete: type: string dhcp: type: boolean digest: type: string enable: type: boolean ipfilter: type: boolean log_level_in: type: string log_level_out: type: string macfilter: type: boolean ndp: type: boolean policy_in: type: string policy_out: type: string radv: type: boolean CreateNodesSingleQemuSingleAgentRequest: title: CreateNodesSingleQemuSingleAgentRequest type: object properties: command: type: string required: - command CreateNodesSingleQemuSingleAgentFsfreezefreezeRequest: title: CreateNodesSingleQemuSingleAgentFsfreezefreezeRequest type: object properties: {} CreateNodesSingleQemuSingleAgentFsfreezestatusRequest: title: CreateNodesSingleQemuSingleAgentFsfreezestatusRequest type: object properties: {} CreateNodesSingleQemuSingleAgentFsfreezethawRequest: title: CreateNodesSingleQemuSingleAgentFsfreezethawRequest type: object properties: {} CreateNodesSingleQemuSingleAgentFstrimRequest: title: CreateNodesSingleQemuSingleAgentFstrimRequest type: object properties: {} CreateNodesSingleQemuSingleAgentPingRequest: title: CreateNodesSingleQemuSingleAgentPingRequest type: object properties: {} CreateNodesSingleQemuSingleAgentShutdownRequest: title: CreateNodesSingleQemuSingleAgentShutdownRequest type: object properties: {} CreateNodesSingleQemuSingleAgentSuspenddiskRequest: title: CreateNodesSingleQemuSingleAgentSuspenddiskRequest type: object properties: {} CreateNodesSingleQemuSingleAgentSuspendhybridRequest: title: CreateNodesSingleQemuSingleAgentSuspendhybridRequest type: object properties: {} CreateNodesSingleQemuSingleAgentSuspendramRequest: title: CreateNodesSingleQemuSingleAgentSuspendramRequest type: object properties: {} CreateNodesSingleQemuSingleAgentSetuserpasswordRequest: title: CreateNodesSingleQemuSingleAgentSetuserpasswordRequest type: object properties: crypted: type: boolean password: type: string username: type: string required: - password - username CreateNodesSingleQemuSingleAgentExecRequest: title: CreateNodesSingleQemuSingleAgentExecRequest type: object properties: command: type: string input-data: type: string CreateNodesSingleQemuSingleAgentFilewriteRequest: title: CreateNodesSingleQemuSingleAgentFilewriteRequest type: object properties: content: type: string file: type: string required: - content - file UpdateVMConfigRequest: title: UpdateVMConfigRequest type: object properties: acpi: type: boolean agent: type: string arch: type: string args: type: string audio0: type: string autostart: type: boolean background_delay: type: integer balloon: type: integer bios: type: string boot: type: string bootdisk: type: string cdrom: type: string cicustom: type: string cipassword: type: string citype: type: string ciuser: type: string cores: type: integer cpu: type: string cpulimit: type: number cpuunits: type: integer delete: type: string description: type: string digest: type: string efidisk0: type: string force: type: boolean freeze: type: boolean hookscript: type: string hostpci0: type: string hostpci1: type: string hostpci2: type: string hostpci3: type: string hostpci4: type: string hostpci5: type: string hostpci6: type: string hostpci7: type: string hostpci8: type: string hostpci9: type: string hostpci10: type: string hostpci11: type: string hostpci12: type: string hostpci13: type: string hostpci14: type: string hostpci15: type: string hostpci16: type: string hostpci17: type: string hostpci18: type: string hostpci19: type: string hostpci20: type: string hostpci21: type: string hostpci22: type: string hostpci23: type: string hostpci24: type: string hostpci25: type: string hostpci26: type: string hostpci27: type: string hostpci28: type: string hostpci29: type: string hotplug: type: string hugepages: type: string ide0: type: string ide1: type: string ide2: type: string ide3: type: string ide4: type: string ide5: type: string ide6: type: string ide7: type: string ide8: type: string ide9: type: string ide10: type: string ide11: type: string ide12: type: string ide13: type: string ide14: type: string ide15: type: string ide16: type: string ide17: type: string ide18: type: string ide19: type: string ide20: type: string ide21: type: string ide22: type: string ide23: type: string ide24: type: string ide25: type: string ide26: type: string ide27: type: string ide28: type: string ide29: type: string ipconfig0: type: string ipconfig1: type: string ipconfig2: type: string ipconfig3: type: string ipconfig4: type: string ipconfig5: type: string ipconfig6: type: string ipconfig7: type: string ipconfig8: type: string ipconfig9: type: string ipconfig10: type: string ipconfig11: type: string ipconfig12: type: string ipconfig13: type: string ipconfig14: type: string ipconfig15: type: string ipconfig16: type: string ipconfig17: type: string ipconfig18: type: string ipconfig19: type: string ipconfig20: type: string ipconfig21: type: string ipconfig22: type: string ipconfig23: type: string ipconfig24: type: string ipconfig25: type: string ipconfig26: type: string ipconfig27: type: string ipconfig28: type: string ipconfig29: type: string ivshmem: type: string keephugepages: type: boolean keyboard: type: string kvm: type: boolean localtime: type: boolean lock: type: string machine: type: string memory: type: integer migrate_downtime: type: number migrate_speed: type: integer name: type: string nameserver: type: string net0: type: string net1: type: string net2: type: string net3: type: string net4: type: string net5: type: string net6: type: string net7: type: string net8: type: string net9: type: string net10: type: string net11: type: string net12: type: string net13: type: string net14: type: string net15: type: string net16: type: string net17: type: string net18: type: string net19: type: string net20: type: string net21: type: string net22: type: string net23: type: string net24: type: string net25: type: string net26: type: string net27: type: string net28: type: string net29: type: string numa: type: boolean numa0: type: string numa1: type: string numa2: type: string numa3: type: string numa4: type: string numa5: type: string numa6: type: string numa7: type: string numa8: type: string numa9: type: string numa10: type: string numa11: type: string numa12: type: string numa13: type: string numa14: type: string numa15: type: string numa16: type: string numa17: type: string numa18: type: string numa19: type: string numa20: type: string numa21: type: string numa22: type: string numa23: type: string numa24: type: string numa25: type: string numa26: type: string numa27: type: string numa28: type: string numa29: type: string onboot: type: boolean ostype: type: string parallel0: type: string parallel1: type: string parallel2: type: string parallel3: type: string parallel4: type: string parallel5: type: string parallel6: type: string parallel7: type: string parallel8: type: string parallel9: type: string parallel10: type: string parallel11: type: string parallel12: type: string parallel13: type: string parallel14: type: string parallel15: type: string parallel16: type: string parallel17: type: string parallel18: type: string parallel19: type: string parallel20: type: string parallel21: type: string parallel22: type: string parallel23: type: string parallel24: type: string parallel25: type: string parallel26: type: string parallel27: type: string parallel28: type: string parallel29: type: string protection: type: boolean reboot: type: boolean revert: type: string rng0: type: string sata0: type: string sata1: type: string sata2: type: string sata3: type: string sata4: type: string sata5: type: string sata6: type: string sata7: type: string sata8: type: string sata9: type: string sata10: type: string sata11: type: string sata12: type: string sata13: type: string sata14: type: string sata15: type: string sata16: type: string sata17: type: string sata18: type: string sata19: type: string sata20: type: string sata21: type: string sata22: type: string sata23: type: string sata24: type: string sata25: type: string sata26: type: string sata27: type: string sata28: type: string sata29: type: string scsi0: type: string scsi1: type: string scsi2: type: string scsi3: type: string scsi4: type: string scsi5: type: string scsi6: type: string scsi7: type: string scsi8: type: string scsi9: type: string scsi10: type: string scsi11: type: string scsi12: type: string scsi13: type: string scsi14: type: string scsi15: type: string scsi16: type: string scsi17: type: string scsi18: type: string scsi19: type: string scsi20: type: string scsi21: type: string scsi22: type: string scsi23: type: string scsi24: type: string scsi25: type: string scsi26: type: string scsi27: type: string scsi28: type: string scsi29: type: string scsihw: type: string searchdomain: type: string serial0: type: string serial1: type: string serial2: type: string serial3: type: string serial4: type: string serial5: type: string serial6: type: string serial7: type: string serial8: type: string serial9: type: string serial10: type: string serial11: type: string serial12: type: string serial13: type: string serial14: type: string serial15: type: string serial16: type: string serial17: type: string serial18: type: string serial19: type: string serial20: type: string serial21: type: string serial22: type: string serial23: type: string serial24: type: string serial25: type: string serial26: type: string serial27: type: string serial28: type: string serial29: type: string shares: type: integer skiplock: type: boolean smbios1: type: string smp: type: integer sockets: type: integer spice_enhancements: type: string sshkeys: type: string startdate: type: string startup: type: string tablet: type: boolean tags: type: string tdf: type: boolean template: type: boolean unused0: type: string unused1: type: string unused2: type: string unused3: type: string unused4: type: string unused5: type: string unused6: type: string unused7: type: string unused8: type: string unused9: type: string unused10: type: string unused11: type: string unused12: type: string unused13: type: string unused14: type: string unused15: type: string unused16: type: string unused17: type: string unused18: type: string unused19: type: string unused20: type: string unused21: type: string unused22: type: string unused23: type: string unused24: type: string unused25: type: string unused26: type: string unused27: type: string unused28: type: string unused29: type: string usb0: type: string usb1: type: string usb2: type: string usb3: type: string usb4: type: string usb5: type: string usb6: type: string usb7: type: string usb8: type: string usb9: type: string usb10: type: string usb11: type: string usb12: type: string usb13: type: string usb14: type: string usb15: type: string usb16: type: string usb17: type: string usb18: type: string usb19: type: string usb20: type: string usb21: type: string usb22: type: string usb23: type: string usb24: type: string usb25: type: string usb26: type: string usb27: type: string usb28: type: string usb29: type: string vcpus: type: integer vga: type: string virtio0: type: string virtio1: type: string virtio2: type: string virtio3: type: string virtio4: type: string virtio5: type: string virtio6: type: string virtio7: type: string virtio8: type: string virtio9: type: string virtio10: type: string virtio11: type: string virtio12: type: string virtio13: type: string virtio14: type: string virtio15: type: string virtio16: type: string virtio17: type: string virtio18: type: string virtio19: type: string virtio20: type: string virtio21: type: string virtio22: type: string virtio23: type: string virtio24: type: string virtio25: type: string virtio26: type: string virtio27: type: string virtio28: type: string virtio29: type: string vmgenid: type: string vmstatestorage: type: string watchdog: type: string UpdateVMConfigSyncRequest: title: UpdateVMConfigSyncRequest type: object properties: acpi: type: boolean agent: type: string arch: type: string args: type: string audio0: type: string autostart: type: boolean balloon: type: integer bios: type: string boot: type: string bootdisk: type: string cdrom: type: string cicustom: type: string cipassword: type: string citype: type: string ciuser: type: string cores: type: integer cpu: type: string cpulimit: type: number cpuunits: type: integer delete: type: string description: type: string digest: type: string efidisk0: type: string force: type: boolean freeze: type: boolean hookscript: type: string hostpci0: type: string hostpci1: type: string hostpci2: type: string hostpci3: type: string hostpci4: type: string hostpci5: type: string hostpci6: type: string hostpci7: type: string hostpci8: type: string hostpci9: type: string hostpci10: type: string hostpci11: type: string hostpci12: type: string hostpci13: type: string hostpci14: type: string hostpci15: type: string hostpci16: type: string hostpci17: type: string hostpci18: type: string hostpci19: type: string hostpci20: type: string hostpci21: type: string hostpci22: type: string hostpci23: type: string hostpci24: type: string hostpci25: type: string hostpci26: type: string hostpci27: type: string hostpci28: type: string hostpci29: type: string hotplug: type: string hugepages: type: string ide0: type: string ide1: type: string ide2: type: string ide3: type: string ide4: type: string ide5: type: string ide6: type: string ide7: type: string ide8: type: string ide9: type: string ide10: type: string ide11: type: string ide12: type: string ide13: type: string ide14: type: string ide15: type: string ide16: type: string ide17: type: string ide18: type: string ide19: type: string ide20: type: string ide21: type: string ide22: type: string ide23: type: string ide24: type: string ide25: type: string ide26: type: string ide27: type: string ide28: type: string ide29: type: string ipconfig0: type: string ipconfig1: type: string ipconfig2: type: string ipconfig3: type: string ipconfig4: type: string ipconfig5: type: string ipconfig6: type: string ipconfig7: type: string ipconfig8: type: string ipconfig9: type: string ipconfig10: type: string ipconfig11: type: string ipconfig12: type: string ipconfig13: type: string ipconfig14: type: string ipconfig15: type: string ipconfig16: type: string ipconfig17: type: string ipconfig18: type: string ipconfig19: type: string ipconfig20: type: string ipconfig21: type: string ipconfig22: type: string ipconfig23: type: string ipconfig24: type: string ipconfig25: type: string ipconfig26: type: string ipconfig27: type: string ipconfig28: type: string ipconfig29: type: string ivshmem: type: string keephugepages: type: boolean keyboard: type: string kvm: type: boolean localtime: type: boolean lock: type: string machine: type: string memory: type: integer migrate_downtime: type: number migrate_speed: type: integer name: type: string nameserver: type: string net0: type: string net1: type: string net2: type: string net3: type: string net4: type: string net5: type: string net6: type: string net7: type: string net8: type: string net9: type: string net10: type: string net11: type: string net12: type: string net13: type: string net14: type: string net15: type: string net16: type: string net17: type: string net18: type: string net19: type: string net20: type: string net21: type: string net22: type: string net23: type: string net24: type: string net25: type: string net26: type: string net27: type: string net28: type: string net29: type: string numa: type: boolean numa0: type: string numa1: type: string numa2: type: string numa3: type: string numa4: type: string numa5: type: string numa6: type: string numa7: type: string numa8: type: string numa9: type: string numa10: type: string numa11: type: string numa12: type: string numa13: type: string numa14: type: string numa15: type: string numa16: type: string numa17: type: string numa18: type: string numa19: type: string numa20: type: string numa21: type: string numa22: type: string numa23: type: string numa24: type: string numa25: type: string numa26: type: string numa27: type: string numa28: type: string numa29: type: string onboot: type: boolean ostype: type: string parallel0: type: string parallel1: type: string parallel2: type: string parallel3: type: string parallel4: type: string parallel5: type: string parallel6: type: string parallel7: type: string parallel8: type: string parallel9: type: string parallel10: type: string parallel11: type: string parallel12: type: string parallel13: type: string parallel14: type: string parallel15: type: string parallel16: type: string parallel17: type: string parallel18: type: string parallel19: type: string parallel20: type: string parallel21: type: string parallel22: type: string parallel23: type: string parallel24: type: string parallel25: type: string parallel26: type: string parallel27: type: string parallel28: type: string parallel29: type: string protection: type: boolean reboot: type: boolean revert: type: string rng0: type: string sata0: type: string sata1: type: string sata2: type: string sata3: type: string sata4: type: string sata5: type: string sata6: type: string sata7: type: string sata8: type: string sata9: type: string sata10: type: string sata11: type: string sata12: type: string sata13: type: string sata14: type: string sata15: type: string sata16: type: string sata17: type: string sata18: type: string sata19: type: string sata20: type: string sata21: type: string sata22: type: string sata23: type: string sata24: type: string sata25: type: string sata26: type: string sata27: type: string sata28: type: string sata29: type: string scsi0: type: string scsi1: type: string scsi2: type: string scsi3: type: string scsi4: type: string scsi5: type: string scsi6: type: string scsi7: type: string scsi8: type: string scsi9: type: string scsi10: type: string scsi11: type: string scsi12: type: string scsi13: type: string scsi14: type: string scsi15: type: string scsi16: type: string scsi17: type: string scsi18: type: string scsi19: type: string scsi20: type: string scsi21: type: string scsi22: type: string scsi23: type: string scsi24: type: string scsi25: type: string scsi26: type: string scsi27: type: string scsi28: type: string scsi29: type: string scsihw: type: string searchdomain: type: string serial0: type: string serial1: type: string serial2: type: string serial3: type: string serial4: type: string serial5: type: string serial6: type: string serial7: type: string serial8: type: string serial9: type: string serial10: type: string serial11: type: string serial12: type: string serial13: type: string serial14: type: string serial15: type: string serial16: type: string serial17: type: string serial18: type: string serial19: type: string serial20: type: string serial21: type: string serial22: type: string serial23: type: string serial24: type: string serial25: type: string serial26: type: string serial27: type: string serial28: type: string serial29: type: string shares: type: integer skiplock: type: boolean smbios1: type: string smp: type: integer sockets: type: integer spice_enhancements: type: string sshkeys: type: string startdate: type: string startup: type: string tablet: type: boolean tags: type: string tdf: type: boolean template: type: boolean unused0: type: string unused1: type: string unused2: type: string unused3: type: string unused4: type: string unused5: type: string unused6: type: string unused7: type: string unused8: type: string unused9: type: string unused10: type: string unused11: type: string unused12: type: string unused13: type: string unused14: type: string unused15: type: string unused16: type: string unused17: type: string unused18: type: string unused19: type: string unused20: type: string unused21: type: string unused22: type: string unused23: type: string unused24: type: string unused25: type: string unused26: type: string unused27: type: string unused28: type: string unused29: type: string usb0: type: string usb1: type: string usb2: type: string usb3: type: string usb4: type: string usb5: type: string usb6: type: string usb7: type: string usb8: type: string usb9: type: string usb10: type: string usb11: type: string usb12: type: string usb13: type: string usb14: type: string usb15: type: string usb16: type: string usb17: type: string usb18: type: string usb19: type: string usb20: type: string usb21: type: string usb22: type: string usb23: type: string usb24: type: string usb25: type: string usb26: type: string usb27: type: string usb28: type: string usb29: type: string vcpus: type: integer vga: type: string virtio0: type: string virtio1: type: string virtio2: type: string virtio3: type: string virtio4: type: string virtio5: type: string virtio6: type: string virtio7: type: string virtio8: type: string virtio9: type: string virtio10: type: string virtio11: type: string virtio12: type: string virtio13: type: string virtio14: type: string virtio15: type: string virtio16: type: string virtio17: type: string virtio18: type: string virtio19: type: string virtio20: type: string virtio21: type: string virtio22: type: string virtio23: type: string virtio24: type: string virtio25: type: string virtio26: type: string virtio27: type: string virtio28: type: string virtio29: type: string vmgenid: type: string vmstatestorage: type: string watchdog: type: string UnlinkVMDiskImagesRequest: title: UnlinkVMDiskImagesRequest type: object properties: force: type: boolean idlist: type: string required: - idlist CreateNodesSingleQemuSingleVncproxyRequest: title: CreateNodesSingleQemuSingleVncproxyRequest type: object properties: generate-password: type: boolean websocket: type: boolean CreateNodesSingleQemuSingleTermproxyRequest: title: CreateNodesSingleQemuSingleTermproxyRequest type: object properties: serial: type: string CreateNodesSingleQemuSingleSpiceproxyRequest: title: CreateNodesSingleQemuSingleSpiceproxyRequest type: object properties: proxy: type: string StartVMRequest: title: StartVMRequest type: object properties: force-cpu: type: string machine: type: string migratedfrom: type: string migration_network: type: string migration_type: type: string skiplock: type: boolean stateuri: type: string targetstorage: type: string timeout: type: integer StopVMRequest: title: StopVMRequest type: object properties: keepActive: type: boolean migratedfrom: type: string skiplock: type: boolean timeout: type: integer ResetVMRequest: title: ResetVMRequest type: object properties: skiplock: type: boolean ShutdownVMRequest: title: ShutdownVMRequest type: object properties: forceStop: type: boolean keepActive: type: boolean skiplock: type: boolean timeout: type: integer RebootVMRequest: title: RebootVMRequest type: object properties: timeout: type: integer SuspendVMRequest: title: SuspendVMRequest type: object properties: skiplock: type: boolean statestorage: type: string todisk: type: boolean ResumeVMRequest: title: ResumeVMRequest type: object properties: nocheck: type: boolean skiplock: type: boolean UpdateNodesSingleQemuSingleSendkeyRequest: title: UpdateNodesSingleQemuSingleSendkeyRequest type: object properties: key: type: string skiplock: type: boolean required: - key CloneVMRequest: title: CloneVMRequest type: object properties: bwlimit: type: integer description: type: string format: type: string full: type: boolean name: type: string newid: type: integer pool: type: string snapname: type: string storage: type: string target: type: string required: - newid CreateNodesSingleQemuSingleMovediskRequest: title: CreateNodesSingleQemuSingleMovediskRequest type: object properties: bwlimit: type: integer delete: type: boolean digest: type: string disk: type: string format: type: string storage: type: string required: - disk - storage CreateNodesSingleQemuSingleMigrateRequest: title: CreateNodesSingleQemuSingleMigrateRequest type: object properties: bwlimit: type: integer force: type: boolean migration_network: type: string migration_type: type: string online: type: boolean target: type: string targetstorage: type: string with-local-disks: type: boolean required: - target CreateNodesSingleQemuSingleMonitorRequest: title: CreateNodesSingleQemuSingleMonitorRequest type: object properties: command: type: string required: - command UpdateNodesSingleQemuSingleResizeRequest: title: UpdateNodesSingleQemuSingleResizeRequest type: object properties: digest: type: string disk: type: string size: type: string skiplock: type: boolean required: - disk - size CreateVMSnapshotRequest: title: CreateVMSnapshotRequest type: object properties: description: type: string snapname: type: string vmstate: type: boolean required: - snapname UpdateVMSnapshotConfigRequest: title: UpdateVMSnapshotConfigRequest type: object properties: description: type: string RollbackVMSnapshotRequest: title: RollbackVMSnapshotRequest type: object properties: {} CreateNodesSingleQemuSingleTemplateRequest: title: CreateNodesSingleQemuSingleTemplateRequest type: object properties: disk: type: string CreateNodesSingleLxcRequest: title: CreateNodesSingleLxcRequest type: object properties: arch: type: string bwlimit: type: number cmode: type: string console: type: boolean cores: type: integer cpulimit: type: number cpuunits: type: integer debug: type: boolean description: type: string features: type: string force: type: boolean hookscript: type: string hostname: type: string ignore-unpack-errors: type: boolean lock: type: string memory: type: integer mp0: type: string mp1: type: string mp2: type: string mp3: type: string mp4: type: string mp5: type: string mp6: type: string mp7: type: string mp8: type: string mp9: type: string mp10: type: string mp11: type: string mp12: type: string mp13: type: string mp14: type: string mp15: type: string mp16: type: string mp17: type: string mp18: type: string mp19: type: string mp20: type: string mp21: type: string mp22: type: string mp23: type: string mp24: type: string mp25: type: string mp26: type: string mp27: type: string mp28: type: string mp29: type: string nameserver: type: string net0: type: string net1: type: string net2: type: string net3: type: string net4: type: string net5: type: string net6: type: string net7: type: string net8: type: string net9: type: string net10: type: string net11: type: string net12: type: string net13: type: string net14: type: string net15: type: string net16: type: string net17: type: string net18: type: string net19: type: string net20: type: string net21: type: string net22: type: string net23: type: string net24: type: string net25: type: string net26: type: string net27: type: string net28: type: string net29: type: string onboot: type: boolean ostemplate: type: string ostype: type: string password: type: string pool: type: string protection: type: boolean restore: type: boolean rootfs: type: string searchdomain: type: string ssh-public-keys: type: string start: type: boolean startup: type: string storage: type: string swap: type: integer tags: type: string template: type: boolean timezone: type: string tty: type: integer unique: type: boolean unprivileged: type: boolean unused0: type: string unused1: type: string unused2: type: string unused3: type: string unused4: type: string unused5: type: string unused6: type: string unused7: type: string unused8: type: string unused9: type: string unused10: type: string unused11: type: string unused12: type: string unused13: type: string unused14: type: string unused15: type: string unused16: type: string unused17: type: string unused18: type: string unused19: type: string unused20: type: string unused21: type: string unused22: type: string unused23: type: string unused24: type: string unused25: type: string unused26: type: string unused27: type: string unused28: type: string unused29: type: string vmid: type: integer required: - ostemplate - vmid UpdateNodesSingleLxcSingleConfigRequest: title: UpdateNodesSingleLxcSingleConfigRequest type: object properties: arch: type: string cmode: type: string console: type: boolean cores: type: integer cpulimit: type: number cpuunits: type: integer debug: type: boolean delete: type: string description: type: string digest: type: string features: type: string hookscript: type: string hostname: type: string lock: type: string memory: type: integer mp0: type: string mp1: type: string mp2: type: string mp3: type: string mp4: type: string mp5: type: string mp6: type: string mp7: type: string mp8: type: string mp9: type: string mp10: type: string mp11: type: string mp12: type: string mp13: type: string mp14: type: string mp15: type: string mp16: type: string mp17: type: string mp18: type: string mp19: type: string mp20: type: string mp21: type: string mp22: type: string mp23: type: string mp24: type: string mp25: type: string mp26: type: string mp27: type: string mp28: type: string mp29: type: string nameserver: type: string net0: type: string net1: type: string net2: type: string net3: type: string net4: type: string net5: type: string net6: type: string net7: type: string net8: type: string net9: type: string net10: type: string net11: type: string net12: type: string net13: type: string net14: type: string net15: type: string net16: type: string net17: type: string net18: type: string net19: type: string net20: type: string net21: type: string net22: type: string net23: type: string net24: type: string net25: type: string net26: type: string net27: type: string net28: type: string net29: type: string onboot: type: boolean ostype: type: string protection: type: boolean revert: type: string rootfs: type: string searchdomain: type: string startup: type: string swap: type: integer tags: type: string template: type: boolean timezone: type: string tty: type: integer unprivileged: type: boolean unused0: type: string unused1: type: string unused2: type: string unused3: type: string unused4: type: string unused5: type: string unused6: type: string unused7: type: string unused8: type: string unused9: type: string unused10: type: string unused11: type: string unused12: type: string unused13: type: string unused14: type: string unused15: type: string unused16: type: string unused17: type: string unused18: type: string unused19: type: string unused20: type: string unused21: type: string unused22: type: string unused23: type: string unused24: type: string unused25: type: string unused26: type: string unused27: type: string unused28: type: string unused29: type: string CreateNodesSingleLxcSingleStatusStartRequest: title: CreateNodesSingleLxcSingleStatusStartRequest type: object properties: debug: type: boolean skiplock: type: boolean CreateNodesSingleLxcSingleStatusStopRequest: title: CreateNodesSingleLxcSingleStatusStopRequest type: object properties: skiplock: type: boolean CreateNodesSingleLxcSingleStatusShutdownRequest: title: CreateNodesSingleLxcSingleStatusShutdownRequest type: object properties: forceStop: type: boolean timeout: type: integer CreateNodesSingleLxcSingleStatusSuspendRequest: title: CreateNodesSingleLxcSingleStatusSuspendRequest type: object properties: {} CreateNodesSingleLxcSingleStatusResumeRequest: title: CreateNodesSingleLxcSingleStatusResumeRequest type: object properties: {} CreateNodesSingleLxcSingleStatusRebootRequest: title: CreateNodesSingleLxcSingleStatusRebootRequest type: object properties: timeout: type: integer CreateNodesSingleLxcSingleSnapshotRequest: title: CreateNodesSingleLxcSingleSnapshotRequest type: object properties: description: type: string snapname: type: string required: - snapname CreateNodesSingleLxcSingleSnapshotSingleRollbackRequest: title: CreateNodesSingleLxcSingleSnapshotSingleRollbackRequest type: object properties: {} UpdateNodesSingleLxcSingleSnapshotSingleConfigRequest: title: UpdateNodesSingleLxcSingleSnapshotSingleConfigRequest type: object properties: description: type: string CreateNodesSingleLxcSingleFirewallRulesRequest: title: CreateNodesSingleLxcSingleFirewallRulesRequest type: object properties: action: type: string comment: type: string dest: type: string digest: type: string dport: type: string enable: type: integer icmp-type: type: string iface: type: string log: type: string macro: type: string pos: type: integer proto: type: string source: type: string sport: type: string type: type: string required: - action - type UpdateNodesSingleLxcSingleFirewallRulesSingleRequest: title: UpdateNodesSingleLxcSingleFirewallRulesSingleRequest type: object properties: action: type: string comment: type: string delete: type: string dest: type: string digest: type: string dport: type: string enable: type: integer icmp-type: type: string iface: type: string log: type: string macro: type: string moveto: type: integer proto: type: string source: type: string sport: type: string type: type: string CreateNodesSingleLxcSingleFirewallAliasesRequest: title: CreateNodesSingleLxcSingleFirewallAliasesRequest type: object properties: cidr: type: string comment: type: string name: type: string required: - cidr - name UpdateNodesSingleLxcSingleFirewallAliasesSingleRequest: title: UpdateNodesSingleLxcSingleFirewallAliasesSingleRequest type: object properties: cidr: type: string comment: type: string digest: type: string rename: type: string required: - cidr CreateNodesSingleLxcSingleFirewallIpsetRequest: title: CreateNodesSingleLxcSingleFirewallIpsetRequest type: object properties: comment: type: string digest: type: string name: type: string rename: type: string required: - name CreateNodesSingleLxcSingleFirewallIpsetSingleRequest: title: CreateNodesSingleLxcSingleFirewallIpsetSingleRequest type: object properties: cidr: type: string comment: type: string nomatch: type: boolean required: - cidr UpdateNodesSingleLxcSingleFirewallIpsetSingleSingleRequest: title: UpdateNodesSingleLxcSingleFirewallIpsetSingleSingleRequest type: object properties: comment: type: string digest: type: string nomatch: type: boolean UpdateNodesSingleLxcSingleFirewallOptionsRequest: title: UpdateNodesSingleLxcSingleFirewallOptionsRequest type: object properties: delete: type: string dhcp: type: boolean digest: type: string enable: type: boolean ipfilter: type: boolean log_level_in: type: string log_level_out: type: string macfilter: type: boolean ndp: type: boolean policy_in: type: string policy_out: type: string radv: type: boolean CreateNodesSingleLxcSingleVncproxyRequest: title: CreateNodesSingleLxcSingleVncproxyRequest type: object properties: height: type: integer websocket: type: boolean width: type: integer CreateNodesSingleLxcSingleTermproxyRequest: title: CreateNodesSingleLxcSingleTermproxyRequest type: object properties: {} CreateNodesSingleLxcSingleSpiceproxyRequest: title: CreateNodesSingleLxcSingleSpiceproxyRequest type: object properties: proxy: type: string CreateNodesSingleLxcSingleMigrateRequest: title: CreateNodesSingleLxcSingleMigrateRequest type: object properties: bwlimit: type: number force: type: boolean online: type: boolean restart: type: boolean target: type: string timeout: type: integer required: - target CreateNodesSingleLxcSingleTemplateRequest: title: CreateNodesSingleLxcSingleTemplateRequest type: object properties: {} CreateNodesSingleLxcSingleCloneRequest: title: CreateNodesSingleLxcSingleCloneRequest type: object properties: bwlimit: type: number description: type: string full: type: boolean hostname: type: string newid: type: integer pool: type: string snapname: type: string storage: type: string target: type: string required: - newid UpdateNodesSingleLxcSingleResizeRequest: title: UpdateNodesSingleLxcSingleResizeRequest type: object properties: digest: type: string disk: type: string size: type: string required: - disk - size CreateNodesSingleLxcSingleMovevolumeRequest: title: CreateNodesSingleLxcSingleMovevolumeRequest type: object properties: bwlimit: type: number delete: type: boolean digest: type: string storage: type: string volume: type: string required: - storage - volume CreateNodesSingleCephOsdRequest: title: CreateNodesSingleCephOsdRequest type: object properties: crush-device-class: type: string db_dev: type: string db_size: type: number dev: type: string encrypted: type: boolean wal_dev: type: string wal_size: type: number required: - dev CreateNodesSingleCephOsdSingleInRequest: title: CreateNodesSingleCephOsdSingleInRequest type: object properties: {} CreateNodesSingleCephOsdSingleOutRequest: title: CreateNodesSingleCephOsdSingleOutRequest type: object properties: {} CreateNodesSingleCephOsdSingleScrubRequest: title: CreateNodesSingleCephOsdSingleScrubRequest type: object properties: deep: type: boolean CreateNodesSingleCephMdsSingleRequest: title: CreateNodesSingleCephMdsSingleRequest type: object properties: hotstandby: type: boolean CreateNodesSingleCephMgrSingleRequest: title: CreateNodesSingleCephMgrSingleRequest type: object properties: {} CreateNodesSingleCephMonSingleRequest: title: CreateNodesSingleCephMonSingleRequest type: object properties: mon-address: type: string CreateNodesSingleCephFsSingleRequest: title: CreateNodesSingleCephFsSingleRequest type: object properties: add-storage: type: boolean pg_num: type: integer CreateNodesSingleCephInitRequest: title: CreateNodesSingleCephInitRequest type: object properties: cluster-network: type: string disable_cephx: type: boolean min_size: type: integer network: type: string pg_bits: type: integer size: type: integer CreateNodesSingleCephStopRequest: title: CreateNodesSingleCephStopRequest type: object properties: service: type: string CreateNodesSingleCephStartRequest: title: CreateNodesSingleCephStartRequest type: object properties: service: type: string CreateNodesSingleCephRestartRequest: title: CreateNodesSingleCephRestartRequest type: object properties: service: type: string CreateNodesSingleCephPoolsRequest: title: CreateNodesSingleCephPoolsRequest type: object properties: add_storages: type: boolean application: type: string crush_rule: type: string min_size: type: integer name: type: string pg_autoscale_mode: type: string pg_num: type: integer size: type: integer required: - name UpdateNodesSingleCephPoolsSingleRequest: title: UpdateNodesSingleCephPoolsSingleRequest type: object properties: application: type: string crush_rule: type: string min_size: type: integer pg_autoscale_mode: type: string pg_num: type: integer size: type: integer CreateNodesSingleCephFlagsSingleRequest: title: CreateNodesSingleCephFlagsSingleRequest type: object properties: {} CreateNodesSingleVzdumpRequest: title: CreateNodesSingleVzdumpRequest type: object properties: all: type: boolean bwlimit: type: integer compress: type: string dumpdir: type: string exclude: type: string exclude-path: type: string ionice: type: integer lockwait: type: integer mailnotification: type: string mailto: type: string maxfiles: type: integer mode: type: string pigz: type: integer pool: type: string prune-backups: type: string quiet: type: boolean remove: type: boolean script: type: string size: type: integer stdexcludes: type: boolean stdout: type: boolean stop: type: boolean stopwait: type: integer storage: type: string tmpdir: type: string vmid: type: string zstd: type: integer CreateNodesSingleServicesSingleStartRequest: title: CreateNodesSingleServicesSingleStartRequest type: object properties: {} CreateNodesSingleServicesSingleStopRequest: title: CreateNodesSingleServicesSingleStopRequest type: object properties: {} CreateNodesSingleServicesSingleRestartRequest: title: CreateNodesSingleServicesSingleRestartRequest type: object properties: {} CreateNodesSingleServicesSingleReloadRequest: title: CreateNodesSingleServicesSingleReloadRequest type: object properties: {} CreateNodesSingleSubscriptionRequest: title: CreateNodesSingleSubscriptionRequest type: object properties: force: type: boolean UpdateNodesSingleSubscriptionRequest: title: UpdateNodesSingleSubscriptionRequest type: object properties: key: type: string required: - key CreateNodesSingleNetworkRequest: title: CreateNodesSingleNetworkRequest type: object properties: address: type: string address6: type: string autostart: type: boolean bond-primary: type: string bond_mode: type: string bond_xmit_hash_policy: type: string bridge_ports: type: string bridge_vlan_aware: type: boolean cidr: type: string cidr6: type: string comments: type: string comments6: type: string gateway: type: string gateway6: type: string iface: type: string mtu: type: integer netmask: type: string netmask6: type: integer ovs_bonds: type: string ovs_bridge: type: string ovs_options: type: string ovs_ports: type: string ovs_tag: type: integer slaves: type: string type: type: string vlan-id: type: integer vlan-raw-device: type: string required: - iface - type UpdateNodesSingleNetworkRequest: title: UpdateNodesSingleNetworkRequest type: object properties: {} UpdateNodesSingleNetworkSingleRequest: title: UpdateNodesSingleNetworkSingleRequest type: object properties: address: type: string address6: type: string autostart: type: boolean bond-primary: type: string bond_mode: type: string bond_xmit_hash_policy: type: string bridge_ports: type: string bridge_vlan_aware: type: boolean cidr: type: string cidr6: type: string comments: type: string comments6: type: string delete: type: string gateway: type: string gateway6: type: string mtu: type: integer netmask: type: string netmask6: type: integer ovs_bonds: type: string ovs_bridge: type: string ovs_options: type: string ovs_ports: type: string ovs_tag: type: integer slaves: type: string type: type: string vlan-id: type: integer vlan-raw-device: type: string required: - type CreateNodesSingleStorageSingleContentRequest: title: CreateNodesSingleStorageSingleContentRequest type: object properties: filename: type: string format: type: string size: type: string vmid: type: integer required: - filename - size - vmid CreateNodesSingleStorageSingleContentSingleRequest: title: CreateNodesSingleStorageSingleContentSingleRequest type: object properties: target: type: string target_node: type: string required: - target UpdateNodesSingleStorageSingleContentSingleRequest: title: UpdateNodesSingleStorageSingleContentSingleRequest type: object properties: notes: type: string CreateNodesSingleStorageSingleUploadRequest: title: CreateNodesSingleStorageSingleUploadRequest type: object properties: content: type: string filename: type: string tmpfilename: type: string required: - content - filename CreateNodesSingleDisksLvmRequest: title: CreateNodesSingleDisksLvmRequest type: object properties: add_storage: type: boolean device: type: string name: type: string required: - device - name CreateNodesSingleDisksLvmthinRequest: title: CreateNodesSingleDisksLvmthinRequest type: object properties: add_storage: type: boolean device: type: string name: type: string required: - device - name CreateNodesSingleDisksDirectoryRequest: title: CreateNodesSingleDisksDirectoryRequest type: object properties: add_storage: type: boolean device: type: string filesystem: type: string name: type: string required: - device - name CreateNodesSingleDisksZfsRequest: title: CreateNodesSingleDisksZfsRequest type: object properties: add_storage: type: boolean ashift: type: integer compression: type: string devices: type: string name: type: string raidlevel: type: string required: - devices - name - raidlevel CreateNodesSingleDisksInitgptRequest: title: CreateNodesSingleDisksInitgptRequest type: object properties: disk: type: string uuid: type: string required: - disk CreateNodesSingleAptUpdateRequest: title: CreateNodesSingleAptUpdateRequest type: object properties: notify: type: boolean quiet: type: boolean CreateNodeFirewallRuleRequest: title: CreateNodeFirewallRuleRequest type: object properties: action: type: string comment: type: string dest: type: string digest: type: string dport: type: string enable: type: integer icmp-type: type: string iface: type: string log: type: string macro: type: string pos: type: integer proto: type: string source: type: string sport: type: string type: type: string required: - action - type UpdateNodeFirewallRuleRequest: title: UpdateNodeFirewallRuleRequest type: object properties: action: type: string comment: type: string delete: type: string dest: type: string digest: type: string dport: type: string enable: type: integer icmp-type: type: string iface: type: string log: type: string macro: type: string moveto: type: integer proto: type: string source: type: string sport: type: string type: type: string UpdateNodeFirewallOptionsRequest: title: UpdateNodeFirewallOptionsRequest type: object properties: delete: type: string digest: type: string enable: type: boolean log_level_in: type: string log_level_out: type: string log_nf_conntrack: type: boolean ndp: type: boolean nf_conntrack_allow_invalid: type: boolean nf_conntrack_max: type: integer nf_conntrack_tcp_timeout_established: type: integer nf_conntrack_tcp_timeout_syn_recv: type: integer nosmurfs: type: boolean protection_synflood: type: boolean protection_synflood_burst: type: integer protection_synflood_rate: type: integer smurf_log_level: type: string tcp_flags_log_level: type: string tcpflags: type: boolean CreateNodesSingleReplicationSingleSchedulenowRequest: title: CreateNodesSingleReplicationSingleSchedulenowRequest type: object properties: {} CreateNodesSingleCertificatesAcmeCertificateRequest: title: CreateNodesSingleCertificatesAcmeCertificateRequest type: object properties: force: type: boolean UpdateNodesSingleCertificatesAcmeCertificateRequest: title: UpdateNodesSingleCertificatesAcmeCertificateRequest type: object properties: force: type: boolean CreateNodesSingleCertificatesCustomRequest: title: CreateNodesSingleCertificatesCustomRequest type: object properties: certificates: type: string force: type: boolean key: type: string restart: type: boolean required: - certificates UpdateNodesSingleConfigRequest: title: UpdateNodesSingleConfigRequest type: object properties: acme: type: string acmedomain0: type: string acmedomain1: type: string acmedomain2: type: string acmedomain3: type: string acmedomain4: type: string acmedomain5: type: string acmedomain6: type: string acmedomain7: type: string acmedomain8: type: string acmedomain9: type: string acmedomain10: type: string acmedomain11: type: string acmedomain12: type: string acmedomain13: type: string acmedomain14: type: string acmedomain15: type: string acmedomain16: type: string acmedomain17: type: string acmedomain18: type: string acmedomain19: type: string acmedomain20: type: string acmedomain21: type: string acmedomain22: type: string acmedomain23: type: string acmedomain24: type: string acmedomain25: type: string acmedomain26: type: string acmedomain27: type: string acmedomain28: type: string acmedomain29: type: string delete: type: string description: type: string digest: type: string startall-onboot-delay: type: integer wakeonlan: type: string CreateNodesSingleStatusRequest: title: CreateNodesSingleStatusRequest type: object properties: command: type: string required: - command CreateNodesSingleExecuteRequest: title: CreateNodesSingleExecuteRequest type: object properties: commands: type: string required: - commands CreateNodesSingleWakeonlanRequest: title: CreateNodesSingleWakeonlanRequest type: object properties: {} CreateNodesSingleVncshellRequest: title: CreateNodesSingleVncshellRequest type: object properties: cmd: type: string cmd-opts: type: string height: type: integer upgrade: type: boolean websocket: type: boolean width: type: integer CreateNodesSingleTermproxyRequest: title: CreateNodesSingleTermproxyRequest type: object properties: cmd: type: string cmd-opts: type: string upgrade: type: boolean CreateNodesSingleSpiceshellRequest: title: CreateNodesSingleSpiceshellRequest type: object properties: cmd: type: string cmd-opts: type: string proxy: type: string upgrade: type: boolean UpdateNodesSingleDnsRequest: title: UpdateNodesSingleDnsRequest type: object properties: dns1: type: string dns2: type: string dns3: type: string search: type: string required: - search UpdateNodesSingleTimeRequest: title: UpdateNodesSingleTimeRequest type: object properties: timezone: type: string required: - timezone CreateNodesSingleAplinfoRequest: title: CreateNodesSingleAplinfoRequest type: object properties: storage: type: string template: type: string required: - storage - template CreateNodesSingleStartallRequest: title: CreateNodesSingleStartallRequest type: object properties: force: type: boolean vms: type: string CreateNodesSingleStopallRequest: title: CreateNodesSingleStopallRequest type: object properties: vms: type: string CreateNodesSingleMigrateallRequest: title: CreateNodesSingleMigrateallRequest type: object properties: maxworkers: type: integer target: type: string vms: type: string with-local-disks: type: boolean required: - target CreateNodesSingleHostsRequest: title: CreateNodesSingleHostsRequest type: object properties: data: type: string digest: type: string required: - data CreateStorageRequest: title: CreateStorageRequest type: object properties: authsupported: type: string base: type: string blocksize: type: string bwlimit: type: string comstar_hg: type: string comstar_tg: type: string content: type: string datastore: type: string disable: type: boolean domain: type: string encryption-key: type: string export: type: string fingerprint: type: string format: type: string fuse: type: boolean is_mountpoint: type: string iscsiprovider: type: string krbd: type: boolean lio_tpg: type: string maxfiles: type: integer mkdir: type: boolean monhost: type: string mountpoint: type: string nodes: type: string nowritecache: type: boolean options: type: string password: type: string path: type: string pool: type: string port: type: integer portal: type: string prune-backups: type: string redundancy: type: integer saferemove: type: boolean saferemove_throughput: type: string server: type: string server2: type: string share: type: string shared: type: boolean smbversion: type: string sparse: type: boolean storage: type: string subdir: type: string tagged_only: type: boolean target: type: string thinpool: type: string transport: type: string type: type: string username: type: string vgname: type: string volume: type: string required: - storage - type UpdateStorageSingleRequest: title: UpdateStorageSingleRequest type: object properties: blocksize: type: string bwlimit: type: string comstar_hg: type: string comstar_tg: type: string content: type: string delete: type: string digest: type: string disable: type: boolean domain: type: string encryption-key: type: string fingerprint: type: string format: type: string fuse: type: boolean is_mountpoint: type: string krbd: type: boolean lio_tpg: type: string maxfiles: type: integer mkdir: type: boolean monhost: type: string mountpoint: type: string nodes: type: string nowritecache: type: boolean options: type: string password: type: string pool: type: string port: type: integer prune-backups: type: string redundancy: type: integer saferemove: type: boolean saferemove_throughput: type: string server: type: string server2: type: string shared: type: boolean smbversion: type: string sparse: type: boolean subdir: type: string tagged_only: type: boolean transport: type: string username: type: string CreateAccessUsersRequest: title: CreateAccessUsersRequest type: object properties: comment: type: string email: type: string enable: type: boolean expire: type: integer firstname: type: string groups: type: string keys: type: string lastname: type: string password: type: string userid: type: string required: - userid UpdateAccessUsersSingleRequest: title: UpdateAccessUsersSingleRequest type: object properties: append: type: boolean comment: type: string email: type: string enable: type: boolean expire: type: integer firstname: type: string groups: type: string keys: type: string lastname: type: string CreateAccessUsersSingleTokenSingleRequest: title: CreateAccessUsersSingleTokenSingleRequest type: object properties: comment: type: string expire: type: integer privsep: type: boolean UpdateAccessUsersSingleTokenSingleRequest: title: UpdateAccessUsersSingleTokenSingleRequest type: object properties: comment: type: string expire: type: integer privsep: type: boolean CreateAccessGroupsRequest: title: CreateAccessGroupsRequest type: object properties: comment: type: string groupid: type: string required: - groupid UpdateAccessGroupsSingleRequest: title: UpdateAccessGroupsSingleRequest type: object properties: comment: type: string CreateAccessRolesRequest: title: CreateAccessRolesRequest type: object properties: privs: type: string roleid: type: string required: - roleid UpdateAccessRolesSingleRequest: title: UpdateAccessRolesSingleRequest type: object properties: append: type: boolean privs: type: string UpdateAccessAclRequest: title: UpdateAccessAclRequest type: object properties: delete: type: boolean groups: type: string path: type: string propagate: type: boolean roles: type: string tokens: type: string users: type: string required: - path - roles CreateAccessDomainsRequest: title: CreateAccessDomainsRequest type: object properties: base_dn: type: string bind_dn: type: string capath: type: string case-sensitive: type: boolean cert: type: string certkey: type: string comment: type: string default: type: boolean domain: type: string filter: type: string group_classes: type: string group_dn: type: string group_filter: type: string group_name_attr: type: string mode: type: string password: type: string port: type: integer realm: type: string secure: type: boolean server1: type: string server2: type: string sslversion: type: string sync-defaults-options: type: string sync_attributes: type: string tfa: type: string type: type: string user_attr: type: string user_classes: type: string verify: type: boolean required: - realm - type UpdateAccessDomainsSingleRequest: title: UpdateAccessDomainsSingleRequest type: object properties: base_dn: type: string bind_dn: type: string capath: type: string case-sensitive: type: boolean cert: type: string certkey: type: string comment: type: string default: type: boolean delete: type: string digest: type: string domain: type: string filter: type: string group_classes: type: string group_dn: type: string group_filter: type: string group_name_attr: type: string mode: type: string password: type: string port: type: integer secure: type: boolean server1: type: string server2: type: string sslversion: type: string sync-defaults-options: type: string sync_attributes: type: string tfa: type: string user_attr: type: string user_classes: type: string verify: type: boolean CreateAccessDomainsSingleSyncRequest: title: CreateAccessDomainsSingleSyncRequest type: object properties: dry-run: type: boolean enable-new: type: boolean full: type: boolean purge: type: boolean scope: type: string required: - enable-new - full - purge - scope CreateAccessTicketRequest: title: CreateAccessTicketRequest type: object properties: otp: type: string password: type: string path: type: string privs: type: string realm: type: string username: type: string required: - password - username UpdateAccessPasswordRequest: title: UpdateAccessPasswordRequest type: object properties: password: type: string userid: type: string required: - password - userid CreateAccessTfaRequest: title: CreateAccessTfaRequest type: object properties: response: type: string required: - response UpdateAccessTfaRequest: title: UpdateAccessTfaRequest type: object properties: action: type: string config: type: string key: type: string password: type: string response: type: string userid: type: string required: - action - userid CreatePoolRequest: title: CreatePoolRequest type: object properties: comment: type: string poolid: type: string required: - poolid UpdatePoolRequest: title: UpdatePoolRequest type: object properties: comment: type: string delete: type: boolean storage: type: string vms: type: string responses: GetClusterResponse: description: GetClusterResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: {} GetClusterReplicationResponse: description: GetClusterReplicationResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: {} CreateClusterReplicationResponse: description: CreateClusterReplicationResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' DeleteClusterReplicationSingleResponse: description: DeleteClusterReplicationSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetClusterReplicationSingleResponse: description: GetClusterReplicationSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' UpdateClusterReplicationSingleResponse: description: UpdateClusterReplicationSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetClusterMetricsResponse: description: GetClusterMetricsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: {} GetClusterMetricsServerResponse: description: GetClusterMetricsServerResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: disable: type: boolean description: Flag to disable the plugin. id: type: string description: The ID of the entry. port: type: integer description: Server network port server: type: string description: Server dns name or IP address type: type: string description: Plugin type. DeleteClusterMetricsServerSingleResponse: description: DeleteClusterMetricsServerSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetClusterMetricsServerSingleResponse: description: GetClusterMetricsServerSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' CreateClusterMetricsServerSingleResponse: description: CreateClusterMetricsServerSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' UpdateClusterMetricsServerSingleResponse: description: UpdateClusterMetricsServerSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetClusterConfigResponse: description: GetClusterConfigResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: {} CreateClusterConfigResponse: description: CreateClusterConfigResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetClusterConfigApiversionResponse: description: GetClusterConfigApiversionResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: integer description: 'Cluster Join API version, currently 1' GetClusterConfigNodesResponse: description: GetClusterConfigNodesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: node: type: string description: '' DeleteClusterConfigNodesSingleResponse: description: DeleteClusterConfigNodesSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' CreateClusterConfigNodesSingleResponse: description: CreateClusterConfigNodesSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: corosync_authkey: type: string description: '' corosync_conf: type: string description: '' warnings: type: array description: '' items: type: string description: '' GetClusterConfigJoinResponse: description: GetClusterConfigJoinResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: config_digest: type: string description: '' nodelist: type: array description: '' items: type: object description: '' properties: name: type: string description: The cluster node name. nodeid: type: integer description: Node id for this node. pve_addr: type: string description: '' pve_fp: type: string description: Certificate SHA 256 fingerprint. quorum_votes: type: integer description: '' ring0_addr: type: string description: >- Address and priority information of a single corosync link. (up to 8 links supported; link0..link7) preferred_node: type: string description: The cluster node name. totem: type: object description: '' CreateClusterConfigJoinResponse: description: CreateClusterConfigJoinResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetClusterConfigTotemResponse: description: GetClusterConfigTotemResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' GetClusterConfigQdeviceResponse: description: GetClusterConfigQdeviceResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' GetClusterFirewallResponse: description: GetClusterFirewallResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: {} GetClusterFirewallGroupsResponse: description: GetClusterFirewallGroupsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: comment: type: string description: '' digest: type: string description: >- Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. group: type: string description: Security Group name. CreateClusterFirewallGroupResponse: description: CreateClusterFirewallGroupResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' DeleteClusterFirewallGroupResponse: description: DeleteClusterFirewallGroupResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetClusterFirewallGroupRulesResponse: description: GetClusterFirewallGroupRulesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: pos: type: integer description: '' AddClusterFirewallGroupRuleResponse: description: AddClusterFirewallGroupRuleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' RemoveClusterFirewallGroupRuleResponse: description: RemoveClusterFirewallGroupRuleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetClusterFirewallGroupRuleResponse: description: GetClusterFirewallGroupRuleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: action: type: string description: '' comment: type: string description: '' dest: type: string description: '' dport: type: string description: '' enable: type: integer description: '' icmp-type: type: string description: '' iface: type: string description: '' ipversion: type: integer description: '' log: type: string description: Log level for firewall rule macro: type: string description: '' pos: type: integer description: '' proto: type: string description: '' source: type: string description: '' sport: type: string description: '' type: type: string description: '' UpdateClusterFirewallGroupRuleResponse: description: UpdateClusterFirewallGroupRuleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetClusterFirewallRulesResponse: description: GetClusterFirewallRulesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: pos: type: integer description: '' AddClusterFirewallRuleResponse: description: AddClusterFirewallRuleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' RemoveClusterFirewallRuleResponse: description: RemoveClusterFirewallRuleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetClusterFirewallRuleResponse: description: GetClusterFirewallRuleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: action: type: string description: '' comment: type: string description: '' dest: type: string description: '' dport: type: string description: '' enable: type: integer description: '' icmp-type: type: string description: '' iface: type: string description: '' ipversion: type: integer description: '' log: type: string description: Log level for firewall rule macro: type: string description: '' pos: type: integer description: '' proto: type: string description: '' source: type: string description: '' sport: type: string description: '' type: type: string description: '' UpdateClusterFirewallRuleResponse: description: UpdateClusterFirewallRuleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetClusterFirewallIPSetsResponse: description: GetClusterFirewallIPSetsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: comment: type: string description: '' digest: type: string description: >- Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. name: type: string description: IP set name. CreateClusterFirewallIPSetResponse: description: CreateClusterFirewallIPSetResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' DeleteClusterFirewallIPSetResponse: description: DeleteClusterFirewallIPSetResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetClusterFirewallIPSetResponse: description: GetClusterFirewallIPSetResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: cidr: type: string description: '' comment: type: string description: '' digest: type: string description: >- Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. nomatch: type: boolean description: '' AddClusterFirewallIPSetIPResponse: description: AddClusterFirewallIPSetIPResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' RemoveClusterFirewallIPSetIPResponse: description: RemoveClusterFirewallIPSetIPResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetClusterFirewallIPSetIPResponse: description: GetClusterFirewallIPSetIPResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' UpdateClusterFirewallIPSetIPResponse: description: UpdateClusterFirewallIPSetIPResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetClusterFirewallAliasesResponse: description: GetClusterFirewallAliasesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: cidr: type: string description: '' comment: type: string description: '' digest: type: string description: >- Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. name: type: string description: '' CreateClusterFirewallAliasesResponse: description: CreateClusterFirewallAliasesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' DeleteClusterFirewallAliasesSingleResponse: description: DeleteClusterFirewallAliasesSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetClusterFirewallAliasesSingleResponse: description: GetClusterFirewallAliasesSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' UpdateClusterFirewallAliasesSingleResponse: description: UpdateClusterFirewallAliasesSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetClusterFirewallOptionsResponse: description: GetClusterFirewallOptionsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: ebtables: type: boolean description: Enable ebtables rules cluster wide. enable: type: integer description: Enable or disable the firewall cluster wide. log_ratelimit: type: string description: Log ratelimiting settings policy_in: type: string description: Input policy. policy_out: type: string description: Output policy. UpdateClusterFirewallOptionsResponse: description: UpdateClusterFirewallOptionsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetClusterFirewallMacrosResponse: description: GetClusterFirewallMacrosResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: descr: type: string description: More verbose description (if available). macro: type: string description: Macro name. GetClusterFirewallRefsResponse: description: GetClusterFirewallRefsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: comment: type: string description: '' name: type: string description: '' ref: type: string description: '' type: type: string description: '' GetClusterBackupResponse: description: GetClusterBackupResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: id: type: string description: The job ID. CreateClusterBackupResponse: description: CreateClusterBackupResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' DeleteClusterBackupSingleResponse: description: DeleteClusterBackupSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetClusterBackupSingleResponse: description: GetClusterBackupSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' UpdateClusterBackupSingleResponse: description: UpdateClusterBackupSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetClusterBackupSingleIncludedvolumesResponse: description: GetClusterBackupSingleIncludedvolumesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: >- Root node of the tree object. Children represent guests, grandchildren represent volumes of that guest. properties: children: type: array description: '' items: type: object description: '' properties: children: type: array description: >- The volumes of the guest with the information if they will be included in backups. items: type: object description: '' properties: id: type: string description: Configuration key of the volume. included: type: boolean description: >- Whether the volume is included in the backup or not. name: type: string description: Name of the volume. reason: type: string description: >- The reason why the volume is included (or excluded). id: type: integer description: VMID of the guest. name: type: string description: Name of the guest type: type: string description: >- Type of the guest, VM, CT or unknown for removed but not purged guests. GetClusterBackupinfoResponse: description: GetClusterBackupinfoResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: Shows stub message GetClusterBackupinfoNotbackedupResponse: description: GetClusterBackupinfoNotbackedupResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: Contains the guest objects. items: type: object description: '' properties: name: type: string description: Name of the guest type: type: string description: Type of the guest. vmid: type: integer description: VMID of the guest. GetClusterHaResponse: description: GetClusterHaResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: id: type: string description: '' GetClusterHaResourcesResponse: description: GetClusterHaResourcesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: sid: type: string description: '' CreateClusterHaResourcesResponse: description: CreateClusterHaResourcesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' DeleteClusterHaResourcesSingleResponse: description: DeleteClusterHaResourcesSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetClusterHaResourcesSingleResponse: description: GetClusterHaResourcesSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: comment: type: string description: Description. digest: type: string description: Can be used to prevent concurrent modifications. group: type: string description: The HA group identifier. max_relocate: type: integer description: >- Maximal number of service relocate tries when a service failes to start. max_restart: type: integer description: >- Maximal number of tries to restart the service on a node after its start failed. sid: type: string description: >- HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100). state: type: string description: Requested resource state. type: type: string description: The type of the resources. UpdateClusterHaResourcesSingleResponse: description: UpdateClusterHaResourcesSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' CreateClusterHaResourcesSingleMigrateResponse: description: CreateClusterHaResourcesSingleMigrateResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' CreateClusterHaResourcesSingleRelocateResponse: description: CreateClusterHaResourcesSingleRelocateResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetClusterHaGroupsResponse: description: GetClusterHaGroupsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: group: type: string description: '' CreateClusterHaGroupsResponse: description: CreateClusterHaGroupsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' DeleteClusterHaGroupsSingleResponse: description: DeleteClusterHaGroupsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetClusterHaGroupsSingleResponse: description: GetClusterHaGroupsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' UpdateClusterHaGroupsSingleResponse: description: UpdateClusterHaGroupsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetClusterHaStatusResponse: description: GetClusterHaStatusResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: {} GetClusterHaStatusCurrentResponse: description: GetClusterHaStatusCurrentResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' GetClusterHaStatusManagerstatusResponse: description: GetClusterHaStatusManagerstatusResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' GetClusterAcmeResponse: description: GetClusterAcmeResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: {} GetClusterAcmePluginsResponse: description: GetClusterAcmePluginsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: plugin: type: string description: Unique identifier for ACME plugin instance. CreateClusterAcmePluginsResponse: description: CreateClusterAcmePluginsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' DeleteClusterAcmePluginsSingleResponse: description: DeleteClusterAcmePluginsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetClusterAcmePluginsSingleResponse: description: GetClusterAcmePluginsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' UpdateClusterAcmePluginsSingleResponse: description: UpdateClusterAcmePluginsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetClusterAcmeAccountResponse: description: GetClusterAcmeAccountResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: {} CreateClusterAcmeAccountResponse: description: CreateClusterAcmeAccountResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' DeleteClusterAcmeAccountSingleResponse: description: DeleteClusterAcmeAccountSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetClusterAcmeAccountSingleResponse: description: GetClusterAcmeAccountSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: account: type: object description: '' directory: type: string description: URL of ACME CA directory endpoint. location: type: string description: '' tos: type: string description: '' UpdateClusterAcmeAccountSingleResponse: description: UpdateClusterAcmeAccountSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetClusterAcmeTosResponse: description: GetClusterAcmeTosResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: ACME TermsOfService URL. GetClusterAcmeDirectoriesResponse: description: GetClusterAcmeDirectoriesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: name: type: string description: '' url: type: string description: URL of ACME CA directory endpoint. GetClusterAcmeChallengeschemaResponse: description: GetClusterAcmeChallengeschemaResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: id: type: string description: '' name: type: string description: 'Human readable name, falls back to id' schema: type: object description: '' type: type: string description: '' GetClusterCephResponse: description: GetClusterCephResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: {} GetClusterCephMetadataResponse: description: GetClusterCephMetadataResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' GetClusterCephStatusResponse: description: GetClusterCephStatusResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' GetClusterCephFlagsResponse: description: GetClusterCephFlagsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: name: type: string description: Flag name. UpdateClusterCephFlagsResponse: description: UpdateClusterCephFlagsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetClusterCephFlagsSingleResponse: description: GetClusterCephFlagsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: boolean description: '' UpdateClusterCephFlagsSingleResponse: description: UpdateClusterCephFlagsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetClusterSDNResponse: description: GetClusterSDNResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: id: type: string description: '' UpdateClusterSDNResponse: description: UpdateClusterSDNResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetClusterSDNVnetsResponse: description: GetClusterSDNVnetsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: {} CreateClusterSDNVnetResponse: description: CreateClusterSDNVnetResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' DeleteClusterSDNVnetResponse: description: DeleteClusterSDNVnetResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetClusterSDNVnetResponse: description: GetClusterSDNVnetResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' UpdateClusterSDNVnetResponse: description: UpdateClusterSDNVnetResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetClusterSDNZonesResponse: description: GetClusterSDNZonesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: type: type: string description: '' zone: type: string description: '' CreateClusterSDNZoneResponse: description: CreateClusterSDNZoneResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' DeleteClusterSDNZoneResponse: description: DeleteClusterSDNZoneResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetClusterSDNZoneResponse: description: GetClusterSDNZoneResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' UpdateClusterSDNZoneResponse: description: UpdateClusterSDNZoneResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetClusterSDNControllersResponse: description: GetClusterSDNControllersResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: controller: type: string description: '' type: type: string description: '' CreateClusterSDNControllerResponse: description: CreateClusterSDNControllerResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' DeleteClusterSDNControllerResponse: description: DeleteClusterSDNControllerResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetClusterSDNControllerResponse: description: GetClusterSDNControllerResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' UpdateClusterSDNControllerResponse: description: UpdateClusterSDNControllerResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetClusterLogResponse: description: GetClusterLogResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: {} GetClusterResourcesResponse: description: GetClusterResourcesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: content: type: string description: Allowed storage content types (when type == storage). cpu: type: number description: 'CPU utilization (when type in node,qemu,lxc).' disk: type: string description: >- Used disk space in bytes (when type in storage), used root image spave for VMs (type in qemu,lxc). hastate: type: string description: HA service status (for HA managed VMs). id: type: string description: '' level: type: string description: Support level (when type == node). maxcpu: type: number description: 'Number of available CPUs (when type in node,qemu,lxc).' maxdisk: type: integer description: >- Storage size in bytes (when type in storage), root image size for VMs (type in qemu,lxc). maxmem: type: integer description: >- Number of available memory in bytes (when type in node,qemu,lxc). mem: type: string description: 'Used memory in bytes (when type in node,qemu,lxc).' node: type: string description: >- The cluster node name (when type in node,storage,qemu,lxc). pool: type: string description: 'The pool name (when type in pool,qemu,lxc).' status: type: string description: Resource type dependent status. storage: type: string description: The storage identifier (when type == storage). type: type: string description: Resource type. uptime: type: integer description: 'Node uptime in seconds (when type in node,qemu,lxc).' GetClusterTasksResponse: description: GetClusterTasksResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: upid: type: string description: '' GetClusterOptionsResponse: description: GetClusterOptionsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' UpdateClusterOptionsResponse: description: UpdateClusterOptionsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetClusterStatusResponse: description: GetClusterStatusResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: id: type: string description: '' ip: type: string description: '[node] IP of the resolved nodename.' level: type: string description: >- [node] Proxmox VE Subscription level, indicates if eligible for enterprise support as well as access to the stable Proxmox VE Enterprise Repository. local: type: boolean description: '[node] Indicates if this is the responding node.' name: type: string description: '' nodeid: type: integer description: '[node] ID of the node from the corosync configuration.' nodes: type: integer description: '[cluster] Nodes count, including offline nodes.' online: type: boolean description: '[node] Indicates if the node is online or offline.' quorate: type: boolean description: >- [cluster] Indicates if there is a majority of nodes online to make decisions type: type: string description: >- Indicates the type, either cluster or node. The type defines the object properties e.g. quorate available for type cluster. version: type: integer description: >- [cluster] Current version of the corosync configuration file. GetClusterNextidResponse: description: GetClusterNextidResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: integer description: The next free VMID. GetNodesResponse: description: GetNodesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: cpu: type: number description: CPU utilization. level: type: string description: Support level. maxcpu: type: integer description: Number of available CPUs. maxmem: type: integer description: Number of available memory in bytes. mem: type: integer description: Used memory in bytes. node: type: string description: The cluster node name. ssl_fingerprint: type: string description: The SSL fingerprint for the node certificate. status: type: string description: Node status. uptime: type: integer description: Node uptime in seconds. GetNodeResponse: description: GetNodeResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: {} GetVMsResponse: description: GetVMsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: cpus: type: number description: Maximum usable CPUs. lock: type: string description: 'The current config lock, if any.' maxdisk: type: integer description: Root disk size in bytes. maxmem: type: integer description: Maximum memory in bytes. name: type: string description: VM name. pid: type: integer description: PID of running qemu process. qmpstatus: type: string description: Qemu QMP agent status. status: type: string description: Qemu process status. tags: type: string description: 'The current configured tags, if any' uptime: type: integer description: Uptime. vmid: type: integer description: The (unique) ID of the VM. CreateVMResponse: description: CreateVMResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' DeleteVMResponse: description: DeleteVMResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetVMResponse: description: GetVMResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: subdir: type: string description: '' GetVMFirewallResponse: description: GetVMFirewallResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: {} GetVMFirewallRulesResponse: description: GetVMFirewallRulesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: pos: type: integer description: '' CreateVMFirewallRuleResponse: description: CreateVMFirewallRuleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' DeleteVMFirewallRuleResponse: description: DeleteVMFirewallRuleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetVMFirewallRuleResponse: description: GetVMFirewallRuleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: action: type: string description: '' comment: type: string description: '' dest: type: string description: '' dport: type: string description: '' enable: type: integer description: '' icmp-type: type: string description: '' iface: type: string description: '' ipversion: type: integer description: '' log: type: string description: Log level for firewall rule macro: type: string description: '' pos: type: integer description: '' proto: type: string description: '' source: type: string description: '' sport: type: string description: '' type: type: string description: '' UpdateVMFirewallRuleResponse: description: UpdateVMFirewallRuleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleQemuSingleFirewallAliasesResponse: description: GetNodesSingleQemuSingleFirewallAliasesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: cidr: type: string description: '' comment: type: string description: '' digest: type: string description: >- Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. name: type: string description: '' CreateNodesSingleQemuSingleFirewallAliasesResponse: description: CreateNodesSingleQemuSingleFirewallAliasesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' DeleteNodesSingleQemuSingleFirewallAliasesSingleResponse: description: DeleteNodesSingleQemuSingleFirewallAliasesSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleQemuSingleFirewallAliasesSingleResponse: description: GetNodesSingleQemuSingleFirewallAliasesSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' UpdateNodesSingleQemuSingleFirewallAliasesSingleResponse: description: UpdateNodesSingleQemuSingleFirewallAliasesSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetVMFirewallIPSetsResponse: description: GetVMFirewallIPSetsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: comment: type: string description: '' digest: type: string description: >- Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. name: type: string description: IP set name. CreateVMFirewallIPSetResponse: description: CreateVMFirewallIPSetResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' DeleteVMFirewallIPSetResponse: description: DeleteVMFirewallIPSetResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetVMFirewallIPSetResponse: description: GetVMFirewallIPSetResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: cidr: type: string description: '' comment: type: string description: '' digest: type: string description: >- Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. nomatch: type: boolean description: '' AddVMFirewallIPSetIPResponse: description: AddVMFirewallIPSetIPResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' RemoveVMFirewallIPSetIPResponse: description: RemoveVMFirewallIPSetIPResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetVMFirewallIPSetIPResponse: description: GetVMFirewallIPSetIPResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' UpdateVMFirewallIPSetIPResponse: description: UpdateVMFirewallIPSetIPResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetVMFirewallOptionsResponse: description: GetVMFirewallOptionsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: dhcp: type: boolean description: Enable DHCP. enable: type: boolean description: Enable/disable firewall rules. ipfilter: type: boolean description: >- Enable default IP filters. This is equivalent to adding an empty ipfilter-net ipset for every interface. Such ipsets implicitly contain sane default restrictions such as restricting IPv6 link local addresses to the one derived from the interface's MAC address. For containers the configured IP addresses will be implicitly added. log_level_in: type: string description: Log level for incoming traffic. log_level_out: type: string description: Log level for outgoing traffic. macfilter: type: boolean description: Enable/disable MAC address filter. ndp: type: boolean description: Enable NDP (Neighbor Discovery Protocol). policy_in: type: string description: Input policy. policy_out: type: string description: Output policy. radv: type: boolean description: Allow sending Router Advertisement. UpdateVMFirewallOptionsResponse: description: UpdateVMFirewallOptionsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleQemuSingleFirewallLogResponse: description: GetNodesSingleQemuSingleFirewallLogResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: 'n': type: integer description: Line number t: type: string description: Line text GetNodesSingleQemuSingleFirewallRefsResponse: description: GetNodesSingleQemuSingleFirewallRefsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: comment: type: string description: '' name: type: string description: '' type: type: string description: '' GetNodesSingleQemuSingleAgentResponse: description: GetNodesSingleQemuSingleAgentResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: Returns the list of Qemu Agent commands items: type: object description: '' properties: {} CreateNodesSingleQemuSingleAgentResponse: description: CreateNodesSingleQemuSingleAgentResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Returns an object with a single `result` property. CreateNodesSingleQemuSingleAgentFsfreezefreezeResponse: description: CreateNodesSingleQemuSingleAgentFsfreezefreezeResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Returns an object with a single `result` property. CreateNodesSingleQemuSingleAgentFsfreezestatusResponse: description: CreateNodesSingleQemuSingleAgentFsfreezestatusResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Returns an object with a single `result` property. CreateNodesSingleQemuSingleAgentFsfreezethawResponse: description: CreateNodesSingleQemuSingleAgentFsfreezethawResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Returns an object with a single `result` property. CreateNodesSingleQemuSingleAgentFstrimResponse: description: CreateNodesSingleQemuSingleAgentFstrimResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Returns an object with a single `result` property. GetNodesSingleQemuSingleAgentGetfsinfoResponse: description: GetNodesSingleQemuSingleAgentGetfsinfoResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Returns an object with a single `result` property. GetNodesSingleQemuSingleAgentGethostnameResponse: description: GetNodesSingleQemuSingleAgentGethostnameResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Returns an object with a single `result` property. GetNodesSingleQemuSingleAgentGetmemoryblockinfoResponse: description: GetNodesSingleQemuSingleAgentGetmemoryblockinfoResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Returns an object with a single `result` property. GetNodesSingleQemuSingleAgentGetmemoryblocksResponse: description: GetNodesSingleQemuSingleAgentGetmemoryblocksResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Returns an object with a single `result` property. GetNodesSingleQemuSingleAgentGetosinfoResponse: description: GetNodesSingleQemuSingleAgentGetosinfoResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Returns an object with a single `result` property. GetNodesSingleQemuSingleAgentGettimeResponse: description: GetNodesSingleQemuSingleAgentGettimeResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Returns an object with a single `result` property. GetNodesSingleQemuSingleAgentGettimezoneResponse: description: GetNodesSingleQemuSingleAgentGettimezoneResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Returns an object with a single `result` property. GetNodesSingleQemuSingleAgentGetusersResponse: description: GetNodesSingleQemuSingleAgentGetusersResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Returns an object with a single `result` property. GetNodesSingleQemuSingleAgentGetvcpusResponse: description: GetNodesSingleQemuSingleAgentGetvcpusResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Returns an object with a single `result` property. GetNodesSingleQemuSingleAgentInfoResponse: description: GetNodesSingleQemuSingleAgentInfoResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Returns an object with a single `result` property. GetNodesSingleQemuSingleAgentNetworkgetinterfacesResponse: description: GetNodesSingleQemuSingleAgentNetworkgetinterfacesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Returns an object with a single `result` property. CreateNodesSingleQemuSingleAgentPingResponse: description: CreateNodesSingleQemuSingleAgentPingResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Returns an object with a single `result` property. CreateNodesSingleQemuSingleAgentShutdownResponse: description: CreateNodesSingleQemuSingleAgentShutdownResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Returns an object with a single `result` property. CreateNodesSingleQemuSingleAgentSuspenddiskResponse: description: CreateNodesSingleQemuSingleAgentSuspenddiskResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Returns an object with a single `result` property. CreateNodesSingleQemuSingleAgentSuspendhybridResponse: description: CreateNodesSingleQemuSingleAgentSuspendhybridResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Returns an object with a single `result` property. CreateNodesSingleQemuSingleAgentSuspendramResponse: description: CreateNodesSingleQemuSingleAgentSuspendramResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Returns an object with a single `result` property. CreateNodesSingleQemuSingleAgentSetuserpasswordResponse: description: CreateNodesSingleQemuSingleAgentSetuserpasswordResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Returns an object with a single `result` property. CreateNodesSingleQemuSingleAgentExecResponse: description: CreateNodesSingleQemuSingleAgentExecResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: pid: type: integer description: The PID of the process started by the guest-agent. GetNodesSingleQemuSingleAgentExecstatusResponse: description: GetNodesSingleQemuSingleAgentExecstatusResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: err-data: type: string description: stderr of the process err-truncated: type: boolean description: true if stderr was not fully captured exitcode: type: integer description: process exit code if it was normally terminated. exited: type: boolean description: Tells if the given command has exited yet. out-data: type: string description: stdout of the process out-truncated: type: boolean description: true if stdout was not fully captured signal: type: integer description: >- signal number or exception code if the process was abnormally terminated. GetNodesSingleQemuSingleAgentFilereadResponse: description: GetNodesSingleQemuSingleAgentFilereadResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Returns an object with a `content` property. properties: content: type: string description: 'The content of the file, maximum 16777216' truncated: type: boolean description: 'If set to 1, the output is truncated and not complete' CreateNodesSingleQemuSingleAgentFilewriteResponse: description: CreateNodesSingleQemuSingleAgentFilewriteResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetVMRRDResponse: description: GetVMRRDResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: filename: type: string description: '' GetVMRRDDataResponse: description: GetVMRRDDataResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: {} GetVMConfigResponse: description: GetVMConfigResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: The VM configuration. properties: acpi: type: boolean description: Enable/disable ACPI. agent: type: string description: Enable/disable Qemu GuestAgent and its properties. arch: type: string description: Virtual processor architecture. Defaults to the host. args: type: string description: Arbitrary arguments passed to kvm. audio0: type: string description: >- Configure a audio device, useful in combination with QXL/Spice. autostart: type: boolean description: Automatic restart after crash (currently ignored). balloon: type: integer description: >- Amount of target RAM for the VM in MB. Using zero disables the ballon driver. bios: type: string description: Select BIOS implementation. boot: type: string description: >- Specify guest boot order. Use with 'order=', usage with no key or 'legacy=' is deprecated. bootdisk: type: string description: >- Enable booting from specified disk. Deprecated: Use 'boot: order=foo;bar' instead. cdrom: type: string description: This is an alias for option -ide2 cicustom: type: string description: >- cloud-init: Specify custom files to replace the automatically generated ones at start. cipassword: type: string description: >- cloud-init: Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords. citype: type: string description: >- Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows. ciuser: type: string description: >- cloud-init: User name to change ssh keys and password for instead of the image's configured default user. cores: type: integer description: The number of cores per socket. cpu: type: string description: Emulated CPU type. cpulimit: type: number description: Limit of CPU usage. cpuunits: type: integer description: CPU weight for a VM. description: type: string description: >- Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file. digest: type: string description: >- SHA1 digest of configuration file. This can be used to prevent concurrent modifications. efidisk0: type: string description: Configure a Disk for storing EFI vars freeze: type: boolean description: >- Freeze CPU at startup (use 'c' monitor command to start execution). hookscript: type: string description: >- Script that will be executed during various steps in the vms lifetime. hostpci0: type: string description: Map host PCI devices into guest. hostpci1: type: string description: Map host PCI devices into guest. hostpci2: type: string description: Map host PCI devices into guest. hostpci3: type: string description: Map host PCI devices into guest. hostpci4: type: string description: Map host PCI devices into guest. hostpci5: type: string description: Map host PCI devices into guest. hostpci6: type: string description: Map host PCI devices into guest. hostpci7: type: string description: Map host PCI devices into guest. hostpci8: type: string description: Map host PCI devices into guest. hostpci9: type: string description: Map host PCI devices into guest. hostpci10: type: string description: Map host PCI devices into guest. hostpci11: type: string description: Map host PCI devices into guest. hostpci12: type: string description: Map host PCI devices into guest. hostpci13: type: string description: Map host PCI devices into guest. hostpci14: type: string description: Map host PCI devices into guest. hostpci15: type: string description: Map host PCI devices into guest. hostpci16: type: string description: Map host PCI devices into guest. hostpci17: type: string description: Map host PCI devices into guest. hostpci18: type: string description: Map host PCI devices into guest. hostpci19: type: string description: Map host PCI devices into guest. hostpci20: type: string description: Map host PCI devices into guest. hostpci21: type: string description: Map host PCI devices into guest. hostpci22: type: string description: Map host PCI devices into guest. hostpci23: type: string description: Map host PCI devices into guest. hostpci24: type: string description: Map host PCI devices into guest. hostpci25: type: string description: Map host PCI devices into guest. hostpci26: type: string description: Map host PCI devices into guest. hostpci27: type: string description: Map host PCI devices into guest. hostpci28: type: string description: Map host PCI devices into guest. hostpci29: type: string description: Map host PCI devices into guest. hotplug: type: string description: >- Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to disable hotplug completely. Value '1' is an alias for the default 'network,disk,usb'. hugepages: type: string description: Enable/disable hugepages memory. ide0: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide1: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide2: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide3: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide4: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide5: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide6: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide7: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide8: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide9: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide10: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide11: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide12: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide13: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide14: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide15: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide16: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide17: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide18: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide19: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide20: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide21: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide22: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide23: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide24: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide25: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide26: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide27: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide28: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide29: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ipconfig0: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig1: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig2: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig3: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig4: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig5: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig6: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig7: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig8: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig9: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig10: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig11: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig12: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig13: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig14: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig15: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig16: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig17: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig18: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig19: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig20: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig21: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig22: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig23: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig24: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig25: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig26: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig27: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig28: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig29: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ivshmem: type: string description: >- Inter-VM shared memory. Useful for direct communication between VMs, or to the host. keephugepages: type: boolean description: >- Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts. keyboard: type: string description: >- Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it. kvm: type: boolean description: Enable/disable KVM hardware virtualization. localtime: type: boolean description: >- Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS. lock: type: string description: Lock/unlock the VM. machine: type: string description: Specifies the Qemu machine type. memory: type: integer description: >- Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device. migrate_downtime: type: number description: >- Set maximum tolerated downtime (in seconds) for migrations. migrate_speed: type: integer description: >- Set maximum speed (in MB/s) for migrations. Value 0 is no limit. name: type: string description: >- Set a name for the VM. Only used on the configuration web interface. nameserver: type: string description: "cloud-init: Sets DNS server IP address for a container. Create will'\n\t .' automatically use the setting from the host if neither searchdomain nor nameserver'\n\t .' are set." net0: type: string description: Specify network devices. net1: type: string description: Specify network devices. net2: type: string description: Specify network devices. net3: type: string description: Specify network devices. net4: type: string description: Specify network devices. net5: type: string description: Specify network devices. net6: type: string description: Specify network devices. net7: type: string description: Specify network devices. net8: type: string description: Specify network devices. net9: type: string description: Specify network devices. net10: type: string description: Specify network devices. net11: type: string description: Specify network devices. net12: type: string description: Specify network devices. net13: type: string description: Specify network devices. net14: type: string description: Specify network devices. net15: type: string description: Specify network devices. net16: type: string description: Specify network devices. net17: type: string description: Specify network devices. net18: type: string description: Specify network devices. net19: type: string description: Specify network devices. net20: type: string description: Specify network devices. net21: type: string description: Specify network devices. net22: type: string description: Specify network devices. net23: type: string description: Specify network devices. net24: type: string description: Specify network devices. net25: type: string description: Specify network devices. net26: type: string description: Specify network devices. net27: type: string description: Specify network devices. net28: type: string description: Specify network devices. net29: type: string description: Specify network devices. numa: type: boolean description: Enable/disable NUMA. numa0: type: string description: NUMA topology. numa1: type: string description: NUMA topology. numa2: type: string description: NUMA topology. numa3: type: string description: NUMA topology. numa4: type: string description: NUMA topology. numa5: type: string description: NUMA topology. numa6: type: string description: NUMA topology. numa7: type: string description: NUMA topology. numa8: type: string description: NUMA topology. numa9: type: string description: NUMA topology. numa10: type: string description: NUMA topology. numa11: type: string description: NUMA topology. numa12: type: string description: NUMA topology. numa13: type: string description: NUMA topology. numa14: type: string description: NUMA topology. numa15: type: string description: NUMA topology. numa16: type: string description: NUMA topology. numa17: type: string description: NUMA topology. numa18: type: string description: NUMA topology. numa19: type: string description: NUMA topology. numa20: type: string description: NUMA topology. numa21: type: string description: NUMA topology. numa22: type: string description: NUMA topology. numa23: type: string description: NUMA topology. numa24: type: string description: NUMA topology. numa25: type: string description: NUMA topology. numa26: type: string description: NUMA topology. numa27: type: string description: NUMA topology. numa28: type: string description: NUMA topology. numa29: type: string description: NUMA topology. onboot: type: boolean description: >- Specifies whether a VM will be started during system bootup. ostype: type: string description: Specify guest operating system. parallel0: type: string description: Map host parallel devices (n is 0 to 2). parallel1: type: string description: Map host parallel devices (n is 0 to 2). parallel2: type: string description: Map host parallel devices (n is 0 to 2). parallel3: type: string description: Map host parallel devices (n is 0 to 2). parallel4: type: string description: Map host parallel devices (n is 0 to 2). parallel5: type: string description: Map host parallel devices (n is 0 to 2). parallel6: type: string description: Map host parallel devices (n is 0 to 2). parallel7: type: string description: Map host parallel devices (n is 0 to 2). parallel8: type: string description: Map host parallel devices (n is 0 to 2). parallel9: type: string description: Map host parallel devices (n is 0 to 2). parallel10: type: string description: Map host parallel devices (n is 0 to 2). parallel11: type: string description: Map host parallel devices (n is 0 to 2). parallel12: type: string description: Map host parallel devices (n is 0 to 2). parallel13: type: string description: Map host parallel devices (n is 0 to 2). parallel14: type: string description: Map host parallel devices (n is 0 to 2). parallel15: type: string description: Map host parallel devices (n is 0 to 2). parallel16: type: string description: Map host parallel devices (n is 0 to 2). parallel17: type: string description: Map host parallel devices (n is 0 to 2). parallel18: type: string description: Map host parallel devices (n is 0 to 2). parallel19: type: string description: Map host parallel devices (n is 0 to 2). parallel20: type: string description: Map host parallel devices (n is 0 to 2). parallel21: type: string description: Map host parallel devices (n is 0 to 2). parallel22: type: string description: Map host parallel devices (n is 0 to 2). parallel23: type: string description: Map host parallel devices (n is 0 to 2). parallel24: type: string description: Map host parallel devices (n is 0 to 2). parallel25: type: string description: Map host parallel devices (n is 0 to 2). parallel26: type: string description: Map host parallel devices (n is 0 to 2). parallel27: type: string description: Map host parallel devices (n is 0 to 2). parallel28: type: string description: Map host parallel devices (n is 0 to 2). parallel29: type: string description: Map host parallel devices (n is 0 to 2). protection: type: boolean description: >- Sets the protection flag of the VM. This will disable the remove VM and remove disk operations. reboot: type: boolean description: Allow reboot. If set to '0' the VM exit on reboot. rng0: type: string description: Configure a VirtIO-based Random Number Generator. sata0: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata1: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata2: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata3: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata4: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata5: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata6: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata7: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata8: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata9: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata10: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata11: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata12: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata13: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata14: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata15: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata16: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata17: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata18: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata19: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata20: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata21: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata22: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata23: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata24: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata25: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata26: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata27: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata28: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata29: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). scsi0: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi1: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi2: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi3: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi4: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi5: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi6: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi7: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi8: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi9: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi10: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi11: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi12: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi13: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi14: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi15: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi16: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi17: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi18: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi19: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi20: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi21: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi22: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi23: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi24: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi25: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi26: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi27: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi28: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi29: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsihw: type: string description: SCSI controller model searchdomain: type: string description: "cloud-init: Sets DNS search domains for a container. Create will'\n\t .' automatically use the setting from the host if neither searchdomain nor nameserver'\n\t .' are set." serial0: type: string description: Create a serial device inside the VM (n is 0 to 3) serial1: type: string description: Create a serial device inside the VM (n is 0 to 3) serial2: type: string description: Create a serial device inside the VM (n is 0 to 3) serial3: type: string description: Create a serial device inside the VM (n is 0 to 3) serial4: type: string description: Create a serial device inside the VM (n is 0 to 3) serial5: type: string description: Create a serial device inside the VM (n is 0 to 3) serial6: type: string description: Create a serial device inside the VM (n is 0 to 3) serial7: type: string description: Create a serial device inside the VM (n is 0 to 3) serial8: type: string description: Create a serial device inside the VM (n is 0 to 3) serial9: type: string description: Create a serial device inside the VM (n is 0 to 3) serial10: type: string description: Create a serial device inside the VM (n is 0 to 3) serial11: type: string description: Create a serial device inside the VM (n is 0 to 3) serial12: type: string description: Create a serial device inside the VM (n is 0 to 3) serial13: type: string description: Create a serial device inside the VM (n is 0 to 3) serial14: type: string description: Create a serial device inside the VM (n is 0 to 3) serial15: type: string description: Create a serial device inside the VM (n is 0 to 3) serial16: type: string description: Create a serial device inside the VM (n is 0 to 3) serial17: type: string description: Create a serial device inside the VM (n is 0 to 3) serial18: type: string description: Create a serial device inside the VM (n is 0 to 3) serial19: type: string description: Create a serial device inside the VM (n is 0 to 3) serial20: type: string description: Create a serial device inside the VM (n is 0 to 3) serial21: type: string description: Create a serial device inside the VM (n is 0 to 3) serial22: type: string description: Create a serial device inside the VM (n is 0 to 3) serial23: type: string description: Create a serial device inside the VM (n is 0 to 3) serial24: type: string description: Create a serial device inside the VM (n is 0 to 3) serial25: type: string description: Create a serial device inside the VM (n is 0 to 3) serial26: type: string description: Create a serial device inside the VM (n is 0 to 3) serial27: type: string description: Create a serial device inside the VM (n is 0 to 3) serial28: type: string description: Create a serial device inside the VM (n is 0 to 3) serial29: type: string description: Create a serial device inside the VM (n is 0 to 3) shares: type: integer description: >- Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning. Auto-ballooning is done by pvestatd. smbios1: type: string description: Specify SMBIOS type 1 fields. smp: type: integer description: The number of CPUs. Please use option -sockets instead. sockets: type: integer description: The number of CPU sockets. spice_enhancements: type: string description: Configure additional enhancements for SPICE. sshkeys: type: string description: >- cloud-init: Setup public SSH keys (one key per line, OpenSSH format). startdate: type: string description: >- Set the initial date of the real time clock. Valid format for date are:'now' or '2006-06-17T16:01:21' or '2006-06-17'. startup: type: string description: >- Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped. tablet: type: boolean description: Enable/disable the USB tablet device. tags: type: string description: Tags of the VM. This is only meta information. tdf: type: boolean description: Enable/disable time drift fix. template: type: boolean description: Enable/disable Template. unused0: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused1: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused2: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused3: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused4: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused5: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused6: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused7: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused8: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused9: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused10: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused11: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused12: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused13: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused14: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused15: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused16: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused17: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused18: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused19: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused20: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused21: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused22: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused23: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused24: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused25: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused26: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused27: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused28: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused29: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. usb0: type: string description: Configure an USB device (n is 0 to 4). usb1: type: string description: Configure an USB device (n is 0 to 4). usb2: type: string description: Configure an USB device (n is 0 to 4). usb3: type: string description: Configure an USB device (n is 0 to 4). usb4: type: string description: Configure an USB device (n is 0 to 4). usb5: type: string description: Configure an USB device (n is 0 to 4). usb6: type: string description: Configure an USB device (n is 0 to 4). usb7: type: string description: Configure an USB device (n is 0 to 4). usb8: type: string description: Configure an USB device (n is 0 to 4). usb9: type: string description: Configure an USB device (n is 0 to 4). usb10: type: string description: Configure an USB device (n is 0 to 4). usb11: type: string description: Configure an USB device (n is 0 to 4). usb12: type: string description: Configure an USB device (n is 0 to 4). usb13: type: string description: Configure an USB device (n is 0 to 4). usb14: type: string description: Configure an USB device (n is 0 to 4). usb15: type: string description: Configure an USB device (n is 0 to 4). usb16: type: string description: Configure an USB device (n is 0 to 4). usb17: type: string description: Configure an USB device (n is 0 to 4). usb18: type: string description: Configure an USB device (n is 0 to 4). usb19: type: string description: Configure an USB device (n is 0 to 4). usb20: type: string description: Configure an USB device (n is 0 to 4). usb21: type: string description: Configure an USB device (n is 0 to 4). usb22: type: string description: Configure an USB device (n is 0 to 4). usb23: type: string description: Configure an USB device (n is 0 to 4). usb24: type: string description: Configure an USB device (n is 0 to 4). usb25: type: string description: Configure an USB device (n is 0 to 4). usb26: type: string description: Configure an USB device (n is 0 to 4). usb27: type: string description: Configure an USB device (n is 0 to 4). usb28: type: string description: Configure an USB device (n is 0 to 4). usb29: type: string description: Configure an USB device (n is 0 to 4). vcpus: type: integer description: Number of hotplugged vcpus. vga: type: string description: Configure the VGA hardware. virtio0: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio1: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio2: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio3: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio4: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio5: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio6: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio7: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio8: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio9: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio10: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio11: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio12: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio13: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio14: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio15: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio16: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio17: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio18: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio19: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio20: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio21: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio22: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio23: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio24: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio25: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio26: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio27: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio28: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio29: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). vmgenid: type: string description: >- Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly. vmstatestorage: type: string description: Default storage for VM state volumes/files. watchdog: type: string description: Create a virtual hardware watchdog device. UpdateVMConfigResponse: description: UpdateVMConfigResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' UpdateVMConfigSyncResponse: description: UpdateVMConfigSyncResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetVMConfigPendingResponse: description: GetVMConfigPendingResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: delete: type: integer description: >- Indicates a pending delete request if present and not 0. The value 2 indicates a force-delete request. key: type: string description: Configuration option name. pending: type: string description: Pending value. value: type: string description: Current value. UnlinkVMDiskImagesResponse: description: UnlinkVMDiskImagesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' CreateNodesSingleQemuSingleVncproxyResponse: description: CreateNodesSingleQemuSingleVncproxyResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' CreateNodesSingleQemuSingleTermproxyResponse: description: CreateNodesSingleQemuSingleTermproxyResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleQemuSingleVncwebsocketResponse: description: GetNodesSingleQemuSingleVncwebsocketResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: port: type: string description: '' CreateNodesSingleQemuSingleSpiceproxyResponse: description: CreateNodesSingleQemuSingleSpiceproxyResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: >- Returned values can be directly passed to the 'remote-viewer' application. GetVMStatusResponse: description: GetVMStatusResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: subdir: type: string description: '' GetCurrentVMStatusResponse: description: GetCurrentVMStatusResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: agent: type: boolean description: Qemu GuestAgent enabled in config. cpus: type: number description: Maximum usable CPUs. ha: type: object description: HA manager service status. lock: type: string description: 'The current config lock, if any.' maxdisk: type: integer description: Root disk size in bytes. maxmem: type: integer description: Maximum memory in bytes. name: type: string description: VM name. pid: type: integer description: PID of running qemu process. qmpstatus: type: string description: Qemu QMP agent status. spice: type: boolean description: Qemu VGA configuration supports spice. status: type: string description: Qemu process status. tags: type: string description: 'The current configured tags, if any' uptime: type: integer description: Uptime. vmid: type: integer description: The (unique) ID of the VM. StartVMResponse: description: StartVMResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' StopVMResponse: description: StopVMResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' ResetVMResponse: description: ResetVMResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' ShutdownVMResponse: description: ShutdownVMResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' RebootVMResponse: description: RebootVMResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' SuspendVMResponse: description: SuspendVMResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' ResumeVMResponse: description: ResumeVMResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' UpdateNodesSingleQemuSingleSendkeyResponse: description: UpdateNodesSingleQemuSingleSendkeyResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleQemuSingleFeatureResponse: description: GetNodesSingleQemuSingleFeatureResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: hasFeature: type: boolean description: '' nodes: type: array description: '' items: type: string description: '' CloneVMResponse: description: CloneVMResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' CreateNodesSingleQemuSingleMovediskResponse: description: CreateNodesSingleQemuSingleMovediskResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: the task ID. MigrateVMResponse: description: MigrateVMResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: allowed_nodes: type: array description: >- List nodes allowed for offline migration, only passed if VM is offline local_disks: type: array description: >- List local disks including CD-Rom, unsused and not referenced disks local_resources: type: array description: 'List local resources e.g. pci, usb' not_allowed_nodes: type: object description: >- List not allowed nodes with additional informations, only passed if VM is offline running: type: boolean description: '' CreateNodesSingleQemuSingleMigrateResponse: description: CreateNodesSingleQemuSingleMigrateResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: the task ID. CreateNodesSingleQemuSingleMonitorResponse: description: CreateNodesSingleQemuSingleMonitorResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' UpdateNodesSingleQemuSingleResizeResponse: description: UpdateNodesSingleQemuSingleResizeResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetVMSnapshotsResponse: description: GetVMSnapshotsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: description: type: string description: Snapshot description. name: type: string description: >- Snapshot identifier. Value 'current' identifies the current VM. parent: type: string description: Parent snapshot identifier. snaptime: type: integer description: Snapshot creation time vmstate: type: boolean description: Snapshot includes RAM. CreateVMSnapshotResponse: description: CreateVMSnapshotResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: the task ID. DeleteVMSnapshotResponse: description: DeleteVMSnapshotResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: the task ID. GetVMSnapshotResponse: description: GetVMSnapshotResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: {} GetVMSnapshotConfigResponse: description: GetVMSnapshotConfigResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' UpdateVMSnapshotConfigResponse: description: UpdateVMSnapshotConfigResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' RollbackVMSnapshotResponse: description: RollbackVMSnapshotResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: the task ID. CreateNodesSingleQemuSingleTemplateResponse: description: CreateNodesSingleQemuSingleTemplateResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleQemuSingleCloudinitDumpResponse: description: GetNodesSingleQemuSingleCloudinitDumpResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleCpuResponse: description: GetNodesSingleCpuResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: custom: type: boolean description: True if this is a custom CPU model. name: type: string description: >- Name of the CPU model. Identifies it for subsequent API calls. Prefixed with 'custom-' for custom models. vendor: type: string description: >- CPU vendor visible to the guest when this model is selected. Vendor of 'reported-model' in case of custom models. GetNodesSingleLxcResponse: description: GetNodesSingleLxcResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: cpus: type: number description: Maximum usable CPUs. lock: type: string description: 'The current config lock, if any.' maxdisk: type: integer description: Root disk size in bytes. maxmem: type: integer description: Maximum memory in bytes. maxswap: type: integer description: Maximum SWAP memory in bytes. name: type: string description: Container name. status: type: string description: LXC Container status. tags: type: string description: 'The current configured tags, if any.' uptime: type: integer description: Uptime. vmid: type: integer description: The (unique) ID of the VM. CreateNodesSingleLxcResponse: description: CreateNodesSingleLxcResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' DeleteNodesSingleLxcSingleResponse: description: DeleteNodesSingleLxcSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleLxcSingleResponse: description: GetNodesSingleLxcSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: subdir: type: string description: '' GetNodesSingleLxcSingleConfigResponse: description: GetNodesSingleLxcSingleConfigResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: arch: type: string description: OS architecture type. cmode: type: string description: >- Console mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login). console: type: boolean description: Attach a console device (/dev/console) to the container. cores: type: integer description: >- The number of cores assigned to the container. A container can use all available cores by default. cpulimit: type: number description: >- Limit of CPU usage. NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit. cpuunits: type: integer description: >- CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to the weights of all the other running VMs. NOTE: You can disable fair-scheduler configuration by setting this to 0. debug: type: boolean description: >- Try to be more verbose. For now this only enables debug log-level on start. description: type: string description: >- Container description. Only used on the configuration web interface. digest: type: string description: >- SHA1 digest of configuration file. This can be used to prevent concurrent modifications. features: type: string description: Allow containers access to advanced features. hookscript: type: string description: >- Script that will be exectued during various steps in the containers lifetime. hostname: type: string description: Set a host name for the container. lock: type: string description: Lock/unlock the VM. lxc: type: array description: >- Array of lxc low-level configurations ([[key1, value1], [key2, value2] ...]). items: type: array description: '' items: type: string description: '' memory: type: integer description: Amount of RAM for the VM in MB. mp0: type: string description: Use volume as container mount point. mp1: type: string description: Use volume as container mount point. mp2: type: string description: Use volume as container mount point. mp3: type: string description: Use volume as container mount point. mp4: type: string description: Use volume as container mount point. mp5: type: string description: Use volume as container mount point. mp6: type: string description: Use volume as container mount point. mp7: type: string description: Use volume as container mount point. mp8: type: string description: Use volume as container mount point. mp9: type: string description: Use volume as container mount point. mp10: type: string description: Use volume as container mount point. mp11: type: string description: Use volume as container mount point. mp12: type: string description: Use volume as container mount point. mp13: type: string description: Use volume as container mount point. mp14: type: string description: Use volume as container mount point. mp15: type: string description: Use volume as container mount point. mp16: type: string description: Use volume as container mount point. mp17: type: string description: Use volume as container mount point. mp18: type: string description: Use volume as container mount point. mp19: type: string description: Use volume as container mount point. mp20: type: string description: Use volume as container mount point. mp21: type: string description: Use volume as container mount point. mp22: type: string description: Use volume as container mount point. mp23: type: string description: Use volume as container mount point. mp24: type: string description: Use volume as container mount point. mp25: type: string description: Use volume as container mount point. mp26: type: string description: Use volume as container mount point. mp27: type: string description: Use volume as container mount point. mp28: type: string description: Use volume as container mount point. mp29: type: string description: Use volume as container mount point. nameserver: type: string description: >- Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver. net0: type: string description: Specifies network interfaces for the container. net1: type: string description: Specifies network interfaces for the container. net2: type: string description: Specifies network interfaces for the container. net3: type: string description: Specifies network interfaces for the container. net4: type: string description: Specifies network interfaces for the container. net5: type: string description: Specifies network interfaces for the container. net6: type: string description: Specifies network interfaces for the container. net7: type: string description: Specifies network interfaces for the container. net8: type: string description: Specifies network interfaces for the container. net9: type: string description: Specifies network interfaces for the container. net10: type: string description: Specifies network interfaces for the container. net11: type: string description: Specifies network interfaces for the container. net12: type: string description: Specifies network interfaces for the container. net13: type: string description: Specifies network interfaces for the container. net14: type: string description: Specifies network interfaces for the container. net15: type: string description: Specifies network interfaces for the container. net16: type: string description: Specifies network interfaces for the container. net17: type: string description: Specifies network interfaces for the container. net18: type: string description: Specifies network interfaces for the container. net19: type: string description: Specifies network interfaces for the container. net20: type: string description: Specifies network interfaces for the container. net21: type: string description: Specifies network interfaces for the container. net22: type: string description: Specifies network interfaces for the container. net23: type: string description: Specifies network interfaces for the container. net24: type: string description: Specifies network interfaces for the container. net25: type: string description: Specifies network interfaces for the container. net26: type: string description: Specifies network interfaces for the container. net27: type: string description: Specifies network interfaces for the container. net28: type: string description: Specifies network interfaces for the container. net29: type: string description: Specifies network interfaces for the container. onboot: type: boolean description: >- Specifies whether a VM will be started during system bootup. ostype: type: string description: >- OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/.common.conf. Value 'unmanaged' can be used to skip and OS specific setup. protection: type: boolean description: >- Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation. rootfs: type: string description: Use volume as container root. searchdomain: type: string description: >- Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver. startup: type: string description: >- Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped. swap: type: integer description: Amount of SWAP for the VM in MB. tags: type: string description: Tags of the Container. This is only meta information. template: type: boolean description: Enable/disable Template. timezone: type: string description: >- Time zone to use in the container. If option isn't set, then nothing will be done. Can be set to 'host' to match the host time zone, or an arbitrary time zone option from /usr/share/zoneinfo/zone.tab tty: type: integer description: Specify the number of tty available to the container unprivileged: type: boolean description: >- Makes the container run as unprivileged user. (Should not be modified manually.) unused0: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused1: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused2: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused3: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused4: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused5: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused6: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused7: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused8: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused9: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused10: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused11: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused12: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused13: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused14: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused15: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused16: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused17: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused18: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused19: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused20: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused21: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused22: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused23: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused24: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused25: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused26: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused27: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused28: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused29: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. UpdateNodesSingleLxcSingleConfigResponse: description: UpdateNodesSingleLxcSingleConfigResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleLxcSingleStatusResponse: description: GetNodesSingleLxcSingleStatusResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: subdir: type: string description: '' GetNodesSingleLxcSingleStatusCurrentResponse: description: GetNodesSingleLxcSingleStatusCurrentResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: cpus: type: number description: Maximum usable CPUs. ha: type: object description: HA manager service status. lock: type: string description: 'The current config lock, if any.' maxdisk: type: integer description: Root disk size in bytes. maxmem: type: integer description: Maximum memory in bytes. maxswap: type: integer description: Maximum SWAP memory in bytes. name: type: string description: Container name. status: type: string description: LXC Container status. tags: type: string description: 'The current configured tags, if any.' uptime: type: integer description: Uptime. vmid: type: integer description: The (unique) ID of the VM. CreateNodesSingleLxcSingleStatusStartResponse: description: CreateNodesSingleLxcSingleStatusStartResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' CreateNodesSingleLxcSingleStatusStopResponse: description: CreateNodesSingleLxcSingleStatusStopResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' CreateNodesSingleLxcSingleStatusShutdownResponse: description: CreateNodesSingleLxcSingleStatusShutdownResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' CreateNodesSingleLxcSingleStatusSuspendResponse: description: CreateNodesSingleLxcSingleStatusSuspendResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' CreateNodesSingleLxcSingleStatusResumeResponse: description: CreateNodesSingleLxcSingleStatusResumeResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' CreateNodesSingleLxcSingleStatusRebootResponse: description: CreateNodesSingleLxcSingleStatusRebootResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleLxcSingleSnapshotResponse: description: GetNodesSingleLxcSingleSnapshotResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: description: type: string description: Snapshot description. name: type: string description: >- Snapshot identifier. Value 'current' identifies the current VM. parent: type: string description: Parent snapshot identifier. snaptime: type: integer description: Snapshot creation time CreateNodesSingleLxcSingleSnapshotResponse: description: CreateNodesSingleLxcSingleSnapshotResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: the task ID. DeleteNodesSingleLxcSingleSnapshotSingleResponse: description: DeleteNodesSingleLxcSingleSnapshotSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: the task ID. GetNodesSingleLxcSingleSnapshotSingleResponse: description: GetNodesSingleLxcSingleSnapshotSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: {} CreateNodesSingleLxcSingleSnapshotSingleRollbackResponse: description: CreateNodesSingleLxcSingleSnapshotSingleRollbackResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: the task ID. GetNodesSingleLxcSingleSnapshotSingleConfigResponse: description: GetNodesSingleLxcSingleSnapshotSingleConfigResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' UpdateNodesSingleLxcSingleSnapshotSingleConfigResponse: description: UpdateNodesSingleLxcSingleSnapshotSingleConfigResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleLxcSingleFirewallResponse: description: GetNodesSingleLxcSingleFirewallResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: {} GetNodesSingleLxcSingleFirewallRulesResponse: description: GetNodesSingleLxcSingleFirewallRulesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: pos: type: integer description: '' CreateNodesSingleLxcSingleFirewallRulesResponse: description: CreateNodesSingleLxcSingleFirewallRulesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' DeleteNodesSingleLxcSingleFirewallRulesSingleResponse: description: DeleteNodesSingleLxcSingleFirewallRulesSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleLxcSingleFirewallRulesSingleResponse: description: GetNodesSingleLxcSingleFirewallRulesSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: action: type: string description: '' comment: type: string description: '' dest: type: string description: '' dport: type: string description: '' enable: type: integer description: '' icmp-type: type: string description: '' iface: type: string description: '' ipversion: type: integer description: '' log: type: string description: Log level for firewall rule macro: type: string description: '' pos: type: integer description: '' proto: type: string description: '' source: type: string description: '' sport: type: string description: '' type: type: string description: '' UpdateNodesSingleLxcSingleFirewallRulesSingleResponse: description: UpdateNodesSingleLxcSingleFirewallRulesSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleLxcSingleFirewallAliasesResponse: description: GetNodesSingleLxcSingleFirewallAliasesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: cidr: type: string description: '' comment: type: string description: '' digest: type: string description: >- Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. name: type: string description: '' CreateNodesSingleLxcSingleFirewallAliasesResponse: description: CreateNodesSingleLxcSingleFirewallAliasesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' DeleteNodesSingleLxcSingleFirewallAliasesSingleResponse: description: DeleteNodesSingleLxcSingleFirewallAliasesSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleLxcSingleFirewallAliasesSingleResponse: description: GetNodesSingleLxcSingleFirewallAliasesSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' UpdateNodesSingleLxcSingleFirewallAliasesSingleResponse: description: UpdateNodesSingleLxcSingleFirewallAliasesSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleLxcSingleFirewallIpsetResponse: description: GetNodesSingleLxcSingleFirewallIpsetResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: comment: type: string description: '' digest: type: string description: >- Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. name: type: string description: IP set name. CreateNodesSingleLxcSingleFirewallIpsetResponse: description: CreateNodesSingleLxcSingleFirewallIpsetResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' DeleteNodesSingleLxcSingleFirewallIpsetSingleResponse: description: DeleteNodesSingleLxcSingleFirewallIpsetSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleLxcSingleFirewallIpsetSingleResponse: description: GetNodesSingleLxcSingleFirewallIpsetSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: cidr: type: string description: '' comment: type: string description: '' digest: type: string description: >- Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. nomatch: type: boolean description: '' CreateNodesSingleLxcSingleFirewallIpsetSingleResponse: description: CreateNodesSingleLxcSingleFirewallIpsetSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' DeleteNodesSingleLxcSingleFirewallIpsetSingleSingleResponse: description: DeleteNodesSingleLxcSingleFirewallIpsetSingleSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleLxcSingleFirewallIpsetSingleSingleResponse: description: GetNodesSingleLxcSingleFirewallIpsetSingleSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' UpdateNodesSingleLxcSingleFirewallIpsetSingleSingleResponse: description: UpdateNodesSingleLxcSingleFirewallIpsetSingleSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleLxcSingleFirewallOptionsResponse: description: GetNodesSingleLxcSingleFirewallOptionsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: dhcp: type: boolean description: Enable DHCP. enable: type: boolean description: Enable/disable firewall rules. ipfilter: type: boolean description: >- Enable default IP filters. This is equivalent to adding an empty ipfilter-net ipset for every interface. Such ipsets implicitly contain sane default restrictions such as restricting IPv6 link local addresses to the one derived from the interface's MAC address. For containers the configured IP addresses will be implicitly added. log_level_in: type: string description: Log level for incoming traffic. log_level_out: type: string description: Log level for outgoing traffic. macfilter: type: boolean description: Enable/disable MAC address filter. ndp: type: boolean description: Enable NDP (Neighbor Discovery Protocol). policy_in: type: string description: Input policy. policy_out: type: string description: Output policy. radv: type: boolean description: Allow sending Router Advertisement. UpdateNodesSingleLxcSingleFirewallOptionsResponse: description: UpdateNodesSingleLxcSingleFirewallOptionsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleLxcSingleFirewallLogResponse: description: GetNodesSingleLxcSingleFirewallLogResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: 'n': type: integer description: Line number t: type: string description: Line text GetNodesSingleLxcSingleFirewallRefsResponse: description: GetNodesSingleLxcSingleFirewallRefsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: comment: type: string description: '' name: type: string description: '' type: type: string description: '' GetNodesSingleLxcSingleRrdResponse: description: GetNodesSingleLxcSingleRrdResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: filename: type: string description: '' GetNodesSingleLxcSingleRrddataResponse: description: GetNodesSingleLxcSingleRrddataResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: {} CreateNodesSingleLxcSingleVncproxyResponse: description: CreateNodesSingleLxcSingleVncproxyResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' CreateNodesSingleLxcSingleTermproxyResponse: description: CreateNodesSingleLxcSingleTermproxyResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleLxcSingleVncwebsocketResponse: description: GetNodesSingleLxcSingleVncwebsocketResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: port: type: string description: '' CreateNodesSingleLxcSingleSpiceproxyResponse: description: CreateNodesSingleLxcSingleSpiceproxyResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: >- Returned values can be directly passed to the 'remote-viewer' application. CreateNodesSingleLxcSingleMigrateResponse: description: CreateNodesSingleLxcSingleMigrateResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: the task ID. GetNodesSingleLxcSingleFeatureResponse: description: GetNodesSingleLxcSingleFeatureResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: hasFeature: type: boolean description: '' CreateNodesSingleLxcSingleTemplateResponse: description: CreateNodesSingleLxcSingleTemplateResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' CreateNodesSingleLxcSingleCloneResponse: description: CreateNodesSingleLxcSingleCloneResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' UpdateNodesSingleLxcSingleResizeResponse: description: UpdateNodesSingleLxcSingleResizeResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: the task ID. CreateNodesSingleLxcSingleMovevolumeResponse: description: CreateNodesSingleLxcSingleMovevolumeResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleLxcSinglePendingResponse: description: GetNodesSingleLxcSinglePendingResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: delete: type: integer description: Indicates a pending delete request if present and not 0. key: type: string description: Configuration option name. pending: type: string description: Pending value. value: type: string description: Current value. GetNodesSingleCephResponse: description: GetNodesSingleCephResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: {} GetNodesSingleCephOsdResponse: description: GetNodesSingleCephOsdResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' CreateNodesSingleCephOsdResponse: description: CreateNodesSingleCephOsdResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' DeleteNodesSingleCephOsdSingleResponse: description: DeleteNodesSingleCephOsdSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' CreateNodesSingleCephOsdSingleInResponse: description: CreateNodesSingleCephOsdSingleInResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' CreateNodesSingleCephOsdSingleOutResponse: description: CreateNodesSingleCephOsdSingleOutResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' CreateNodesSingleCephOsdSingleScrubResponse: description: CreateNodesSingleCephOsdSingleScrubResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleCephMdsResponse: description: GetNodesSingleCephMdsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: addr: type: string description: '' host: type: string description: '' name: type: string description: The name (ID) for the MDS rank: type: integer description: '' standby_replay: type: boolean description: >- If true, the standby MDS is polling the active MDS for faster recovery (hot standby). state: type: string description: State of the MDS DeleteNodesSingleCephMdsSingleResponse: description: DeleteNodesSingleCephMdsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' CreateNodesSingleCephMdsSingleResponse: description: CreateNodesSingleCephMdsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleCephMgrResponse: description: GetNodesSingleCephMgrResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: addr: type: string description: '' host: type: string description: '' name: type: string description: The name (ID) for the MGR state: type: string description: State of the MGR DeleteNodesSingleCephMgrSingleResponse: description: DeleteNodesSingleCephMgrSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' CreateNodesSingleCephMgrSingleResponse: description: CreateNodesSingleCephMgrSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleCephMonResponse: description: GetNodesSingleCephMonResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: addr: type: string description: '' host: type: string description: '' name: type: string description: '' DeleteNodesSingleCephMonSingleResponse: description: DeleteNodesSingleCephMonSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' CreateNodesSingleCephMonSingleResponse: description: CreateNodesSingleCephMonSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleCephFsResponse: description: GetNodesSingleCephFsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: data_pool: type: string description: The name of the data pool. metadata_pool: type: string description: The name of the metadata pool. name: type: string description: The ceph filesystem name. CreateNodesSingleCephFsSingleResponse: description: CreateNodesSingleCephFsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleCephDisksResponse: description: GetNodesSingleCephDisksResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: dev: type: string description: '' gpt: type: boolean description: '' model: type: string description: '' osdid: type: integer description: '' serial: type: string description: '' size: type: integer description: '' used: type: string description: '' vendor: type: string description: '' GetNodesSingleCephConfigResponse: description: GetNodesSingleCephConfigResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleCephConfigdbResponse: description: GetNodesSingleCephConfigdbResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: can_update_at_runtime: type: boolean description: '' level: type: string description: '' mask: type: string description: '' name: type: string description: '' section: type: string description: '' value: type: string description: '' CreateNodesSingleCephInitResponse: description: CreateNodesSingleCephInitResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' CreateNodesSingleCephStopResponse: description: CreateNodesSingleCephStopResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' CreateNodesSingleCephStartResponse: description: CreateNodesSingleCephStartResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' CreateNodesSingleCephRestartResponse: description: CreateNodesSingleCephRestartResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleCephStatusResponse: description: GetNodesSingleCephStatusResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' GetNodesSingleCephPoolsResponse: description: GetNodesSingleCephPoolsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: bytes_used: type: integer description: '' crush_rule: type: integer description: '' crush_rule_name: type: string description: '' min_size: type: integer description: '' percent_used: type: number description: '' pg_autoscale_mode: type: string description: '' pg_num: type: integer description: '' pool: type: integer description: '' pool_name: type: string description: '' size: type: integer description: '' CreateNodesSingleCephPoolsResponse: description: CreateNodesSingleCephPoolsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' DeleteNodesSingleCephPoolsSingleResponse: description: DeleteNodesSingleCephPoolsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' UpdateNodesSingleCephPoolsSingleResponse: description: UpdateNodesSingleCephPoolsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleCephFlagsResponse: description: GetNodesSingleCephFlagsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' DeleteNodesSingleCephFlagsSingleResponse: description: DeleteNodesSingleCephFlagsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' CreateNodesSingleCephFlagsSingleResponse: description: CreateNodesSingleCephFlagsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleCephCrushResponse: description: GetNodesSingleCephCrushResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleCephLogResponse: description: GetNodesSingleCephLogResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: 'n': type: integer description: Line number t: type: string description: Line text GetNodesSingleCephRulesResponse: description: GetNodesSingleCephRulesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: {} CreateNodesSingleVzdumpResponse: description: CreateNodesSingleVzdumpResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleVzdumpExtractconfigResponse: description: GetNodesSingleVzdumpExtractconfigResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleServicesResponse: description: GetNodesSingleServicesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: {} GetNodesSingleServicesSingleResponse: description: GetNodesSingleServicesSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: subdir: type: string description: '' GetNodesSingleServicesSingleStateResponse: description: GetNodesSingleServicesSingleStateResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' CreateNodesSingleServicesSingleStartResponse: description: CreateNodesSingleServicesSingleStartResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' CreateNodesSingleServicesSingleStopResponse: description: CreateNodesSingleServicesSingleStopResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' CreateNodesSingleServicesSingleRestartResponse: description: CreateNodesSingleServicesSingleRestartResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' CreateNodesSingleServicesSingleReloadResponse: description: CreateNodesSingleServicesSingleReloadResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' DeleteNodesSingleSubscriptionResponse: description: DeleteNodesSingleSubscriptionResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleSubscriptionResponse: description: GetNodesSingleSubscriptionResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' CreateNodesSingleSubscriptionResponse: description: CreateNodesSingleSubscriptionResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' UpdateNodesSingleSubscriptionResponse: description: UpdateNodesSingleSubscriptionResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' DeleteNodesSingleNetworkResponse: description: DeleteNodesSingleNetworkResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleNetworkResponse: description: GetNodesSingleNetworkResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: {} CreateNodesSingleNetworkResponse: description: CreateNodesSingleNetworkResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' UpdateNodesSingleNetworkResponse: description: UpdateNodesSingleNetworkResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' DeleteNodesSingleNetworkSingleResponse: description: DeleteNodesSingleNetworkSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleNetworkSingleResponse: description: GetNodesSingleNetworkSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: method: type: string description: '' type: type: string description: '' UpdateNodesSingleNetworkSingleResponse: description: UpdateNodesSingleNetworkSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodeTasksResponse: description: GetNodeTasksResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: endtime: type: integer description: '' id: type: string description: '' node: type: string description: '' pid: type: integer description: '' pstart: type: integer description: '' starttime: type: integer description: '' status: type: string description: '' type: type: string description: '' upid: type: string description: '' user: type: string description: '' StopNodeTaskResponse: description: StopNodeTaskResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodeTaskResponse: description: GetNodeTaskResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: {} GetNodeTaskLogResponse: description: GetNodeTaskLogResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: 'n': type: integer description: Line number t: type: string description: Line text GetNodeTaskStatusResponse: description: GetNodeTaskStatusResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: pid: type: integer description: '' status: type: string description: '' GetNodesSingleScanResponse: description: GetNodesSingleScanResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: method: type: string description: '' GetNodesSingleScanZfsResponse: description: GetNodesSingleScanZfsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: pool: type: string description: ZFS pool name. GetNodesSingleScanNfsResponse: description: GetNodesSingleScanNfsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: options: type: string description: NFS export options. path: type: string description: The exported path. GetNodesSingleScanCifsResponse: description: GetNodesSingleScanCifsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: description: type: string description: Descriptive text from server. share: type: string description: The cifs share name. GetNodesSingleScanGlusterfsResponse: description: GetNodesSingleScanGlusterfsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: volname: type: string description: The volume name. GetNodesSingleScanIscsiResponse: description: GetNodesSingleScanIscsiResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: portal: type: string description: The iSCSI portal name. target: type: string description: The iSCSI target name. GetNodesSingleScanLvmResponse: description: GetNodesSingleScanLvmResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: vg: type: string description: The LVM logical volume group name. GetNodesSingleScanLvmthinResponse: description: GetNodesSingleScanLvmthinResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: lv: type: string description: The LVM Thin Pool name (LVM logical volume). GetNodesSingleScanUsbResponse: description: GetNodesSingleScanUsbResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: busnum: type: integer description: '' class: type: integer description: '' devnum: type: integer description: '' level: type: integer description: '' manufacturer: type: string description: '' port: type: integer description: '' prodid: type: string description: '' product: type: string description: '' serial: type: string description: '' speed: type: string description: '' usbpath: type: string description: '' vendid: type: string description: '' GetNodesSingleHardwareResponse: description: GetNodesSingleHardwareResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: type: type: string description: '' GetNodesSingleHardwarePciResponse: description: GetNodesSingleHardwarePciResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: class: type: string description: The PCI Class of the device. device: type: string description: The Device ID. device_name: type: string description: '' id: type: string description: The PCI ID. iommugroup: type: integer description: >- The IOMMU group in which the device is in. If no IOMMU group is detected, it is set to -1. mdev: type: boolean description: >- If set, marks that the device is capable of creating mediated devices. subsystem_device: type: string description: The Subsystem Device ID. subsystem_device_name: type: string description: '' subsystem_vendor: type: string description: The Subsystem Vendor ID. subsystem_vendor_name: type: string description: '' vendor: type: string description: The Vendor ID. vendor_name: type: string description: '' GetNodesSingleHardwarePciSingleResponse: description: GetNodesSingleHardwarePciSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: method: type: string description: '' GetNodesSingleHardwarePciSingleMdevResponse: description: GetNodesSingleHardwarePciSingleMdevResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: available: type: integer description: The number of still available instances of this type. description: type: string description: '' type: type: string description: The name of the mdev type. GetNodesSingleStorageResponse: description: GetNodesSingleStorageResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: active: type: boolean description: Set when storage is accessible. avail: type: integer description: Available storage space in bytes. content: type: string description: Allowed storage content types. enabled: type: boolean description: Set when storage is enabled (not disabled). shared: type: boolean description: Shared flag from storage configuration. storage: type: string description: The storage identifier. total: type: integer description: Total storage space in bytes. type: type: string description: Storage type. used: type: integer description: Used storage space in bytes. used_fraction: type: number description: Used fraction (used/total). GetNodesSingleStorageSingleResponse: description: GetNodesSingleStorageSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: subdir: type: string description: '' DeleteNodesSingleStorageSinglePrunebackupsResponse: description: DeleteNodesSingleStorageSinglePrunebackupsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleStorageSinglePrunebackupsResponse: description: GetNodesSingleStorageSinglePrunebackupsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: ctime: type: integer description: >- Creation time of the backup (seconds since the UNIX epoch). mark: type: string description: >- Whether the backup would be kept or removed. For backups that don't use the standard naming scheme, it's 'protected'. type: type: string description: 'One of ''qemu'', ''lxc'', ''openvz'' or ''unknown''.' vmid: type: integer description: The VM the backup belongs to. volid: type: string description: Backup volume ID. GetNodesSingleStorageSingleContentResponse: description: GetNodesSingleStorageSingleContentResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: ctime: type: integer description: Creation time (seconds since the UNIX Epoch). format: type: string description: >- Format identifier ('raw', 'qcow2', 'subvol', 'iso', 'tgz' ...) notes: type: string description: >- Optional notes. If they contain multiple lines, only the first one is returned here. parent: type: string description: Volume identifier of parent (for linked cloned). size: type: integer description: Volume size in bytes. used: type: integer description: >- Used space. Please note that most storage plugins do not report anything useful here. verification: type: object description: >- Last backup verification result, only useful for PBS storages. properties: state: type: string description: Last backup verification state. upid: type: string description: Last backup verification UPID. vmid: type: integer description: Associated Owner VMID. volid: type: string description: Volume identifier. CreateNodesSingleStorageSingleContentResponse: description: CreateNodesSingleStorageSingleContentResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: Volume identifier DeleteNodesSingleStorageSingleContentSingleResponse: description: DeleteNodesSingleStorageSingleContentSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleStorageSingleContentSingleResponse: description: GetNodesSingleStorageSingleContentSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: format: type: string description: >- Format identifier ('raw', 'qcow2', 'subvol', 'iso', 'tgz' ...) notes: type: string description: Optional notes. path: type: string description: The Path size: type: integer description: Volume size in bytes. used: type: integer description: >- Used space. Please note that most storage plugins do not report anything useful here. CreateNodesSingleStorageSingleContentSingleResponse: description: CreateNodesSingleStorageSingleContentSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' UpdateNodesSingleStorageSingleContentSingleResponse: description: UpdateNodesSingleStorageSingleContentSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleStorageSingleStatusResponse: description: GetNodesSingleStorageSingleStatusResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' GetNodesSingleStorageSingleRrdResponse: description: GetNodesSingleStorageSingleRrdResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: filename: type: string description: '' GetNodesSingleStorageSingleRrddataResponse: description: GetNodesSingleStorageSingleRrddataResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: {} CreateNodesSingleStorageSingleUploadResponse: description: CreateNodesSingleStorageSingleUploadResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleDisksResponse: description: GetNodesSingleDisksResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: {} GetNodesSingleDisksLvmResponse: description: GetNodesSingleDisksLvmResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: children: type: array description: '' items: type: object description: '' properties: children: type: array description: The underlying physical volumes items: type: object description: '' properties: free: type: integer description: The free bytes in the physical volume leaf: type: boolean description: '' name: type: string description: The name of the physical volume size: type: integer description: The size of the physical volume in bytes free: type: integer description: The free bytes in the volume group leaf: type: boolean description: '' name: type: string description: The name of the volume group size: type: integer description: The size of the volume group in bytes leaf: type: boolean description: '' CreateNodesSingleDisksLvmResponse: description: CreateNodesSingleDisksLvmResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleDisksLvmthinResponse: description: GetNodesSingleDisksLvmthinResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: lv: type: string description: The name of the thinpool. lv_size: type: integer description: The size of the thinpool in bytes. metadata_size: type: integer description: The size of the metadata lv in bytes. metadata_used: type: integer description: The used bytes of the metadata lv. used: type: integer description: The used bytes of the thinpool. CreateNodesSingleDisksLvmthinResponse: description: CreateNodesSingleDisksLvmthinResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleDisksDirectoryResponse: description: GetNodesSingleDisksDirectoryResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: device: type: string description: The mounted device. options: type: string description: The mount options. path: type: string description: The mount path. type: type: string description: The filesystem type. unitfile: type: string description: The path of the mount unit. CreateNodesSingleDisksDirectoryResponse: description: CreateNodesSingleDisksDirectoryResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleDisksZfsResponse: description: GetNodesSingleDisksZfsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: alloc: type: integer description: '' dedup: type: number description: '' frag: type: integer description: '' free: type: integer description: '' health: type: string description: '' name: type: string description: '' size: type: integer description: '' CreateNodesSingleDisksZfsResponse: description: CreateNodesSingleDisksZfsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleDisksZfsSingleResponse: description: GetNodesSingleDisksZfsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: action: type: string description: Information about the recommended action to fix the state. children: type: array description: >- The pool configuration information, including the vdevs for each section (e.g. spares, cache), may be nested. items: type: object description: '' properties: cksum: type: number description: '' msg: type: string description: An optional message about the vdev. name: type: string description: The name of the vdev or section. read: type: number description: '' state: type: string description: The state of the vdev. write: type: number description: '' errors: type: string description: Information about the errors on the zpool. name: type: string description: The name of the zpool. scan: type: string description: Information about the last/current scrub. state: type: string description: The state of the zpool. status: type: string description: Information about the state of the zpool. GetNodesSingleDisksListResponse: description: GetNodesSingleDisksListResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: devpath: type: string description: The device path gpt: type: boolean description: '' health: type: string description: '' model: type: string description: '' osdid: type: integer description: '' serial: type: string description: '' size: type: integer description: '' used: type: string description: '' vendor: type: string description: '' wwn: type: string description: '' GetNodesSingleDisksSmartResponse: description: GetNodesSingleDisksSmartResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: attributes: type: array description: '' health: type: string description: '' text: type: string description: '' type: type: string description: '' CreateNodesSingleDisksInitgptResponse: description: CreateNodesSingleDisksInitgptResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleAptResponse: description: GetNodesSingleAptResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: id: type: string description: '' GetNodesSingleAptUpdateResponse: description: GetNodesSingleAptUpdateResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: {} CreateNodesSingleAptUpdateResponse: description: CreateNodesSingleAptUpdateResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleAptChangelogResponse: description: GetNodesSingleAptChangelogResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleAptVersionsResponse: description: GetNodesSingleAptVersionsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: {} GetNodeFirewallResponse: description: GetNodeFirewallResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: {} GetNodeFirewallRulesResponse: description: GetNodeFirewallRulesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: pos: type: integer description: '' CreateNodeFirewallRuleResponse: description: CreateNodeFirewallRuleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' DeleteNodeFirewallRuleResponse: description: DeleteNodeFirewallRuleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodeFirewallRuleResponse: description: GetNodeFirewallRuleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: action: type: string description: '' comment: type: string description: '' dest: type: string description: '' dport: type: string description: '' enable: type: integer description: '' icmp-type: type: string description: '' iface: type: string description: '' ipversion: type: integer description: '' log: type: string description: Log level for firewall rule macro: type: string description: '' pos: type: integer description: '' proto: type: string description: '' source: type: string description: '' sport: type: string description: '' type: type: string description: '' UpdateNodeFirewallRuleResponse: description: UpdateNodeFirewallRuleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodeFirewallOptionsResponse: description: GetNodeFirewallOptionsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: enable: type: boolean description: Enable host firewall rules. log_level_in: type: string description: Log level for incoming traffic. log_level_out: type: string description: Log level for outgoing traffic. log_nf_conntrack: type: boolean description: Enable logging of conntrack information. ndp: type: boolean description: Enable NDP (Neighbor Discovery Protocol). nf_conntrack_allow_invalid: type: boolean description: Allow invalid packets on connection tracking. nf_conntrack_max: type: integer description: Maximum number of tracked connections. nf_conntrack_tcp_timeout_established: type: integer description: Conntrack established timeout. nf_conntrack_tcp_timeout_syn_recv: type: integer description: Conntrack syn recv timeout. nosmurfs: type: boolean description: Enable SMURFS filter. protection_synflood: type: boolean description: Enable synflood protection protection_synflood_burst: type: integer description: Synflood protection rate burst by ip src. protection_synflood_rate: type: integer description: Synflood protection rate syn/sec by ip src. smurf_log_level: type: string description: Log level for SMURFS filter. tcp_flags_log_level: type: string description: Log level for illegal tcp flags filter. tcpflags: type: boolean description: Filter illegal combinations of TCP flags. UpdateNodeFirewallOptionsResponse: description: UpdateNodeFirewallOptionsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleFirewallLogResponse: description: GetNodesSingleFirewallLogResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: 'n': type: integer description: Line number t: type: string description: Line text GetNodesSingleReplicationResponse: description: GetNodesSingleReplicationResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: id: type: string description: '' GetNodesSingleReplicationSingleResponse: description: GetNodesSingleReplicationSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: {} GetNodesSingleReplicationSingleStatusResponse: description: GetNodesSingleReplicationSingleStatusResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' GetNodesSingleReplicationSingleLogResponse: description: GetNodesSingleReplicationSingleLogResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: 'n': type: integer description: Line number t: type: string description: Line text CreateNodesSingleReplicationSingleSchedulenowResponse: description: CreateNodesSingleReplicationSingleSchedulenowResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleCertificatesResponse: description: GetNodesSingleCertificatesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: {} GetNodesSingleCertificatesAcmeResponse: description: GetNodesSingleCertificatesAcmeResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: {} DeleteNodesSingleCertificatesAcmeCertificateResponse: description: DeleteNodesSingleCertificatesAcmeCertificateResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' CreateNodesSingleCertificatesAcmeCertificateResponse: description: CreateNodesSingleCertificatesAcmeCertificateResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' UpdateNodesSingleCertificatesAcmeCertificateResponse: description: UpdateNodesSingleCertificatesAcmeCertificateResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleCertificatesInfoResponse: description: GetNodesSingleCertificatesInfoResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: filename: type: string description: '' fingerprint: type: string description: Certificate SHA 256 fingerprint. issuer: type: string description: Certificate issuer name. notafter: type: integer description: Certificate's notAfter timestamp (UNIX epoch). notbefore: type: integer description: Certificate's notBefore timestamp (UNIX epoch). pem: type: string description: Certificate in PEM format public-key-bits: type: integer description: Certificate's public key size public-key-type: type: string description: Certificate's public key algorithm san: type: array description: List of Certificate's SubjectAlternativeName entries. items: type: string description: '' subject: type: string description: Certificate subject name. DeleteNodesSingleCertificatesCustomResponse: description: DeleteNodesSingleCertificatesCustomResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' CreateNodesSingleCertificatesCustomResponse: description: CreateNodesSingleCertificatesCustomResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: filename: type: string description: '' fingerprint: type: string description: Certificate SHA 256 fingerprint. issuer: type: string description: Certificate issuer name. notafter: type: integer description: Certificate's notAfter timestamp (UNIX epoch). notbefore: type: integer description: Certificate's notBefore timestamp (UNIX epoch). pem: type: string description: Certificate in PEM format public-key-bits: type: integer description: Certificate's public key size public-key-type: type: string description: Certificate's public key algorithm san: type: array description: List of Certificate's SubjectAlternativeName entries. items: type: string description: '' subject: type: string description: Certificate subject name. GetNodesSingleConfigResponse: description: GetNodesSingleConfigResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' UpdateNodesSingleConfigResponse: description: UpdateNodesSingleConfigResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodeSDNResponse: description: GetNodeSDNResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: {} GetNodeSDNZonesResponse: description: GetNodeSDNZonesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: status: type: string description: Status of zone zone: type: string description: The SDN zone object identifier. GetNodeSDNZoneResponse: description: GetNodeSDNZoneResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: subdir: type: string description: '' GetNodeSDNZoneContentResponse: description: GetNodeSDNZoneContentResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: status: type: string description: Status. statusmsg: type: string description: Status details vnet: type: string description: Vnet identifier. GetNodesSingleVersionResponse: description: GetNodesSingleVersionResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: release: type: string description: The current installed Proxmox VE Release repoid: type: string description: >- The short git commit hash ID from which this version was build version: type: string description: The current installed pve-manager package version GetNodesSingleStatusResponse: description: GetNodesSingleStatusResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' CreateNodesSingleStatusResponse: description: CreateNodesSingleStatusResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleNetstatResponse: description: GetNodesSingleNetstatResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: {} CreateNodesSingleExecuteResponse: description: CreateNodesSingleExecuteResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' CreateNodesSingleWakeonlanResponse: description: CreateNodesSingleWakeonlanResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: MAC address used to assemble the WoL magic packet. GetNodeRRDResponse: description: GetNodeRRDResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: filename: type: string description: '' GetNodeRRDDataResponse: description: GetNodeRRDDataResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: {} GetNodesSingleSyslogResponse: description: GetNodesSingleSyslogResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: 'n': type: integer description: Line number t: type: string description: Line text GetNodesSingleJournalResponse: description: GetNodesSingleJournalResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: string description: '' CreateNodesSingleVncshellResponse: description: CreateNodesSingleVncshellResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' CreateNodesSingleTermproxyResponse: description: CreateNodesSingleTermproxyResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleVncwebsocketResponse: description: GetNodesSingleVncwebsocketResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: port: type: string description: '' CreateNodesSingleSpiceshellResponse: description: CreateNodesSingleSpiceshellResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: >- Returned values can be directly passed to the 'remote-viewer' application. GetNodesSingleDnsResponse: description: GetNodesSingleDnsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: dns1: type: string description: First name server IP address. dns2: type: string description: Second name server IP address. dns3: type: string description: Third name server IP address. search: type: string description: Search domain for host-name lookup. UpdateNodesSingleDnsResponse: description: UpdateNodesSingleDnsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleTimeResponse: description: GetNodesSingleTimeResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: localtime: type: integer description: 'Seconds since 1970-01-01 00:00:00 (local time)' time: type: integer description: 'Seconds since 1970-01-01 00:00:00 UTC.' timezone: type: string description: Time zone UpdateNodesSingleTimeResponse: description: UpdateNodesSingleTimeResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleAplinfoResponse: description: GetNodesSingleAplinfoResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: {} CreateNodesSingleAplinfoResponse: description: CreateNodesSingleAplinfoResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleReportResponse: description: GetNodesSingleReportResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' CreateNodesSingleStartallResponse: description: CreateNodesSingleStartallResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' CreateNodesSingleStopallResponse: description: CreateNodesSingleStopallResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' CreateNodesSingleMigrateallResponse: description: CreateNodesSingleMigrateallResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetNodesSingleHostsResponse: description: GetNodesSingleHostsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: data: type: string description: The content of /etc/hosts. digest: type: string description: >- Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. CreateNodesSingleHostsResponse: description: CreateNodesSingleHostsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetStorageResponse: description: GetStorageResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: storage: type: string description: '' CreateStorageResponse: description: CreateStorageResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: config: type: object description: >- Partial, possible server generated, configuration properties. properties: encryption-key: type: string description: 'The, possible auto-generated, encryption-key.' storage: type: string description: The ID of the created storage. type: type: string description: The type of the created storage. DeleteStorageSingleResponse: description: DeleteStorageSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetStorageSingleResponse: description: GetStorageSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' UpdateStorageSingleResponse: description: UpdateStorageSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: config: type: object description: >- Partial, possible server generated, configuration properties. properties: encryption-key: type: string description: 'The, possible auto-generated, encryption-key.' storage: type: string description: The ID of the created storage. type: type: string description: The type of the created storage. GetAccessResponse: description: GetAccessResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: subdir: type: string description: '' GetAccessUsersResponse: description: GetAccessUsersResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: comment: type: string description: '' email: type: string description: '' enable: type: boolean description: >- Enable the account (default). You can set this to '0' to disable the account expire: type: integer description: >- Account expiration date (seconds since epoch). '0' means no expiration date. firstname: type: string description: '' groups: type: string description: '' keys: type: string description: Keys for two factor auth (yubico). lastname: type: string description: '' tokens: type: array description: '' items: type: object description: '' properties: comment: type: string description: '' expire: type: integer description: >- API token expiration date (seconds since epoch). '0' means no expiration date. privsep: type: boolean description: >- Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user. tokenid: type: string description: User-specific token identifier. userid: type: string description: User ID CreateAccessUsersResponse: description: CreateAccessUsersResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' DeleteAccessUsersSingleResponse: description: DeleteAccessUsersSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetAccessUsersSingleResponse: description: GetAccessUsersSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: comment: type: string description: '' email: type: string description: '' enable: type: boolean description: >- Enable the account (default). You can set this to '0' to disable the account expire: type: integer description: >- Account expiration date (seconds since epoch). '0' means no expiration date. firstname: type: string description: '' groups: type: array description: '' items: type: string description: '' keys: type: string description: Keys for two factor auth (yubico). lastname: type: string description: '' tokens: type: object description: '' UpdateAccessUsersSingleResponse: description: UpdateAccessUsersSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetAccessUsersSingleTfaResponse: description: GetAccessUsersSingleTfaResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: realm: type: string description: 'The type of TFA the users realm has set, if any.' user: type: string description: 'The type of TFA the user has set, if any.' GetAccessUsersSingleTokenResponse: description: GetAccessUsersSingleTokenResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: comment: type: string description: '' expire: type: integer description: >- API token expiration date (seconds since epoch). '0' means no expiration date. privsep: type: boolean description: >- Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user. tokenid: type: string description: User-specific token identifier. DeleteAccessUsersSingleTokenSingleResponse: description: DeleteAccessUsersSingleTokenSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetAccessUsersSingleTokenSingleResponse: description: GetAccessUsersSingleTokenSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: comment: type: string description: '' expire: type: integer description: >- API token expiration date (seconds since epoch). '0' means no expiration date. privsep: type: boolean description: >- Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user. CreateAccessUsersSingleTokenSingleResponse: description: CreateAccessUsersSingleTokenSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: full-tokenid: type: string description: The full token id. info: type: object description: '' properties: comment: type: string description: '' expire: type: integer description: >- API token expiration date (seconds since epoch). '0' means no expiration date. privsep: type: boolean description: >- Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user. value: type: string description: API token value used for authentication. UpdateAccessUsersSingleTokenSingleResponse: description: UpdateAccessUsersSingleTokenSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Updated token information. properties: comment: type: string description: '' expire: type: integer description: >- API token expiration date (seconds since epoch). '0' means no expiration date. privsep: type: boolean description: >- Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user. GetAccessGroupsResponse: description: GetAccessGroupsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: comment: type: string description: '' groupid: type: string description: '' users: type: string description: list of users which form this group CreateAccessGroupsResponse: description: CreateAccessGroupsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' DeleteAccessGroupsSingleResponse: description: DeleteAccessGroupsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetAccessGroupsSingleResponse: description: GetAccessGroupsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: comment: type: string description: '' members: type: array description: '' items: type: string description: User ID UpdateAccessGroupsSingleResponse: description: UpdateAccessGroupsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetAccessRolesResponse: description: GetAccessRolesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: privs: type: string description: '' roleid: type: string description: '' special: type: boolean description: '' CreateAccessRolesResponse: description: CreateAccessRolesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' DeleteAccessRolesSingleResponse: description: DeleteAccessRolesSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetAccessRolesSingleResponse: description: GetAccessRolesSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: Datastore.Allocate: type: boolean description: '' Datastore.AllocateSpace: type: boolean description: '' Datastore.AllocateTemplate: type: boolean description: '' Datastore.Audit: type: boolean description: '' Group.Allocate: type: boolean description: '' Permissions.Modify: type: boolean description: '' Pool.Allocate: type: boolean description: '' Realm.Allocate: type: boolean description: '' Realm.AllocateUser: type: boolean description: '' SDN.Allocate: type: boolean description: '' SDN.Audit: type: boolean description: '' Sys.Audit: type: boolean description: '' Sys.Console: type: boolean description: '' Sys.Modify: type: boolean description: '' Sys.PowerMgmt: type: boolean description: '' Sys.Syslog: type: boolean description: '' User.Modify: type: boolean description: '' VM.Allocate: type: boolean description: '' VM.Audit: type: boolean description: '' VM.Backup: type: boolean description: '' VM.Clone: type: boolean description: '' VM.Config.CDROM: type: boolean description: '' VM.Config.CPU: type: boolean description: '' VM.Config.Cloudinit: type: boolean description: '' VM.Config.Disk: type: boolean description: '' VM.Config.HWType: type: boolean description: '' VM.Config.Memory: type: boolean description: '' VM.Config.Network: type: boolean description: '' VM.Config.Options: type: boolean description: '' VM.Console: type: boolean description: '' VM.Migrate: type: boolean description: '' VM.Monitor: type: boolean description: '' VM.PowerMgmt: type: boolean description: '' VM.Snapshot: type: boolean description: '' VM.Snapshot.Rollback: type: boolean description: '' UpdateAccessRolesSingleResponse: description: UpdateAccessRolesSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetAccessAclResponse: description: GetAccessAclResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: path: type: string description: Access control path propagate: type: boolean description: Allow to propagate (inherit) permissions. roleid: type: string description: '' type: type: string description: '' ugid: type: string description: '' UpdateAccessAclResponse: description: UpdateAccessAclResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetAccessDomainsResponse: description: GetAccessDomainsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: comment: type: string description: >- A comment. The GUI use this text when you select a domain (Realm) on the login window. realm: type: string description: '' tfa: type: string description: Two-factor authentication provider. type: type: string description: '' CreateAccessDomainsResponse: description: CreateAccessDomainsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' DeleteAccessDomainsSingleResponse: description: DeleteAccessDomainsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetAccessDomainsSingleResponse: description: GetAccessDomainsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' UpdateAccessDomainsSingleResponse: description: UpdateAccessDomainsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' CreateAccessDomainsSingleSyncResponse: description: CreateAccessDomainsSingleSyncResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: Worker Task-UPID GetAccessTicketResponse: description: GetAccessTicketResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' CreateAccessTicketResponse: description: CreateAccessTicketResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: CSRFPreventionToken: type: string description: '' clustername: type: string description: '' ticket: type: string description: '' username: type: string description: '' UpdateAccessPasswordResponse: description: UpdateAccessPasswordResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' CreateAccessTfaResponse: description: CreateAccessTfaResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: ticket: type: string description: '' UpdateAccessTfaResponse: description: UpdateAccessTfaResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' GetAccessPermissionsResponse: description: GetAccessPermissionsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Map of "path" => (Map of "privilege" => "propagate boolean"). GetPoolsResponse: description: GetPoolsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: '' items: type: object description: '' properties: poolid: type: string description: '' CreatePoolResponse: description: CreatePoolResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' DeletePoolResponse: description: DeletePoolResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetPoolResponse: description: GetPoolResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: comment: type: string description: '' members: type: array description: '' items: type: object description: '' properties: id: type: string description: '' node: type: string description: '' storage: type: string description: '' type: type: string description: '' vmid: type: integer description: '' UpdatePoolResponse: description: UpdatePoolResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: '' GetVersionResponse: description: GetVersionResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: '' properties: release: type: string description: '' repoid: type: string description: '' version: type: string description: ''