diff --git a/build/mapping.js b/build/mapping.js index 1975249..2b163dc 100644 --- a/build/mapping.js +++ b/build/mapping.js @@ -98,5 +98,10 @@ module.exports = { deleteClusterFirewallIpsetSingle: 'deleteClusterFirewallIPSet', getClusterFirewallIpsetSingleSingle: 'getClusterFirewallIPSetIP', updateClusterFirewallIpsetSingleSingle: 'updateClusterFirewallIPSetIP', - deleteClusterFirewallIpsetSingleSingle: 'removeClusterFirewallIPSetIP' + deleteClusterFirewallIpsetSingleSingle: 'removeClusterFirewallIPSetIP', + getNodesSingleTasks: 'getNodeTasks', + getNodesSingleTasksSingle: 'getNodeTask', + deleteNodesSingleTasksSingle: 'stopNodeTask', + getNodesSingleTasksSingleLog: 'getNodeTaskLog', + getNodesSingleTasksSingleStatus: 'getNodeTaskStatus' } diff --git a/reference/spec.v2.yaml b/reference/spec.v2.yaml index c88efda..251afdd 100644 --- a/reference/spec.v2.yaml +++ b/reference/spec.v2.yaml @@ -7197,8 +7197,8 @@ paths: $ref: '#/components/schemas/UpdateNodesSingleNetworkSingleRequest' '/nodes/{node}/tasks': get: - operationId: getNodesSingleTasks - summary: getNodesSingleTasks + operationId: getNodeTasks + summary: getNodeTasks description: Read task list for one node (finished tasks). tags: - nodes @@ -7211,11 +7211,11 @@ paths: type: string responses: '200': - $ref: '#/components/responses/GetNodesSingleTasksResponse' + $ref: '#/components/responses/GetNodeTasksResponse' '/nodes/{node}/tasks/{upid}': delete: - operationId: deleteNodesSingleTasksSingle - summary: deleteNodesSingleTasksSingle + operationId: stopNodeTask + summary: stopNodeTask description: Stop a task. tags: - nodes @@ -7234,11 +7234,11 @@ paths: type: string responses: '200': - $ref: '#/components/responses/DeleteNodesSingleTasksSingleResponse' + $ref: '#/components/responses/StopNodeTaskResponse' get: - operationId: getNodesSingleTasksSingle - summary: getNodesSingleTasksSingle - description: getNodesSingleTasksSingle + operationId: getNodeTask + summary: getNodeTask + description: getNodeTask tags: - nodes parameters: @@ -7256,11 +7256,11 @@ paths: type: string responses: '200': - $ref: '#/components/responses/GetNodesSingleTasksSingleResponse' + $ref: '#/components/responses/GetNodeTaskResponse' '/nodes/{node}/tasks/{upid}/log': get: - operationId: getNodesSingleTasksSingleLog - summary: getNodesSingleTasksSingleLog + operationId: getNodeTaskLog + summary: getNodeTaskLog description: Read task log. tags: - nodes @@ -7279,11 +7279,11 @@ paths: type: string responses: '200': - $ref: '#/components/responses/GetNodesSingleTasksSingleLogResponse' + $ref: '#/components/responses/GetNodeTaskLogResponse' '/nodes/{node}/tasks/{upid}/status': get: - operationId: getNodesSingleTasksSingleStatus - summary: getNodesSingleTasksSingleStatus + operationId: getNodeTaskStatus + summary: getNodeTaskStatus description: Read task status. tags: - nodes @@ -7302,7 +7302,7 @@ paths: type: string responses: '200': - $ref: '#/components/responses/GetNodesSingleTasksSingleStatusResponse' + $ref: '#/components/responses/GetNodeTaskStatusResponse' '/nodes/{node}/scan': get: operationId: getNodesSingleScan @@ -13807,6160 +13807,9496 @@ components: content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: {} + 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: array - description: '' - items: - type: object - description: '' - properties: {} + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' DeleteClusterReplicationSingleResponse: description: DeleteClusterReplicationSingleResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetClusterReplicationSingleResponse: description: GetClusterReplicationSingleResponse content: application/json: schema: type: object - description: '' + properties: + errors: + type: array + items: + type: string + data: + type: object + description: '' UpdateClusterReplicationSingleResponse: description: UpdateClusterReplicationSingleResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetClusterMetricsResponse: description: GetClusterMetricsResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: {} + 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: array - description: '' - items: - type: object - description: '' - properties: - disable: - type: boolean - description: Flag to disable the plugin. - id: + type: object + properties: + errors: + type: array + items: 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. + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetClusterMetricsServerSingleResponse: description: GetClusterMetricsServerSingleResponse content: application/json: schema: type: object - description: '' + properties: + errors: + type: array + items: + type: string + data: + type: object + description: '' CreateClusterMetricsServerSingleResponse: description: CreateClusterMetricsServerSingleResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' UpdateClusterMetricsServerSingleResponse: description: UpdateClusterMetricsServerSingleResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetClusterConfigResponse: description: GetClusterConfigResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: {} + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetClusterConfigApiversionResponse: description: GetClusterConfigApiversionResponse content: application/json: schema: - type: integer - description: 'Cluster Join API version, currently 1' + 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: array - description: '' - items: - type: object - description: '' - properties: - node: + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' CreateClusterConfigNodesSingleResponse: description: CreateClusterConfigNodesSingleResponse content: application/json: schema: type: object - description: '' properties: - corosync_authkey: - type: string - description: '' - corosync_conf: - type: string - description: '' - warnings: + errors: type: array - description: '' items: type: string - description: '' + 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 - description: '' properties: - config_digest: - type: string - description: '' - nodelist: + errors: 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: 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetClusterConfigTotemResponse: description: GetClusterConfigTotemResponse content: application/json: schema: type: object - description: '' + properties: + errors: + type: array + items: + type: string + data: + type: object + description: '' GetClusterConfigQdeviceResponse: description: GetClusterConfigQdeviceResponse content: application/json: schema: type: object - description: '' + properties: + errors: + type: array + items: + type: string + data: + type: object + description: '' GetClusterFirewallResponse: description: GetClusterFirewallResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: {} + 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: array - description: '' - items: - type: object - description: '' - properties: - comment: + type: object + properties: + errors: + type: array + items: type: string + data: + type: array + description: '' + items: + type: object 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. + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' DeleteClusterFirewallGroupResponse: description: DeleteClusterFirewallGroupResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetClusterFirewallGroupRulesResponse: description: GetClusterFirewallGroupRulesResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: - pos: - type: integer + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' RemoveClusterFirewallGroupRuleResponse: description: RemoveClusterFirewallGroupRuleResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetClusterFirewallGroupRuleResponse: description: GetClusterFirewallGroupRuleResponse content: application/json: schema: 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 + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetClusterFirewallRulesResponse: description: GetClusterFirewallRulesResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: - pos: - type: integer + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' RemoveClusterFirewallRuleResponse: description: RemoveClusterFirewallRuleResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetClusterFirewallRuleResponse: description: GetClusterFirewallRuleResponse content: application/json: schema: 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 + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetClusterFirewallIPSetsResponse: description: GetClusterFirewallIPSetsResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: - comment: + type: object + properties: + errors: + type: array + items: type: string + data: + type: array + description: '' + items: + type: object 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. + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' DeleteClusterFirewallIPSetResponse: description: DeleteClusterFirewallIPSetResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetClusterFirewallIPSetResponse: description: GetClusterFirewallIPSetResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: - cidr: + type: object + properties: + errors: + type: array + items: type: string + data: + type: array + description: '' + items: + type: object 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: '' + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' RemoveClusterFirewallIPSetIPResponse: description: RemoveClusterFirewallIPSetIPResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetClusterFirewallIPSetIPResponse: description: GetClusterFirewallIPSetIPResponse content: application/json: schema: type: object - description: '' + properties: + errors: + type: array + items: + type: string + data: + type: object + description: '' UpdateClusterFirewallIPSetIPResponse: description: UpdateClusterFirewallIPSetIPResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetClusterFirewallAliasesResponse: description: GetClusterFirewallAliasesResponse content: application/json: schema: - 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: 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' DeleteClusterFirewallAliasesSingleResponse: description: DeleteClusterFirewallAliasesSingleResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetClusterFirewallAliasesSingleResponse: description: GetClusterFirewallAliasesSingleResponse content: application/json: schema: type: object - description: '' + properties: + errors: + type: array + items: + type: string + data: + type: object + description: '' UpdateClusterFirewallAliasesSingleResponse: description: UpdateClusterFirewallAliasesSingleResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetClusterFirewallOptionsResponse: description: GetClusterFirewallOptionsResponse content: application/json: schema: 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. + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetClusterFirewallMacrosResponse: description: GetClusterFirewallMacrosResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: - descr: + type: object + properties: + errors: + type: array + items: type: string - description: More verbose description (if available). - macro: - type: string - description: Macro name. + 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: array - description: '' - items: - type: object - description: '' - properties: - comment: - type: string - description: '' - name: - type: string - description: '' - ref: - type: string - description: '' - type: + 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: array - description: '' - items: - type: object - description: '' - properties: - id: + type: object + properties: + errors: + type: array + items: type: string - description: The job ID. + data: + type: array + description: '' + items: + type: object + description: '' + properties: + id: + type: string + description: The job ID. CreateClusterBackupResponse: description: CreateClusterBackupResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' DeleteClusterBackupSingleResponse: description: DeleteClusterBackupSingleResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetClusterBackupSingleResponse: description: GetClusterBackupSingleResponse content: application/json: schema: type: object - description: '' + properties: + errors: + type: array + items: + type: string + data: + type: object + description: '' UpdateClusterBackupSingleResponse: description: UpdateClusterBackupSingleResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetClusterBackupSingleIncludedvolumesResponse: description: GetClusterBackupSingleIncludedvolumesResponse content: application/json: schema: type: object - description: >- - Root node of the tree object. Children represent guests, - grandchildren represent volumes of that guest. properties: - children: + 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: - 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: string - description: Shows stub message - GetClusterBackupinfoNotbackedupResponse: - description: GetClusterBackupinfoNotbackedupResponse - content: - application/json: - schema: - 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: array - description: '' - items: - type: object - description: '' - properties: - id: - type: string - description: '' + description: '' GetClusterHaResourcesResponse: description: GetClusterHaResourcesResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: - sid: + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' DeleteClusterHaResourcesSingleResponse: description: DeleteClusterHaResourcesSingleResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetClusterHaResourcesSingleResponse: description: GetClusterHaResourcesSingleResponse content: application/json: schema: 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. + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' CreateClusterHaResourcesSingleMigrateResponse: description: CreateClusterHaResourcesSingleMigrateResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' CreateClusterHaResourcesSingleRelocateResponse: description: CreateClusterHaResourcesSingleRelocateResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetClusterHaGroupsResponse: description: GetClusterHaGroupsResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: - group: + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' DeleteClusterHaGroupsSingleResponse: description: DeleteClusterHaGroupsSingleResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetClusterHaGroupsSingleResponse: description: GetClusterHaGroupsSingleResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' UpdateClusterHaGroupsSingleResponse: description: UpdateClusterHaGroupsSingleResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetClusterHaStatusResponse: description: GetClusterHaStatusResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: {} + 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: array - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: array + description: '' GetClusterHaStatusManagerstatusResponse: description: GetClusterHaStatusManagerstatusResponse content: application/json: schema: type: object - description: '' + properties: + errors: + type: array + items: + type: string + data: + type: object + description: '' GetClusterAcmeResponse: description: GetClusterAcmeResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: {} + 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: array - description: '' - items: - type: object - description: '' - properties: - plugin: + type: object + properties: + errors: + type: array + items: type: string - description: Unique identifier for ACME plugin instance. + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' DeleteClusterAcmePluginsSingleResponse: description: DeleteClusterAcmePluginsSingleResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetClusterAcmePluginsSingleResponse: description: GetClusterAcmePluginsSingleResponse content: application/json: schema: type: object - description: '' + properties: + errors: + type: array + items: + type: string + data: + type: object + description: '' UpdateClusterAcmePluginsSingleResponse: description: UpdateClusterAcmePluginsSingleResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetClusterAcmeAccountResponse: description: GetClusterAcmeAccountResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: {} + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' DeleteClusterAcmeAccountSingleResponse: description: DeleteClusterAcmeAccountSingleResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetClusterAcmeAccountSingleResponse: description: GetClusterAcmeAccountSingleResponse content: application/json: schema: type: object - description: '' properties: - account: + errors: + type: array + items: + type: string + data: type: object description: '' - directory: - type: string - description: URL of ACME CA directory endpoint. - location: - type: string - description: '' - tos: - type: string - 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetClusterAcmeTosResponse: description: GetClusterAcmeTosResponse content: application/json: schema: - type: string - description: ACME TermsOfService URL. + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: ACME TermsOfService URL. GetClusterAcmeDirectoriesResponse: description: GetClusterAcmeDirectoriesResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: - name: + type: object + properties: + errors: + type: array + items: type: string + data: + type: array + description: '' + items: + type: object description: '' - url: - type: string - description: URL of ACME CA directory endpoint. + properties: + name: + type: string + description: '' + url: + type: string + description: URL of ACME CA directory endpoint. GetClusterAcmeChallengeschemaResponse: description: GetClusterAcmeChallengeschemaResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: - id: + type: object + properties: + errors: + type: array + items: type: string - description: '' - name: - type: string - description: 'Human readable name, falls back to id' - schema: + data: + type: array + description: '' + items: type: object description: '' - type: - type: string - 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: array - description: '' - items: - type: object - description: '' - properties: {} + 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 - description: '' + properties: + errors: + type: array + items: + type: string + data: + type: object + description: '' GetClusterCephStatusResponse: description: GetClusterCephStatusResponse content: application/json: schema: type: object - description: '' + properties: + errors: + type: array + items: + type: string + data: + type: object + description: '' GetClusterCephFlagsResponse: description: GetClusterCephFlagsResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: - name: + type: object + properties: + errors: + type: array + items: type: string - description: Flag name. + data: + type: array + description: '' + items: + type: object + description: '' + properties: + name: + type: string + description: Flag name. UpdateClusterCephFlagsResponse: description: UpdateClusterCephFlagsResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetClusterCephFlagsSingleResponse: description: GetClusterCephFlagsSingleResponse content: application/json: schema: - type: boolean - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: boolean + description: '' UpdateClusterCephFlagsSingleResponse: description: UpdateClusterCephFlagsSingleResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetClusterSDNResponse: description: GetClusterSDNResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: - id: + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetClusterSDNVnetsResponse: description: GetClusterSDNVnetsResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: {} + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' DeleteClusterSDNVnetResponse: description: DeleteClusterSDNVnetResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetClusterSDNVnetResponse: description: GetClusterSDNVnetResponse content: application/json: schema: type: object - description: '' + properties: + errors: + type: array + items: + type: string + data: + type: object + description: '' UpdateClusterSDNVnetResponse: description: UpdateClusterSDNVnetResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetClusterSDNZonesResponse: description: GetClusterSDNZonesResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: - type: - type: string - description: '' - zone: + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' DeleteClusterSDNZoneResponse: description: DeleteClusterSDNZoneResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetClusterSDNZoneResponse: description: GetClusterSDNZoneResponse content: application/json: schema: type: object - description: '' + properties: + errors: + type: array + items: + type: string + data: + type: object + description: '' UpdateClusterSDNZoneResponse: description: UpdateClusterSDNZoneResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetClusterSDNControllersResponse: description: GetClusterSDNControllersResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: - controller: - type: string - description: '' - type: + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' DeleteClusterSDNControllerResponse: description: DeleteClusterSDNControllerResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetClusterSDNControllerResponse: description: GetClusterSDNControllerResponse content: application/json: schema: type: object - description: '' + properties: + errors: + type: array + items: + type: string + data: + type: object + description: '' UpdateClusterSDNControllerResponse: description: UpdateClusterSDNControllerResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetClusterLogResponse: description: GetClusterLogResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: {} + 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: 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: object + properties: + errors: + type: array + items: type: string + data: + type: array + description: '' + items: + type: object 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).' + 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: array - description: '' - items: - type: object - description: '' - properties: - upid: + 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 - description: '' + properties: + errors: + type: array + items: + type: string + data: + type: object + description: '' UpdateClusterOptionsResponse: description: UpdateClusterOptionsResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetClusterStatusResponse: description: GetClusterStatusResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: - id: + type: object + properties: + errors: + type: array + items: type: string + data: + type: array + description: '' + items: + type: object 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. + 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: integer - description: The next free VMID. + 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: array - description: '' - items: - type: object - description: '' - properties: - cpu: - type: number - description: CPU utilization. - level: + type: object + properties: + errors: + type: array + items: 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. + 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: array - description: '' - items: - type: object - description: '' - properties: {} + 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: array - description: '' - items: - type: object - description: '' - properties: - cpus: - type: number - description: Maximum usable CPUs. - lock: + type: object + properties: + errors: + type: array + items: 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. + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' DeleteVMResponse: description: DeleteVMResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetVMResponse: description: GetVMResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: - subdir: + 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: array - description: '' - items: - type: object - description: '' - properties: {} + 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: array - description: '' - items: - type: object - description: '' - properties: - pos: - type: integer + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' DeleteVMFirewallRuleResponse: description: DeleteVMFirewallRuleResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetVMFirewallRuleResponse: description: GetVMFirewallRuleResponse content: application/json: schema: 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 + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleQemuSingleFirewallAliasesResponse: description: GetNodesSingleQemuSingleFirewallAliasesResponse content: application/json: schema: - 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: 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' DeleteNodesSingleQemuSingleFirewallAliasesSingleResponse: description: DeleteNodesSingleQemuSingleFirewallAliasesSingleResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleQemuSingleFirewallAliasesSingleResponse: description: GetNodesSingleQemuSingleFirewallAliasesSingleResponse content: application/json: schema: type: object - description: '' + properties: + errors: + type: array + items: + type: string + data: + type: object + description: '' UpdateNodesSingleQemuSingleFirewallAliasesSingleResponse: description: UpdateNodesSingleQemuSingleFirewallAliasesSingleResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetVMFirewallIPSetsResponse: description: GetVMFirewallIPSetsResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: - comment: + type: object + properties: + errors: + type: array + items: type: string + data: + type: array + description: '' + items: + type: object 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. + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' DeleteVMFirewallIPSetResponse: description: DeleteVMFirewallIPSetResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetVMFirewallIPSetResponse: description: GetVMFirewallIPSetResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: - cidr: + type: object + properties: + errors: + type: array + items: type: string + data: + type: array + description: '' + items: + type: object 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: '' + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' RemoveVMFirewallIPSetIPResponse: description: RemoveVMFirewallIPSetIPResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetVMFirewallIPSetIPResponse: description: GetVMFirewallIPSetIPResponse content: application/json: schema: type: object - description: '' + properties: + errors: + type: array + items: + type: string + data: + type: object + description: '' UpdateVMFirewallIPSetIPResponse: description: UpdateVMFirewallIPSetIPResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetVMFirewallOptionsResponse: description: GetVMFirewallOptionsResponse content: application/json: schema: 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. + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleQemuSingleFirewallLogResponse: description: GetNodesSingleQemuSingleFirewallLogResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: - 'n': - type: integer - description: Line number - t: + type: object + properties: + errors: + type: array + items: type: string - description: Line text + 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: array - description: '' - items: - type: object - description: '' - properties: - comment: - type: string - description: '' - name: - type: string - description: '' - type: + 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: array - description: Returns the list of Qemu Agent commands - items: - type: object - description: '' - properties: {} + 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 - description: Returns an object with a single `result` property. + 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 - description: Returns an object with a single `result` property. + 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 - description: Returns an object with a single `result` property. + 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 - description: Returns an object with a single `result` property. + 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 - description: Returns an object with a single `result` property. + 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 - description: Returns an object with a single `result` property. + 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 - description: Returns an object with a single `result` property. + 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 - description: Returns an object with a single `result` property. + 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 - description: Returns an object with a single `result` property. + 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 - description: Returns an object with a single `result` property. + 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 - description: Returns an object with a single `result` property. + 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 - description: Returns an object with a single `result` property. + 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 - description: Returns an object with a single `result` property. + 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 - description: Returns an object with a single `result` property. + 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 - description: Returns an object with a single `result` property. + 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 - description: Returns an object with a single `result` property. + 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 - description: Returns an object with a single `result` property. + 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 - description: Returns an object with a single `result` property. + 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 - description: Returns an object with a single `result` property. + 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 - description: Returns an object with a single `result` property. + 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 - description: Returns an object with a single `result` property. + 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 - description: Returns an object with a single `result` property. + 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 - description: '' properties: - pid: - type: integer - description: The PID of the process started by the guest-agent. + 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 - 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. + 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 - 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' + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetVMRRDResponse: description: GetVMRRDResponse content: application/json: schema: type: object - description: '' properties: - filename: - type: string + errors: + type: array + items: + type: string + data: + type: object description: '' + properties: + filename: + type: string + description: '' GetVMRRDDataResponse: description: GetVMRRDDataResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: {} + 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 - 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. - hostpci: + errors: type: array items: 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. - ide: - type: array - items: - type: string - description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). - ipconfig: - type: array - items: - type: string - description: > - cloud-init: Specify IP addresses and gateways for the - corresponding interface. + 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. + hostpci: + type: array + items: + 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. + ide: + type: array + items: + type: string + description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). + ipconfig: + type: array + items: + 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. + 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 + The special string 'dhcp' can be used for IP addresses + to use DHCP, in which case no explicit - gateway should be provided. + gateway should be provided. - For IPv6 the special string 'auto' can be used to use - stateless autoconfiguration. + 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 + 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." - net: - type: array - items: - type: string - description: Specify network devices. - numa: - type: array - items: - 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. - parallel: - type: array - items: - 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. - sata: - type: array - items: - type: string - description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). - scsi: - type: array - items: - 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." - serial: - type: array - items: - 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. - unused: - type: array - items: - type: string - description: >- - Reference to unused volumes. This is used internally, and - should not be modified manually. - usb: - type: array - items: - 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. - virtio: - type: array - items: - 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. + 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." + net: + type: array + items: + type: string + description: Specify network devices. + numa: + type: array + items: + 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. + parallel: + type: array + items: + 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. + sata: + type: array + items: + type: string + description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). + scsi: + type: array + items: + 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." + serial: + type: array + items: + 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. + unused: + type: array + items: + type: string + description: >- + Reference to unused volumes. This is used internally, + and should not be modified manually. + usb: + type: array + items: + 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. + virtio: + type: array + items: + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' UpdateVMConfigSyncResponse: description: UpdateVMConfigSyncResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetVMConfigPendingResponse: description: GetVMConfigPendingResponse content: application/json: schema: - 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: object + properties: + errors: + type: array + items: type: string - description: Configuration option name. - pending: - type: string - description: Pending value. - value: - type: string - description: Current value. + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' CreateNodesSingleQemuSingleVncproxyResponse: description: CreateNodesSingleQemuSingleVncproxyResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' CreateNodesSingleQemuSingleTermproxyResponse: description: CreateNodesSingleQemuSingleTermproxyResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleQemuSingleVncwebsocketResponse: description: GetNodesSingleQemuSingleVncwebsocketResponse content: application/json: schema: type: object - description: '' properties: - port: - type: string + errors: + type: array + items: + type: string + data: + type: object description: '' + properties: + port: + type: string + description: '' CreateNodesSingleQemuSingleSpiceproxyResponse: description: CreateNodesSingleQemuSingleSpiceproxyResponse content: application/json: schema: - type: string - description: >- - Returned values can be directly passed to the 'remote-viewer' - application. + 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: array - description: '' - items: - type: object - description: '' - properties: - subdir: + 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 - description: '' properties: - agent: - type: boolean - description: Qemu GuestAgent enabled in config. - cpus: - type: number - description: Maximum usable CPUs. - ha: + errors: + type: array + items: + type: string + data: 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. + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' StopVMResponse: description: StopVMResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' ResetVMResponse: description: ResetVMResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' ShutdownVMResponse: description: ShutdownVMResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' RebootVMResponse: description: RebootVMResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' SuspendVMResponse: description: SuspendVMResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' ResumeVMResponse: description: ResumeVMResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' UpdateNodesSingleQemuSingleSendkeyResponse: description: UpdateNodesSingleQemuSingleSendkeyResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleQemuSingleFeatureResponse: description: GetNodesSingleQemuSingleFeatureResponse content: application/json: schema: type: object - description: '' properties: - hasFeature: - type: boolean - description: '' - nodes: + errors: type: array - description: '' items: type: string - description: '' + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' CreateNodesSingleQemuSingleMovediskResponse: description: CreateNodesSingleQemuSingleMovediskResponse content: application/json: schema: - type: string - description: the task ID. + 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 - description: '' properties: - allowed_nodes: + errors: 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: + items: + type: string + data: type: object - description: >- - List not allowed nodes with additional informations, only - passed if VM is offline - running: - type: boolean 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: string - description: the task ID. + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: the task ID. CreateNodesSingleQemuSingleMonitorResponse: description: CreateNodesSingleQemuSingleMonitorResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' UpdateNodesSingleQemuSingleResizeResponse: description: UpdateNodesSingleQemuSingleResizeResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetVMSnapshotsResponse: description: GetVMSnapshotsResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: - description: + type: object + properties: + errors: + type: array + items: 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. + 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: string - description: the task ID. + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: the task ID. DeleteVMSnapshotResponse: description: DeleteVMSnapshotResponse content: application/json: schema: - type: string - description: the task ID. + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: the task ID. GetVMSnapshotResponse: description: GetVMSnapshotResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: {} + 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 - description: '' + properties: + errors: + type: array + items: + type: string + data: + type: object + description: '' UpdateVMSnapshotConfigResponse: description: UpdateVMSnapshotConfigResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' RollbackVMSnapshotResponse: description: RollbackVMSnapshotResponse content: application/json: schema: - type: string - description: the task ID. + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: the task ID. CreateNodesSingleQemuSingleTemplateResponse: description: CreateNodesSingleQemuSingleTemplateResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleQemuSingleCloudinitDumpResponse: description: GetNodesSingleQemuSingleCloudinitDumpResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleCpuResponse: description: GetNodesSingleCpuResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: - custom: - type: boolean - description: True if this is a custom CPU model. - name: + type: object + properties: + errors: + type: array + items: 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. + 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: array - description: '' - items: - type: object - description: '' - properties: - cpus: - type: number - description: Maximum usable CPUs. - lock: + type: object + properties: + errors: + type: array + items: 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. + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' DeleteNodesSingleLxcSingleResponse: description: DeleteNodesSingleLxcSingleResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleLxcSingleResponse: description: GetNodesSingleLxcSingleResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: - subdir: + 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 - 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: + errors: type: array - description: >- - Array of lxc low-level configurations ([[key1, value1], [key2, - value2] ...]). items: - type: array - description: '' - items: + type: string + data: + type: object + description: '' + properties: + arch: type: string - description: '' - memory: - type: integer - description: Amount of RAM for the VM in MB. - mp: - type: array - items: - 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. - net: - type: array - items: - 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.) - unused: - type: array - items: - type: string - description: >- - Reference to unused volumes. This is used internally, and - should not be modified manually. + 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. + mp: + type: array + items: + 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. + net: + type: array + items: + 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.) + unused: + type: array + items: + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleLxcSingleStatusResponse: description: GetNodesSingleLxcSingleStatusResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: - subdir: + 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 - description: '' properties: - cpus: - type: number - description: Maximum usable CPUs. - ha: + errors: + type: array + items: + type: string + data: 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. + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' CreateNodesSingleLxcSingleStatusStopResponse: description: CreateNodesSingleLxcSingleStatusStopResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' CreateNodesSingleLxcSingleStatusShutdownResponse: description: CreateNodesSingleLxcSingleStatusShutdownResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' CreateNodesSingleLxcSingleStatusSuspendResponse: description: CreateNodesSingleLxcSingleStatusSuspendResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' CreateNodesSingleLxcSingleStatusResumeResponse: description: CreateNodesSingleLxcSingleStatusResumeResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' CreateNodesSingleLxcSingleStatusRebootResponse: description: CreateNodesSingleLxcSingleStatusRebootResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleLxcSingleSnapshotResponse: description: GetNodesSingleLxcSingleSnapshotResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: - description: + type: object + properties: + errors: + type: array + items: 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 + 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: string - description: the task ID. + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: the task ID. DeleteNodesSingleLxcSingleSnapshotSingleResponse: description: DeleteNodesSingleLxcSingleSnapshotSingleResponse content: application/json: schema: - type: string - description: the task ID. + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: the task ID. GetNodesSingleLxcSingleSnapshotSingleResponse: description: GetNodesSingleLxcSingleSnapshotSingleResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: {} + 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: string - description: the task ID. + 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 - description: '' + properties: + errors: + type: array + items: + type: string + data: + type: object + description: '' UpdateNodesSingleLxcSingleSnapshotSingleConfigResponse: description: UpdateNodesSingleLxcSingleSnapshotSingleConfigResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleLxcSingleFirewallResponse: description: GetNodesSingleLxcSingleFirewallResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: {} + 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: array - description: '' - items: - type: object - description: '' - properties: - pos: - type: integer + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' DeleteNodesSingleLxcSingleFirewallRulesSingleResponse: description: DeleteNodesSingleLxcSingleFirewallRulesSingleResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleLxcSingleFirewallRulesSingleResponse: description: GetNodesSingleLxcSingleFirewallRulesSingleResponse content: application/json: schema: 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 + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleLxcSingleFirewallAliasesResponse: description: GetNodesSingleLxcSingleFirewallAliasesResponse content: application/json: schema: - 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: 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' DeleteNodesSingleLxcSingleFirewallAliasesSingleResponse: description: DeleteNodesSingleLxcSingleFirewallAliasesSingleResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleLxcSingleFirewallAliasesSingleResponse: description: GetNodesSingleLxcSingleFirewallAliasesSingleResponse content: application/json: schema: type: object - description: '' + properties: + errors: + type: array + items: + type: string + data: + type: object + description: '' UpdateNodesSingleLxcSingleFirewallAliasesSingleResponse: description: UpdateNodesSingleLxcSingleFirewallAliasesSingleResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleLxcSingleFirewallIpsetResponse: description: GetNodesSingleLxcSingleFirewallIpsetResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: - comment: + type: object + properties: + errors: + type: array + items: type: string + data: + type: array + description: '' + items: + type: object 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. + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' DeleteNodesSingleLxcSingleFirewallIpsetSingleResponse: description: DeleteNodesSingleLxcSingleFirewallIpsetSingleResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleLxcSingleFirewallIpsetSingleResponse: description: GetNodesSingleLxcSingleFirewallIpsetSingleResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: - cidr: + type: object + properties: + errors: + type: array + items: type: string + data: + type: array + description: '' + items: + type: object 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: '' + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' DeleteNodesSingleLxcSingleFirewallIpsetSingleSingleResponse: description: DeleteNodesSingleLxcSingleFirewallIpsetSingleSingleResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleLxcSingleFirewallIpsetSingleSingleResponse: description: GetNodesSingleLxcSingleFirewallIpsetSingleSingleResponse content: application/json: schema: type: object - description: '' + properties: + errors: + type: array + items: + type: string + data: + type: object + description: '' UpdateNodesSingleLxcSingleFirewallIpsetSingleSingleResponse: description: UpdateNodesSingleLxcSingleFirewallIpsetSingleSingleResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleLxcSingleFirewallOptionsResponse: description: GetNodesSingleLxcSingleFirewallOptionsResponse content: application/json: schema: 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. + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleLxcSingleFirewallLogResponse: description: GetNodesSingleLxcSingleFirewallLogResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: - 'n': - type: integer - description: Line number - t: + type: object + properties: + errors: + type: array + items: type: string - description: Line text + 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: array - description: '' - items: - type: object - description: '' - properties: - comment: - type: string - description: '' - name: - type: string - description: '' - type: + 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 - description: '' properties: - filename: - type: string + errors: + type: array + items: + type: string + data: + type: object description: '' + properties: + filename: + type: string + description: '' GetNodesSingleLxcSingleRrddataResponse: description: GetNodesSingleLxcSingleRrddataResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: {} + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' CreateNodesSingleLxcSingleTermproxyResponse: description: CreateNodesSingleLxcSingleTermproxyResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleLxcSingleVncwebsocketResponse: description: GetNodesSingleLxcSingleVncwebsocketResponse content: application/json: schema: type: object - description: '' properties: - port: - type: string + errors: + type: array + items: + type: string + data: + type: object description: '' + properties: + port: + type: string + description: '' CreateNodesSingleLxcSingleSpiceproxyResponse: description: CreateNodesSingleLxcSingleSpiceproxyResponse content: application/json: schema: - type: string - description: >- - Returned values can be directly passed to the 'remote-viewer' - application. + 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: string - description: the task ID. + 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 - description: '' properties: - hasFeature: - type: boolean + errors: + type: array + items: + type: string + data: + type: object description: '' + properties: + hasFeature: + type: boolean + description: '' CreateNodesSingleLxcSingleTemplateResponse: description: CreateNodesSingleLxcSingleTemplateResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' CreateNodesSingleLxcSingleCloneResponse: description: CreateNodesSingleLxcSingleCloneResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' UpdateNodesSingleLxcSingleResizeResponse: description: UpdateNodesSingleLxcSingleResizeResponse content: application/json: schema: - type: string - description: the task ID. + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: the task ID. CreateNodesSingleLxcSingleMovevolumeResponse: description: CreateNodesSingleLxcSingleMovevolumeResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleLxcSinglePendingResponse: description: GetNodesSingleLxcSinglePendingResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: - delete: - type: integer - description: Indicates a pending delete request if present and not 0. - key: + type: object + properties: + errors: + type: array + items: type: string - description: Configuration option name. - pending: - type: string - description: Pending value. - value: - type: string - description: Current value. + 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: array - description: '' - items: - type: object - description: '' - properties: {} + 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 - description: '' + properties: + errors: + type: array + items: + type: string + data: + type: object + description: '' CreateNodesSingleCephOsdResponse: description: CreateNodesSingleCephOsdResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' DeleteNodesSingleCephOsdSingleResponse: description: DeleteNodesSingleCephOsdSingleResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' CreateNodesSingleCephOsdSingleInResponse: description: CreateNodesSingleCephOsdSingleInResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' CreateNodesSingleCephOsdSingleOutResponse: description: CreateNodesSingleCephOsdSingleOutResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' CreateNodesSingleCephOsdSingleScrubResponse: description: CreateNodesSingleCephOsdSingleScrubResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleCephMdsResponse: description: GetNodesSingleCephMdsResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: - addr: + type: object + properties: + errors: + type: array + items: type: string + data: + type: array + description: '' + items: + type: object 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 + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' CreateNodesSingleCephMdsSingleResponse: description: CreateNodesSingleCephMdsSingleResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleCephMgrResponse: description: GetNodesSingleCephMgrResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: - addr: + type: object + properties: + errors: + type: array + items: type: string + data: + type: array + description: '' + items: + type: object description: '' - host: - type: string - description: '' - name: - type: string - description: The name (ID) for the MGR - state: - type: string - description: State of the MGR + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' CreateNodesSingleCephMgrSingleResponse: description: CreateNodesSingleCephMgrSingleResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleCephMonResponse: description: GetNodesSingleCephMonResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: - addr: - type: string - description: '' - host: - type: string - description: '' - name: + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' CreateNodesSingleCephMonSingleResponse: description: CreateNodesSingleCephMonSingleResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleCephFsResponse: description: GetNodesSingleCephFsResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: - data_pool: + type: object + properties: + errors: + type: array + items: 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. + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleCephDisksResponse: description: GetNodesSingleCephDisksResponse content: application/json: schema: - 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: 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleCephConfigdbResponse: description: GetNodesSingleCephConfigdbResponse content: application/json: schema: - 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: 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' CreateNodesSingleCephStopResponse: description: CreateNodesSingleCephStopResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' CreateNodesSingleCephStartResponse: description: CreateNodesSingleCephStartResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' CreateNodesSingleCephRestartResponse: description: CreateNodesSingleCephRestartResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleCephStatusResponse: description: GetNodesSingleCephStatusResponse content: application/json: schema: type: object - description: '' + properties: + errors: + type: array + items: + type: string + data: + type: object + description: '' GetNodesSingleCephPoolsResponse: description: GetNodesSingleCephPoolsResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: - bytes_used: - type: integer - description: '' - crush_rule: - type: integer - description: '' - crush_rule_name: + type: object + properties: + errors: + type: array + items: type: string + data: + type: array + description: '' + items: + type: object 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: '' + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' DeleteNodesSingleCephPoolsSingleResponse: description: DeleteNodesSingleCephPoolsSingleResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' UpdateNodesSingleCephPoolsSingleResponse: description: UpdateNodesSingleCephPoolsSingleResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleCephFlagsResponse: description: GetNodesSingleCephFlagsResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' DeleteNodesSingleCephFlagsSingleResponse: description: DeleteNodesSingleCephFlagsSingleResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' CreateNodesSingleCephFlagsSingleResponse: description: CreateNodesSingleCephFlagsSingleResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleCephCrushResponse: description: GetNodesSingleCephCrushResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleCephLogResponse: description: GetNodesSingleCephLogResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: - 'n': - type: integer - description: Line number - t: + type: object + properties: + errors: + type: array + items: type: string - description: Line text + 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: array - description: '' - items: - type: object - description: '' - properties: {} + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleVzdumpExtractconfigResponse: description: GetNodesSingleVzdumpExtractconfigResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleServicesResponse: description: GetNodesSingleServicesResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: {} + 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: array - description: '' - items: - type: object - description: '' - properties: - subdir: + 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 - description: '' + properties: + errors: + type: array + items: + type: string + data: + type: object + description: '' CreateNodesSingleServicesSingleStartResponse: description: CreateNodesSingleServicesSingleStartResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' CreateNodesSingleServicesSingleStopResponse: description: CreateNodesSingleServicesSingleStopResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' CreateNodesSingleServicesSingleRestartResponse: description: CreateNodesSingleServicesSingleRestartResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' CreateNodesSingleServicesSingleReloadResponse: description: CreateNodesSingleServicesSingleReloadResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' DeleteNodesSingleSubscriptionResponse: description: DeleteNodesSingleSubscriptionResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleSubscriptionResponse: description: GetNodesSingleSubscriptionResponse content: application/json: schema: type: object - description: '' + properties: + errors: + type: array + items: + type: string + data: + type: object + description: '' CreateNodesSingleSubscriptionResponse: description: CreateNodesSingleSubscriptionResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' UpdateNodesSingleSubscriptionResponse: description: UpdateNodesSingleSubscriptionResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' DeleteNodesSingleNetworkResponse: description: DeleteNodesSingleNetworkResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleNetworkResponse: description: GetNodesSingleNetworkResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: {} + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' UpdateNodesSingleNetworkResponse: description: UpdateNodesSingleNetworkResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' DeleteNodesSingleNetworkSingleResponse: description: DeleteNodesSingleNetworkSingleResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleNetworkSingleResponse: description: GetNodesSingleNetworkSingleResponse content: application/json: schema: type: object - description: '' properties: - method: - type: string - description: '' - type: - type: string + 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: string - description: '' - GetNodesSingleTasksResponse: - description: GetNodesSingleTasksResponse - content: - application/json: - schema: - type: array - description: '' - items: - type: object - description: '' - properties: - endtime: - type: integer - description: '' - id: + type: object + properties: + errors: + type: array + items: 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: '' - DeleteNodesSingleTasksSingleResponse: - description: DeleteNodesSingleTasksSingleResponse - content: - application/json: - schema: - type: string - description: '' - GetNodesSingleTasksSingleResponse: - description: GetNodesSingleTasksSingleResponse - content: - application/json: - schema: - type: array - description: '' - items: - type: object - description: '' - properties: {} - GetNodesSingleTasksSingleLogResponse: - description: GetNodesSingleTasksSingleLogResponse - content: - application/json: - schema: - type: array - description: '' - items: - type: object - description: '' - properties: - 'n': - type: integer - description: Line number - t: - type: string - description: Line text - GetNodesSingleTasksSingleStatusResponse: - description: GetNodesSingleTasksSingleStatusResponse + data: + type: string + description: '' + GetNodeTasksResponse: + description: GetNodeTasksResponse content: application/json: schema: type: object - description: '' properties: - pid: - type: integer + errors: + type: array + items: + type: string + data: + type: array description: '' - status: + 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: array - description: '' - items: - type: object - description: '' - properties: - method: + 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: array - description: '' - items: - type: object - description: '' - properties: - pool: + type: object + properties: + errors: + type: array + items: type: string - description: ZFS pool name. + data: + type: array + description: '' + items: + type: object + description: '' + properties: + pool: + type: string + description: ZFS pool name. GetNodesSingleScanNfsResponse: description: GetNodesSingleScanNfsResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: - options: + type: object + properties: + errors: + type: array + items: type: string - description: NFS export options. - path: - type: string - description: The exported path. + 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: array - description: '' - items: - type: object - description: '' - properties: - description: + type: object + properties: + errors: + type: array + items: type: string - description: Descriptive text from server. - share: - type: string - description: The cifs share name. + 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: array - description: '' - items: - type: object - description: '' - properties: - volname: + type: object + properties: + errors: + type: array + items: type: string - description: The volume name. + data: + type: array + description: '' + items: + type: object + description: '' + properties: + volname: + type: string + description: The volume name. GetNodesSingleScanIscsiResponse: description: GetNodesSingleScanIscsiResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: - portal: + type: object + properties: + errors: + type: array + items: type: string - description: The iSCSI portal name. - target: - type: string - description: The iSCSI target name. + 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: array - description: '' - items: - type: object - description: '' - properties: - vg: + type: object + properties: + errors: + type: array + items: type: string - description: The LVM logical volume group name. + 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: array - description: '' - items: - type: object - description: '' - properties: - lv: + type: object + properties: + errors: + type: array + items: type: string - description: The LVM Thin Pool name (LVM logical volume). + 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: 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: 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: array - description: '' - items: - type: object - description: '' - properties: - type: + 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: 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: 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: array - description: '' - items: - type: object - description: '' - properties: - method: + 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: array - description: '' - items: - type: object - description: '' - properties: - available: - type: integer - description: The number of still available instances of this type. - description: + type: object + properties: + errors: + type: array + items: type: string + data: + type: array + description: '' + items: + type: object description: '' - type: - type: string - description: The name of the mdev type. + 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: 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: object + properties: + errors: + type: array + items: 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). + 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: array - description: '' - items: - type: object - description: '' - properties: - subdir: + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleStorageSinglePrunebackupsResponse: description: GetNodesSingleStorageSinglePrunebackupsResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: - ctime: - type: integer - description: Creation time of the backup (seconds since the UNIX epoch). - mark: + type: object + properties: + errors: + type: array + items: 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. + 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: array - description: '' - items: - type: object - description: '' - properties: - ctime: - type: integer - description: Creation time (seconds since the UNIX Epoch). - format: + type: object + properties: + errors: + type: array + items: 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: + data: + type: array + description: '' + items: type: object - description: >- - Last backup verification result, only useful for PBS - storages. + description: '' properties: - state: + ctime: + type: integer + description: Creation time (seconds since the UNIX Epoch). + format: type: string - description: Last backup verification state. - upid: + description: >- + Format identifier ('raw', 'qcow2', 'subvol', 'iso', + 'tgz' ...) + notes: type: string - description: Last backup verification UPID. - vmid: - type: integer - description: Associated Owner VMID. - volid: - type: string - description: Volume identifier. + 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: string - description: Volume identifier + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: Volume identifier DeleteNodesSingleStorageSingleContentSingleResponse: description: DeleteNodesSingleStorageSingleContentSingleResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleStorageSingleContentSingleResponse: description: GetNodesSingleStorageSingleContentSingleResponse content: application/json: schema: 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. + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' UpdateNodesSingleStorageSingleContentSingleResponse: description: UpdateNodesSingleStorageSingleContentSingleResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleStorageSingleStatusResponse: description: GetNodesSingleStorageSingleStatusResponse content: application/json: schema: type: object - description: '' + properties: + errors: + type: array + items: + type: string + data: + type: object + description: '' GetNodesSingleStorageSingleRrdResponse: description: GetNodesSingleStorageSingleRrdResponse content: application/json: schema: type: object - description: '' properties: - filename: - type: string + errors: + type: array + items: + type: string + data: + type: object description: '' + properties: + filename: + type: string + description: '' GetNodesSingleStorageSingleRrddataResponse: description: GetNodesSingleStorageSingleRrddataResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: {} + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleDisksResponse: description: GetNodesSingleDisksResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: {} + 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 - description: '' properties: - children: + 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: - 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: + lv: type: string - description: The name of the volume group - size: + description: The name of the thinpool. + lv_size: type: integer - description: The size of the volume group in bytes - leaf: - type: boolean - description: '' - CreateNodesSingleDisksLvmResponse: - description: CreateNodesSingleDisksLvmResponse - content: - application/json: - schema: - type: string - description: '' - GetNodesSingleDisksLvmthinResponse: - description: GetNodesSingleDisksLvmthinResponse - content: - application/json: - schema: - 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. + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleDisksDirectoryResponse: description: GetNodesSingleDisksDirectoryResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: - device: + type: object + properties: + errors: + type: array + items: 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. + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleDisksZfsResponse: description: GetNodesSingleDisksZfsResponse content: application/json: schema: - 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: object + properties: + errors: + type: array + items: type: string + data: + type: array + description: '' + items: + type: object description: '' - name: - type: string - description: '' - size: - type: integer - 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleDisksZfsSingleResponse: description: GetNodesSingleDisksZfsSingleResponse content: application/json: schema: 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. + 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: 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: 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 - description: '' properties: - attributes: + errors: type: array + items: + type: string + data: + type: object description: '' - health: - type: string - description: '' - text: - type: string - description: '' - type: - type: string - 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleAptResponse: description: GetNodesSingleAptResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: - id: + 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: array - description: '' - items: - type: object - description: '' - properties: {} + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleAptChangelogResponse: description: GetNodesSingleAptChangelogResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleAptVersionsResponse: description: GetNodesSingleAptVersionsResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: {} + 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: array - description: '' - items: - type: object - description: '' - properties: {} + 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: array - description: '' - items: - type: object - description: '' - properties: - pos: - type: integer + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' DeleteNodeFirewallRuleResponse: description: DeleteNodeFirewallRuleResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodeFirewallRuleResponse: description: GetNodeFirewallRuleResponse content: application/json: schema: 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 + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodeFirewallOptionsResponse: description: GetNodeFirewallOptionsResponse content: application/json: schema: 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. + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleFirewallLogResponse: description: GetNodesSingleFirewallLogResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: - 'n': - type: integer - description: Line number - t: + type: object + properties: + errors: + type: array + items: type: string - description: Line text + 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: array - description: '' - items: - type: object - description: '' - properties: - id: + 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: array - description: '' - items: - type: object - description: '' - properties: {} + 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 - description: '' + properties: + errors: + type: array + items: + type: string + data: + type: object + description: '' GetNodesSingleReplicationSingleLogResponse: description: GetNodesSingleReplicationSingleLogResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: - 'n': - type: integer - description: Line number - t: + type: object + properties: + errors: + type: array + items: type: string - description: Line text + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleCertificatesResponse: description: GetNodesSingleCertificatesResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: {} + 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: array - description: '' - items: - type: object - description: '' - properties: {} + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' CreateNodesSingleCertificatesAcmeCertificateResponse: description: CreateNodesSingleCertificatesAcmeCertificateResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' UpdateNodesSingleCertificatesAcmeCertificateResponse: description: UpdateNodesSingleCertificatesAcmeCertificateResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleCertificatesInfoResponse: description: GetNodesSingleCertificatesInfoResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: - filename: + type: object + properties: + errors: + type: array + items: type: string + data: + type: array + description: '' + items: + type: object 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. + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' CreateNodesSingleCertificatesCustomResponse: description: CreateNodesSingleCertificatesCustomResponse content: application/json: schema: 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: + errors: type: array - description: List of Certificate's SubjectAlternativeName entries. items: type: string - description: '' - subject: - type: string - description: Certificate subject name. + 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 - description: '' + properties: + errors: + type: array + items: + type: string + data: + type: object + description: '' UpdateNodesSingleConfigResponse: description: UpdateNodesSingleConfigResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodeSDNResponse: description: GetNodeSDNResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: {} + 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: array - description: '' - items: - type: object - description: '' - properties: - status: + type: object + properties: + errors: + type: array + items: type: string - description: Status of zone - zone: - type: string - description: The SDN zone object identifier. + 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: array - description: '' - items: - type: object - description: '' - properties: - subdir: + 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: array - description: '' - items: - type: object - description: '' - properties: - status: + type: object + properties: + errors: + type: array + items: type: string - description: Status. - statusmsg: - type: string - description: Status details - vnet: - type: string - description: Vnet identifier. + 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 - 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 + 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 - description: '' + properties: + errors: + type: array + items: + type: string + data: + type: object + description: '' CreateNodesSingleStatusResponse: description: CreateNodesSingleStatusResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleNetstatResponse: description: GetNodesSingleNetstatResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: {} + 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: array - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: array + description: '' CreateNodesSingleWakeonlanResponse: description: CreateNodesSingleWakeonlanResponse content: application/json: schema: - type: string - description: MAC address used to assemble the WoL magic packet. + 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 - description: '' properties: - filename: - type: string + errors: + type: array + items: + type: string + data: + type: object description: '' + properties: + filename: + type: string + description: '' GetNodeRRDDataResponse: description: GetNodeRRDDataResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: {} + 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: array - description: '' - items: - type: object - description: '' - properties: - 'n': - type: integer - description: Line number - t: + type: object + properties: + errors: + type: array + items: type: string - description: Line text + 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: array - description: '' - items: - type: string - description: '' + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' CreateNodesSingleTermproxyResponse: description: CreateNodesSingleTermproxyResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleVncwebsocketResponse: description: GetNodesSingleVncwebsocketResponse content: application/json: schema: type: object - description: '' properties: - port: - type: string + errors: + type: array + items: + type: string + data: + type: object description: '' + properties: + port: + type: string + description: '' CreateNodesSingleSpiceshellResponse: description: CreateNodesSingleSpiceshellResponse content: application/json: schema: - type: string - description: >- - Returned values can be directly passed to the 'remote-viewer' - application. + 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 - 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. + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleTimeResponse: description: GetNodesSingleTimeResponse content: application/json: schema: 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 + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleAplinfoResponse: description: GetNodesSingleAplinfoResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: {} + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleReportResponse: description: GetNodesSingleReportResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' CreateNodesSingleStartallResponse: description: CreateNodesSingleStartallResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' CreateNodesSingleStopallResponse: description: CreateNodesSingleStopallResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' CreateNodesSingleMigrateallResponse: description: CreateNodesSingleMigrateallResponse content: application/json: schema: - type: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetNodesSingleHostsResponse: description: GetNodesSingleHostsResponse content: application/json: schema: type: object - description: '' properties: + errors: + type: array + items: + type: string 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. + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetStorageResponse: description: GetStorageResponse content: application/json: schema: - type: array - description: '' - items: - type: object - description: '' - properties: - storage: + 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 - description: '' properties: - config: + errors: + type: array + items: + type: string + data: type: object - description: 'Partial, possible server generated, configuration properties.' + description: '' properties: - encryption-key: + 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, 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. + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetStorageSingleResponse: description: GetStorageSingleResponse content: application/json: schema: type: object - description: '' + properties: + errors: + type: array + items: + type: string + data: + type: object + description: '' UpdateStorageSingleResponse: description: UpdateStorageSingleResponse content: application/json: schema: type: object - description: '' properties: - config: + errors: + type: array + items: + type: string + data: type: object - description: 'Partial, possible server generated, configuration properties.' + description: '' properties: - encryption-key: + 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, 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. + 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: array - description: '' - items: - type: object - description: '' - properties: - subdir: + 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: array - description: '' - items: - type: object - description: '' - properties: - comment: + type: object + properties: + errors: + type: array + items: type: string + data: + type: array + description: '' + items: + type: object description: '' - email: + 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 - 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: + data: + type: string + description: '' + DeleteAccessUsersSingleResponse: + description: DeleteAccessUsersSingleResponse + content: + application/json: + schema: + type: object + properties: + errors: + type: array + items: type: string - description: '' - groups: + data: + type: string + description: '' + GetAccessUsersSingleResponse: + description: GetAccessUsersSingleResponse + content: + application/json: + schema: + type: object + properties: + errors: + type: array + items: type: string - description: '' - keys: + 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 - description: Keys for two factor auth (yubico). - lastname: + 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: '' - tokens: - type: array - description: '' - items: + 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: @@ -19978,158 +23314,23 @@ components: 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: string - description: '' - DeleteAccessUsersSingleResponse: - description: DeleteAccessUsersSingleResponse - content: - application/json: - schema: - type: string - description: '' - GetAccessUsersSingleResponse: - description: GetAccessUsersSingleResponse + value: + type: string + description: API token value used for authentication. + UpdateAccessUsersSingleTokenSingleResponse: + description: UpdateAccessUsersSingleTokenSingleResponse content: application/json: schema: 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: + errors: type: array - description: '' items: type: string - description: '' - keys: - type: string - description: Keys for two factor auth (yubico). - lastname: - type: string - description: '' - tokens: + data: type: object - description: '' - UpdateAccessUsersSingleResponse: - description: UpdateAccessUsersSingleResponse - content: - application/json: - schema: - type: string - description: '' - GetAccessUsersSingleTfaResponse: - description: GetAccessUsersSingleTfaResponse - content: - application/json: - schema: - 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: 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: string - description: '' - GetAccessUsersSingleTokenSingleResponse: - description: GetAccessUsersSingleTokenSingleResponse - content: - application/json: - schema: - 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 - description: '' - properties: - full-tokenid: - type: string - description: The full token id. - info: - type: object - description: '' + description: Updated token information. properties: comment: type: string @@ -20144,476 +23345,662 @@ components: 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 - 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: 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: string - description: '' - DeleteAccessGroupsSingleResponse: - description: DeleteAccessGroupsSingleResponse - content: - application/json: - schema: - type: string - description: '' - GetAccessGroupsSingleResponse: - description: GetAccessGroupsSingleResponse content: application/json: schema: type: object - description: '' properties: - comment: - type: string - description: '' - members: + errors: type: array - description: '' items: type: string - description: User ID - UpdateAccessGroupsSingleResponse: - description: UpdateAccessGroupsSingleResponse - content: - application/json: - schema: - type: string - description: '' - GetAccessRolesResponse: - description: GetAccessRolesResponse - content: - application/json: - schema: - 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: string - description: '' - DeleteAccessRolesSingleResponse: - description: DeleteAccessRolesSingleResponse - content: - application/json: - schema: - type: string - description: '' - GetAccessRolesSingleResponse: - description: GetAccessRolesSingleResponse - content: - application/json: - schema: - 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: string - description: '' - GetAccessAclResponse: - description: GetAccessAclResponse - content: - application/json: - schema: - 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: string - description: '' - GetAccessDomainsResponse: - description: GetAccessDomainsResponse - content: - application/json: - schema: - 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: string - description: '' - DeleteAccessDomainsSingleResponse: - description: DeleteAccessDomainsSingleResponse - content: - application/json: - schema: - type: string - description: '' - GetAccessDomainsSingleResponse: - description: GetAccessDomainsSingleResponse - content: - application/json: - schema: - type: string - description: '' - UpdateAccessDomainsSingleResponse: - description: UpdateAccessDomainsSingleResponse - content: - application/json: - schema: - type: string - description: '' - CreateAccessDomainsSingleSyncResponse: - description: CreateAccessDomainsSingleSyncResponse - content: - application/json: - schema: - type: string - description: Worker Task-UPID - GetAccessTicketResponse: - description: GetAccessTicketResponse - content: - application/json: - schema: - type: string - description: '' - CreateAccessTicketResponse: - description: CreateAccessTicketResponse - content: - application/json: - schema: - 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: string - description: '' - CreateAccessTfaResponse: - description: CreateAccessTfaResponse - content: - application/json: - schema: - type: object - description: '' - properties: - ticket: - type: string - description: '' - UpdateAccessTfaResponse: - description: UpdateAccessTfaResponse - content: - application/json: - schema: - type: object - description: '' - GetAccessPermissionsResponse: - description: GetAccessPermissionsResponse - content: - application/json: - schema: - type: object - description: Map of "path" => (Map of "privilege" => "propagate boolean"). - GetPoolsResponse: - description: GetPoolsResponse - content: - application/json: - schema: - type: array - description: '' - items: - type: object - description: '' - properties: - poolid: - type: string - description: '' - CreatePoolResponse: - description: CreatePoolResponse - content: - application/json: - schema: - type: string - description: '' - DeletePoolResponse: - description: DeletePoolResponse - content: - application/json: - schema: - type: string - description: '' - GetPoolResponse: - description: GetPoolResponse - content: - application/json: - schema: - type: object - description: '' - properties: - comment: - type: string - description: '' - members: + data: type: array description: '' items: type: object description: '' properties: - id: + comment: type: string description: '' - node: + groupid: type: string description: '' - storage: + 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: '' - vmid: - type: integer + 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: string - description: '' + type: object + properties: + errors: + type: array + items: + type: string + data: + type: string + description: '' GetVersionResponse: description: GetVersionResponse content: application/json: schema: type: object - description: '' properties: - release: - type: string - description: '' - repoid: - type: string - description: '' - version: - type: string + errors: + type: array + items: + type: string + data: + type: object description: '' + properties: + release: + type: string + description: '' + repoid: + type: string + description: '' + version: + type: string + description: ''