openapi: 3.0.0 info: title: ProxMox VE API version: "2.0" description: ProxMox VE API contact: name: LUMASERV Support Team email: support@lumaserv.com servers: - description: local url: "https://cluster.local:8006/api2/json" tags: - name: cluster - name: nodes - name: storage - name: access - name: pools - name: version paths: /cluster: get: operationId: getCluster summary: getCluster description: Cluster index. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterResponse" /cluster/replication: get: operationId: getClusterReplication summary: getClusterReplication description: List replication jobs. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterReplicationResponse" post: operationId: createClusterReplication summary: createClusterReplication description: Create a new replication job tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/CreateClusterReplicationResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateClusterReplicationRequest" "/cluster/replication/{id}": delete: operationId: deleteClusterReplicationSingle summary: deleteClusterReplicationSingle description: Mark replication job for removal. tags: - cluster parameters: - name: id in: path required: true description: id schema: type: string responses: "200": $ref: "#/components/responses/DeleteClusterReplicationSingleResponse" get: operationId: getClusterReplicationSingle summary: getClusterReplicationSingle description: Read replication job configuration. tags: - cluster parameters: - name: id in: path required: true description: id schema: type: string responses: "200": $ref: "#/components/responses/GetClusterReplicationSingleResponse" put: operationId: updateClusterReplicationSingle summary: updateClusterReplicationSingle description: Update replication job configuration. tags: - cluster parameters: - name: id in: path required: true description: id schema: type: string responses: "200": $ref: "#/components/responses/UpdateClusterReplicationSingleResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateClusterReplicationSingleRequest" /cluster/metrics: get: operationId: getClusterMetrics summary: getClusterMetrics description: Metrics index. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterMetricsResponse" /cluster/metrics/server: get: operationId: getClusterMetricsServer summary: getClusterMetricsServer description: List configured metric servers. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterMetricsServerResponse" "/cluster/metrics/server/{id}": delete: operationId: deleteClusterMetricsServerSingle summary: deleteClusterMetricsServerSingle description: Remove Metric server. tags: - cluster parameters: - name: id in: path required: true description: id schema: type: string responses: "200": $ref: "#/components/responses/DeleteClusterMetricsServerSingleResponse" get: operationId: getClusterMetricsServerSingle summary: getClusterMetricsServerSingle description: Read metric server configuration. tags: - cluster parameters: - name: id in: path required: true description: id schema: type: string responses: "200": $ref: "#/components/responses/GetClusterMetricsServerSingleResponse" post: operationId: createClusterMetricsServerSingle summary: createClusterMetricsServerSingle description: Create a new external metric server config tags: - cluster parameters: - name: id in: path required: true description: id schema: type: string responses: "200": $ref: "#/components/responses/CreateClusterMetricsServerSingleResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateClusterMetricsServerSingleRequest" put: operationId: updateClusterMetricsServerSingle summary: updateClusterMetricsServerSingle description: Update metric server configuration. tags: - cluster parameters: - name: id in: path required: true description: id schema: type: string responses: "200": $ref: "#/components/responses/UpdateClusterMetricsServerSingleResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateClusterMetricsServerSingleRequest" /cluster/metrics/export: get: operationId: getClusterMetricsExport summary: getClusterMetricsExport description: Retrieve metrics of the cluster. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterMetricsExportResponse" /cluster/notifications: get: operationId: getClusterNotifications summary: getClusterNotifications description: Index for notification-related API endpoints. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterNotificationsResponse" /cluster/notifications/matcher-fields: get: operationId: getClusterNotificationsMatcherfields summary: getClusterNotificationsMatcherfields description: Returns known notification metadata fields tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterNotificationsMatcherfieldsResponse" /cluster/notifications/matcher-field-values: get: operationId: getClusterNotificationsMatcherfieldvalues summary: getClusterNotificationsMatcherfieldvalues description: Returns known notification metadata fields and their known values tags: - cluster parameters: [] responses: "200": $ref: >- #/components/responses/GetClusterNotificationsMatcherfieldvaluesResponse /cluster/notifications/endpoints: get: operationId: getClusterNotificationsEndpoints summary: getClusterNotificationsEndpoints description: Index for all available endpoint types. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterNotificationsEndpointsResponse" /cluster/notifications/endpoints/sendmail: get: operationId: getClusterNotificationsEndpointsSendmail summary: getClusterNotificationsEndpointsSendmail description: Returns a list of all sendmail endpoints tags: - cluster parameters: [] responses: "200": $ref: >- #/components/responses/GetClusterNotificationsEndpointsSendmailResponse post: operationId: createClusterNotificationsEndpointsSendmail summary: createClusterNotificationsEndpointsSendmail description: Create a new sendmail endpoint tags: - cluster parameters: [] responses: "200": $ref: >- #/components/responses/CreateClusterNotificationsEndpointsSendmailResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateClusterNotificationsEndpointsSendmailRequest "/cluster/notifications/endpoints/sendmail/{name}": delete: operationId: deleteClusterNotificationsEndpointsSendmailSingle summary: deleteClusterNotificationsEndpointsSendmailSingle description: Remove sendmail endpoint tags: - cluster parameters: - name: name in: path required: true description: name schema: type: string responses: "200": $ref: >- #/components/responses/DeleteClusterNotificationsEndpointsSendmailSingleResponse get: operationId: getClusterNotificationsEndpointsSendmailSingle summary: getClusterNotificationsEndpointsSendmailSingle description: Return a specific sendmail endpoint tags: - cluster parameters: - name: name in: path required: true description: name schema: type: string responses: "200": $ref: >- #/components/responses/GetClusterNotificationsEndpointsSendmailSingleResponse put: operationId: updateClusterNotificationsEndpointsSendmailSingle summary: updateClusterNotificationsEndpointsSendmailSingle description: Update existing sendmail endpoint tags: - cluster parameters: - name: name in: path required: true description: name schema: type: string responses: "200": $ref: >- #/components/responses/UpdateClusterNotificationsEndpointsSendmailSingleResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/UpdateClusterNotificationsEndpointsSendmailSingleRequest /cluster/notifications/endpoints/gotify: get: operationId: getClusterNotificationsEndpointsGotify summary: getClusterNotificationsEndpointsGotify description: Returns a list of all gotify endpoints tags: - cluster parameters: [] responses: "200": $ref: >- #/components/responses/GetClusterNotificationsEndpointsGotifyResponse post: operationId: createClusterNotificationsEndpointsGotify summary: createClusterNotificationsEndpointsGotify description: Create a new gotify endpoint tags: - cluster parameters: [] responses: "200": $ref: >- #/components/responses/CreateClusterNotificationsEndpointsGotifyResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateClusterNotificationsEndpointsGotifyRequest "/cluster/notifications/endpoints/gotify/{name}": delete: operationId: deleteClusterNotificationsEndpointsGotifySingle summary: deleteClusterNotificationsEndpointsGotifySingle description: Remove gotify endpoint tags: - cluster parameters: - name: name in: path required: true description: name schema: type: string responses: "200": $ref: >- #/components/responses/DeleteClusterNotificationsEndpointsGotifySingleResponse get: operationId: getClusterNotificationsEndpointsGotifySingle summary: getClusterNotificationsEndpointsGotifySingle description: Return a specific gotify endpoint tags: - cluster parameters: - name: name in: path required: true description: name schema: type: string responses: "200": $ref: >- #/components/responses/GetClusterNotificationsEndpointsGotifySingleResponse put: operationId: updateClusterNotificationsEndpointsGotifySingle summary: updateClusterNotificationsEndpointsGotifySingle description: Update existing gotify endpoint tags: - cluster parameters: - name: name in: path required: true description: name schema: type: string responses: "200": $ref: >- #/components/responses/UpdateClusterNotificationsEndpointsGotifySingleResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/UpdateClusterNotificationsEndpointsGotifySingleRequest /cluster/notifications/endpoints/smtp: get: operationId: getClusterNotificationsEndpointsSmtp summary: getClusterNotificationsEndpointsSmtp description: Returns a list of all smtp endpoints tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterNotificationsEndpointsSmtpResponse" post: operationId: createClusterNotificationsEndpointsSmtp summary: createClusterNotificationsEndpointsSmtp description: Create a new smtp endpoint tags: - cluster parameters: [] responses: "200": $ref: >- #/components/responses/CreateClusterNotificationsEndpointsSmtpResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateClusterNotificationsEndpointsSmtpRequest "/cluster/notifications/endpoints/smtp/{name}": delete: operationId: deleteClusterNotificationsEndpointsSmtpSingle summary: deleteClusterNotificationsEndpointsSmtpSingle description: Remove smtp endpoint tags: - cluster parameters: - name: name in: path required: true description: name schema: type: string responses: "200": $ref: >- #/components/responses/DeleteClusterNotificationsEndpointsSmtpSingleResponse get: operationId: getClusterNotificationsEndpointsSmtpSingle summary: getClusterNotificationsEndpointsSmtpSingle description: Return a specific smtp endpoint tags: - cluster parameters: - name: name in: path required: true description: name schema: type: string responses: "200": $ref: >- #/components/responses/GetClusterNotificationsEndpointsSmtpSingleResponse put: operationId: updateClusterNotificationsEndpointsSmtpSingle summary: updateClusterNotificationsEndpointsSmtpSingle description: Update existing smtp endpoint tags: - cluster parameters: - name: name in: path required: true description: name schema: type: string responses: "200": $ref: >- #/components/responses/UpdateClusterNotificationsEndpointsSmtpSingleResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/UpdateClusterNotificationsEndpointsSmtpSingleRequest /cluster/notifications/endpoints/webhook: get: operationId: getClusterNotificationsEndpointsWebhook summary: getClusterNotificationsEndpointsWebhook description: Returns a list of all webhook endpoints tags: - cluster parameters: [] responses: "200": $ref: >- #/components/responses/GetClusterNotificationsEndpointsWebhookResponse post: operationId: createClusterNotificationsEndpointsWebhook summary: createClusterNotificationsEndpointsWebhook description: Create a new webhook endpoint tags: - cluster parameters: [] responses: "200": $ref: >- #/components/responses/CreateClusterNotificationsEndpointsWebhookResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateClusterNotificationsEndpointsWebhookRequest "/cluster/notifications/endpoints/webhook/{name}": delete: operationId: deleteClusterNotificationsEndpointsWebhookSingle summary: deleteClusterNotificationsEndpointsWebhookSingle description: Remove webhook endpoint tags: - cluster parameters: - name: name in: path required: true description: name schema: type: string responses: "200": $ref: >- #/components/responses/DeleteClusterNotificationsEndpointsWebhookSingleResponse get: operationId: getClusterNotificationsEndpointsWebhookSingle summary: getClusterNotificationsEndpointsWebhookSingle description: Return a specific webhook endpoint tags: - cluster parameters: - name: name in: path required: true description: name schema: type: string responses: "200": $ref: >- #/components/responses/GetClusterNotificationsEndpointsWebhookSingleResponse put: operationId: updateClusterNotificationsEndpointsWebhookSingle summary: updateClusterNotificationsEndpointsWebhookSingle description: Update existing webhook endpoint tags: - cluster parameters: - name: name in: path required: true description: name schema: type: string responses: "200": $ref: >- #/components/responses/UpdateClusterNotificationsEndpointsWebhookSingleResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/UpdateClusterNotificationsEndpointsWebhookSingleRequest /cluster/notifications/targets: get: operationId: getClusterNotificationsTargets summary: getClusterNotificationsTargets description: Returns a list of all entities that can be used as notification targets. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterNotificationsTargetsResponse" "/cluster/notifications/targets/{name}/test": post: operationId: createClusterNotificationsTargetsSingleTest summary: createClusterNotificationsTargetsSingleTest description: Send a test notification to a provided target. tags: - cluster parameters: - name: name in: path required: true description: name schema: type: string responses: "200": $ref: >- #/components/responses/CreateClusterNotificationsTargetsSingleTestResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateClusterNotificationsTargetsSingleTestRequest /cluster/notifications/matchers: get: operationId: getClusterNotificationsMatchers summary: getClusterNotificationsMatchers description: Returns a list of all matchers tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterNotificationsMatchersResponse" post: operationId: createClusterNotificationsMatchers summary: createClusterNotificationsMatchers description: Create a new matcher tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/CreateClusterNotificationsMatchersResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateClusterNotificationsMatchersRequest" "/cluster/notifications/matchers/{name}": delete: operationId: deleteClusterNotificationsMatchersSingle summary: deleteClusterNotificationsMatchersSingle description: Remove matcher tags: - cluster parameters: - name: name in: path required: true description: name schema: type: string responses: "200": $ref: >- #/components/responses/DeleteClusterNotificationsMatchersSingleResponse get: operationId: getClusterNotificationsMatchersSingle summary: getClusterNotificationsMatchersSingle description: Return a specific matcher tags: - cluster parameters: - name: name in: path required: true description: name schema: type: string responses: "200": $ref: "#/components/responses/GetClusterNotificationsMatchersSingleResponse" put: operationId: updateClusterNotificationsMatchersSingle summary: updateClusterNotificationsMatchersSingle description: Update existing matcher tags: - cluster parameters: - name: name in: path required: true description: name schema: type: string responses: "200": $ref: >- #/components/responses/UpdateClusterNotificationsMatchersSingleResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/UpdateClusterNotificationsMatchersSingleRequest /cluster/config: get: operationId: getClusterConfig summary: getClusterConfig description: Directory index. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterConfigResponse" post: operationId: createClusterConfig summary: createClusterConfig description: >- Generate new cluster configuration. If no links given, default to local IP address as link0. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/CreateClusterConfigResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateClusterConfigRequest" /cluster/config/apiversion: get: operationId: getClusterConfigApiversion summary: getClusterConfigApiversion description: Return the version of the cluster join API available on this node. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterConfigApiversionResponse" /cluster/config/nodes: get: operationId: getClusterConfigNodes summary: getClusterConfigNodes description: Corosync node list. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterConfigNodesResponse" "/cluster/config/nodes/{node}": delete: operationId: deleteClusterConfigNodesSingle summary: deleteClusterConfigNodesSingle description: Removes a node from the cluster configuration. tags: - cluster parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/DeleteClusterConfigNodesSingleResponse" post: operationId: createClusterConfigNodesSingle summary: createClusterConfigNodesSingle description: Adds a node to the cluster configuration. This call is for internal use. tags: - cluster parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/CreateClusterConfigNodesSingleResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateClusterConfigNodesSingleRequest" /cluster/config/join: get: operationId: getClusterConfigJoin summary: getClusterConfigJoin description: Get information needed to join this cluster over the connected node. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterConfigJoinResponse" post: operationId: createClusterConfigJoin summary: createClusterConfigJoin description: >- Joins this node into an existing cluster. If no links are given, default to IP resolved by node's hostname on single link (fallback fails for clusters with multiple links). tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/CreateClusterConfigJoinResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateClusterConfigJoinRequest" /cluster/config/totem: get: operationId: getClusterConfigTotem summary: getClusterConfigTotem description: Get corosync totem protocol settings. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterConfigTotemResponse" /cluster/config/qdevice: get: operationId: getClusterConfigQdevice summary: getClusterConfigQdevice description: Get QDevice status tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterConfigQdeviceResponse" /cluster/firewall: get: operationId: getClusterFirewall summary: getClusterFirewall description: Directory index. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterFirewallResponse" /cluster/firewall/groups: get: operationId: getClusterFirewallGroups summary: getClusterFirewallGroups description: List security groups. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterFirewallGroupsResponse" post: operationId: createClusterFirewallGroup summary: createClusterFirewallGroup description: Create new security group. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/CreateClusterFirewallGroupResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateClusterFirewallGroupRequest" "/cluster/firewall/groups/{group}": delete: operationId: deleteClusterFirewallGroup summary: deleteClusterFirewallGroup description: Delete security group. tags: - cluster parameters: - name: group in: path required: true description: group schema: type: string responses: "200": $ref: "#/components/responses/DeleteClusterFirewallGroupResponse" get: operationId: getClusterFirewallGroupRules summary: getClusterFirewallGroupRules description: List rules. tags: - cluster parameters: - name: group in: path required: true description: group schema: type: string responses: "200": $ref: "#/components/responses/GetClusterFirewallGroupRulesResponse" post: operationId: addClusterFirewallGroupRule summary: addClusterFirewallGroupRule description: Create new rule. tags: - cluster parameters: - name: group in: path required: true description: group schema: type: string responses: "200": $ref: "#/components/responses/AddClusterFirewallGroupRuleResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/AddClusterFirewallGroupRuleRequest" "/cluster/firewall/groups/{group}/{pos}": delete: operationId: removeClusterFirewallGroupRule summary: removeClusterFirewallGroupRule description: Delete rule. tags: - cluster parameters: - name: group in: path required: true description: group schema: type: string - name: pos in: path required: true description: pos schema: type: integer responses: "200": $ref: "#/components/responses/RemoveClusterFirewallGroupRuleResponse" get: operationId: getClusterFirewallGroupRule summary: getClusterFirewallGroupRule description: Get single rule data. tags: - cluster parameters: - name: group in: path required: true description: group schema: type: string - name: pos in: path required: true description: pos schema: type: integer responses: "200": $ref: "#/components/responses/GetClusterFirewallGroupRuleResponse" put: operationId: updateClusterFirewallGroupRule summary: updateClusterFirewallGroupRule description: Modify rule data. tags: - cluster parameters: - name: group in: path required: true description: group schema: type: string - name: pos in: path required: true description: pos schema: type: integer responses: "200": $ref: "#/components/responses/UpdateClusterFirewallGroupRuleResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateClusterFirewallGroupRuleRequest" /cluster/firewall/rules: get: operationId: getClusterFirewallRules summary: getClusterFirewallRules description: List rules. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterFirewallRulesResponse" post: operationId: addClusterFirewallRule summary: addClusterFirewallRule description: Create new rule. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/AddClusterFirewallRuleResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/AddClusterFirewallRuleRequest" "/cluster/firewall/rules/{pos}": delete: operationId: removeClusterFirewallRule summary: removeClusterFirewallRule description: Delete rule. tags: - cluster parameters: - name: pos in: path required: true description: pos schema: type: integer responses: "200": $ref: "#/components/responses/RemoveClusterFirewallRuleResponse" get: operationId: getClusterFirewallRule summary: getClusterFirewallRule description: Get single rule data. tags: - cluster parameters: - name: pos in: path required: true description: pos schema: type: integer responses: "200": $ref: "#/components/responses/GetClusterFirewallRuleResponse" put: operationId: updateClusterFirewallRule summary: updateClusterFirewallRule description: Modify rule data. tags: - cluster parameters: - name: pos in: path required: true description: pos schema: type: integer responses: "200": $ref: "#/components/responses/UpdateClusterFirewallRuleResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateClusterFirewallRuleRequest" /cluster/firewall/ipset: get: operationId: getClusterFirewallIPSets summary: getClusterFirewallIPSets description: List IPSets tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterFirewallIPSetsResponse" post: operationId: createClusterFirewallIPSet summary: createClusterFirewallIPSet description: Create new IPSet tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/CreateClusterFirewallIPSetResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateClusterFirewallIPSetRequest" "/cluster/firewall/ipset/{name}": delete: operationId: deleteClusterFirewallIPSet summary: deleteClusterFirewallIPSet description: Delete IPSet tags: - cluster parameters: - name: name in: path required: true description: name schema: type: string responses: "200": $ref: "#/components/responses/DeleteClusterFirewallIPSetResponse" get: operationId: getClusterFirewallIPSet summary: getClusterFirewallIPSet description: List IPSet content tags: - cluster parameters: - name: name in: path required: true description: name schema: type: string responses: "200": $ref: "#/components/responses/GetClusterFirewallIPSetResponse" post: operationId: addClusterFirewallIPSetIP summary: addClusterFirewallIPSetIP description: Add IP or Network to IPSet. tags: - cluster parameters: - name: name in: path required: true description: name schema: type: string responses: "200": $ref: "#/components/responses/AddClusterFirewallIPSetIPResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/AddClusterFirewallIPSetIPRequest" "/cluster/firewall/ipset/{name}/{cidr}": delete: operationId: removeClusterFirewallIPSetIP summary: removeClusterFirewallIPSetIP description: Remove IP or Network from IPSet. tags: - cluster parameters: - name: cidr in: path required: true description: cidr schema: type: string - name: name in: path required: true description: name schema: type: string responses: "200": $ref: "#/components/responses/RemoveClusterFirewallIPSetIPResponse" get: operationId: getClusterFirewallIPSetIP summary: getClusterFirewallIPSetIP description: Read IP or Network settings from IPSet. tags: - cluster parameters: - name: cidr in: path required: true description: cidr schema: type: string - name: name in: path required: true description: name schema: type: string responses: "200": $ref: "#/components/responses/GetClusterFirewallIPSetIPResponse" put: operationId: updateClusterFirewallIPSetIP summary: updateClusterFirewallIPSetIP description: Update IP or Network settings tags: - cluster parameters: - name: cidr in: path required: true description: cidr schema: type: string - name: name in: path required: true description: name schema: type: string responses: "200": $ref: "#/components/responses/UpdateClusterFirewallIPSetIPResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateClusterFirewallIPSetIPRequest" /cluster/firewall/aliases: get: operationId: getClusterFirewallAliases summary: getClusterFirewallAliases description: List aliases tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterFirewallAliasesResponse" post: operationId: createClusterFirewallAliases summary: createClusterFirewallAliases description: Create IP or Network Alias. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/CreateClusterFirewallAliasesResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateClusterFirewallAliasesRequest" "/cluster/firewall/aliases/{name}": delete: operationId: deleteClusterFirewallAliasesSingle summary: deleteClusterFirewallAliasesSingle description: Remove IP or Network alias. tags: - cluster parameters: - name: name in: path required: true description: name schema: type: string responses: "200": $ref: "#/components/responses/DeleteClusterFirewallAliasesSingleResponse" get: operationId: getClusterFirewallAliasesSingle summary: getClusterFirewallAliasesSingle description: Read alias. tags: - cluster parameters: - name: name in: path required: true description: name schema: type: string responses: "200": $ref: "#/components/responses/GetClusterFirewallAliasesSingleResponse" put: operationId: updateClusterFirewallAliasesSingle summary: updateClusterFirewallAliasesSingle description: Update IP or Network alias. tags: - cluster parameters: - name: name in: path required: true description: name schema: type: string responses: "200": $ref: "#/components/responses/UpdateClusterFirewallAliasesSingleResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateClusterFirewallAliasesSingleRequest" /cluster/firewall/options: get: operationId: getClusterFirewallOptions summary: getClusterFirewallOptions description: Get Firewall options. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterFirewallOptionsResponse" put: operationId: updateClusterFirewallOptions summary: updateClusterFirewallOptions description: Set Firewall options. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/UpdateClusterFirewallOptionsResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateClusterFirewallOptionsRequest" /cluster/firewall/macros: get: operationId: getClusterFirewallMacros summary: getClusterFirewallMacros description: List available macros tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterFirewallMacrosResponse" /cluster/firewall/refs: get: operationId: getClusterFirewallRefs summary: getClusterFirewallRefs description: >- Lists possible IPSet/Alias reference which are allowed in source/dest properties. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterFirewallRefsResponse" /cluster/backup: get: operationId: getClusterBackup summary: getClusterBackup description: List vzdump backup schedule. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterBackupResponse" post: operationId: createClusterBackup summary: createClusterBackup description: Create new vzdump backup job. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/CreateClusterBackupResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateClusterBackupRequest" "/cluster/backup/{id}": delete: operationId: deleteClusterBackupSingle summary: deleteClusterBackupSingle description: Delete vzdump backup job definition. tags: - cluster parameters: - name: id in: path required: true description: id schema: type: string responses: "200": $ref: "#/components/responses/DeleteClusterBackupSingleResponse" get: operationId: getClusterBackupSingle summary: getClusterBackupSingle description: Read vzdump backup job definition. tags: - cluster parameters: - name: id in: path required: true description: id schema: type: string responses: "200": $ref: "#/components/responses/GetClusterBackupSingleResponse" put: operationId: updateClusterBackupSingle summary: updateClusterBackupSingle description: Update vzdump backup job definition. tags: - cluster parameters: - name: id in: path required: true description: id schema: type: string responses: "200": $ref: "#/components/responses/UpdateClusterBackupSingleResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateClusterBackupSingleRequest" "/cluster/backup/{id}/included_volumes": get: operationId: getClusterBackupSingleIncludedvolumes summary: getClusterBackupSingleIncludedvolumes description: >- Returns included guests and the backup status of their disks. Optimized to be used in ExtJS tree views. tags: - cluster parameters: - name: id in: path required: true description: id schema: type: string responses: "200": $ref: "#/components/responses/GetClusterBackupSingleIncludedvolumesResponse" /cluster/backup-info: get: operationId: getClusterBackupinfo summary: getClusterBackupinfo description: Index for backup info related endpoints tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterBackupinfoResponse" /cluster/backup-info/not-backed-up: get: operationId: getClusterBackupinfoNotbackedup summary: getClusterBackupinfoNotbackedup description: Shows all guests which are not covered by any backup job. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterBackupinfoNotbackedupResponse" /cluster/ha: get: operationId: getClusterHa summary: getClusterHa description: Directory index. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterHaResponse" /cluster/ha/resources: get: operationId: getClusterHaResources summary: getClusterHaResources description: List HA resources. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterHaResourcesResponse" post: operationId: createClusterHaResources summary: createClusterHaResources description: Create a new HA resource. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/CreateClusterHaResourcesResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateClusterHaResourcesRequest" "/cluster/ha/resources/{sid}": delete: operationId: deleteClusterHaResourcesSingle summary: deleteClusterHaResourcesSingle description: Delete resource configuration. tags: - cluster parameters: - name: sid in: path required: true description: sid schema: type: string responses: "200": $ref: "#/components/responses/DeleteClusterHaResourcesSingleResponse" get: operationId: getClusterHaResourcesSingle summary: getClusterHaResourcesSingle description: Read resource configuration. tags: - cluster parameters: - name: sid in: path required: true description: sid schema: type: string responses: "200": $ref: "#/components/responses/GetClusterHaResourcesSingleResponse" put: operationId: updateClusterHaResourcesSingle summary: updateClusterHaResourcesSingle description: Update resource configuration. tags: - cluster parameters: - name: sid in: path required: true description: sid schema: type: string responses: "200": $ref: "#/components/responses/UpdateClusterHaResourcesSingleResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateClusterHaResourcesSingleRequest" "/cluster/ha/resources/{sid}/migrate": post: operationId: createClusterHaResourcesSingleMigrate summary: createClusterHaResourcesSingleMigrate description: Request resource migration (online) to another node. tags: - cluster parameters: - name: sid in: path required: true description: sid schema: type: string responses: "200": $ref: "#/components/responses/CreateClusterHaResourcesSingleMigrateResponse" requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateClusterHaResourcesSingleMigrateRequest "/cluster/ha/resources/{sid}/relocate": post: operationId: createClusterHaResourcesSingleRelocate summary: createClusterHaResourcesSingleRelocate description: >- Request resource relocatzion to another node. This stops the service on the old node, and restarts it on the target node. tags: - cluster parameters: - name: sid in: path required: true description: sid schema: type: string responses: "200": $ref: >- #/components/responses/CreateClusterHaResourcesSingleRelocateResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateClusterHaResourcesSingleRelocateRequest /cluster/ha/groups: get: operationId: getClusterHaGroups summary: getClusterHaGroups description: Get HA groups. (deprecated in favor of HA rules) tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterHaGroupsResponse" post: operationId: createClusterHaGroups summary: createClusterHaGroups description: Create a new HA group. (deprecated in favor of HA rules) tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/CreateClusterHaGroupsResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateClusterHaGroupsRequest" "/cluster/ha/groups/{group}": delete: operationId: deleteClusterHaGroupsSingle summary: deleteClusterHaGroupsSingle description: Delete ha group configuration. (deprecated in favor of HA rules) tags: - cluster parameters: - name: group in: path required: true description: group schema: type: string responses: "200": $ref: "#/components/responses/DeleteClusterHaGroupsSingleResponse" get: operationId: getClusterHaGroupsSingle summary: getClusterHaGroupsSingle description: Read ha group configuration. (deprecated in favor of HA rules) tags: - cluster parameters: - name: group in: path required: true description: group schema: type: string responses: "200": $ref: "#/components/responses/GetClusterHaGroupsSingleResponse" put: operationId: updateClusterHaGroupsSingle summary: updateClusterHaGroupsSingle description: Update ha group configuration. (deprecated in favor of HA rules) tags: - cluster parameters: - name: group in: path required: true description: group schema: type: string responses: "200": $ref: "#/components/responses/UpdateClusterHaGroupsSingleResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateClusterHaGroupsSingleRequest" /cluster/ha/rules: get: operationId: getClusterHaRules summary: getClusterHaRules description: Get HA rules. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterHaRulesResponse" post: operationId: createClusterHaRules summary: createClusterHaRules description: Create HA rule. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/CreateClusterHaRulesResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateClusterHaRulesRequest" "/cluster/ha/rules/{rule}": delete: operationId: deleteClusterHaRulesSingle summary: deleteClusterHaRulesSingle description: Delete HA rule. tags: - cluster parameters: - name: rule in: path required: true description: rule schema: type: string responses: "200": $ref: "#/components/responses/DeleteClusterHaRulesSingleResponse" get: operationId: getClusterHaRulesSingle summary: getClusterHaRulesSingle description: Read HA rule. tags: - cluster parameters: - name: rule in: path required: true description: rule schema: type: string responses: "200": $ref: "#/components/responses/GetClusterHaRulesSingleResponse" put: operationId: updateClusterHaRulesSingle summary: updateClusterHaRulesSingle description: Update HA rule. tags: - cluster parameters: - name: rule in: path required: true description: rule schema: type: string responses: "200": $ref: "#/components/responses/UpdateClusterHaRulesSingleResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateClusterHaRulesSingleRequest" /cluster/ha/status: get: operationId: getClusterHaStatus summary: getClusterHaStatus description: Directory index. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterHaStatusResponse" /cluster/ha/status/current: get: operationId: getClusterHaStatusCurrent summary: getClusterHaStatusCurrent description: Get HA manger status. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterHaStatusCurrentResponse" /cluster/ha/status/manager_status: get: operationId: getClusterHaStatusManagerstatus summary: getClusterHaStatusManagerstatus description: "Get full HA manger status, including LRM status." tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterHaStatusManagerstatusResponse" /cluster/acme: get: operationId: getClusterAcme summary: getClusterAcme description: ACMEAccount index. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterAcmeResponse" /cluster/acme/plugins: get: operationId: getClusterAcmePlugins summary: getClusterAcmePlugins description: ACME plugin index. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterAcmePluginsResponse" post: operationId: createClusterAcmePlugins summary: createClusterAcmePlugins description: Add ACME plugin configuration. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/CreateClusterAcmePluginsResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateClusterAcmePluginsRequest" "/cluster/acme/plugins/{id}": delete: operationId: deleteClusterAcmePluginsSingle summary: deleteClusterAcmePluginsSingle description: Delete ACME plugin configuration. tags: - cluster parameters: - name: id in: path required: true description: id schema: type: string responses: "200": $ref: "#/components/responses/DeleteClusterAcmePluginsSingleResponse" get: operationId: getClusterAcmePluginsSingle summary: getClusterAcmePluginsSingle description: Get ACME plugin configuration. tags: - cluster parameters: - name: id in: path required: true description: id schema: type: string responses: "200": $ref: "#/components/responses/GetClusterAcmePluginsSingleResponse" put: operationId: updateClusterAcmePluginsSingle summary: updateClusterAcmePluginsSingle description: Update ACME plugin configuration. tags: - cluster parameters: - name: id in: path required: true description: id schema: type: string responses: "200": $ref: "#/components/responses/UpdateClusterAcmePluginsSingleResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateClusterAcmePluginsSingleRequest" /cluster/acme/account: get: operationId: getClusterAcmeAccount summary: getClusterAcmeAccount description: ACMEAccount index. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterAcmeAccountResponse" post: operationId: createClusterAcmeAccount summary: createClusterAcmeAccount description: Register a new ACME account with CA. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/CreateClusterAcmeAccountResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateClusterAcmeAccountRequest" "/cluster/acme/account/{name}": delete: operationId: deleteClusterAcmeAccountSingle summary: deleteClusterAcmeAccountSingle description: Deactivate existing ACME account at CA. tags: - cluster parameters: - name: name in: path required: true description: name schema: type: string responses: "200": $ref: "#/components/responses/DeleteClusterAcmeAccountSingleResponse" get: operationId: getClusterAcmeAccountSingle summary: getClusterAcmeAccountSingle description: Return existing ACME account information. tags: - cluster parameters: - name: name in: path required: true description: name schema: type: string responses: "200": $ref: "#/components/responses/GetClusterAcmeAccountSingleResponse" put: operationId: updateClusterAcmeAccountSingle summary: updateClusterAcmeAccountSingle description: >- Update existing ACME account information with CA. Note: not specifying any new account information triggers a refresh. tags: - cluster parameters: - name: name in: path required: true description: name schema: type: string responses: "200": $ref: "#/components/responses/UpdateClusterAcmeAccountSingleResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateClusterAcmeAccountSingleRequest" /cluster/acme/tos: get: operationId: getClusterAcmeTos summary: getClusterAcmeTos description: >- Retrieve ACME TermsOfService URL from CA. Deprecated, please use /cluster/acme/meta. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterAcmeTosResponse" /cluster/acme/meta: get: operationId: getClusterAcmeMeta summary: getClusterAcmeMeta description: Retrieve ACME Directory Meta Information tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterAcmeMetaResponse" /cluster/acme/directories: get: operationId: getClusterAcmeDirectories summary: getClusterAcmeDirectories description: Get named known ACME directory endpoints. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterAcmeDirectoriesResponse" /cluster/acme/challenge-schema: get: operationId: getClusterAcmeChallengeschema summary: getClusterAcmeChallengeschema description: Get schema of ACME challenge types. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterAcmeChallengeschemaResponse" /cluster/ceph: get: operationId: getClusterCeph summary: getClusterCeph description: Cluster ceph index. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterCephResponse" /cluster/ceph/metadata: get: operationId: getClusterCephMetadata summary: getClusterCephMetadata description: Get ceph metadata. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterCephMetadataResponse" /cluster/ceph/status: get: operationId: getClusterCephStatus summary: getClusterCephStatus description: Get ceph status. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterCephStatusResponse" /cluster/ceph/flags: get: operationId: getClusterCephFlags summary: getClusterCephFlags description: get the status of all ceph flags tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterCephFlagsResponse" put: operationId: updateClusterCephFlags summary: updateClusterCephFlags description: Set/Unset multiple ceph flags at once. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/UpdateClusterCephFlagsResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateClusterCephFlagsRequest" "/cluster/ceph/flags/{flag}": get: operationId: getClusterCephFlagsSingle summary: getClusterCephFlagsSingle description: Get the status of a specific ceph flag. tags: - cluster parameters: - name: flag in: path required: true description: flag schema: type: string responses: "200": $ref: "#/components/responses/GetClusterCephFlagsSingleResponse" put: operationId: updateClusterCephFlagsSingle summary: updateClusterCephFlagsSingle description: Set or clear (unset) a specific ceph flag tags: - cluster parameters: - name: flag in: path required: true description: flag schema: type: string responses: "200": $ref: "#/components/responses/UpdateClusterCephFlagsSingleResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateClusterCephFlagsSingleRequest" /cluster/jobs: get: operationId: getClusterJobs summary: getClusterJobs description: Index for jobs related endpoints. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterJobsResponse" /cluster/jobs/realm-sync: get: operationId: getClusterJobsRealmsync summary: getClusterJobsRealmsync description: List configured realm-sync-jobs. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterJobsRealmsyncResponse" "/cluster/jobs/realm-sync/{id}": delete: operationId: deleteClusterJobsRealmsyncSingle summary: deleteClusterJobsRealmsyncSingle description: Delete realm-sync job definition. tags: - cluster parameters: - name: id in: path required: true description: id schema: type: string responses: "200": $ref: "#/components/responses/DeleteClusterJobsRealmsyncSingleResponse" get: operationId: getClusterJobsRealmsyncSingle summary: getClusterJobsRealmsyncSingle description: Read realm-sync job definition. tags: - cluster parameters: - name: id in: path required: true description: id schema: type: string responses: "200": $ref: "#/components/responses/GetClusterJobsRealmsyncSingleResponse" post: operationId: createClusterJobsRealmsyncSingle summary: createClusterJobsRealmsyncSingle description: Create new realm-sync job. tags: - cluster parameters: - name: id in: path required: true description: id schema: type: string responses: "200": $ref: "#/components/responses/CreateClusterJobsRealmsyncSingleResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateClusterJobsRealmsyncSingleRequest" put: operationId: updateClusterJobsRealmsyncSingle summary: updateClusterJobsRealmsyncSingle description: Update realm-sync job definition. tags: - cluster parameters: - name: id in: path required: true description: id schema: type: string responses: "200": $ref: "#/components/responses/UpdateClusterJobsRealmsyncSingleResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateClusterJobsRealmsyncSingleRequest" /cluster/jobs/schedule-analyze: get: operationId: getClusterJobsScheduleanalyze summary: getClusterJobsScheduleanalyze description: Returns a list of future schedule runtimes. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterJobsScheduleanalyzeResponse" /cluster/mapping: get: operationId: getClusterMapping summary: getClusterMapping description: List resource types. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterMappingResponse" /cluster/mapping/dir: get: operationId: getClusterMappingDir summary: getClusterMappingDir description: List directory mapping tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterMappingDirResponse" post: operationId: createClusterMappingDir summary: createClusterMappingDir description: Create a new directory mapping. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/CreateClusterMappingDirResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateClusterMappingDirRequest" "/cluster/mapping/dir/{id}": delete: operationId: deleteClusterMappingDirSingle summary: deleteClusterMappingDirSingle description: Remove directory mapping. tags: - cluster parameters: - name: id in: path required: true description: id schema: type: string responses: "200": $ref: "#/components/responses/DeleteClusterMappingDirSingleResponse" get: operationId: getClusterMappingDirSingle summary: getClusterMappingDirSingle description: Get directory mapping. tags: - cluster parameters: - name: id in: path required: true description: id schema: type: string responses: "200": $ref: "#/components/responses/GetClusterMappingDirSingleResponse" put: operationId: updateClusterMappingDirSingle summary: updateClusterMappingDirSingle description: Update a directory mapping. tags: - cluster parameters: - name: id in: path required: true description: id schema: type: string responses: "200": $ref: "#/components/responses/UpdateClusterMappingDirSingleResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateClusterMappingDirSingleRequest" /cluster/mapping/pci: get: operationId: getClusterMappingPci summary: getClusterMappingPci description: List PCI Hardware Mapping tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterMappingPciResponse" post: operationId: createClusterMappingPci summary: createClusterMappingPci description: Create a new hardware mapping. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/CreateClusterMappingPciResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateClusterMappingPciRequest" "/cluster/mapping/pci/{id}": delete: operationId: deleteClusterMappingPciSingle summary: deleteClusterMappingPciSingle description: Remove Hardware Mapping. tags: - cluster parameters: - name: id in: path required: true description: id schema: type: string responses: "200": $ref: "#/components/responses/DeleteClusterMappingPciSingleResponse" get: operationId: getClusterMappingPciSingle summary: getClusterMappingPciSingle description: Get PCI Mapping. tags: - cluster parameters: - name: id in: path required: true description: id schema: type: string responses: "200": $ref: "#/components/responses/GetClusterMappingPciSingleResponse" put: operationId: updateClusterMappingPciSingle summary: updateClusterMappingPciSingle description: Update a hardware mapping. tags: - cluster parameters: - name: id in: path required: true description: id schema: type: string responses: "200": $ref: "#/components/responses/UpdateClusterMappingPciSingleResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateClusterMappingPciSingleRequest" /cluster/mapping/usb: get: operationId: getClusterMappingUsb summary: getClusterMappingUsb description: List USB Hardware Mappings tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterMappingUsbResponse" post: operationId: createClusterMappingUsb summary: createClusterMappingUsb description: Create a new hardware mapping. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/CreateClusterMappingUsbResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateClusterMappingUsbRequest" "/cluster/mapping/usb/{id}": delete: operationId: deleteClusterMappingUsbSingle summary: deleteClusterMappingUsbSingle description: Remove Hardware Mapping. tags: - cluster parameters: - name: id in: path required: true description: id schema: type: string responses: "200": $ref: "#/components/responses/DeleteClusterMappingUsbSingleResponse" get: operationId: getClusterMappingUsbSingle summary: getClusterMappingUsbSingle description: Get USB Mapping. tags: - cluster parameters: - name: id in: path required: true description: id schema: type: string responses: "200": $ref: "#/components/responses/GetClusterMappingUsbSingleResponse" put: operationId: updateClusterMappingUsbSingle summary: updateClusterMappingUsbSingle description: Update a hardware mapping. tags: - cluster parameters: - name: id in: path required: true description: id schema: type: string responses: "200": $ref: "#/components/responses/UpdateClusterMappingUsbSingleResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateClusterMappingUsbSingleRequest" /cluster/bulk-action: get: operationId: getClusterBulkaction summary: getClusterBulkaction description: List resource types. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterBulkactionResponse" /cluster/bulk-action/guest: get: operationId: getClusterBulkactionGuest summary: getClusterBulkactionGuest description: Bulk action index. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterBulkactionGuestResponse" /cluster/bulk-action/guest/start: post: operationId: createClusterBulkactionGuestStart summary: createClusterBulkactionGuestStart description: Bulk start or resume all guests on the cluster. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/CreateClusterBulkactionGuestStartResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateClusterBulkactionGuestStartRequest" /cluster/bulk-action/guest/shutdown: post: operationId: createClusterBulkactionGuestShutdown summary: createClusterBulkactionGuestShutdown description: Bulk shutdown all guests on the cluster. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/CreateClusterBulkactionGuestShutdownResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateClusterBulkactionGuestShutdownRequest" /cluster/bulk-action/guest/suspend: post: operationId: createClusterBulkactionGuestSuspend summary: createClusterBulkactionGuestSuspend description: Bulk suspend all guests on the cluster. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/CreateClusterBulkactionGuestSuspendResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateClusterBulkactionGuestSuspendRequest" /cluster/bulk-action/guest/migrate: post: operationId: createClusterBulkactionGuestMigrate summary: createClusterBulkactionGuestMigrate description: Bulk migrate all guests on the cluster. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/CreateClusterBulkactionGuestMigrateResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateClusterBulkactionGuestMigrateRequest" /cluster/sdn: get: operationId: getClusterSDN summary: getClusterSDN description: Directory index. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterSDNResponse" put: operationId: updateClusterSDN summary: updateClusterSDN description: Apply sdn controller changes && reload. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/UpdateClusterSDNResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateClusterSDNRequest" /cluster/sdn/vnets: get: operationId: getClusterSDNVnets summary: getClusterSDNVnets description: SDN vnets index. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterSDNVnetsResponse" post: operationId: createClusterSDNVnet summary: createClusterSDNVnet description: Create a new sdn vnet object. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/CreateClusterSDNVnetResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateClusterSDNVnetRequest" "/cluster/sdn/vnets/{vnet}": delete: operationId: deleteClusterSDNVnet summary: deleteClusterSDNVnet description: Delete sdn vnet object configuration. tags: - cluster parameters: - name: vnet in: path required: true description: vnet schema: type: string responses: "200": $ref: "#/components/responses/DeleteClusterSDNVnetResponse" get: operationId: getClusterSDNVnet summary: getClusterSDNVnet description: Read sdn vnet configuration. tags: - cluster parameters: - name: vnet in: path required: true description: vnet schema: type: string responses: "200": $ref: "#/components/responses/GetClusterSDNVnetResponse" put: operationId: updateClusterSDNVnet summary: updateClusterSDNVnet description: Update sdn vnet object configuration. tags: - cluster parameters: - name: vnet in: path required: true description: vnet schema: type: string responses: "200": $ref: "#/components/responses/UpdateClusterSDNVnetResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateClusterSDNVnetRequest" "/cluster/sdn/vnets/{vnet}/firewall": get: operationId: getClusterSdnVnetsSingleFirewall summary: getClusterSdnVnetsSingleFirewall description: Directory index. tags: - cluster parameters: - name: vnet in: path required: true description: vnet schema: type: string responses: "200": $ref: "#/components/responses/GetClusterSdnVnetsSingleFirewallResponse" "/cluster/sdn/vnets/{vnet}/firewall/rules": get: operationId: getClusterSdnVnetsSingleFirewallRules summary: getClusterSdnVnetsSingleFirewallRules description: List rules. tags: - cluster parameters: - name: vnet in: path required: true description: vnet schema: type: string responses: "200": $ref: "#/components/responses/GetClusterSdnVnetsSingleFirewallRulesResponse" post: operationId: createClusterSdnVnetsSingleFirewallRules summary: createClusterSdnVnetsSingleFirewallRules description: Create new rule. tags: - cluster parameters: - name: vnet in: path required: true description: vnet schema: type: string responses: "200": $ref: >- #/components/responses/CreateClusterSdnVnetsSingleFirewallRulesResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateClusterSdnVnetsSingleFirewallRulesRequest "/cluster/sdn/vnets/{vnet}/firewall/rules/{pos}": delete: operationId: deleteClusterSdnVnetsSingleFirewallRulesSingle summary: deleteClusterSdnVnetsSingleFirewallRulesSingle description: Delete rule. tags: - cluster parameters: - name: pos in: path required: true description: pos schema: type: integer - name: vnet in: path required: true description: vnet schema: type: string responses: "200": $ref: >- #/components/responses/DeleteClusterSdnVnetsSingleFirewallRulesSingleResponse get: operationId: getClusterSdnVnetsSingleFirewallRulesSingle summary: getClusterSdnVnetsSingleFirewallRulesSingle description: Get single rule data. tags: - cluster parameters: - name: pos in: path required: true description: pos schema: type: integer - name: vnet in: path required: true description: vnet schema: type: string responses: "200": $ref: >- #/components/responses/GetClusterSdnVnetsSingleFirewallRulesSingleResponse put: operationId: updateClusterSdnVnetsSingleFirewallRulesSingle summary: updateClusterSdnVnetsSingleFirewallRulesSingle description: Modify rule data. tags: - cluster parameters: - name: pos in: path required: true description: pos schema: type: integer - name: vnet in: path required: true description: vnet schema: type: string responses: "200": $ref: >- #/components/responses/UpdateClusterSdnVnetsSingleFirewallRulesSingleResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/UpdateClusterSdnVnetsSingleFirewallRulesSingleRequest "/cluster/sdn/vnets/{vnet}/firewall/options": get: operationId: getClusterSdnVnetsSingleFirewallOptions summary: getClusterSdnVnetsSingleFirewallOptions description: Get vnet firewall options. tags: - cluster parameters: - name: vnet in: path required: true description: vnet schema: type: string responses: "200": $ref: >- #/components/responses/GetClusterSdnVnetsSingleFirewallOptionsResponse put: operationId: updateClusterSdnVnetsSingleFirewallOptions summary: updateClusterSdnVnetsSingleFirewallOptions description: Set Firewall options. tags: - cluster parameters: - name: vnet in: path required: true description: vnet schema: type: string responses: "200": $ref: >- #/components/responses/UpdateClusterSdnVnetsSingleFirewallOptionsResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/UpdateClusterSdnVnetsSingleFirewallOptionsRequest "/cluster/sdn/vnets/{vnet}/subnets": get: operationId: getClusterSdnVnetsSingleSubnets summary: getClusterSdnVnetsSingleSubnets description: SDN subnets index. tags: - cluster parameters: - name: vnet in: path required: true description: vnet schema: type: string responses: "200": $ref: "#/components/responses/GetClusterSdnVnetsSingleSubnetsResponse" post: operationId: createClusterSdnVnetsSingleSubnets summary: createClusterSdnVnetsSingleSubnets description: Create a new sdn subnet object. tags: - cluster parameters: - name: vnet in: path required: true description: vnet schema: type: string responses: "200": $ref: "#/components/responses/CreateClusterSdnVnetsSingleSubnetsResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateClusterSdnVnetsSingleSubnetsRequest" "/cluster/sdn/vnets/{vnet}/subnets/{subnet}": delete: operationId: deleteClusterSdnVnetsSingleSubnetsSingle summary: deleteClusterSdnVnetsSingleSubnetsSingle description: Delete sdn subnet object configuration. tags: - cluster parameters: - name: subnet in: path required: true description: subnet schema: type: string - name: vnet in: path required: true description: vnet schema: type: string responses: "200": $ref: >- #/components/responses/DeleteClusterSdnVnetsSingleSubnetsSingleResponse get: operationId: getClusterSdnVnetsSingleSubnetsSingle summary: getClusterSdnVnetsSingleSubnetsSingle description: Read sdn subnet configuration. tags: - cluster parameters: - name: subnet in: path required: true description: subnet schema: type: string - name: vnet in: path required: true description: vnet schema: type: string responses: "200": $ref: "#/components/responses/GetClusterSdnVnetsSingleSubnetsSingleResponse" put: operationId: updateClusterSdnVnetsSingleSubnetsSingle summary: updateClusterSdnVnetsSingleSubnetsSingle description: Update sdn subnet object configuration. tags: - cluster parameters: - name: subnet in: path required: true description: subnet schema: type: string - name: vnet in: path required: true description: vnet schema: type: string responses: "200": $ref: >- #/components/responses/UpdateClusterSdnVnetsSingleSubnetsSingleResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/UpdateClusterSdnVnetsSingleSubnetsSingleRequest "/cluster/sdn/vnets/{vnet}/ips": delete: operationId: deleteClusterSdnVnetsSingleIps summary: deleteClusterSdnVnetsSingleIps description: Delete IP Mappings in a VNet tags: - cluster parameters: - name: vnet in: path required: true description: vnet schema: type: string responses: "200": $ref: "#/components/responses/DeleteClusterSdnVnetsSingleIpsResponse" post: operationId: createClusterSdnVnetsSingleIps summary: createClusterSdnVnetsSingleIps description: Create IP Mapping in a VNet tags: - cluster parameters: - name: vnet in: path required: true description: vnet schema: type: string responses: "200": $ref: "#/components/responses/CreateClusterSdnVnetsSingleIpsResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateClusterSdnVnetsSingleIpsRequest" put: operationId: updateClusterSdnVnetsSingleIps summary: updateClusterSdnVnetsSingleIps description: Update IP Mapping in a VNet tags: - cluster parameters: - name: vnet in: path required: true description: vnet schema: type: string responses: "200": $ref: "#/components/responses/UpdateClusterSdnVnetsSingleIpsResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateClusterSdnVnetsSingleIpsRequest" /cluster/sdn/zones: get: operationId: getClusterSDNZones summary: getClusterSDNZones description: SDN zones index. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterSDNZonesResponse" post: operationId: createClusterSDNZone summary: createClusterSDNZone description: Create a new sdn zone object. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/CreateClusterSDNZoneResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateClusterSDNZoneRequest" "/cluster/sdn/zones/{zone}": delete: operationId: deleteClusterSDNZone summary: deleteClusterSDNZone description: Delete sdn zone object configuration. tags: - cluster parameters: - name: zone in: path required: true description: zone schema: type: string responses: "200": $ref: "#/components/responses/DeleteClusterSDNZoneResponse" get: operationId: getClusterSDNZone summary: getClusterSDNZone description: Read sdn zone configuration. tags: - cluster parameters: - name: zone in: path required: true description: zone schema: type: string responses: "200": $ref: "#/components/responses/GetClusterSDNZoneResponse" put: operationId: updateClusterSDNZone summary: updateClusterSDNZone description: Update sdn zone object configuration. tags: - cluster parameters: - name: zone in: path required: true description: zone schema: type: string responses: "200": $ref: "#/components/responses/UpdateClusterSDNZoneResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateClusterSDNZoneRequest" /cluster/sdn/controllers: get: operationId: getClusterSDNControllers summary: getClusterSDNControllers description: SDN controllers index. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterSDNControllersResponse" post: operationId: createClusterSDNController summary: createClusterSDNController description: Create a new sdn controller object. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/CreateClusterSDNControllerResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateClusterSDNControllerRequest" "/cluster/sdn/controllers/{controller}": delete: operationId: deleteClusterSDNController summary: deleteClusterSDNController description: Delete sdn controller object configuration. tags: - cluster parameters: - name: controller in: path required: true description: controller schema: type: string responses: "200": $ref: "#/components/responses/DeleteClusterSDNControllerResponse" get: operationId: getClusterSDNController summary: getClusterSDNController description: Read sdn controller configuration. tags: - cluster parameters: - name: controller in: path required: true description: controller schema: type: string responses: "200": $ref: "#/components/responses/GetClusterSDNControllerResponse" put: operationId: updateClusterSDNController summary: updateClusterSDNController description: Update sdn controller object configuration. tags: - cluster parameters: - name: controller in: path required: true description: controller schema: type: string responses: "200": $ref: "#/components/responses/UpdateClusterSDNControllerResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateClusterSDNControllerRequest" /cluster/sdn/ipams: get: operationId: getClusterSdnIpams summary: getClusterSdnIpams description: SDN ipams index. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterSdnIpamsResponse" post: operationId: createClusterSdnIpams summary: createClusterSdnIpams description: Create a new sdn ipam object. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/CreateClusterSdnIpamsResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateClusterSdnIpamsRequest" "/cluster/sdn/ipams/{ipam}": delete: operationId: deleteClusterSdnIpamsSingle summary: deleteClusterSdnIpamsSingle description: Delete sdn ipam object configuration. tags: - cluster parameters: - name: ipam in: path required: true description: ipam schema: type: string responses: "200": $ref: "#/components/responses/DeleteClusterSdnIpamsSingleResponse" get: operationId: getClusterSdnIpamsSingle summary: getClusterSdnIpamsSingle description: Read sdn ipam configuration. tags: - cluster parameters: - name: ipam in: path required: true description: ipam schema: type: string responses: "200": $ref: "#/components/responses/GetClusterSdnIpamsSingleResponse" put: operationId: updateClusterSdnIpamsSingle summary: updateClusterSdnIpamsSingle description: Update sdn ipam object configuration. tags: - cluster parameters: - name: ipam in: path required: true description: ipam schema: type: string responses: "200": $ref: "#/components/responses/UpdateClusterSdnIpamsSingleResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateClusterSdnIpamsSingleRequest" "/cluster/sdn/ipams/{ipam}/status": get: operationId: getClusterSdnIpamsSingleStatus summary: getClusterSdnIpamsSingleStatus description: List PVE IPAM Entries tags: - cluster parameters: - name: ipam in: path required: true description: ipam schema: type: string responses: "200": $ref: "#/components/responses/GetClusterSdnIpamsSingleStatusResponse" /cluster/sdn/dns: get: operationId: getClusterSdnDns summary: getClusterSdnDns description: SDN dns index. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterSdnDnsResponse" post: operationId: createClusterSdnDns summary: createClusterSdnDns description: Create a new sdn dns object. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/CreateClusterSdnDnsResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateClusterSdnDnsRequest" "/cluster/sdn/dns/{dns}": delete: operationId: deleteClusterSdnDnsSingle summary: deleteClusterSdnDnsSingle description: Delete sdn dns object configuration. tags: - cluster parameters: - name: dns in: path required: true description: dns schema: type: string responses: "200": $ref: "#/components/responses/DeleteClusterSdnDnsSingleResponse" get: operationId: getClusterSdnDnsSingle summary: getClusterSdnDnsSingle description: Read sdn dns configuration. tags: - cluster parameters: - name: dns in: path required: true description: dns schema: type: string responses: "200": $ref: "#/components/responses/GetClusterSdnDnsSingleResponse" put: operationId: updateClusterSdnDnsSingle summary: updateClusterSdnDnsSingle description: Update sdn dns object configuration. tags: - cluster parameters: - name: dns in: path required: true description: dns schema: type: string responses: "200": $ref: "#/components/responses/UpdateClusterSdnDnsSingleResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateClusterSdnDnsSingleRequest" /cluster/sdn/fabrics: get: operationId: getClusterSdnFabrics summary: getClusterSdnFabrics description: SDN Fabrics Index tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterSdnFabricsResponse" /cluster/sdn/fabrics/fabric: get: operationId: getClusterSdnFabricsFabric summary: getClusterSdnFabricsFabric description: SDN Fabrics Index tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterSdnFabricsFabricResponse" post: operationId: createClusterSdnFabricsFabric summary: createClusterSdnFabricsFabric description: Add a fabric tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/CreateClusterSdnFabricsFabricResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateClusterSdnFabricsFabricRequest" "/cluster/sdn/fabrics/fabric/{id}": delete: operationId: deleteClusterSdnFabricsFabricSingle summary: deleteClusterSdnFabricsFabricSingle description: Add a fabric tags: - cluster parameters: - name: id in: path required: true description: id schema: type: string responses: "200": $ref: "#/components/responses/DeleteClusterSdnFabricsFabricSingleResponse" get: operationId: getClusterSdnFabricsFabricSingle summary: getClusterSdnFabricsFabricSingle description: Update a fabric tags: - cluster parameters: - name: id in: path required: true description: id schema: type: string responses: "200": $ref: "#/components/responses/GetClusterSdnFabricsFabricSingleResponse" put: operationId: updateClusterSdnFabricsFabricSingle summary: updateClusterSdnFabricsFabricSingle description: Update a fabric tags: - cluster parameters: - name: id in: path required: true description: id schema: type: string responses: "200": $ref: "#/components/responses/UpdateClusterSdnFabricsFabricSingleResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateClusterSdnFabricsFabricSingleRequest" /cluster/sdn/fabrics/node: get: operationId: getClusterSdnFabricsNode summary: getClusterSdnFabricsNode description: SDN Fabrics Index tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterSdnFabricsNodeResponse" "/cluster/sdn/fabrics/node/{fabric_id}": get: operationId: getClusterSdnFabricsNodeSingle summary: getClusterSdnFabricsNodeSingle description: SDN Fabrics Index tags: - cluster parameters: - name: fabric_id in: path required: true description: fabric_id schema: type: string responses: "200": $ref: "#/components/responses/GetClusterSdnFabricsNodeSingleResponse" post: operationId: createClusterSdnFabricsNodeSingle summary: createClusterSdnFabricsNodeSingle description: Add a node tags: - cluster parameters: - name: fabric_id in: path required: true description: fabric_id schema: type: string responses: "200": $ref: "#/components/responses/CreateClusterSdnFabricsNodeSingleResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateClusterSdnFabricsNodeSingleRequest" "/cluster/sdn/fabrics/node/{fabric_id}/{node_id}": delete: operationId: deleteClusterSdnFabricsNodeSingleSingle summary: deleteClusterSdnFabricsNodeSingleSingle description: Add a node tags: - cluster parameters: - name: fabric_id in: path required: true description: fabric_id schema: type: string - name: node_id in: path required: true description: node_id schema: type: string responses: "200": $ref: >- #/components/responses/DeleteClusterSdnFabricsNodeSingleSingleResponse get: operationId: getClusterSdnFabricsNodeSingleSingle summary: getClusterSdnFabricsNodeSingleSingle description: Get a node tags: - cluster parameters: - name: fabric_id in: path required: true description: fabric_id schema: type: string - name: node_id in: path required: true description: node_id schema: type: string responses: "200": $ref: "#/components/responses/GetClusterSdnFabricsNodeSingleSingleResponse" put: operationId: updateClusterSdnFabricsNodeSingleSingle summary: updateClusterSdnFabricsNodeSingleSingle description: Update a node tags: - cluster parameters: - name: fabric_id in: path required: true description: fabric_id schema: type: string - name: node_id in: path required: true description: node_id schema: type: string responses: "200": $ref: >- #/components/responses/UpdateClusterSdnFabricsNodeSingleSingleResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/UpdateClusterSdnFabricsNodeSingleSingleRequest /cluster/sdn/fabrics/all: get: operationId: getClusterSdnFabricsAll summary: getClusterSdnFabricsAll description: SDN Fabrics Index tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterSdnFabricsAllResponse" /cluster/sdn/lock: delete: operationId: deleteClusterSdnLock summary: deleteClusterSdnLock description: Release global lock for SDN configuration tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/DeleteClusterSdnLockResponse" post: operationId: createClusterSdnLock summary: createClusterSdnLock description: Acquire global lock for SDN configuration tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/CreateClusterSdnLockResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateClusterSdnLockRequest" /cluster/sdn/rollback: post: operationId: createClusterSdnRollback summary: createClusterSdnRollback description: Rollback pending changes to SDN configuration tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/CreateClusterSdnRollbackResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateClusterSdnRollbackRequest" /cluster/log: get: operationId: getClusterLog summary: getClusterLog description: Read cluster log tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterLogResponse" /cluster/resources: get: operationId: getClusterResources summary: getClusterResources description: Resources index (cluster wide). tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterResourcesResponse" /cluster/tasks: get: operationId: getClusterTasks summary: getClusterTasks description: List recent tasks (cluster wide). tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterTasksResponse" /cluster/options: get: operationId: getClusterOptions summary: getClusterOptions description: >- Get datacenter options. Without 'Sys.Audit' on '/' not all options are returned. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterOptionsResponse" put: operationId: updateClusterOptions summary: updateClusterOptions description: Set datacenter options. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/UpdateClusterOptionsResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateClusterOptionsRequest" /cluster/status: get: operationId: getClusterStatus summary: getClusterStatus description: Get cluster status information. tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterStatusResponse" /cluster/nextid: get: operationId: getClusterNextid summary: getClusterNextid description: >- Get next free VMID. Pass a VMID to assert that its free (at time of check). tags: - cluster parameters: [] responses: "200": $ref: "#/components/responses/GetClusterNextidResponse" /nodes: get: operationId: getNodes summary: getNodes description: Cluster node index. tags: - nodes parameters: [] responses: "200": $ref: "#/components/responses/GetNodesResponse" "/nodes/{node}": get: operationId: getNode summary: getNode description: Node index. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodeResponse" "/nodes/{node}/qemu": get: operationId: getVMs summary: getVMs description: Virtual machine index (per node). tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetVMsResponse" post: operationId: createVM summary: createVM description: Create or restore a virtual machine. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/CreateVMResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateVMRequest" "/nodes/{node}/qemu/{vmid}": delete: operationId: deleteVM summary: deleteVM description: >- Destroy the VM and all used/owned volumes. Removes any VM specific permissions and firewall rules tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/DeleteVMResponse" get: operationId: getVM summary: getVM description: Directory index tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/GetVMResponse" "/nodes/{node}/qemu/{vmid}/firewall": get: operationId: getVMFirewall summary: getVMFirewall description: Directory index. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/GetVMFirewallResponse" "/nodes/{node}/qemu/{vmid}/firewall/rules": get: operationId: getVMFirewallRules summary: getVMFirewallRules description: List rules. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/GetVMFirewallRulesResponse" post: operationId: createVMFirewallRule summary: createVMFirewallRule description: Create new rule. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/CreateVMFirewallRuleResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateVMFirewallRuleRequest" "/nodes/{node}/qemu/{vmid}/firewall/rules/{pos}": delete: operationId: deleteVMFirewallRule summary: deleteVMFirewallRule description: Delete rule. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: pos in: path required: true description: pos schema: type: integer - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/DeleteVMFirewallRuleResponse" get: operationId: getVMFirewallRule summary: getVMFirewallRule description: Get single rule data. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: pos in: path required: true description: pos schema: type: integer - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/GetVMFirewallRuleResponse" put: operationId: updateVMFirewallRule summary: updateVMFirewallRule description: Modify rule data. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: pos in: path required: true description: pos schema: type: integer - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/UpdateVMFirewallRuleResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateVMFirewallRuleRequest" "/nodes/{node}/qemu/{vmid}/firewall/aliases": get: operationId: getNodesSingleQemuSingleFirewallAliases summary: getNodesSingleQemuSingleFirewallAliases description: List aliases tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/GetNodesSingleQemuSingleFirewallAliasesResponse post: operationId: createNodesSingleQemuSingleFirewallAliases summary: createNodesSingleQemuSingleFirewallAliases description: Create IP or Network Alias. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/CreateNodesSingleQemuSingleFirewallAliasesResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleQemuSingleFirewallAliasesRequest "/nodes/{node}/qemu/{vmid}/firewall/aliases/{name}": delete: operationId: deleteNodesSingleQemuSingleFirewallAliasesSingle summary: deleteNodesSingleQemuSingleFirewallAliasesSingle description: Remove IP or Network alias. tags: - nodes parameters: - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/DeleteNodesSingleQemuSingleFirewallAliasesSingleResponse get: operationId: getNodesSingleQemuSingleFirewallAliasesSingle summary: getNodesSingleQemuSingleFirewallAliasesSingle description: Read alias. tags: - nodes parameters: - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/GetNodesSingleQemuSingleFirewallAliasesSingleResponse put: operationId: updateNodesSingleQemuSingleFirewallAliasesSingle summary: updateNodesSingleQemuSingleFirewallAliasesSingle description: Update IP or Network alias. tags: - nodes parameters: - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/UpdateNodesSingleQemuSingleFirewallAliasesSingleResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/UpdateNodesSingleQemuSingleFirewallAliasesSingleRequest "/nodes/{node}/qemu/{vmid}/firewall/ipset": get: operationId: getVMFirewallIPSets summary: getVMFirewallIPSets description: List IPSets tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/GetVMFirewallIPSetsResponse" post: operationId: createVMFirewallIPSet summary: createVMFirewallIPSet description: Create new IPSet tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/CreateVMFirewallIPSetResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateVMFirewallIPSetRequest" "/nodes/{node}/qemu/{vmid}/firewall/ipset/{name}": delete: operationId: deleteVMFirewallIPSet summary: deleteVMFirewallIPSet description: Delete IPSet tags: - nodes parameters: - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/DeleteVMFirewallIPSetResponse" get: operationId: getVMFirewallIPSet summary: getVMFirewallIPSet description: List IPSet content tags: - nodes parameters: - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/GetVMFirewallIPSetResponse" post: operationId: addVMFirewallIPSetIP summary: addVMFirewallIPSetIP description: Add IP or Network to IPSet. tags: - nodes parameters: - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/AddVMFirewallIPSetIPResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/AddVMFirewallIPSetIPRequest" "/nodes/{node}/qemu/{vmid}/firewall/ipset/{name}/{cidr}": delete: operationId: removeVMFirewallIPSetIP summary: removeVMFirewallIPSetIP description: Remove IP or Network from IPSet. tags: - nodes parameters: - name: cidr in: path required: true description: cidr schema: type: string - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/RemoveVMFirewallIPSetIPResponse" get: operationId: getVMFirewallIPSetIP summary: getVMFirewallIPSetIP description: Read IP or Network settings from IPSet. tags: - nodes parameters: - name: cidr in: path required: true description: cidr schema: type: string - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/GetVMFirewallIPSetIPResponse" put: operationId: updateVMFirewallIPSetIP summary: updateVMFirewallIPSetIP description: Update IP or Network settings tags: - nodes parameters: - name: cidr in: path required: true description: cidr schema: type: string - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/UpdateVMFirewallIPSetIPResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateVMFirewallIPSetIPRequest" "/nodes/{node}/qemu/{vmid}/firewall/options": get: operationId: getVMFirewallOptions summary: getVMFirewallOptions description: Get VM firewall options. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/GetVMFirewallOptionsResponse" put: operationId: updateVMFirewallOptions summary: updateVMFirewallOptions description: Set Firewall options. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/UpdateVMFirewallOptionsResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateVMFirewallOptionsRequest" "/nodes/{node}/qemu/{vmid}/firewall/log": get: operationId: getNodesSingleQemuSingleFirewallLog summary: getNodesSingleQemuSingleFirewallLog description: Read firewall log tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/GetNodesSingleQemuSingleFirewallLogResponse" "/nodes/{node}/qemu/{vmid}/firewall/refs": get: operationId: getNodesSingleQemuSingleFirewallRefs summary: getNodesSingleQemuSingleFirewallRefs description: >- Lists possible IPSet/Alias reference which are allowed in source/dest properties. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/GetNodesSingleQemuSingleFirewallRefsResponse" "/nodes/{node}/qemu/{vmid}/agent": get: operationId: getNodesSingleQemuSingleAgent summary: getNodesSingleQemuSingleAgent description: QEMU Guest Agent command index. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/GetNodesSingleQemuSingleAgentResponse" post: operationId: createNodesSingleQemuSingleAgent summary: createNodesSingleQemuSingleAgent description: Execute QEMU Guest Agent commands. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/CreateNodesSingleQemuSingleAgentResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleQemuSingleAgentRequest" "/nodes/{node}/qemu/{vmid}/agent/fsfreeze-freeze": post: operationId: createNodesSingleQemuSingleAgentFsfreezefreeze summary: createNodesSingleQemuSingleAgentFsfreezefreeze description: Execute fsfreeze-freeze. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/CreateNodesSingleQemuSingleAgentFsfreezefreezeResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleQemuSingleAgentFsfreezefreezeRequest "/nodes/{node}/qemu/{vmid}/agent/fsfreeze-status": post: operationId: createNodesSingleQemuSingleAgentFsfreezestatus summary: createNodesSingleQemuSingleAgentFsfreezestatus description: Execute fsfreeze-status. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/CreateNodesSingleQemuSingleAgentFsfreezestatusResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleQemuSingleAgentFsfreezestatusRequest "/nodes/{node}/qemu/{vmid}/agent/fsfreeze-thaw": post: operationId: createNodesSingleQemuSingleAgentFsfreezethaw summary: createNodesSingleQemuSingleAgentFsfreezethaw description: Execute fsfreeze-thaw. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/CreateNodesSingleQemuSingleAgentFsfreezethawResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleQemuSingleAgentFsfreezethawRequest "/nodes/{node}/qemu/{vmid}/agent/fstrim": post: operationId: createNodesSingleQemuSingleAgentFstrim summary: createNodesSingleQemuSingleAgentFstrim description: Execute fstrim. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/CreateNodesSingleQemuSingleAgentFstrimResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleQemuSingleAgentFstrimRequest "/nodes/{node}/qemu/{vmid}/agent/get-fsinfo": get: operationId: getNodesSingleQemuSingleAgentGetfsinfo summary: getNodesSingleQemuSingleAgentGetfsinfo description: Execute get-fsinfo. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/GetNodesSingleQemuSingleAgentGetfsinfoResponse "/nodes/{node}/qemu/{vmid}/agent/get-host-name": get: operationId: getNodesSingleQemuSingleAgentGethostname summary: getNodesSingleQemuSingleAgentGethostname description: Execute get-host-name. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/GetNodesSingleQemuSingleAgentGethostnameResponse "/nodes/{node}/qemu/{vmid}/agent/get-memory-block-info": get: operationId: getNodesSingleQemuSingleAgentGetmemoryblockinfo summary: getNodesSingleQemuSingleAgentGetmemoryblockinfo description: Execute get-memory-block-info. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/GetNodesSingleQemuSingleAgentGetmemoryblockinfoResponse "/nodes/{node}/qemu/{vmid}/agent/get-memory-blocks": get: operationId: getNodesSingleQemuSingleAgentGetmemoryblocks summary: getNodesSingleQemuSingleAgentGetmemoryblocks description: Execute get-memory-blocks. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/GetNodesSingleQemuSingleAgentGetmemoryblocksResponse "/nodes/{node}/qemu/{vmid}/agent/get-osinfo": get: operationId: getNodesSingleQemuSingleAgentGetosinfo summary: getNodesSingleQemuSingleAgentGetosinfo description: Execute get-osinfo. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/GetNodesSingleQemuSingleAgentGetosinfoResponse "/nodes/{node}/qemu/{vmid}/agent/get-time": get: operationId: getNodesSingleQemuSingleAgentGettime summary: getNodesSingleQemuSingleAgentGettime description: Execute get-time. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/GetNodesSingleQemuSingleAgentGettimeResponse" "/nodes/{node}/qemu/{vmid}/agent/get-timezone": get: operationId: getNodesSingleQemuSingleAgentGettimezone summary: getNodesSingleQemuSingleAgentGettimezone description: Execute get-timezone. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/GetNodesSingleQemuSingleAgentGettimezoneResponse "/nodes/{node}/qemu/{vmid}/agent/get-users": get: operationId: getNodesSingleQemuSingleAgentGetusers summary: getNodesSingleQemuSingleAgentGetusers description: Execute get-users. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/GetNodesSingleQemuSingleAgentGetusersResponse" "/nodes/{node}/qemu/{vmid}/agent/get-vcpus": get: operationId: getNodesSingleQemuSingleAgentGetvcpus summary: getNodesSingleQemuSingleAgentGetvcpus description: Execute get-vcpus. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/GetNodesSingleQemuSingleAgentGetvcpusResponse" "/nodes/{node}/qemu/{vmid}/agent/info": get: operationId: getNodesSingleQemuSingleAgentInfo summary: getNodesSingleQemuSingleAgentInfo description: Execute info. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/GetNodesSingleQemuSingleAgentInfoResponse" "/nodes/{node}/qemu/{vmid}/agent/network-get-interfaces": get: operationId: getNodesSingleQemuSingleAgentNetworkgetinterfaces summary: getNodesSingleQemuSingleAgentNetworkgetinterfaces description: Execute network-get-interfaces. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/GetNodesSingleQemuSingleAgentNetworkgetinterfacesResponse "/nodes/{node}/qemu/{vmid}/agent/ping": post: operationId: createNodesSingleQemuSingleAgentPing summary: createNodesSingleQemuSingleAgentPing description: Execute ping. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/CreateNodesSingleQemuSingleAgentPingResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleQemuSingleAgentPingRequest" "/nodes/{node}/qemu/{vmid}/agent/shutdown": post: operationId: createNodesSingleQemuSingleAgentShutdown summary: createNodesSingleQemuSingleAgentShutdown description: Execute shutdown. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/CreateNodesSingleQemuSingleAgentShutdownResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleQemuSingleAgentShutdownRequest "/nodes/{node}/qemu/{vmid}/agent/suspend-disk": post: operationId: createNodesSingleQemuSingleAgentSuspenddisk summary: createNodesSingleQemuSingleAgentSuspenddisk description: Execute suspend-disk. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/CreateNodesSingleQemuSingleAgentSuspenddiskResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleQemuSingleAgentSuspenddiskRequest "/nodes/{node}/qemu/{vmid}/agent/suspend-hybrid": post: operationId: createNodesSingleQemuSingleAgentSuspendhybrid summary: createNodesSingleQemuSingleAgentSuspendhybrid description: Execute suspend-hybrid. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/CreateNodesSingleQemuSingleAgentSuspendhybridResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleQemuSingleAgentSuspendhybridRequest "/nodes/{node}/qemu/{vmid}/agent/suspend-ram": post: operationId: createNodesSingleQemuSingleAgentSuspendram summary: createNodesSingleQemuSingleAgentSuspendram description: Execute suspend-ram. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/CreateNodesSingleQemuSingleAgentSuspendramResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleQemuSingleAgentSuspendramRequest "/nodes/{node}/qemu/{vmid}/agent/set-user-password": post: operationId: createNodesSingleQemuSingleAgentSetuserpassword summary: createNodesSingleQemuSingleAgentSetuserpassword description: Sets the password for the given user to the given password tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/CreateNodesSingleQemuSingleAgentSetuserpasswordResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleQemuSingleAgentSetuserpasswordRequest "/nodes/{node}/qemu/{vmid}/agent/exec": post: operationId: createNodesSingleQemuSingleAgentExec summary: createNodesSingleQemuSingleAgentExec description: >- Executes the given command in the vm via the guest-agent and returns an object with the pid. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/CreateNodesSingleQemuSingleAgentExecResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleQemuSingleAgentExecRequest" "/nodes/{node}/qemu/{vmid}/agent/exec-status": get: operationId: getNodesSingleQemuSingleAgentExecstatus summary: getNodesSingleQemuSingleAgentExecstatus description: Gets the status of the given pid started by the guest-agent tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/GetNodesSingleQemuSingleAgentExecstatusResponse "/nodes/{node}/qemu/{vmid}/agent/file-read": get: operationId: getNodesSingleQemuSingleAgentFileread summary: getNodesSingleQemuSingleAgentFileread description: Reads the given file via guest agent. Is limited to 16777216 bytes. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/GetNodesSingleQemuSingleAgentFilereadResponse" "/nodes/{node}/qemu/{vmid}/agent/file-write": post: operationId: createNodesSingleQemuSingleAgentFilewrite summary: createNodesSingleQemuSingleAgentFilewrite description: Writes the given file via guest agent. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/CreateNodesSingleQemuSingleAgentFilewriteResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleQemuSingleAgentFilewriteRequest "/nodes/{node}/qemu/{vmid}/rrd": get: operationId: getVMRRD summary: getVMRRD description: Read VM RRD statistics (returns PNG) tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/GetVMRRDResponse" "/nodes/{node}/qemu/{vmid}/rrddata": get: operationId: getVMRRDData summary: getVMRRDData description: Read VM RRD statistics tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/GetVMRRDDataResponse" "/nodes/{node}/qemu/{vmid}/config": get: operationId: getVMConfig summary: getVMConfig description: >- Get the virtual machine configuration with pending configuration changes applied. Set the 'current' parameter to get the current configuration instead. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/GetVMConfigResponse" post: operationId: updateVMConfig summary: updateVMConfig description: Set virtual machine options (asynchronous API). tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/UpdateVMConfigResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateVMConfigRequest" put: operationId: updateVMConfigSync summary: updateVMConfigSync description: >- Set virtual machine options (synchronous API) - You should consider using the POST method instead for any actions involving hotplug or storage allocation. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/UpdateVMConfigSyncResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateVMConfigSyncRequest" "/nodes/{node}/qemu/{vmid}/pending": get: operationId: getVMConfigPending summary: getVMConfigPending description: >- Get the virtual machine configuration with both current and pending values. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/GetVMConfigPendingResponse" "/nodes/{node}/qemu/{vmid}/cloudinit": get: operationId: getNodesSingleQemuSingleCloudinit summary: getNodesSingleQemuSingleCloudinit description: Get the cloudinit configuration with both current and pending values. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/GetNodesSingleQemuSingleCloudinitResponse" put: operationId: updateNodesSingleQemuSingleCloudinit summary: updateNodesSingleQemuSingleCloudinit description: Regenerate and change cloudinit config drive. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/UpdateNodesSingleQemuSingleCloudinitResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateNodesSingleQemuSingleCloudinitRequest" "/nodes/{node}/qemu/{vmid}/cloudinit/dump": get: operationId: getNodesSingleQemuSingleCloudinitDump summary: getNodesSingleQemuSingleCloudinitDump description: Get automatically generated cloudinit config. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/GetNodesSingleQemuSingleCloudinitDumpResponse" "/nodes/{node}/qemu/{vmid}/unlink": put: operationId: unlinkVMDiskImages summary: unlinkVMDiskImages description: Unlink/delete disk images. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/UnlinkVMDiskImagesResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UnlinkVMDiskImagesRequest" "/nodes/{node}/qemu/{vmid}/vncproxy": post: operationId: createNodesSingleQemuSingleVncproxy summary: createNodesSingleQemuSingleVncproxy description: Creates a TCP VNC proxy connections. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/CreateNodesSingleQemuSingleVncproxyResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleQemuSingleVncproxyRequest" "/nodes/{node}/qemu/{vmid}/termproxy": post: operationId: createNodesSingleQemuSingleTermproxy summary: createNodesSingleQemuSingleTermproxy description: Creates a TCP proxy connections. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/CreateNodesSingleQemuSingleTermproxyResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleQemuSingleTermproxyRequest" "/nodes/{node}/qemu/{vmid}/vncwebsocket": get: operationId: getNodesSingleQemuSingleVncwebsocket summary: getNodesSingleQemuSingleVncwebsocket description: Opens a websocket for VNC traffic. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/GetNodesSingleQemuSingleVncwebsocketResponse" "/nodes/{node}/qemu/{vmid}/spiceproxy": post: operationId: createNodesSingleQemuSingleSpiceproxy summary: createNodesSingleQemuSingleSpiceproxy description: Returns a SPICE configuration to connect to the VM. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/CreateNodesSingleQemuSingleSpiceproxyResponse" requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleQemuSingleSpiceproxyRequest "/nodes/{node}/qemu/{vmid}/status": get: operationId: getVMStatus summary: getVMStatus description: Directory index tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/GetVMStatusResponse" "/nodes/{node}/qemu/{vmid}/status/current": get: operationId: getCurrentVMStatus summary: getCurrentVMStatus description: Get virtual machine status. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/GetCurrentVMStatusResponse" "/nodes/{node}/qemu/{vmid}/status/start": post: operationId: startVM summary: startVM description: Start virtual machine. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/StartVMResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/StartVMRequest" "/nodes/{node}/qemu/{vmid}/status/stop": post: operationId: stopVM summary: stopVM description: >- Stop virtual machine. The qemu process will exit immediately. This is akin to pulling the power plug of a running computer and may damage the VM data. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/StopVMResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/StopVMRequest" "/nodes/{node}/qemu/{vmid}/status/reset": post: operationId: resetVM summary: resetVM description: Reset virtual machine. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/ResetVMResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/ResetVMRequest" "/nodes/{node}/qemu/{vmid}/status/shutdown": post: operationId: shutdownVM summary: shutdownVM description: >- Shutdown virtual machine. This is similar to pressing the power button on a physical machine. This will send an ACPI event for the guest OS, which should then proceed to a clean shutdown. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/ShutdownVMResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/ShutdownVMRequest" "/nodes/{node}/qemu/{vmid}/status/reboot": post: operationId: rebootVM summary: rebootVM description: >- Reboot the VM by shutting it down, and starting it again. Applies pending changes. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/RebootVMResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/RebootVMRequest" "/nodes/{node}/qemu/{vmid}/status/suspend": post: operationId: suspendVM summary: suspendVM description: Suspend virtual machine. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/SuspendVMResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/SuspendVMRequest" "/nodes/{node}/qemu/{vmid}/status/resume": post: operationId: resumeVM summary: resumeVM description: Resume virtual machine. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/ResumeVMResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/ResumeVMRequest" "/nodes/{node}/qemu/{vmid}/sendkey": put: operationId: updateNodesSingleQemuSingleSendkey summary: updateNodesSingleQemuSingleSendkey description: Send key event to virtual machine. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/UpdateNodesSingleQemuSingleSendkeyResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateNodesSingleQemuSingleSendkeyRequest" "/nodes/{node}/qemu/{vmid}/feature": get: operationId: getNodesSingleQemuSingleFeature summary: getNodesSingleQemuSingleFeature description: Check if feature for virtual machine is available. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/GetNodesSingleQemuSingleFeatureResponse" "/nodes/{node}/qemu/{vmid}/clone": post: operationId: cloneVM summary: cloneVM description: Create a copy of virtual machine/template. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/CloneVMResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CloneVMRequest" "/nodes/{node}/qemu/{vmid}/move_disk": post: operationId: createNodesSingleQemuSingleMovedisk summary: createNodesSingleQemuSingleMovedisk description: Move volume to different storage or to a different VM. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/CreateNodesSingleQemuSingleMovediskResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleQemuSingleMovediskRequest" "/nodes/{node}/qemu/{vmid}/migrate": get: operationId: migrateVM summary: migrateVM description: Get preconditions for migration. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/MigrateVMResponse" post: operationId: createNodesSingleQemuSingleMigrate summary: createNodesSingleQemuSingleMigrate description: Migrate virtual machine. Creates a new migration task. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/CreateNodesSingleQemuSingleMigrateResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleQemuSingleMigrateRequest" "/nodes/{node}/qemu/{vmid}/remote_migrate": post: operationId: createNodesSingleQemuSingleRemotemigrate summary: createNodesSingleQemuSingleRemotemigrate description: >- Migrate virtual machine to a remote cluster. Creates a new migration task. EXPERIMENTAL feature! tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/CreateNodesSingleQemuSingleRemotemigrateResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleQemuSingleRemotemigrateRequest "/nodes/{node}/qemu/{vmid}/monitor": post: operationId: createNodesSingleQemuSingleMonitor summary: createNodesSingleQemuSingleMonitor description: Execute QEMU monitor commands. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/CreateNodesSingleQemuSingleMonitorResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleQemuSingleMonitorRequest" "/nodes/{node}/qemu/{vmid}/resize": put: operationId: resizeVMDisk summary: resizeVMDisk description: Extend volume size. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/ResizeVMDiskResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/ResizeVMDiskRequest" "/nodes/{node}/qemu/{vmid}/snapshot": get: operationId: getVMSnapshots summary: getVMSnapshots description: List all snapshots. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/GetVMSnapshotsResponse" post: operationId: createVMSnapshot summary: createVMSnapshot description: Snapshot a VM. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/CreateVMSnapshotResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateVMSnapshotRequest" "/nodes/{node}/qemu/{vmid}/snapshot/{snapname}": delete: operationId: deleteVMSnapshot summary: deleteVMSnapshot description: Delete a VM snapshot. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: snapname in: path required: true description: snapname schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/DeleteVMSnapshotResponse" get: operationId: getVMSnapshot summary: getVMSnapshot description: getVMSnapshot tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: snapname in: path required: true description: snapname schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/GetVMSnapshotResponse" "/nodes/{node}/qemu/{vmid}/snapshot/{snapname}/config": get: operationId: getVMSnapshotConfig summary: getVMSnapshotConfig description: Get snapshot configuration tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: snapname in: path required: true description: snapname schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/GetVMSnapshotConfigResponse" put: operationId: updateVMSnapshotConfig summary: updateVMSnapshotConfig description: Update snapshot metadata. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: snapname in: path required: true description: snapname schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/UpdateVMSnapshotConfigResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateVMSnapshotConfigRequest" "/nodes/{node}/qemu/{vmid}/snapshot/{snapname}/rollback": post: operationId: rollbackVMSnapshot summary: rollbackVMSnapshot description: Rollback VM state to specified snapshot. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: snapname in: path required: true description: snapname schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/RollbackVMSnapshotResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/RollbackVMSnapshotRequest" "/nodes/{node}/qemu/{vmid}/template": post: operationId: createNodesSingleQemuSingleTemplate summary: createNodesSingleQemuSingleTemplate description: Create a Template. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/CreateNodesSingleQemuSingleTemplateResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleQemuSingleTemplateRequest" "/nodes/{node}/qemu/{vmid}/mtunnel": post: operationId: createNodesSingleQemuSingleMtunnel summary: createNodesSingleQemuSingleMtunnel description: Migration tunnel endpoint - only for internal use by VM migration. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/CreateNodesSingleQemuSingleMtunnelResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleQemuSingleMtunnelRequest" "/nodes/{node}/qemu/{vmid}/mtunnelwebsocket": get: operationId: getNodesSingleQemuSingleMtunnelwebsocket summary: getNodesSingleQemuSingleMtunnelwebsocket description: >- Migration tunnel endpoint for websocket upgrade - only for internal use by VM migration. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/GetNodesSingleQemuSingleMtunnelwebsocketResponse "/nodes/{node}/qemu/{vmid}/dbus-vmstate": post: operationId: createNodesSingleQemuSingleDbusvmstate summary: createNodesSingleQemuSingleDbusvmstate description: Control the dbus-vmstate helper for a given running VM. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/CreateNodesSingleQemuSingleDbusvmstateResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleQemuSingleDbusvmstateRequest "/nodes/{node}/lxc": get: operationId: getNodesSingleLxc summary: getNodesSingleLxc description: LXC container index (per node). tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleLxcResponse" post: operationId: createNodesSingleLxc summary: createNodesSingleLxc description: Create or restore a container. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/CreateNodesSingleLxcResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleLxcRequest" "/nodes/{node}/lxc/{vmid}": delete: operationId: deleteNodesSingleLxcSingle summary: deleteNodesSingleLxcSingle description: Destroy the container (also delete all uses files). tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/DeleteNodesSingleLxcSingleResponse" get: operationId: getNodesSingleLxcSingle summary: getNodesSingleLxcSingle description: Directory index tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/GetNodesSingleLxcSingleResponse" "/nodes/{node}/lxc/{vmid}/config": get: operationId: getNodesSingleLxcSingleConfig summary: getNodesSingleLxcSingleConfig description: Get container configuration. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/GetNodesSingleLxcSingleConfigResponse" put: operationId: updateNodesSingleLxcSingleConfig summary: updateNodesSingleLxcSingleConfig description: Set container options. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/UpdateNodesSingleLxcSingleConfigResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateNodesSingleLxcSingleConfigRequest" "/nodes/{node}/lxc/{vmid}/status": get: operationId: getNodesSingleLxcSingleStatus summary: getNodesSingleLxcSingleStatus description: Directory index tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/GetNodesSingleLxcSingleStatusResponse" "/nodes/{node}/lxc/{vmid}/status/current": get: operationId: getNodesSingleLxcSingleStatusCurrent summary: getNodesSingleLxcSingleStatusCurrent description: Get virtual machine status. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/GetNodesSingleLxcSingleStatusCurrentResponse" "/nodes/{node}/lxc/{vmid}/status/start": post: operationId: createNodesSingleLxcSingleStatusStart summary: createNodesSingleLxcSingleStatusStart description: Start the container. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/CreateNodesSingleLxcSingleStatusStartResponse" requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleLxcSingleStatusStartRequest "/nodes/{node}/lxc/{vmid}/status/stop": post: operationId: createNodesSingleLxcSingleStatusStop summary: createNodesSingleLxcSingleStatusStop description: >- Stop the container. This will abruptly stop all processes running in the container. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/CreateNodesSingleLxcSingleStatusStopResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleLxcSingleStatusStopRequest" "/nodes/{node}/lxc/{vmid}/status/shutdown": post: operationId: createNodesSingleLxcSingleStatusShutdown summary: createNodesSingleLxcSingleStatusShutdown description: >- Shutdown the container. This will trigger a clean shutdown of the container, see lxc-stop(1) for details. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/CreateNodesSingleLxcSingleStatusShutdownResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleLxcSingleStatusShutdownRequest "/nodes/{node}/lxc/{vmid}/status/suspend": post: operationId: createNodesSingleLxcSingleStatusSuspend summary: createNodesSingleLxcSingleStatusSuspend description: Suspend the container. This is experimental. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/CreateNodesSingleLxcSingleStatusSuspendResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleLxcSingleStatusSuspendRequest "/nodes/{node}/lxc/{vmid}/status/resume": post: operationId: createNodesSingleLxcSingleStatusResume summary: createNodesSingleLxcSingleStatusResume description: Resume the container. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/CreateNodesSingleLxcSingleStatusResumeResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleLxcSingleStatusResumeRequest "/nodes/{node}/lxc/{vmid}/status/reboot": post: operationId: createNodesSingleLxcSingleStatusReboot summary: createNodesSingleLxcSingleStatusReboot description: >- Reboot the container by shutting it down, and starting it again. Applies pending changes. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/CreateNodesSingleLxcSingleStatusRebootResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleLxcSingleStatusRebootRequest "/nodes/{node}/lxc/{vmid}/snapshot": get: operationId: getNodesSingleLxcSingleSnapshot summary: getNodesSingleLxcSingleSnapshot description: List all snapshots. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/GetNodesSingleLxcSingleSnapshotResponse" post: operationId: createNodesSingleLxcSingleSnapshot summary: createNodesSingleLxcSingleSnapshot description: Snapshot a container. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/CreateNodesSingleLxcSingleSnapshotResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleLxcSingleSnapshotRequest" "/nodes/{node}/lxc/{vmid}/snapshot/{snapname}": delete: operationId: deleteNodesSingleLxcSingleSnapshotSingle summary: deleteNodesSingleLxcSingleSnapshotSingle description: Delete a LXC snapshot. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: snapname in: path required: true description: snapname schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/DeleteNodesSingleLxcSingleSnapshotSingleResponse get: operationId: getNodesSingleLxcSingleSnapshotSingle summary: getNodesSingleLxcSingleSnapshotSingle description: getNodesSingleLxcSingleSnapshotSingle tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: snapname in: path required: true description: snapname schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/GetNodesSingleLxcSingleSnapshotSingleResponse" "/nodes/{node}/lxc/{vmid}/snapshot/{snapname}/rollback": post: operationId: createNodesSingleLxcSingleSnapshotSingleRollback summary: createNodesSingleLxcSingleSnapshotSingleRollback description: Rollback LXC state to specified snapshot. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: snapname in: path required: true description: snapname schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/CreateNodesSingleLxcSingleSnapshotSingleRollbackResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleLxcSingleSnapshotSingleRollbackRequest "/nodes/{node}/lxc/{vmid}/snapshot/{snapname}/config": get: operationId: getNodesSingleLxcSingleSnapshotSingleConfig summary: getNodesSingleLxcSingleSnapshotSingleConfig description: Get snapshot configuration tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: snapname in: path required: true description: snapname schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/GetNodesSingleLxcSingleSnapshotSingleConfigResponse put: operationId: updateNodesSingleLxcSingleSnapshotSingleConfig summary: updateNodesSingleLxcSingleSnapshotSingleConfig description: Update snapshot metadata. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: snapname in: path required: true description: snapname schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/UpdateNodesSingleLxcSingleSnapshotSingleConfigResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/UpdateNodesSingleLxcSingleSnapshotSingleConfigRequest "/nodes/{node}/lxc/{vmid}/firewall": get: operationId: getNodesSingleLxcSingleFirewall summary: getNodesSingleLxcSingleFirewall description: Directory index. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/GetNodesSingleLxcSingleFirewallResponse" "/nodes/{node}/lxc/{vmid}/firewall/rules": get: operationId: getNodesSingleLxcSingleFirewallRules summary: getNodesSingleLxcSingleFirewallRules description: List rules. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/GetNodesSingleLxcSingleFirewallRulesResponse" post: operationId: createNodesSingleLxcSingleFirewallRules summary: createNodesSingleLxcSingleFirewallRules description: Create new rule. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/CreateNodesSingleLxcSingleFirewallRulesResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleLxcSingleFirewallRulesRequest "/nodes/{node}/lxc/{vmid}/firewall/rules/{pos}": delete: operationId: deleteNodesSingleLxcSingleFirewallRulesSingle summary: deleteNodesSingleLxcSingleFirewallRulesSingle description: Delete rule. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: pos in: path required: true description: pos schema: type: integer - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/DeleteNodesSingleLxcSingleFirewallRulesSingleResponse get: operationId: getNodesSingleLxcSingleFirewallRulesSingle summary: getNodesSingleLxcSingleFirewallRulesSingle description: Get single rule data. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: pos in: path required: true description: pos schema: type: integer - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/GetNodesSingleLxcSingleFirewallRulesSingleResponse put: operationId: updateNodesSingleLxcSingleFirewallRulesSingle summary: updateNodesSingleLxcSingleFirewallRulesSingle description: Modify rule data. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: pos in: path required: true description: pos schema: type: integer - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/UpdateNodesSingleLxcSingleFirewallRulesSingleResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/UpdateNodesSingleLxcSingleFirewallRulesSingleRequest "/nodes/{node}/lxc/{vmid}/firewall/aliases": get: operationId: getNodesSingleLxcSingleFirewallAliases summary: getNodesSingleLxcSingleFirewallAliases description: List aliases tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/GetNodesSingleLxcSingleFirewallAliasesResponse post: operationId: createNodesSingleLxcSingleFirewallAliases summary: createNodesSingleLxcSingleFirewallAliases description: Create IP or Network Alias. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/CreateNodesSingleLxcSingleFirewallAliasesResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleLxcSingleFirewallAliasesRequest "/nodes/{node}/lxc/{vmid}/firewall/aliases/{name}": delete: operationId: deleteNodesSingleLxcSingleFirewallAliasesSingle summary: deleteNodesSingleLxcSingleFirewallAliasesSingle description: Remove IP or Network alias. tags: - nodes parameters: - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/DeleteNodesSingleLxcSingleFirewallAliasesSingleResponse get: operationId: getNodesSingleLxcSingleFirewallAliasesSingle summary: getNodesSingleLxcSingleFirewallAliasesSingle description: Read alias. tags: - nodes parameters: - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/GetNodesSingleLxcSingleFirewallAliasesSingleResponse put: operationId: updateNodesSingleLxcSingleFirewallAliasesSingle summary: updateNodesSingleLxcSingleFirewallAliasesSingle description: Update IP or Network alias. tags: - nodes parameters: - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/UpdateNodesSingleLxcSingleFirewallAliasesSingleResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/UpdateNodesSingleLxcSingleFirewallAliasesSingleRequest "/nodes/{node}/lxc/{vmid}/firewall/ipset": get: operationId: getNodesSingleLxcSingleFirewallIpset summary: getNodesSingleLxcSingleFirewallIpset description: List IPSets tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/GetNodesSingleLxcSingleFirewallIpsetResponse" post: operationId: createNodesSingleLxcSingleFirewallIpset summary: createNodesSingleLxcSingleFirewallIpset description: Create new IPSet tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/CreateNodesSingleLxcSingleFirewallIpsetResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleLxcSingleFirewallIpsetRequest "/nodes/{node}/lxc/{vmid}/firewall/ipset/{name}": delete: operationId: deleteNodesSingleLxcSingleFirewallIpsetSingle summary: deleteNodesSingleLxcSingleFirewallIpsetSingle description: Delete IPSet tags: - nodes parameters: - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/DeleteNodesSingleLxcSingleFirewallIpsetSingleResponse get: operationId: getNodesSingleLxcSingleFirewallIpsetSingle summary: getNodesSingleLxcSingleFirewallIpsetSingle description: List IPSet content tags: - nodes parameters: - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/GetNodesSingleLxcSingleFirewallIpsetSingleResponse post: operationId: createNodesSingleLxcSingleFirewallIpsetSingle summary: createNodesSingleLxcSingleFirewallIpsetSingle description: Add IP or Network to IPSet. tags: - nodes parameters: - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/CreateNodesSingleLxcSingleFirewallIpsetSingleResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleLxcSingleFirewallIpsetSingleRequest "/nodes/{node}/lxc/{vmid}/firewall/ipset/{name}/{cidr}": delete: operationId: deleteNodesSingleLxcSingleFirewallIpsetSingleSingle summary: deleteNodesSingleLxcSingleFirewallIpsetSingleSingle description: Remove IP or Network from IPSet. tags: - nodes parameters: - name: cidr in: path required: true description: cidr schema: type: string - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/DeleteNodesSingleLxcSingleFirewallIpsetSingleSingleResponse get: operationId: getNodesSingleLxcSingleFirewallIpsetSingleSingle summary: getNodesSingleLxcSingleFirewallIpsetSingleSingle description: Read IP or Network settings from IPSet. tags: - nodes parameters: - name: cidr in: path required: true description: cidr schema: type: string - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/GetNodesSingleLxcSingleFirewallIpsetSingleSingleResponse put: operationId: updateNodesSingleLxcSingleFirewallIpsetSingleSingle summary: updateNodesSingleLxcSingleFirewallIpsetSingleSingle description: Update IP or Network settings tags: - nodes parameters: - name: cidr in: path required: true description: cidr schema: type: string - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/UpdateNodesSingleLxcSingleFirewallIpsetSingleSingleResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/UpdateNodesSingleLxcSingleFirewallIpsetSingleSingleRequest "/nodes/{node}/lxc/{vmid}/firewall/options": get: operationId: getNodesSingleLxcSingleFirewallOptions summary: getNodesSingleLxcSingleFirewallOptions description: Get VM firewall options. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/GetNodesSingleLxcSingleFirewallOptionsResponse put: operationId: updateNodesSingleLxcSingleFirewallOptions summary: updateNodesSingleLxcSingleFirewallOptions description: Set Firewall options. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/UpdateNodesSingleLxcSingleFirewallOptionsResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/UpdateNodesSingleLxcSingleFirewallOptionsRequest "/nodes/{node}/lxc/{vmid}/firewall/log": get: operationId: getNodesSingleLxcSingleFirewallLog summary: getNodesSingleLxcSingleFirewallLog description: Read firewall log tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/GetNodesSingleLxcSingleFirewallLogResponse" "/nodes/{node}/lxc/{vmid}/firewall/refs": get: operationId: getNodesSingleLxcSingleFirewallRefs summary: getNodesSingleLxcSingleFirewallRefs description: >- Lists possible IPSet/Alias reference which are allowed in source/dest properties. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/GetNodesSingleLxcSingleFirewallRefsResponse" "/nodes/{node}/lxc/{vmid}/rrd": get: operationId: getNodesSingleLxcSingleRrd summary: getNodesSingleLxcSingleRrd description: Read VM RRD statistics (returns PNG) tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/GetNodesSingleLxcSingleRrdResponse" "/nodes/{node}/lxc/{vmid}/rrddata": get: operationId: getNodesSingleLxcSingleRrddata summary: getNodesSingleLxcSingleRrddata description: Read VM RRD statistics tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/GetNodesSingleLxcSingleRrddataResponse" "/nodes/{node}/lxc/{vmid}/vncproxy": post: operationId: createNodesSingleLxcSingleVncproxy summary: createNodesSingleLxcSingleVncproxy description: Creates a TCP VNC proxy connections. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/CreateNodesSingleLxcSingleVncproxyResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleLxcSingleVncproxyRequest" "/nodes/{node}/lxc/{vmid}/termproxy": post: operationId: createNodesSingleLxcSingleTermproxy summary: createNodesSingleLxcSingleTermproxy description: Creates a TCP proxy connection. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/CreateNodesSingleLxcSingleTermproxyResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleLxcSingleTermproxyRequest" "/nodes/{node}/lxc/{vmid}/vncwebsocket": get: operationId: getNodesSingleLxcSingleVncwebsocket summary: getNodesSingleLxcSingleVncwebsocket description: Opens a websocket for VNC traffic. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/GetNodesSingleLxcSingleVncwebsocketResponse" "/nodes/{node}/lxc/{vmid}/spiceproxy": post: operationId: createNodesSingleLxcSingleSpiceproxy summary: createNodesSingleLxcSingleSpiceproxy description: Returns a SPICE configuration to connect to the CT. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/CreateNodesSingleLxcSingleSpiceproxyResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleLxcSingleSpiceproxyRequest" "/nodes/{node}/lxc/{vmid}/remote_migrate": post: operationId: createNodesSingleLxcSingleRemotemigrate summary: createNodesSingleLxcSingleRemotemigrate description: >- Migrate the container to another cluster. Creates a new migration task. EXPERIMENTAL feature! tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/CreateNodesSingleLxcSingleRemotemigrateResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleLxcSingleRemotemigrateRequest "/nodes/{node}/lxc/{vmid}/migrate": get: operationId: getNodesSingleLxcSingleMigrate summary: getNodesSingleLxcSingleMigrate description: Get preconditions for migration. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/GetNodesSingleLxcSingleMigrateResponse" post: operationId: createNodesSingleLxcSingleMigrate summary: createNodesSingleLxcSingleMigrate description: Migrate the container to another node. Creates a new migration task. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/CreateNodesSingleLxcSingleMigrateResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleLxcSingleMigrateRequest" "/nodes/{node}/lxc/{vmid}/feature": get: operationId: getNodesSingleLxcSingleFeature summary: getNodesSingleLxcSingleFeature description: Check if feature for virtual machine is available. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/GetNodesSingleLxcSingleFeatureResponse" "/nodes/{node}/lxc/{vmid}/template": post: operationId: createNodesSingleLxcSingleTemplate summary: createNodesSingleLxcSingleTemplate description: Create a Template. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/CreateNodesSingleLxcSingleTemplateResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleLxcSingleTemplateRequest" "/nodes/{node}/lxc/{vmid}/clone": post: operationId: createNodesSingleLxcSingleClone summary: createNodesSingleLxcSingleClone description: Create a container clone/copy tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/CreateNodesSingleLxcSingleCloneResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleLxcSingleCloneRequest" "/nodes/{node}/lxc/{vmid}/resize": put: operationId: updateNodesSingleLxcSingleResize summary: updateNodesSingleLxcSingleResize description: Resize a container mount point. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/UpdateNodesSingleLxcSingleResizeResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateNodesSingleLxcSingleResizeRequest" "/nodes/{node}/lxc/{vmid}/move_volume": post: operationId: createNodesSingleLxcSingleMovevolume summary: createNodesSingleLxcSingleMovevolume description: >- Move a rootfs-/mp-volume to a different storage or to a different container. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/CreateNodesSingleLxcSingleMovevolumeResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleLxcSingleMovevolumeRequest" "/nodes/{node}/lxc/{vmid}/pending": get: operationId: getNodesSingleLxcSinglePending summary: getNodesSingleLxcSinglePending description: "Get container configuration, including pending changes." tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/GetNodesSingleLxcSinglePendingResponse" "/nodes/{node}/lxc/{vmid}/interfaces": get: operationId: getNodesSingleLxcSingleInterfaces summary: getNodesSingleLxcSingleInterfaces description: Get IP addresses of the specified container interface. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/GetNodesSingleLxcSingleInterfacesResponse" "/nodes/{node}/lxc/{vmid}/mtunnel": post: operationId: createNodesSingleLxcSingleMtunnel summary: createNodesSingleLxcSingleMtunnel description: Migration tunnel endpoint - only for internal use by CT migration. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: "#/components/responses/CreateNodesSingleLxcSingleMtunnelResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleLxcSingleMtunnelRequest" "/nodes/{node}/lxc/{vmid}/mtunnelwebsocket": get: operationId: getNodesSingleLxcSingleMtunnelwebsocket summary: getNodesSingleLxcSingleMtunnelwebsocket description: >- Migration tunnel endpoint for websocket upgrade - only for internal use by VM migration. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vmid in: path required: true description: vmid schema: type: integer responses: "200": $ref: >- #/components/responses/GetNodesSingleLxcSingleMtunnelwebsocketResponse "/nodes/{node}/ceph": get: operationId: getNodesSingleCeph summary: getNodesSingleCeph description: Directory index. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleCephResponse" "/nodes/{node}/ceph/cfg": get: operationId: getNodesSingleCephCfg summary: getNodesSingleCephCfg description: Directory index. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleCephCfgResponse" "/nodes/{node}/ceph/cfg/raw": get: operationId: getNodesSingleCephCfgRaw summary: getNodesSingleCephCfgRaw description: Get the Ceph configuration file. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleCephCfgRawResponse" "/nodes/{node}/ceph/cfg/db": get: operationId: getNodesSingleCephCfgDb summary: getNodesSingleCephCfgDb description: Get the Ceph configuration database. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleCephCfgDbResponse" "/nodes/{node}/ceph/cfg/value": get: operationId: getNodesSingleCephCfgValue summary: getNodesSingleCephCfgValue description: Get configured values from either the config file or config DB. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleCephCfgValueResponse" "/nodes/{node}/ceph/osd": get: operationId: getNodesSingleCephOsd summary: getNodesSingleCephOsd description: Get Ceph osd list/tree. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleCephOsdResponse" post: operationId: createNodesSingleCephOsd summary: createNodesSingleCephOsd description: Create OSD tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/CreateNodesSingleCephOsdResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleCephOsdRequest" "/nodes/{node}/ceph/osd/{osdid}": delete: operationId: deleteNodesSingleCephOsdSingle summary: deleteNodesSingleCephOsdSingle description: Destroy OSD tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: osdid in: path required: true description: osdid schema: type: integer responses: "200": $ref: "#/components/responses/DeleteNodesSingleCephOsdSingleResponse" get: operationId: getNodesSingleCephOsdSingle summary: getNodesSingleCephOsdSingle description: OSD index. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: osdid in: path required: true description: osdid schema: type: integer responses: "200": $ref: "#/components/responses/GetNodesSingleCephOsdSingleResponse" "/nodes/{node}/ceph/osd/{osdid}/metadata": get: operationId: getNodesSingleCephOsdSingleMetadata summary: getNodesSingleCephOsdSingleMetadata description: Get OSD details tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: osdid in: path required: true description: osdid schema: type: integer responses: "200": $ref: "#/components/responses/GetNodesSingleCephOsdSingleMetadataResponse" "/nodes/{node}/ceph/osd/{osdid}/lv-info": get: operationId: getNodesSingleCephOsdSingleLvinfo summary: getNodesSingleCephOsdSingleLvinfo description: Get OSD volume details tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: osdid in: path required: true description: osdid schema: type: integer responses: "200": $ref: "#/components/responses/GetNodesSingleCephOsdSingleLvinfoResponse" "/nodes/{node}/ceph/osd/{osdid}/in": post: operationId: createNodesSingleCephOsdSingleIn summary: createNodesSingleCephOsdSingleIn description: ceph osd in tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: osdid in: path required: true description: osdid schema: type: integer responses: "200": $ref: "#/components/responses/CreateNodesSingleCephOsdSingleInResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleCephOsdSingleInRequest" "/nodes/{node}/ceph/osd/{osdid}/out": post: operationId: createNodesSingleCephOsdSingleOut summary: createNodesSingleCephOsdSingleOut description: ceph osd out tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: osdid in: path required: true description: osdid schema: type: integer responses: "200": $ref: "#/components/responses/CreateNodesSingleCephOsdSingleOutResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleCephOsdSingleOutRequest" "/nodes/{node}/ceph/osd/{osdid}/scrub": post: operationId: createNodesSingleCephOsdSingleScrub summary: createNodesSingleCephOsdSingleScrub description: Instruct the OSD to scrub. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: osdid in: path required: true description: osdid schema: type: integer responses: "200": $ref: "#/components/responses/CreateNodesSingleCephOsdSingleScrubResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleCephOsdSingleScrubRequest" "/nodes/{node}/ceph/mds": get: operationId: getNodesSingleCephMds summary: getNodesSingleCephMds description: MDS directory index. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleCephMdsResponse" "/nodes/{node}/ceph/mds/{name}": delete: operationId: deleteNodesSingleCephMdsSingle summary: deleteNodesSingleCephMdsSingle description: Destroy Ceph Metadata Server tags: - nodes parameters: - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/DeleteNodesSingleCephMdsSingleResponse" post: operationId: createNodesSingleCephMdsSingle summary: createNodesSingleCephMdsSingle description: Create Ceph Metadata Server (MDS) tags: - nodes parameters: - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/CreateNodesSingleCephMdsSingleResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleCephMdsSingleRequest" "/nodes/{node}/ceph/mgr": get: operationId: getNodesSingleCephMgr summary: getNodesSingleCephMgr description: MGR directory index. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleCephMgrResponse" "/nodes/{node}/ceph/mgr/{id}": delete: operationId: deleteNodesSingleCephMgrSingle summary: deleteNodesSingleCephMgrSingle description: Destroy Ceph Manager. tags: - nodes parameters: - name: id in: path required: true description: id schema: type: string - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/DeleteNodesSingleCephMgrSingleResponse" post: operationId: createNodesSingleCephMgrSingle summary: createNodesSingleCephMgrSingle description: Create Ceph Manager tags: - nodes parameters: - name: id in: path required: true description: id schema: type: string - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/CreateNodesSingleCephMgrSingleResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleCephMgrSingleRequest" "/nodes/{node}/ceph/mon": get: operationId: getNodesSingleCephMon summary: getNodesSingleCephMon description: Get Ceph monitor list. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleCephMonResponse" "/nodes/{node}/ceph/mon/{monid}": delete: operationId: deleteNodesSingleCephMonSingle summary: deleteNodesSingleCephMonSingle description: Destroy Ceph Monitor and Manager. tags: - nodes parameters: - name: monid in: path required: true description: monid schema: type: string - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/DeleteNodesSingleCephMonSingleResponse" post: operationId: createNodesSingleCephMonSingle summary: createNodesSingleCephMonSingle description: Create Ceph Monitor and Manager tags: - nodes parameters: - name: monid in: path required: true description: monid schema: type: string - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/CreateNodesSingleCephMonSingleResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleCephMonSingleRequest" "/nodes/{node}/ceph/fs": get: operationId: getNodesSingleCephFs summary: getNodesSingleCephFs description: Directory index. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleCephFsResponse" "/nodes/{node}/ceph/fs/{name}": post: operationId: createNodesSingleCephFsSingle summary: createNodesSingleCephFsSingle description: Create a Ceph filesystem tags: - nodes parameters: - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/CreateNodesSingleCephFsSingleResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleCephFsSingleRequest" "/nodes/{node}/ceph/pool": get: operationId: getNodesSingleCephPool summary: getNodesSingleCephPool description: >- List all pools and their settings (which are settable by the POST/PUT endpoints). tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleCephPoolResponse" post: operationId: createNodesSingleCephPool summary: createNodesSingleCephPool description: Create Ceph pool tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/CreateNodesSingleCephPoolResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleCephPoolRequest" "/nodes/{node}/ceph/pool/{name}": delete: operationId: deleteNodesSingleCephPoolSingle summary: deleteNodesSingleCephPoolSingle description: Destroy pool tags: - nodes parameters: - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/DeleteNodesSingleCephPoolSingleResponse" get: operationId: getNodesSingleCephPoolSingle summary: getNodesSingleCephPoolSingle description: Pool index. tags: - nodes parameters: - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleCephPoolSingleResponse" put: operationId: updateNodesSingleCephPoolSingle summary: updateNodesSingleCephPoolSingle description: Change POOL settings tags: - nodes parameters: - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/UpdateNodesSingleCephPoolSingleResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateNodesSingleCephPoolSingleRequest" "/nodes/{node}/ceph/pool/{name}/status": get: operationId: getNodesSingleCephPoolSingleStatus summary: getNodesSingleCephPoolSingleStatus description: Show the current pool status. tags: - nodes parameters: - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleCephPoolSingleStatusResponse" "/nodes/{node}/ceph/init": post: operationId: createNodesSingleCephInit summary: createNodesSingleCephInit description: Create initial ceph default configuration and setup symlinks. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/CreateNodesSingleCephInitResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleCephInitRequest" "/nodes/{node}/ceph/stop": post: operationId: createNodesSingleCephStop summary: createNodesSingleCephStop description: Stop ceph services. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/CreateNodesSingleCephStopResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleCephStopRequest" "/nodes/{node}/ceph/start": post: operationId: createNodesSingleCephStart summary: createNodesSingleCephStart description: Start ceph services. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/CreateNodesSingleCephStartResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleCephStartRequest" "/nodes/{node}/ceph/restart": post: operationId: createNodesSingleCephRestart summary: createNodesSingleCephRestart description: Restart ceph services. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/CreateNodesSingleCephRestartResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleCephRestartRequest" "/nodes/{node}/ceph/status": get: operationId: getNodesSingleCephStatus summary: getNodesSingleCephStatus description: Get ceph status. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleCephStatusResponse" "/nodes/{node}/ceph/crush": get: operationId: getNodesSingleCephCrush summary: getNodesSingleCephCrush description: Get OSD crush map tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleCephCrushResponse" "/nodes/{node}/ceph/log": get: operationId: getNodesSingleCephLog summary: getNodesSingleCephLog description: Read ceph log tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleCephLogResponse" "/nodes/{node}/ceph/rules": get: operationId: getNodesSingleCephRules summary: getNodesSingleCephRules description: List ceph rules. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleCephRulesResponse" "/nodes/{node}/ceph/cmd-safety": get: operationId: getNodesSingleCephCmdsafety summary: getNodesSingleCephCmdsafety description: Heuristical check if it is safe to perform an action. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleCephCmdsafetyResponse" "/nodes/{node}/vzdump": post: operationId: createNodesSingleVzdump summary: createNodesSingleVzdump description: Create backup. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/CreateNodesSingleVzdumpResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleVzdumpRequest" "/nodes/{node}/vzdump/defaults": get: operationId: getNodesSingleVzdumpDefaults summary: getNodesSingleVzdumpDefaults description: Get the currently configured vzdump defaults. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleVzdumpDefaultsResponse" "/nodes/{node}/vzdump/extractconfig": get: operationId: getNodesSingleVzdumpExtractconfig summary: getNodesSingleVzdumpExtractconfig description: Extract configuration from vzdump backup archive. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleVzdumpExtractconfigResponse" "/nodes/{node}/services": get: operationId: getNodesSingleServices summary: getNodesSingleServices description: Service list. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleServicesResponse" "/nodes/{node}/services/{service}": get: operationId: getNodesSingleServicesSingle summary: getNodesSingleServicesSingle description: Directory index tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: service in: path required: true description: service schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleServicesSingleResponse" "/nodes/{node}/services/{service}/state": get: operationId: getNodesSingleServicesSingleState summary: getNodesSingleServicesSingleState description: Read service properties tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: service in: path required: true description: service schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleServicesSingleStateResponse" "/nodes/{node}/services/{service}/start": post: operationId: createNodesSingleServicesSingleStart summary: createNodesSingleServicesSingleStart description: Start service. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: service in: path required: true description: service schema: type: string responses: "200": $ref: "#/components/responses/CreateNodesSingleServicesSingleStartResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleServicesSingleStartRequest" "/nodes/{node}/services/{service}/stop": post: operationId: createNodesSingleServicesSingleStop summary: createNodesSingleServicesSingleStop description: Stop service. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: service in: path required: true description: service schema: type: string responses: "200": $ref: "#/components/responses/CreateNodesSingleServicesSingleStopResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleServicesSingleStopRequest" "/nodes/{node}/services/{service}/restart": post: operationId: createNodesSingleServicesSingleRestart summary: createNodesSingleServicesSingleRestart description: Hard restart service. Use reload if you want to reduce interruptions. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: service in: path required: true description: service schema: type: string responses: "200": $ref: >- #/components/responses/CreateNodesSingleServicesSingleRestartResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleServicesSingleRestartRequest "/nodes/{node}/services/{service}/reload": post: operationId: createNodesSingleServicesSingleReload summary: createNodesSingleServicesSingleReload description: Reload service. Falls back to restart if service cannot be reloaded. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: service in: path required: true description: service schema: type: string responses: "200": $ref: "#/components/responses/CreateNodesSingleServicesSingleReloadResponse" requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleServicesSingleReloadRequest "/nodes/{node}/subscription": delete: operationId: deleteNodesSingleSubscription summary: deleteNodesSingleSubscription description: Delete subscription key of this node. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/DeleteNodesSingleSubscriptionResponse" get: operationId: getNodesSingleSubscription summary: getNodesSingleSubscription description: Read subscription info. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleSubscriptionResponse" post: operationId: createNodesSingleSubscription summary: createNodesSingleSubscription description: Update subscription info. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/CreateNodesSingleSubscriptionResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleSubscriptionRequest" put: operationId: updateNodesSingleSubscription summary: updateNodesSingleSubscription description: Set subscription key. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/UpdateNodesSingleSubscriptionResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateNodesSingleSubscriptionRequest" "/nodes/{node}/network": delete: operationId: deleteNodesSingleNetwork summary: deleteNodesSingleNetwork description: Revert network configuration changes. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/DeleteNodesSingleNetworkResponse" get: operationId: getNodesSingleNetwork summary: getNodesSingleNetwork description: List available networks tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleNetworkResponse" post: operationId: createNodesSingleNetwork summary: createNodesSingleNetwork description: Create network device configuration tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/CreateNodesSingleNetworkResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleNetworkRequest" put: operationId: updateNodesSingleNetwork summary: updateNodesSingleNetwork description: Reload network configuration tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/UpdateNodesSingleNetworkResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateNodesSingleNetworkRequest" "/nodes/{node}/network/{iface}": delete: operationId: deleteNodesSingleNetworkSingle summary: deleteNodesSingleNetworkSingle description: Delete network device configuration tags: - nodes parameters: - name: iface in: path required: true description: iface schema: type: string - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/DeleteNodesSingleNetworkSingleResponse" get: operationId: getNodesSingleNetworkSingle summary: getNodesSingleNetworkSingle description: Read network device configuration tags: - nodes parameters: - name: iface in: path required: true description: iface schema: type: string - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleNetworkSingleResponse" put: operationId: updateNodesSingleNetworkSingle summary: updateNodesSingleNetworkSingle description: Update network device configuration tags: - nodes parameters: - name: iface in: path required: true description: iface schema: type: string - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/UpdateNodesSingleNetworkSingleResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateNodesSingleNetworkSingleRequest" "/nodes/{node}/tasks": get: operationId: getNodeTasks summary: getNodeTasks description: Read task list for one node (finished tasks). tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodeTasksResponse" "/nodes/{node}/tasks/{upid}": delete: operationId: stopNodeTask summary: stopNodeTask description: Stop a task. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: upid in: path required: true description: upid schema: type: string responses: "200": $ref: "#/components/responses/StopNodeTaskResponse" get: operationId: getNodeTask summary: getNodeTask description: getNodeTask tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: upid in: path required: true description: upid schema: type: string responses: "200": $ref: "#/components/responses/GetNodeTaskResponse" "/nodes/{node}/tasks/{upid}/log": get: operationId: getNodeTaskLog summary: getNodeTaskLog description: Read task log. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: upid in: path required: true description: upid schema: type: string responses: "200": $ref: "#/components/responses/GetNodeTaskLogResponse" "/nodes/{node}/tasks/{upid}/status": get: operationId: getNodeTaskStatus summary: getNodeTaskStatus description: Read task status. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: upid in: path required: true description: upid schema: type: string responses: "200": $ref: "#/components/responses/GetNodeTaskStatusResponse" "/nodes/{node}/scan": get: operationId: getNodesSingleScan summary: getNodesSingleScan description: Index of available scan methods tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleScanResponse" "/nodes/{node}/scan/nfs": get: operationId: getNodesSingleScanNfs summary: getNodesSingleScanNfs description: Scan remote NFS server. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleScanNfsResponse" "/nodes/{node}/scan/cifs": get: operationId: getNodesSingleScanCifs summary: getNodesSingleScanCifs description: Scan remote CIFS server. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleScanCifsResponse" "/nodes/{node}/scan/pbs": get: operationId: getNodesSingleScanPbs summary: getNodesSingleScanPbs description: Scan remote Proxmox Backup Server. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleScanPbsResponse" "/nodes/{node}/scan/iscsi": get: operationId: getNodesSingleScanIscsi summary: getNodesSingleScanIscsi description: Scan remote iSCSI server. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleScanIscsiResponse" "/nodes/{node}/scan/lvm": get: operationId: getNodesSingleScanLvm summary: getNodesSingleScanLvm description: List local LVM volume groups. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleScanLvmResponse" "/nodes/{node}/scan/lvmthin": get: operationId: getNodesSingleScanLvmthin summary: getNodesSingleScanLvmthin description: List local LVM Thin Pools. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleScanLvmthinResponse" "/nodes/{node}/scan/zfs": get: operationId: getNodesSingleScanZfs summary: getNodesSingleScanZfs description: Scan zfs pool list on local node. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleScanZfsResponse" "/nodes/{node}/hardware": get: operationId: getNodesSingleHardware summary: getNodesSingleHardware description: Index of hardware types tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleHardwareResponse" "/nodes/{node}/hardware/pci": get: operationId: getNodesSingleHardwarePci summary: getNodesSingleHardwarePci description: List local PCI devices. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleHardwarePciResponse" "/nodes/{node}/hardware/pci/{pci-id-or-mapping}": get: operationId: getNodesSingleHardwarePciSingle summary: getNodesSingleHardwarePciSingle description: Index of available pci methods tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: pci-id-or-mapping in: path required: true description: pci-id-or-mapping schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleHardwarePciSingleResponse" "/nodes/{node}/hardware/pci/{pci-id-or-mapping}/mdev": get: operationId: getNodesSingleHardwarePciSingleMdev summary: getNodesSingleHardwarePciSingleMdev description: List mediated device types for given PCI device. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: pci-id-or-mapping in: path required: true description: pci-id-or-mapping schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleHardwarePciSingleMdevResponse" "/nodes/{node}/hardware/usb": get: operationId: getNodesSingleHardwareUsb summary: getNodesSingleHardwareUsb description: List local USB devices. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleHardwareUsbResponse" "/nodes/{node}/capabilities": get: operationId: getNodesSingleCapabilities summary: getNodesSingleCapabilities description: Node capabilities index. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleCapabilitiesResponse" "/nodes/{node}/capabilities/qemu": get: operationId: getNodesSingleCapabilitiesQemu summary: getNodesSingleCapabilitiesQemu description: QEMU capabilities index. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleCapabilitiesQemuResponse" "/nodes/{node}/capabilities/qemu/cpu": get: operationId: getNodesSingleCapabilitiesQemuCpu summary: getNodesSingleCapabilitiesQemuCpu description: List all custom and default CPU models. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleCapabilitiesQemuCpuResponse" "/nodes/{node}/capabilities/qemu/cpu-flags": get: operationId: getNodesSingleCapabilitiesQemuCpuflags summary: getNodesSingleCapabilitiesQemuCpuflags description: List of available VM-specific CPU flags. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: >- #/components/responses/GetNodesSingleCapabilitiesQemuCpuflagsResponse "/nodes/{node}/capabilities/qemu/machines": get: operationId: getNodesSingleCapabilitiesQemuMachines summary: getNodesSingleCapabilitiesQemuMachines description: Get available QEMU/KVM machine types. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: >- #/components/responses/GetNodesSingleCapabilitiesQemuMachinesResponse "/nodes/{node}/capabilities/qemu/migration": get: operationId: getNodesSingleCapabilitiesQemuMigration summary: getNodesSingleCapabilitiesQemuMigration description: >- Get node-specific QEMU migration capabilities of the node. Requires the 'Sys.Audit' permission on '/nodes/'. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: >- #/components/responses/GetNodesSingleCapabilitiesQemuMigrationResponse "/nodes/{node}/storage": get: operationId: getNodesSingleStorage summary: getNodesSingleStorage description: Get status for all datastores. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleStorageResponse" "/nodes/{node}/storage/{storage}": get: operationId: getNodesSingleStorageSingle summary: getNodesSingleStorageSingle description: getNodesSingleStorageSingle tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: storage in: path required: true description: storage schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleStorageSingleResponse" "/nodes/{node}/storage/{storage}/prunebackups": delete: operationId: deleteNodesSingleStorageSinglePrunebackups summary: deleteNodesSingleStorageSinglePrunebackups description: >- Prune backups. Only those using the standard naming scheme are considered. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: storage in: path required: true description: storage schema: type: string responses: "200": $ref: >- #/components/responses/DeleteNodesSingleStorageSinglePrunebackupsResponse get: operationId: getNodesSingleStorageSinglePrunebackups summary: getNodesSingleStorageSinglePrunebackups description: >- Get prune information for backups. NOTE: this is only a preview and might not be what a subsequent prune call does if backups are removed/added in the meantime. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: storage in: path required: true description: storage schema: type: string responses: "200": $ref: >- #/components/responses/GetNodesSingleStorageSinglePrunebackupsResponse "/nodes/{node}/storage/{storage}/content": get: operationId: getNodesSingleStorageSingleContent summary: getNodesSingleStorageSingleContent description: List storage content. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: storage in: path required: true description: storage schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleStorageSingleContentResponse" post: operationId: createNodesSingleStorageSingleContent summary: createNodesSingleStorageSingleContent description: Allocate disk images. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: storage in: path required: true description: storage schema: type: string responses: "200": $ref: "#/components/responses/CreateNodesSingleStorageSingleContentResponse" requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleStorageSingleContentRequest "/nodes/{node}/storage/{storage}/content/{volume}": delete: operationId: deleteNodesSingleStorageSingleContentSingle summary: deleteNodesSingleStorageSingleContentSingle description: Delete volume tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: storage in: path required: true description: storage schema: type: string - name: volume in: path required: true description: volume schema: type: string responses: "200": $ref: >- #/components/responses/DeleteNodesSingleStorageSingleContentSingleResponse get: operationId: getNodesSingleStorageSingleContentSingle summary: getNodesSingleStorageSingleContentSingle description: Get volume attributes tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: storage in: path required: true description: storage schema: type: string - name: volume in: path required: true description: volume schema: type: string responses: "200": $ref: >- #/components/responses/GetNodesSingleStorageSingleContentSingleResponse post: operationId: createNodesSingleStorageSingleContentSingle summary: createNodesSingleStorageSingleContentSingle description: Copy a volume. This is experimental code - do not use. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: storage in: path required: true description: storage schema: type: string - name: volume in: path required: true description: volume schema: type: string responses: "200": $ref: >- #/components/responses/CreateNodesSingleStorageSingleContentSingleResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleStorageSingleContentSingleRequest put: operationId: updateNodesSingleStorageSingleContentSingle summary: updateNodesSingleStorageSingleContentSingle description: Update volume attributes tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: storage in: path required: true description: storage schema: type: string - name: volume in: path required: true description: volume schema: type: string responses: "200": $ref: >- #/components/responses/UpdateNodesSingleStorageSingleContentSingleResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/UpdateNodesSingleStorageSingleContentSingleRequest "/nodes/{node}/storage/{storage}/file-restore/list": get: operationId: getNodesSingleStorageSingleFilerestoreList summary: getNodesSingleStorageSingleFilerestoreList description: List files and directories for single file restore under the given path. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: storage in: path required: true description: storage schema: type: string responses: "200": $ref: >- #/components/responses/GetNodesSingleStorageSingleFilerestoreListResponse "/nodes/{node}/storage/{storage}/file-restore/download": get: operationId: getNodesSingleStorageSingleFilerestoreDownload summary: getNodesSingleStorageSingleFilerestoreDownload description: Extract a file or directory (as zip archive) from a PBS backup. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: storage in: path required: true description: storage schema: type: string responses: "200": $ref: >- #/components/responses/GetNodesSingleStorageSingleFilerestoreDownloadResponse "/nodes/{node}/storage/{storage}/status": get: operationId: getNodesSingleStorageSingleStatus summary: getNodesSingleStorageSingleStatus description: Read storage status. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: storage in: path required: true description: storage schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleStorageSingleStatusResponse" "/nodes/{node}/storage/{storage}/rrd": get: operationId: getNodesSingleStorageSingleRrd summary: getNodesSingleStorageSingleRrd description: Read storage RRD statistics (returns PNG). tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: storage in: path required: true description: storage schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleStorageSingleRrdResponse" "/nodes/{node}/storage/{storage}/rrddata": get: operationId: getNodesSingleStorageSingleRrddata summary: getNodesSingleStorageSingleRrddata description: Read storage RRD statistics. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: storage in: path required: true description: storage schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleStorageSingleRrddataResponse" "/nodes/{node}/storage/{storage}/upload": post: operationId: createNodesSingleStorageSingleUpload summary: createNodesSingleStorageSingleUpload description: "Upload templates, ISO images, OVAs and VM images." tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: storage in: path required: true description: storage schema: type: string responses: "200": $ref: "#/components/responses/CreateNodesSingleStorageSingleUploadResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleStorageSingleUploadRequest" "/nodes/{node}/storage/{storage}/download-url": post: operationId: createNodesSingleStorageSingleDownloadurl summary: createNodesSingleStorageSingleDownloadurl description: "Download templates, ISO images, OVAs and VM images by using an URL." tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: storage in: path required: true description: storage schema: type: string responses: "200": $ref: >- #/components/responses/CreateNodesSingleStorageSingleDownloadurlResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleStorageSingleDownloadurlRequest "/nodes/{node}/storage/{storage}/oci-registry-pull": post: operationId: createNodesSingleStorageSingleOciregistrypull summary: createNodesSingleStorageSingleOciregistrypull description: Pull an OCI image from a registry. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: storage in: path required: true description: storage schema: type: string responses: "200": $ref: >- #/components/responses/CreateNodesSingleStorageSingleOciregistrypullResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleStorageSingleOciregistrypullRequest "/nodes/{node}/storage/{storage}/import-metadata": get: operationId: getNodesSingleStorageSingleImportmetadata summary: getNodesSingleStorageSingleImportmetadata description: >- Get the base parameters for creating a guest which imports data from a foreign importable guest, like an ESXi VM tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: storage in: path required: true description: storage schema: type: string responses: "200": $ref: >- #/components/responses/GetNodesSingleStorageSingleImportmetadataResponse "/nodes/{node}/disks": get: operationId: getNodesSingleDisks summary: getNodesSingleDisks description: Node index. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleDisksResponse" "/nodes/{node}/disks/lvm": get: operationId: getNodesSingleDisksLvm summary: getNodesSingleDisksLvm description: List LVM Volume Groups tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleDisksLvmResponse" post: operationId: createNodesSingleDisksLvm summary: createNodesSingleDisksLvm description: Create an LVM Volume Group tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/CreateNodesSingleDisksLvmResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleDisksLvmRequest" "/nodes/{node}/disks/lvm/{name}": delete: operationId: deleteNodesSingleDisksLvmSingle summary: deleteNodesSingleDisksLvmSingle description: Remove an LVM Volume Group. tags: - nodes parameters: - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/DeleteNodesSingleDisksLvmSingleResponse" "/nodes/{node}/disks/lvmthin": get: operationId: getNodesSingleDisksLvmthin summary: getNodesSingleDisksLvmthin description: List LVM thinpools tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleDisksLvmthinResponse" post: operationId: createNodesSingleDisksLvmthin summary: createNodesSingleDisksLvmthin description: Create an LVM thinpool tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/CreateNodesSingleDisksLvmthinResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleDisksLvmthinRequest" "/nodes/{node}/disks/lvmthin/{name}": delete: operationId: deleteNodesSingleDisksLvmthinSingle summary: deleteNodesSingleDisksLvmthinSingle description: Remove an LVM thin pool. tags: - nodes parameters: - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/DeleteNodesSingleDisksLvmthinSingleResponse" "/nodes/{node}/disks/directory": get: operationId: getNodesSingleDisksDirectory summary: getNodesSingleDisksDirectory description: PVE Managed Directory storages. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleDisksDirectoryResponse" post: operationId: createNodesSingleDisksDirectory summary: createNodesSingleDisksDirectory description: >- Create a Filesystem on an unused disk. Will be mounted under '/mnt/pve/NAME'. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/CreateNodesSingleDisksDirectoryResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleDisksDirectoryRequest" "/nodes/{node}/disks/directory/{name}": delete: operationId: deleteNodesSingleDisksDirectorySingle summary: deleteNodesSingleDisksDirectorySingle description: Unmounts the storage and removes the mount unit. tags: - nodes parameters: - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/DeleteNodesSingleDisksDirectorySingleResponse" "/nodes/{node}/disks/zfs": get: operationId: getNodesSingleDisksZfs summary: getNodesSingleDisksZfs description: List Zpools. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleDisksZfsResponse" post: operationId: createNodesSingleDisksZfs summary: createNodesSingleDisksZfs description: Create a ZFS pool. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/CreateNodesSingleDisksZfsResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleDisksZfsRequest" "/nodes/{node}/disks/zfs/{name}": delete: operationId: deleteNodesSingleDisksZfsSingle summary: deleteNodesSingleDisksZfsSingle description: Destroy a ZFS pool. tags: - nodes parameters: - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/DeleteNodesSingleDisksZfsSingleResponse" get: operationId: getNodesSingleDisksZfsSingle summary: getNodesSingleDisksZfsSingle description: Get details about a zpool. tags: - nodes parameters: - name: name in: path required: true description: name schema: type: string - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleDisksZfsSingleResponse" "/nodes/{node}/disks/list": get: operationId: getNodesSingleDisksList summary: getNodesSingleDisksList description: List local disks. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleDisksListResponse" "/nodes/{node}/disks/smart": get: operationId: getNodesSingleDisksSmart summary: getNodesSingleDisksSmart description: Get SMART Health of a disk. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleDisksSmartResponse" "/nodes/{node}/disks/initgpt": post: operationId: createNodesSingleDisksInitgpt summary: createNodesSingleDisksInitgpt description: Initialize Disk with GPT tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/CreateNodesSingleDisksInitgptResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleDisksInitgptRequest" "/nodes/{node}/disks/wipedisk": put: operationId: updateNodesSingleDisksWipedisk summary: updateNodesSingleDisksWipedisk description: Wipe a disk or partition. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/UpdateNodesSingleDisksWipediskResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateNodesSingleDisksWipediskRequest" "/nodes/{node}/apt": get: operationId: getNodesSingleApt summary: getNodesSingleApt description: Directory index for apt (Advanced Package Tool). tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleAptResponse" "/nodes/{node}/apt/update": get: operationId: getNodesSingleAptUpdate summary: getNodesSingleAptUpdate description: List available updates. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleAptUpdateResponse" post: operationId: createNodesSingleAptUpdate summary: createNodesSingleAptUpdate description: >- This is used to resynchronize the package index files from their sources (apt-get update). tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/CreateNodesSingleAptUpdateResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleAptUpdateRequest" "/nodes/{node}/apt/changelog": get: operationId: getNodesSingleAptChangelog summary: getNodesSingleAptChangelog description: Get package changelogs. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleAptChangelogResponse" "/nodes/{node}/apt/repositories": get: operationId: getNodesSingleAptRepositories summary: getNodesSingleAptRepositories description: Get APT repository information. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleAptRepositoriesResponse" post: operationId: createNodesSingleAptRepositories summary: createNodesSingleAptRepositories description: >- Change the properties of a repository. Currently only allows enabling/disabling. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/CreateNodesSingleAptRepositoriesResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleAptRepositoriesRequest" put: operationId: updateNodesSingleAptRepositories summary: updateNodesSingleAptRepositories description: Add a standard repository to the configuration tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/UpdateNodesSingleAptRepositoriesResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateNodesSingleAptRepositoriesRequest" "/nodes/{node}/apt/versions": get: operationId: getNodesSingleAptVersions summary: getNodesSingleAptVersions description: Get package information for important Proxmox packages. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleAptVersionsResponse" "/nodes/{node}/firewall": get: operationId: getNodeFirewall summary: getNodeFirewall description: Directory index. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodeFirewallResponse" "/nodes/{node}/firewall/rules": get: operationId: getNodeFirewallRules summary: getNodeFirewallRules description: List rules. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodeFirewallRulesResponse" post: operationId: createNodeFirewallRule summary: createNodeFirewallRule description: Create new rule. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/CreateNodeFirewallRuleResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodeFirewallRuleRequest" "/nodes/{node}/firewall/rules/{pos}": delete: operationId: deleteNodeFirewallRule summary: deleteNodeFirewallRule description: Delete rule. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: pos in: path required: true description: pos schema: type: integer responses: "200": $ref: "#/components/responses/DeleteNodeFirewallRuleResponse" get: operationId: getNodeFirewallRule summary: getNodeFirewallRule description: Get single rule data. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: pos in: path required: true description: pos schema: type: integer responses: "200": $ref: "#/components/responses/GetNodeFirewallRuleResponse" put: operationId: updateNodeFirewallRule summary: updateNodeFirewallRule description: Modify rule data. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: pos in: path required: true description: pos schema: type: integer responses: "200": $ref: "#/components/responses/UpdateNodeFirewallRuleResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateNodeFirewallRuleRequest" "/nodes/{node}/firewall/options": get: operationId: getNodeFirewallOptions summary: getNodeFirewallOptions description: Get host firewall options. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodeFirewallOptionsResponse" put: operationId: updateNodeFirewallOptions summary: updateNodeFirewallOptions description: Set Firewall options. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/UpdateNodeFirewallOptionsResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateNodeFirewallOptionsRequest" "/nodes/{node}/firewall/log": get: operationId: getNodesSingleFirewallLog summary: getNodesSingleFirewallLog description: Read firewall log tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleFirewallLogResponse" "/nodes/{node}/replication": get: operationId: getNodesSingleReplication summary: getNodesSingleReplication description: List status of all replication jobs on this node. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleReplicationResponse" "/nodes/{node}/replication/{id}": get: operationId: getNodesSingleReplicationSingle summary: getNodesSingleReplicationSingle description: Directory index. tags: - nodes parameters: - name: id in: path required: true description: id schema: type: string - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleReplicationSingleResponse" "/nodes/{node}/replication/{id}/status": get: operationId: getNodesSingleReplicationSingleStatus summary: getNodesSingleReplicationSingleStatus description: Get replication job status. tags: - nodes parameters: - name: id in: path required: true description: id schema: type: string - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleReplicationSingleStatusResponse" "/nodes/{node}/replication/{id}/log": get: operationId: getNodesSingleReplicationSingleLog summary: getNodesSingleReplicationSingleLog description: Read replication job log. tags: - nodes parameters: - name: id in: path required: true description: id schema: type: string - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleReplicationSingleLogResponse" "/nodes/{node}/replication/{id}/schedule_now": post: operationId: createNodesSingleReplicationSingleSchedulenow summary: createNodesSingleReplicationSingleSchedulenow description: Schedule replication job to start as soon as possible. tags: - nodes parameters: - name: id in: path required: true description: id schema: type: string - name: node in: path required: true description: node schema: type: string responses: "200": $ref: >- #/components/responses/CreateNodesSingleReplicationSingleSchedulenowResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleReplicationSingleSchedulenowRequest "/nodes/{node}/certificates": get: operationId: getNodesSingleCertificates summary: getNodesSingleCertificates description: Node index. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleCertificatesResponse" "/nodes/{node}/certificates/acme": get: operationId: getNodesSingleCertificatesAcme summary: getNodesSingleCertificatesAcme description: ACME index. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleCertificatesAcmeResponse" "/nodes/{node}/certificates/acme/certificate": delete: operationId: deleteNodesSingleCertificatesAcmeCertificate summary: deleteNodesSingleCertificatesAcmeCertificate description: Revoke existing certificate from CA. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: >- #/components/responses/DeleteNodesSingleCertificatesAcmeCertificateResponse post: operationId: createNodesSingleCertificatesAcmeCertificate summary: createNodesSingleCertificatesAcmeCertificate description: Order a new certificate from ACME-compatible CA. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: >- #/components/responses/CreateNodesSingleCertificatesAcmeCertificateResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateNodesSingleCertificatesAcmeCertificateRequest put: operationId: updateNodesSingleCertificatesAcmeCertificate summary: updateNodesSingleCertificatesAcmeCertificate description: Renew existing certificate from CA. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: >- #/components/responses/UpdateNodesSingleCertificatesAcmeCertificateResponse requestBody: content: application/json: schema: $ref: >- #/components/schemas/UpdateNodesSingleCertificatesAcmeCertificateRequest "/nodes/{node}/certificates/info": get: operationId: getNodesSingleCertificatesInfo summary: getNodesSingleCertificatesInfo description: Get information about node's certificates. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleCertificatesInfoResponse" "/nodes/{node}/certificates/custom": delete: operationId: deleteNodesSingleCertificatesCustom summary: deleteNodesSingleCertificatesCustom description: DELETE custom certificate chain and key. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/DeleteNodesSingleCertificatesCustomResponse" post: operationId: createNodesSingleCertificatesCustom summary: createNodesSingleCertificatesCustom description: Upload or update custom certificate chain and key. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/CreateNodesSingleCertificatesCustomResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleCertificatesCustomRequest" "/nodes/{node}/config": get: operationId: getNodesSingleConfig summary: getNodesSingleConfig description: Get node configuration options. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleConfigResponse" put: operationId: updateNodesSingleConfig summary: updateNodesSingleConfig description: Set node configuration options. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/UpdateNodesSingleConfigResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateNodesSingleConfigRequest" "/nodes/{node}/sdn": get: operationId: getNodeSDN summary: getNodeSDN description: SDN index. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodeSDNResponse" "/nodes/{node}/sdn/fabrics/{fabric}": get: operationId: getNodesSingleSdnFabricsSingle summary: getNodesSingleSdnFabricsSingle description: Directory index for SDN fabric status. tags: - nodes parameters: - name: fabric in: path required: true description: fabric schema: type: string - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleSdnFabricsSingleResponse" "/nodes/{node}/sdn/fabrics/{fabric}/routes": get: operationId: getNodesSingleSdnFabricsSingleRoutes summary: getNodesSingleSdnFabricsSingleRoutes description: Get all routes for a fabric. tags: - nodes parameters: - name: fabric in: path required: true description: fabric schema: type: string - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleSdnFabricsSingleRoutesResponse" "/nodes/{node}/sdn/fabrics/{fabric}/neighbors": get: operationId: getNodesSingleSdnFabricsSingleNeighbors summary: getNodesSingleSdnFabricsSingleNeighbors description: Get all neighbors for a fabric. tags: - nodes parameters: - name: fabric in: path required: true description: fabric schema: type: string - name: node in: path required: true description: node schema: type: string responses: "200": $ref: >- #/components/responses/GetNodesSingleSdnFabricsSingleNeighborsResponse "/nodes/{node}/sdn/fabrics/{fabric}/interfaces": get: operationId: getNodesSingleSdnFabricsSingleInterfaces summary: getNodesSingleSdnFabricsSingleInterfaces description: Get all interfaces for a fabric. tags: - nodes parameters: - name: fabric in: path required: true description: fabric schema: type: string - name: node in: path required: true description: node schema: type: string responses: "200": $ref: >- #/components/responses/GetNodesSingleSdnFabricsSingleInterfacesResponse "/nodes/{node}/sdn/zones": get: operationId: getNodeSDNZones summary: getNodeSDNZones description: Get status for all zones. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodeSDNZonesResponse" "/nodes/{node}/sdn/zones/{zone}": get: operationId: getNodeSDNZone summary: getNodeSDNZone description: Directory index for SDN zone status. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: zone in: path required: true description: zone schema: type: string responses: "200": $ref: "#/components/responses/GetNodeSDNZoneResponse" "/nodes/{node}/sdn/zones/{zone}/content": get: operationId: getNodeSDNZoneContent summary: getNodeSDNZoneContent description: List zone content. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: zone in: path required: true description: zone schema: type: string responses: "200": $ref: "#/components/responses/GetNodeSDNZoneContentResponse" "/nodes/{node}/sdn/zones/{zone}/bridges": get: operationId: getNodesSingleSdnZonesSingleBridges summary: getNodesSingleSdnZonesSingleBridges description: >- Get a list of all bridges (vnets) that are part of a zone, as well as the ports that are members of that bridge. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: zone in: path required: true description: zone schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleSdnZonesSingleBridgesResponse" "/nodes/{node}/sdn/zones/{zone}/ip-vrf": get: operationId: getNodesSingleSdnZonesSingleIpvrf summary: getNodesSingleSdnZonesSingleIpvrf description: Get the IP VRF of an EVPN zone. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: zone in: path required: true description: zone schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleSdnZonesSingleIpvrfResponse" "/nodes/{node}/sdn/vnets/{vnet}": get: operationId: getNodesSingleSdnVnetsSingle summary: getNodesSingleSdnVnetsSingle description: getNodesSingleSdnVnetsSingle tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vnet in: path required: true description: vnet schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleSdnVnetsSingleResponse" "/nodes/{node}/sdn/vnets/{vnet}/mac-vrf": get: operationId: getNodesSingleSdnVnetsSingleMacvrf summary: getNodesSingleSdnVnetsSingleMacvrf description: Get the MAC VRF for a VNet in an EVPN zone. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string - name: vnet in: path required: true description: vnet schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleSdnVnetsSingleMacvrfResponse" "/nodes/{node}/version": get: operationId: getNodesSingleVersion summary: getNodesSingleVersion description: API version details tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleVersionResponse" "/nodes/{node}/status": get: operationId: getNodesSingleStatus summary: getNodesSingleStatus description: Read node status tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleStatusResponse" post: operationId: createNodesSingleStatus summary: createNodesSingleStatus description: Reboot or shutdown a node. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/CreateNodesSingleStatusResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleStatusRequest" "/nodes/{node}/netstat": get: operationId: getNodesSingleNetstat summary: getNodesSingleNetstat description: Read tap/vm network device interface counters tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleNetstatResponse" "/nodes/{node}/execute": post: operationId: createNodesSingleExecute summary: createNodesSingleExecute description: "Execute multiple commands in order, root only." tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/CreateNodesSingleExecuteResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleExecuteRequest" "/nodes/{node}/wakeonlan": post: operationId: createNodesSingleWakeonlan summary: createNodesSingleWakeonlan description: Try to wake a node via 'wake on LAN' network packet. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/CreateNodesSingleWakeonlanResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleWakeonlanRequest" "/nodes/{node}/rrd": get: operationId: getNodeRRD summary: getNodeRRD description: Read node RRD statistics (returns PNG) tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodeRRDResponse" "/nodes/{node}/rrddata": get: operationId: getNodeRRDData summary: getNodeRRDData description: Read node RRD statistics tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodeRRDDataResponse" "/nodes/{node}/syslog": get: operationId: getNodesSingleSyslog summary: getNodesSingleSyslog description: Read system log tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleSyslogResponse" "/nodes/{node}/journal": get: operationId: getNodesSingleJournal summary: getNodesSingleJournal description: Read Journal tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleJournalResponse" "/nodes/{node}/vncshell": post: operationId: createNodesSingleVncshell summary: createNodesSingleVncshell description: Creates a VNC Shell proxy. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/CreateNodesSingleVncshellResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleVncshellRequest" "/nodes/{node}/termproxy": post: operationId: createNodesSingleTermproxy summary: createNodesSingleTermproxy description: Creates a VNC Shell proxy. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/CreateNodesSingleTermproxyResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleTermproxyRequest" "/nodes/{node}/vncwebsocket": get: operationId: getNodesSingleVncwebsocket summary: getNodesSingleVncwebsocket description: Opens a websocket for VNC traffic. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleVncwebsocketResponse" "/nodes/{node}/spiceshell": post: operationId: createNodesSingleSpiceshell summary: createNodesSingleSpiceshell description: Creates a SPICE shell. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/CreateNodesSingleSpiceshellResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleSpiceshellRequest" "/nodes/{node}/dns": get: operationId: getNodesSingleDns summary: getNodesSingleDns description: Read DNS settings. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleDnsResponse" put: operationId: updateNodesSingleDns summary: updateNodesSingleDns description: Write DNS settings. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/UpdateNodesSingleDnsResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateNodesSingleDnsRequest" "/nodes/{node}/time": get: operationId: getNodesSingleTime summary: getNodesSingleTime description: Read server time and time zone settings. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleTimeResponse" put: operationId: updateNodesSingleTime summary: updateNodesSingleTime description: Set time zone. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/UpdateNodesSingleTimeResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateNodesSingleTimeRequest" "/nodes/{node}/aplinfo": get: operationId: getNodesSingleAplinfo summary: getNodesSingleAplinfo description: Get list of appliances. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleAplinfoResponse" post: operationId: createNodesSingleAplinfo summary: createNodesSingleAplinfo description: Download appliance templates. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/CreateNodesSingleAplinfoResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleAplinfoRequest" "/nodes/{node}/query-oci-repo-tags": get: operationId: getNodesSingleQueryocirepotags summary: getNodesSingleQueryocirepotags description: List all tags for an OCI repository reference. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleQueryocirepotagsResponse" "/nodes/{node}/query-url-metadata": get: operationId: getNodesSingleQueryurlmetadata summary: getNodesSingleQueryurlmetadata description: "Query metadata of an URL: file size, file name and mime type." tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleQueryurlmetadataResponse" "/nodes/{node}/report": get: operationId: getNodesSingleReport summary: getNodesSingleReport description: Gather various systems information about a node tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleReportResponse" "/nodes/{node}/startall": post: operationId: createNodesSingleStartall summary: createNodesSingleStartall description: >- Start all VMs and containers located on this node (by default only those with onboot=1). tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/CreateNodesSingleStartallResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleStartallRequest" "/nodes/{node}/stopall": post: operationId: createNodesSingleStopall summary: createNodesSingleStopall description: Stop all VMs and Containers. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/CreateNodesSingleStopallResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleStopallRequest" "/nodes/{node}/suspendall": post: operationId: createNodesSingleSuspendall summary: createNodesSingleSuspendall description: Suspend all VMs. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/CreateNodesSingleSuspendallResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleSuspendallRequest" "/nodes/{node}/migrateall": post: operationId: createNodesSingleMigrateall summary: createNodesSingleMigrateall description: Migrate all VMs and Containers. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/CreateNodesSingleMigrateallResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleMigrateallRequest" "/nodes/{node}/hosts": get: operationId: getNodesSingleHosts summary: getNodesSingleHosts description: Get the content of /etc/hosts. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/GetNodesSingleHostsResponse" post: operationId: createNodesSingleHosts summary: createNodesSingleHosts description: Write /etc/hosts. tags: - nodes parameters: - name: node in: path required: true description: node schema: type: string responses: "200": $ref: "#/components/responses/CreateNodesSingleHostsResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNodesSingleHostsRequest" /storage: get: operationId: getStorage summary: getStorage description: Storage index. tags: - storage parameters: [] responses: "200": $ref: "#/components/responses/GetStorageResponse" post: operationId: createStorage summary: createStorage description: Create a new storage. tags: - storage parameters: [] responses: "200": $ref: "#/components/responses/CreateStorageResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateStorageRequest" "/storage/{storage}": delete: operationId: deleteStorageSingle summary: deleteStorageSingle description: Delete storage configuration. tags: - storage parameters: - name: storage in: path required: true description: storage schema: type: string responses: "200": $ref: "#/components/responses/DeleteStorageSingleResponse" get: operationId: getStorageSingle summary: getStorageSingle description: Read storage configuration. tags: - storage parameters: - name: storage in: path required: true description: storage schema: type: string responses: "200": $ref: "#/components/responses/GetStorageSingleResponse" put: operationId: updateStorageSingle summary: updateStorageSingle description: Update storage configuration. tags: - storage parameters: - name: storage in: path required: true description: storage schema: type: string responses: "200": $ref: "#/components/responses/UpdateStorageSingleResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateStorageSingleRequest" /access: get: operationId: getAccess summary: getAccess description: Directory index. tags: - access parameters: [] responses: "200": $ref: "#/components/responses/GetAccessResponse" /access/users: get: operationId: getAccessUsers summary: getAccessUsers description: User index. tags: - access parameters: [] responses: "200": $ref: "#/components/responses/GetAccessUsersResponse" post: operationId: createAccessUsers summary: createAccessUsers description: Create new user. tags: - access parameters: [] responses: "200": $ref: "#/components/responses/CreateAccessUsersResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateAccessUsersRequest" "/access/users/{userid}": delete: operationId: deleteAccessUsersSingle summary: deleteAccessUsersSingle description: Delete user. tags: - access parameters: - name: userid in: path required: true description: userid schema: type: string responses: "200": $ref: "#/components/responses/DeleteAccessUsersSingleResponse" get: operationId: getAccessUsersSingle summary: getAccessUsersSingle description: Get user configuration. tags: - access parameters: - name: userid in: path required: true description: userid schema: type: string responses: "200": $ref: "#/components/responses/GetAccessUsersSingleResponse" put: operationId: updateAccessUsersSingle summary: updateAccessUsersSingle description: Update user configuration. tags: - access parameters: - name: userid in: path required: true description: userid schema: type: string responses: "200": $ref: "#/components/responses/UpdateAccessUsersSingleResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateAccessUsersSingleRequest" "/access/users/{userid}/tfa": get: operationId: getAccessUsersSingleTfa summary: getAccessUsersSingleTfa description: Get user TFA types (Personal and Realm). tags: - access parameters: - name: userid in: path required: true description: userid schema: type: string responses: "200": $ref: "#/components/responses/GetAccessUsersSingleTfaResponse" "/access/users/{userid}/unlock-tfa": put: operationId: updateAccessUsersSingleUnlocktfa summary: updateAccessUsersSingleUnlocktfa description: Unlock a user's TFA authentication. tags: - access parameters: - name: userid in: path required: true description: userid schema: type: string responses: "200": $ref: "#/components/responses/UpdateAccessUsersSingleUnlocktfaResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateAccessUsersSingleUnlocktfaRequest" "/access/users/{userid}/token": get: operationId: getAccessUsersSingleToken summary: getAccessUsersSingleToken description: Get user API tokens. tags: - access parameters: - name: userid in: path required: true description: userid schema: type: string responses: "200": $ref: "#/components/responses/GetAccessUsersSingleTokenResponse" "/access/users/{userid}/token/{tokenid}": delete: operationId: deleteAccessUsersSingleTokenSingle summary: deleteAccessUsersSingleTokenSingle description: Remove API token for a specific user. tags: - access parameters: - name: tokenid in: path required: true description: tokenid schema: type: string - name: userid in: path required: true description: userid schema: type: string responses: "200": $ref: "#/components/responses/DeleteAccessUsersSingleTokenSingleResponse" get: operationId: getAccessUsersSingleTokenSingle summary: getAccessUsersSingleTokenSingle description: Get specific API token information. tags: - access parameters: - name: tokenid in: path required: true description: tokenid schema: type: string - name: userid in: path required: true description: userid schema: type: string responses: "200": $ref: "#/components/responses/GetAccessUsersSingleTokenSingleResponse" post: operationId: createAccessUsersSingleTokenSingle summary: createAccessUsersSingleTokenSingle description: >- Generate a new API token for a specific user. NOTE: returns API token value, which needs to be stored as it cannot be retrieved afterwards! tags: - access parameters: - name: tokenid in: path required: true description: tokenid schema: type: string - name: userid in: path required: true description: userid schema: type: string responses: "200": $ref: "#/components/responses/CreateAccessUsersSingleTokenSingleResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateAccessUsersSingleTokenSingleRequest" put: operationId: updateAccessUsersSingleTokenSingle summary: updateAccessUsersSingleTokenSingle description: Update API token for a specific user. tags: - access parameters: - name: tokenid in: path required: true description: tokenid schema: type: string - name: userid in: path required: true description: userid schema: type: string responses: "200": $ref: "#/components/responses/UpdateAccessUsersSingleTokenSingleResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateAccessUsersSingleTokenSingleRequest" /access/groups: get: operationId: getAccessGroups summary: getAccessGroups description: Group index. tags: - access parameters: [] responses: "200": $ref: "#/components/responses/GetAccessGroupsResponse" post: operationId: createAccessGroups summary: createAccessGroups description: Create new group. tags: - access parameters: [] responses: "200": $ref: "#/components/responses/CreateAccessGroupsResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateAccessGroupsRequest" "/access/groups/{groupid}": delete: operationId: deleteAccessGroupsSingle summary: deleteAccessGroupsSingle description: Delete group. tags: - access parameters: - name: groupid in: path required: true description: groupid schema: type: string responses: "200": $ref: "#/components/responses/DeleteAccessGroupsSingleResponse" get: operationId: getAccessGroupsSingle summary: getAccessGroupsSingle description: Get group configuration. tags: - access parameters: - name: groupid in: path required: true description: groupid schema: type: string responses: "200": $ref: "#/components/responses/GetAccessGroupsSingleResponse" put: operationId: updateAccessGroupsSingle summary: updateAccessGroupsSingle description: Update group data. tags: - access parameters: - name: groupid in: path required: true description: groupid schema: type: string responses: "200": $ref: "#/components/responses/UpdateAccessGroupsSingleResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateAccessGroupsSingleRequest" /access/roles: get: operationId: getAccessRoles summary: getAccessRoles description: Role index. tags: - access parameters: [] responses: "200": $ref: "#/components/responses/GetAccessRolesResponse" post: operationId: createAccessRoles summary: createAccessRoles description: Create new role. tags: - access parameters: [] responses: "200": $ref: "#/components/responses/CreateAccessRolesResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateAccessRolesRequest" "/access/roles/{roleid}": delete: operationId: deleteAccessRolesSingle summary: deleteAccessRolesSingle description: Delete role. tags: - access parameters: - name: roleid in: path required: true description: roleid schema: type: string responses: "200": $ref: "#/components/responses/DeleteAccessRolesSingleResponse" get: operationId: getAccessRolesSingle summary: getAccessRolesSingle description: Get role configuration. tags: - access parameters: - name: roleid in: path required: true description: roleid schema: type: string responses: "200": $ref: "#/components/responses/GetAccessRolesSingleResponse" put: operationId: updateAccessRolesSingle summary: updateAccessRolesSingle description: Update an existing role. tags: - access parameters: - name: roleid in: path required: true description: roleid schema: type: string responses: "200": $ref: "#/components/responses/UpdateAccessRolesSingleResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateAccessRolesSingleRequest" /access/acl: get: operationId: getAccessAcl summary: getAccessAcl description: Get Access Control List (ACLs). tags: - access parameters: [] responses: "200": $ref: "#/components/responses/GetAccessAclResponse" put: operationId: updateAccessAcl summary: updateAccessAcl description: Update Access Control List (add or remove permissions). tags: - access parameters: [] responses: "200": $ref: "#/components/responses/UpdateAccessAclResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateAccessAclRequest" /access/domains: get: operationId: getAccessDomains summary: getAccessDomains description: Authentication domain index. tags: - access parameters: [] responses: "200": $ref: "#/components/responses/GetAccessDomainsResponse" post: operationId: createAccessDomains summary: createAccessDomains description: Add an authentication server. tags: - access parameters: [] responses: "200": $ref: "#/components/responses/CreateAccessDomainsResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateAccessDomainsRequest" "/access/domains/{realm}": delete: operationId: deleteAccessDomainsSingle summary: deleteAccessDomainsSingle description: Delete an authentication server. tags: - access parameters: - name: realm in: path required: true description: realm schema: type: string responses: "200": $ref: "#/components/responses/DeleteAccessDomainsSingleResponse" get: operationId: getAccessDomainsSingle summary: getAccessDomainsSingle description: Get auth server configuration. tags: - access parameters: - name: realm in: path required: true description: realm schema: type: string responses: "200": $ref: "#/components/responses/GetAccessDomainsSingleResponse" put: operationId: updateAccessDomainsSingle summary: updateAccessDomainsSingle description: Update authentication server settings. tags: - access parameters: - name: realm in: path required: true description: realm schema: type: string responses: "200": $ref: "#/components/responses/UpdateAccessDomainsSingleResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateAccessDomainsSingleRequest" "/access/domains/{realm}/sync": post: operationId: createAccessDomainsSingleSync summary: createAccessDomainsSingleSync description: >- Syncs users and/or groups from the configured LDAP to user.cfg. NOTE: Synced groups will have the name 'name-$realm', so make sure those groups do not exist to prevent overwriting. tags: - access parameters: - name: realm in: path required: true description: realm schema: type: string responses: "200": $ref: "#/components/responses/CreateAccessDomainsSingleSyncResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateAccessDomainsSingleSyncRequest" /access/openid: get: operationId: getAccessOpenid summary: getAccessOpenid description: Directory index. tags: - access parameters: [] responses: "200": $ref: "#/components/responses/GetAccessOpenidResponse" /access/openid/auth-url: post: operationId: createAccessOpenidAuthurl summary: createAccessOpenidAuthurl description: Get the OpenId Authorization Url for the specified realm. tags: - access parameters: [] responses: "200": $ref: "#/components/responses/CreateAccessOpenidAuthurlResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateAccessOpenidAuthurlRequest" /access/openid/login: post: operationId: createAccessOpenidLogin summary: createAccessOpenidLogin description: " Verify OpenID authorization code and create a ticket." tags: - access parameters: [] responses: "200": $ref: "#/components/responses/CreateAccessOpenidLoginResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateAccessOpenidLoginRequest" /access/tfa: get: operationId: getAccessTfa summary: getAccessTfa description: List TFA configurations of users. tags: - access parameters: [] responses: "200": $ref: "#/components/responses/GetAccessTfaResponse" "/access/tfa/{userid}": get: operationId: getAccessTfaSingle summary: getAccessTfaSingle description: List TFA configurations of users. tags: - access parameters: - name: userid in: path required: true description: userid schema: type: string responses: "200": $ref: "#/components/responses/GetAccessTfaSingleResponse" post: operationId: createAccessTfaSingle summary: createAccessTfaSingle description: Add a TFA entry for a user. tags: - access parameters: - name: userid in: path required: true description: userid schema: type: string responses: "200": $ref: "#/components/responses/CreateAccessTfaSingleResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateAccessTfaSingleRequest" "/access/tfa/{userid}/{id}": delete: operationId: deleteAccessTfaSingleSingle summary: deleteAccessTfaSingleSingle description: Delete a TFA entry by ID. tags: - access parameters: - name: id in: path required: true description: id schema: type: string - name: userid in: path required: true description: userid schema: type: string responses: "200": $ref: "#/components/responses/DeleteAccessTfaSingleSingleResponse" get: operationId: getAccessTfaSingleSingle summary: getAccessTfaSingleSingle description: Fetch a requested TFA entry if present. tags: - access parameters: - name: id in: path required: true description: id schema: type: string - name: userid in: path required: true description: userid schema: type: string responses: "200": $ref: "#/components/responses/GetAccessTfaSingleSingleResponse" put: operationId: updateAccessTfaSingleSingle summary: updateAccessTfaSingleSingle description: Add a TFA entry for a user. tags: - access parameters: - name: id in: path required: true description: id schema: type: string - name: userid in: path required: true description: userid schema: type: string responses: "200": $ref: "#/components/responses/UpdateAccessTfaSingleSingleResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateAccessTfaSingleSingleRequest" /access/ticket: get: operationId: getAccessTicket summary: getAccessTicket description: Dummy. Useful for formatters which want to provide a login page. tags: - access parameters: [] responses: "200": $ref: "#/components/responses/GetAccessTicketResponse" post: operationId: createAccessTicket summary: createAccessTicket description: Create or verify authentication ticket. tags: - access parameters: [] responses: "200": $ref: "#/components/responses/CreateAccessTicketResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateAccessTicketRequest" /access/vncticket: post: operationId: createAccessVncticket summary: createAccessVncticket description: verify VNC authentication ticket. tags: - access parameters: [] responses: "200": $ref: "#/components/responses/CreateAccessVncticketResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateAccessVncticketRequest" /access/password: put: operationId: updateAccessPassword summary: updateAccessPassword description: Change user password. tags: - access parameters: [] responses: "200": $ref: "#/components/responses/UpdateAccessPasswordResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateAccessPasswordRequest" /access/permissions: get: operationId: getAccessPermissions summary: getAccessPermissions description: Retrieve effective permissions of given user/token. tags: - access parameters: [] responses: "200": $ref: "#/components/responses/GetAccessPermissionsResponse" /pools: delete: operationId: deletePools summary: deletePools description: Delete pool. tags: - pools parameters: [] responses: "200": $ref: "#/components/responses/DeletePoolsResponse" get: operationId: getPools summary: getPools description: List pools or get pool configuration. tags: - pools parameters: [] responses: "200": $ref: "#/components/responses/GetPoolsResponse" post: operationId: createPool summary: createPool description: Create new pool. tags: - pools parameters: [] responses: "200": $ref: "#/components/responses/CreatePoolResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreatePoolRequest" put: operationId: updatePools summary: updatePools description: Update pool. tags: - pools parameters: [] responses: "200": $ref: "#/components/responses/UpdatePoolsResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdatePoolsRequest" "/pools/{poolid}": delete: operationId: deletePool summary: deletePool description: >- Delete pool (deprecated, no support for nested pools, use 'DELETE /pools/?poolid={poolid}'). tags: - pools parameters: - name: poolid in: path required: true description: poolid schema: type: string responses: "200": $ref: "#/components/responses/DeletePoolResponse" get: operationId: getPool summary: getPool description: >- Get pool configuration (deprecated, no support for nested pools, use 'GET /pools/?poolid={poolid}'). tags: - pools parameters: - name: poolid in: path required: true description: poolid schema: type: string responses: "200": $ref: "#/components/responses/GetPoolResponse" put: operationId: updatePool summary: updatePool description: >- Update pool data (deprecated, no support for nested pools - use 'PUT /pools/?poolid={poolid}' instead). tags: - pools parameters: - name: poolid in: path required: true description: poolid schema: type: string responses: "200": $ref: "#/components/responses/UpdatePoolResponse" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdatePoolRequest" /version: get: operationId: getVersion summary: getVersion description: >- API version details, including some parts of the global datacenter config. tags: - version parameters: [] responses: "200": $ref: "#/components/responses/GetVersionResponse" components: schemas: CreateClusterReplicationRequest: title: CreateClusterReplicationRequest type: object properties: comment: type: string disable: type: boolean id: type: string rate: type: number remove_job: type: string schedule: type: string source: type: string target: type: string type: type: string required: - id - target - type UpdateClusterReplicationSingleRequest: title: UpdateClusterReplicationSingleRequest type: object properties: comment: type: string delete: type: string digest: type: string disable: type: boolean rate: type: number remove_job: type: string schedule: type: string source: type: string CreateClusterMetricsServerSingleRequest: title: CreateClusterMetricsServerSingleRequest type: object properties: api-path-prefix: type: string bucket: type: string disable: type: boolean influxdbproto: type: string max-body-size: type: integer mtu: type: integer organization: type: string otel-compression: type: string otel-headers: type: string otel-max-body-size: type: integer otel-path: type: string otel-protocol: type: string otel-resource-attributes: type: string otel-timeout: type: integer otel-verify-ssl: type: boolean path: type: string port: type: integer proto: type: string server: type: string timeout: type: integer token: type: string type: type: string verify-certificate: type: boolean required: - port - server - type UpdateClusterMetricsServerSingleRequest: title: UpdateClusterMetricsServerSingleRequest type: object properties: api-path-prefix: type: string bucket: type: string delete: type: string digest: type: string disable: type: boolean influxdbproto: type: string max-body-size: type: integer mtu: type: integer organization: type: string otel-compression: type: string otel-headers: type: string otel-max-body-size: type: integer otel-path: type: string otel-protocol: type: string otel-resource-attributes: type: string otel-timeout: type: integer otel-verify-ssl: type: boolean path: type: string port: type: integer proto: type: string server: type: string timeout: type: integer token: type: string verify-certificate: type: boolean required: - port - server CreateClusterNotificationsEndpointsSendmailRequest: title: CreateClusterNotificationsEndpointsSendmailRequest type: object properties: author: type: string comment: type: string disable: type: boolean from-address: type: string mailto: type: array items: type: string mailto-user: type: array items: type: string name: type: string required: - name UpdateClusterNotificationsEndpointsSendmailSingleRequest: title: UpdateClusterNotificationsEndpointsSendmailSingleRequest type: object properties: author: type: string comment: type: string delete: type: array items: type: string digest: type: string disable: type: boolean from-address: type: string mailto: type: array items: type: string mailto-user: type: array items: type: string CreateClusterNotificationsEndpointsGotifyRequest: title: CreateClusterNotificationsEndpointsGotifyRequest type: object properties: comment: type: string disable: type: boolean name: type: string server: type: string token: type: string required: - name - server - token UpdateClusterNotificationsEndpointsGotifySingleRequest: title: UpdateClusterNotificationsEndpointsGotifySingleRequest type: object properties: comment: type: string delete: type: array items: type: string digest: type: string disable: type: boolean server: type: string token: type: string CreateClusterNotificationsEndpointsSmtpRequest: title: CreateClusterNotificationsEndpointsSmtpRequest type: object properties: author: type: string comment: type: string disable: type: boolean from-address: type: string mailto: type: array items: type: string mailto-user: type: array items: type: string mode: type: string name: type: string password: type: string port: type: integer server: type: string username: type: string required: - from-address - name - server UpdateClusterNotificationsEndpointsSmtpSingleRequest: title: UpdateClusterNotificationsEndpointsSmtpSingleRequest type: object properties: author: type: string comment: type: string delete: type: array items: type: string digest: type: string disable: type: boolean from-address: type: string mailto: type: array items: type: string mailto-user: type: array items: type: string mode: type: string password: type: string port: type: integer server: type: string username: type: string CreateClusterNotificationsEndpointsWebhookRequest: title: CreateClusterNotificationsEndpointsWebhookRequest type: object properties: body: type: string comment: type: string disable: type: boolean header: type: array items: type: string method: type: string name: type: string secret: type: array items: type: string url: type: string required: - method - name - url UpdateClusterNotificationsEndpointsWebhookSingleRequest: title: UpdateClusterNotificationsEndpointsWebhookSingleRequest type: object properties: body: type: string comment: type: string delete: type: array items: type: string digest: type: string disable: type: boolean header: type: array items: type: string method: type: string secret: type: array items: type: string url: type: string CreateClusterNotificationsTargetsSingleTestRequest: title: CreateClusterNotificationsTargetsSingleTestRequest type: object properties: {} CreateClusterNotificationsMatchersRequest: title: CreateClusterNotificationsMatchersRequest type: object properties: comment: type: string disable: type: boolean invert-match: type: boolean match-calendar: type: array items: type: string match-field: type: array items: type: string match-severity: type: array items: type: string mode: type: string name: type: string target: type: array items: type: string required: - name UpdateClusterNotificationsMatchersSingleRequest: title: UpdateClusterNotificationsMatchersSingleRequest type: object properties: comment: type: string delete: type: array items: type: string digest: type: string disable: type: boolean invert-match: type: boolean match-calendar: type: array items: type: string match-field: type: array items: type: string match-severity: type: array items: type: string mode: type: string target: type: array items: type: string CreateClusterConfigRequest: title: CreateClusterConfigRequest type: object properties: clustername: type: string link0: type: string link1: type: string link2: type: string link3: type: string link4: type: string link5: type: string link6: type: string link7: type: string link8: type: string link9: type: string link10: type: string link11: type: string link12: type: string link13: type: string link14: type: string link15: type: string link16: type: string link17: type: string link18: type: string link19: type: string link20: type: string link21: type: string link22: type: string link23: type: string link24: type: string link25: type: string link26: type: string link27: type: string link28: type: string link29: type: string nodeid: type: integer votes: type: integer required: - clustername CreateClusterConfigNodesSingleRequest: title: CreateClusterConfigNodesSingleRequest type: object properties: apiversion: type: integer force: type: boolean link0: type: string link1: type: string link2: type: string link3: type: string link4: type: string link5: type: string link6: type: string link7: type: string link8: type: string link9: type: string link10: type: string link11: type: string link12: type: string link13: type: string link14: type: string link15: type: string link16: type: string link17: type: string link18: type: string link19: type: string link20: type: string link21: type: string link22: type: string link23: type: string link24: type: string link25: type: string link26: type: string link27: type: string link28: type: string link29: type: string new_node_ip: type: string nodeid: type: integer votes: type: integer CreateClusterConfigJoinRequest: title: CreateClusterConfigJoinRequest type: object properties: fingerprint: type: string force: type: boolean hostname: type: string link0: type: string link1: type: string link2: type: string link3: type: string link4: type: string link5: type: string link6: type: string link7: type: string link8: type: string link9: type: string link10: type: string link11: type: string link12: type: string link13: type: string link14: type: string link15: type: string link16: type: string link17: type: string link18: type: string link19: type: string link20: type: string link21: type: string link22: type: string link23: type: string link24: type: string link25: type: string link26: type: string link27: type: string link28: type: string link29: type: string nodeid: type: integer password: type: string votes: type: integer required: - fingerprint - hostname - password CreateClusterFirewallGroupRequest: title: CreateClusterFirewallGroupRequest type: object properties: comment: type: string digest: type: string group: type: string rename: type: string required: - group AddClusterFirewallGroupRuleRequest: title: AddClusterFirewallGroupRuleRequest type: object properties: action: type: string comment: type: string dest: type: string digest: type: string dport: type: string enable: type: integer icmp-type: type: string iface: type: string log: type: string macro: type: string pos: type: integer proto: type: string source: type: string sport: type: string type: type: string required: - action - type UpdateClusterFirewallGroupRuleRequest: title: UpdateClusterFirewallGroupRuleRequest type: object properties: action: type: string comment: type: string delete: type: string dest: type: string digest: type: string dport: type: string enable: type: integer icmp-type: type: string iface: type: string log: type: string macro: type: string moveto: type: integer proto: type: string source: type: string sport: type: string type: type: string AddClusterFirewallRuleRequest: title: AddClusterFirewallRuleRequest type: object properties: action: type: string comment: type: string dest: type: string digest: type: string dport: type: string enable: type: integer icmp-type: type: string iface: type: string log: type: string macro: type: string pos: type: integer proto: type: string source: type: string sport: type: string type: type: string required: - action - type UpdateClusterFirewallRuleRequest: title: UpdateClusterFirewallRuleRequest type: object properties: action: type: string comment: type: string delete: type: string dest: type: string digest: type: string dport: type: string enable: type: integer icmp-type: type: string iface: type: string log: type: string macro: type: string moveto: type: integer proto: type: string source: type: string sport: type: string type: type: string CreateClusterFirewallIPSetRequest: title: CreateClusterFirewallIPSetRequest type: object properties: comment: type: string digest: type: string name: type: string rename: type: string required: - name AddClusterFirewallIPSetIPRequest: title: AddClusterFirewallIPSetIPRequest type: object properties: cidr: type: string comment: type: string nomatch: type: boolean required: - cidr UpdateClusterFirewallIPSetIPRequest: title: UpdateClusterFirewallIPSetIPRequest type: object properties: comment: type: string digest: type: string nomatch: type: boolean CreateClusterFirewallAliasesRequest: title: CreateClusterFirewallAliasesRequest type: object properties: cidr: type: string comment: type: string name: type: string required: - cidr - name UpdateClusterFirewallAliasesSingleRequest: title: UpdateClusterFirewallAliasesSingleRequest type: object properties: cidr: type: string comment: type: string digest: type: string rename: type: string required: - cidr UpdateClusterFirewallOptionsRequest: title: UpdateClusterFirewallOptionsRequest type: object properties: delete: type: string digest: type: string ebtables: type: boolean enable: type: integer log_ratelimit: type: string policy_forward: type: string policy_in: type: string policy_out: type: string CreateClusterBackupRequest: title: CreateClusterBackupRequest type: object properties: all: type: boolean bwlimit: type: integer comment: type: string compress: type: string dow: type: string dumpdir: type: string enabled: type: boolean exclude: type: string exclude-path: type: array items: type: string fleecing: type: string id: type: string ionice: type: integer lockwait: type: integer mailnotification: type: string mailto: type: string maxfiles: type: integer mode: type: string node: type: string notes-template: type: string notification-mode: type: string pbs-change-detection-mode: type: string performance: type: string pigz: type: integer pool: type: string protected: type: boolean prune-backups: type: string quiet: type: boolean remove: type: boolean repeat-missed: type: boolean schedule: type: string script: type: string starttime: type: string stdexcludes: type: boolean stop: type: boolean stopwait: type: integer storage: type: string tmpdir: type: string vmid: type: string zstd: type: integer UpdateClusterBackupSingleRequest: title: UpdateClusterBackupSingleRequest type: object properties: all: type: boolean bwlimit: type: integer comment: type: string compress: type: string delete: type: string dow: type: string dumpdir: type: string enabled: type: boolean exclude: type: string exclude-path: type: array items: type: string fleecing: type: string ionice: type: integer lockwait: type: integer mailnotification: type: string mailto: type: string maxfiles: type: integer mode: type: string node: type: string notes-template: type: string notification-mode: type: string pbs-change-detection-mode: type: string performance: type: string pigz: type: integer pool: type: string protected: type: boolean prune-backups: type: string quiet: type: boolean remove: type: boolean repeat-missed: type: boolean schedule: type: string script: type: string starttime: type: string stdexcludes: type: boolean stop: type: boolean stopwait: type: integer storage: type: string tmpdir: type: string vmid: type: string zstd: type: integer CreateClusterHaResourcesRequest: title: CreateClusterHaResourcesRequest type: object properties: comment: type: string failback: type: boolean group: type: string max_relocate: type: integer max_restart: type: integer sid: type: string state: type: string type: type: string required: - sid UpdateClusterHaResourcesSingleRequest: title: UpdateClusterHaResourcesSingleRequest type: object properties: comment: type: string delete: type: string digest: type: string failback: type: boolean group: type: string max_relocate: type: integer max_restart: type: integer state: type: string CreateClusterHaResourcesSingleMigrateRequest: title: CreateClusterHaResourcesSingleMigrateRequest type: object properties: node: type: string required: - node CreateClusterHaResourcesSingleRelocateRequest: title: CreateClusterHaResourcesSingleRelocateRequest type: object properties: node: type: string required: - node CreateClusterHaGroupsRequest: title: CreateClusterHaGroupsRequest type: object properties: comment: type: string group: type: string nodes: type: string nofailback: type: boolean restricted: type: boolean type: type: string required: - group - nodes UpdateClusterHaGroupsSingleRequest: title: UpdateClusterHaGroupsSingleRequest type: object properties: comment: type: string delete: type: string digest: type: string nodes: type: string nofailback: type: boolean restricted: type: boolean CreateClusterHaRulesRequest: title: CreateClusterHaRulesRequest type: object properties: affinity: type: string comment: type: string disable: type: boolean nodes: type: string resources: type: string rule: type: string strict: type: boolean type: type: string required: - resources - rule - type UpdateClusterHaRulesSingleRequest: title: UpdateClusterHaRulesSingleRequest type: object properties: affinity: type: string comment: type: string delete: type: string digest: type: string disable: type: boolean nodes: type: string resources: type: string strict: type: boolean type: type: string required: - type CreateClusterAcmePluginsRequest: title: CreateClusterAcmePluginsRequest type: object properties: api: type: string data: type: string disable: type: boolean id: type: string nodes: type: string type: type: string validation-delay: type: integer required: - id - type UpdateClusterAcmePluginsSingleRequest: title: UpdateClusterAcmePluginsSingleRequest type: object properties: api: type: string data: type: string delete: type: string digest: type: string disable: type: boolean nodes: type: string validation-delay: type: integer CreateClusterAcmeAccountRequest: title: CreateClusterAcmeAccountRequest type: object properties: contact: type: string directory: type: string eab-hmac-key: type: string eab-kid: type: string name: type: string tos_url: type: string required: - contact UpdateClusterAcmeAccountSingleRequest: title: UpdateClusterAcmeAccountSingleRequest type: object properties: contact: type: string UpdateClusterCephFlagsRequest: title: UpdateClusterCephFlagsRequest type: object properties: nobackfill: type: boolean nodeep-scrub: type: boolean nodown: type: boolean noin: type: boolean noout: type: boolean norebalance: type: boolean norecover: type: boolean noscrub: type: boolean notieragent: type: boolean noup: type: boolean pause: type: boolean UpdateClusterCephFlagsSingleRequest: title: UpdateClusterCephFlagsSingleRequest type: object properties: value: type: boolean required: - value CreateClusterJobsRealmsyncSingleRequest: title: CreateClusterJobsRealmsyncSingleRequest type: object properties: comment: type: string enable-new: type: boolean enabled: type: boolean realm: type: string remove-vanished: type: string schedule: type: string scope: type: string required: - schedule UpdateClusterJobsRealmsyncSingleRequest: title: UpdateClusterJobsRealmsyncSingleRequest type: object properties: comment: type: string delete: type: string enable-new: type: boolean enabled: type: boolean remove-vanished: type: string schedule: type: string scope: type: string required: - schedule CreateClusterMappingDirRequest: title: CreateClusterMappingDirRequest type: object properties: description: type: string id: type: string map: type: array items: type: string required: - id - map UpdateClusterMappingDirSingleRequest: title: UpdateClusterMappingDirSingleRequest type: object properties: delete: type: string description: type: string digest: type: string map: type: array items: type: string CreateClusterMappingPciRequest: title: CreateClusterMappingPciRequest type: object properties: description: type: string id: type: string live-migration-capable: type: boolean map: type: array items: type: string mdev: type: boolean required: - id - map UpdateClusterMappingPciSingleRequest: title: UpdateClusterMappingPciSingleRequest type: object properties: delete: type: string description: type: string digest: type: string live-migration-capable: type: boolean map: type: array items: type: string mdev: type: boolean CreateClusterMappingUsbRequest: title: CreateClusterMappingUsbRequest type: object properties: description: type: string id: type: string map: type: array items: type: string required: - id - map UpdateClusterMappingUsbSingleRequest: title: UpdateClusterMappingUsbSingleRequest type: object properties: delete: type: string description: type: string digest: type: string map: type: array items: type: string required: - map CreateClusterBulkactionGuestStartRequest: title: CreateClusterBulkactionGuestStartRequest type: object properties: maxworkers: type: integer timeout: type: integer vms: type: array items: type: integer CreateClusterBulkactionGuestShutdownRequest: title: CreateClusterBulkactionGuestShutdownRequest type: object properties: force-stop: type: boolean maxworkers: type: integer timeout: type: integer vms: type: array items: type: integer CreateClusterBulkactionGuestSuspendRequest: title: CreateClusterBulkactionGuestSuspendRequest type: object properties: maxworkers: type: integer statestorage: type: string to-disk: type: boolean vms: type: array items: type: integer CreateClusterBulkactionGuestMigrateRequest: title: CreateClusterBulkactionGuestMigrateRequest type: object properties: maxworkers: type: integer online: type: boolean target: type: string vms: type: array items: type: integer with-local-disks: type: boolean required: - target UpdateClusterSDNRequest: title: UpdateClusterSDNRequest type: object properties: lock-token: type: string release-lock: type: boolean CreateClusterSDNVnetRequest: title: CreateClusterSDNVnetRequest type: object properties: alias: type: string isolate-ports: type: boolean lock-token: type: string tag: type: integer type: type: string vlanaware: type: boolean vnet: type: string zone: type: string required: - vnet - zone UpdateClusterSDNVnetRequest: title: UpdateClusterSDNVnetRequest type: object properties: alias: type: string delete: type: string digest: type: string isolate-ports: type: boolean lock-token: type: string tag: type: integer vlanaware: type: boolean zone: type: string CreateClusterSdnVnetsSingleFirewallRulesRequest: title: CreateClusterSdnVnetsSingleFirewallRulesRequest type: object properties: action: type: string comment: type: string dest: type: string digest: type: string dport: type: string enable: type: integer icmp-type: type: string iface: type: string log: type: string macro: type: string pos: type: integer proto: type: string source: type: string sport: type: string type: type: string required: - action - type UpdateClusterSdnVnetsSingleFirewallRulesSingleRequest: title: UpdateClusterSdnVnetsSingleFirewallRulesSingleRequest type: object properties: action: type: string comment: type: string delete: type: string dest: type: string digest: type: string dport: type: string enable: type: integer icmp-type: type: string iface: type: string log: type: string macro: type: string moveto: type: integer proto: type: string source: type: string sport: type: string type: type: string UpdateClusterSdnVnetsSingleFirewallOptionsRequest: title: UpdateClusterSdnVnetsSingleFirewallOptionsRequest type: object properties: delete: type: string digest: type: string enable: type: boolean log_level_forward: type: string policy_forward: type: string CreateClusterSdnVnetsSingleSubnetsRequest: title: CreateClusterSdnVnetsSingleSubnetsRequest type: object properties: dhcp-dns-server: type: string dhcp-range: type: array items: type: string dnszoneprefix: type: string gateway: type: string lock-token: type: string snat: type: boolean subnet: type: string type: type: string required: - subnet - type UpdateClusterSdnVnetsSingleSubnetsSingleRequest: title: UpdateClusterSdnVnetsSingleSubnetsSingleRequest type: object properties: delete: type: string dhcp-dns-server: type: string dhcp-range: type: array items: type: string digest: type: string dnszoneprefix: type: string gateway: type: string lock-token: type: string snat: type: boolean CreateClusterSdnVnetsSingleIpsRequest: title: CreateClusterSdnVnetsSingleIpsRequest type: object properties: ip: type: string mac: type: string zone: type: string required: - ip - zone UpdateClusterSdnVnetsSingleIpsRequest: title: UpdateClusterSdnVnetsSingleIpsRequest type: object properties: ip: type: string mac: type: string vmid: type: integer zone: type: string required: - ip - zone CreateClusterSDNZoneRequest: title: CreateClusterSDNZoneRequest type: object properties: advertise-subnets: type: boolean bridge: type: string bridge-disable-mac-learning: type: boolean controller: type: string dhcp: type: string disable-arp-nd-suppression: type: boolean dns: type: string dnszone: type: string dp-id: type: integer exitnodes: type: string exitnodes-local-routing: type: boolean exitnodes-primary: type: string fabric: type: string ipam: type: string lock-token: type: string mac: type: string mtu: type: integer nodes: type: string peers: type: string reversedns: type: string rt-import: type: string tag: type: integer type: type: string vlan-protocol: type: string vrf-vxlan: type: integer vxlan-port: type: integer zone: type: string required: - type - zone UpdateClusterSDNZoneRequest: title: UpdateClusterSDNZoneRequest type: object properties: advertise-subnets: type: boolean bridge: type: string bridge-disable-mac-learning: type: boolean controller: type: string delete: type: string dhcp: type: string digest: type: string disable-arp-nd-suppression: type: boolean dns: type: string dnszone: type: string dp-id: type: integer exitnodes: type: string exitnodes-local-routing: type: boolean exitnodes-primary: type: string fabric: type: string ipam: type: string lock-token: type: string mac: type: string mtu: type: integer nodes: type: string peers: type: string reversedns: type: string rt-import: type: string tag: type: integer vlan-protocol: type: string vrf-vxlan: type: integer vxlan-port: type: integer CreateClusterSDNControllerRequest: title: CreateClusterSDNControllerRequest type: object properties: asn: type: integer bgp-multipath-as-path-relax: type: boolean controller: type: string ebgp: type: boolean ebgp-multihop: type: integer fabric: type: string isis-domain: type: string isis-ifaces: type: string isis-net: type: string lock-token: type: string loopback: type: string node: type: string peers: type: string type: type: string required: - controller - type UpdateClusterSDNControllerRequest: title: UpdateClusterSDNControllerRequest type: object properties: asn: type: integer bgp-multipath-as-path-relax: type: boolean delete: type: string digest: type: string ebgp: type: boolean ebgp-multihop: type: integer fabric: type: string isis-domain: type: string isis-ifaces: type: string isis-net: type: string lock-token: type: string loopback: type: string node: type: string peers: type: string CreateClusterSdnIpamsRequest: title: CreateClusterSdnIpamsRequest type: object properties: fingerprint: type: string ipam: type: string lock-token: type: string section: type: integer token: type: string type: type: string url: type: string required: - ipam - type UpdateClusterSdnIpamsSingleRequest: title: UpdateClusterSdnIpamsSingleRequest type: object properties: delete: type: string digest: type: string fingerprint: type: string lock-token: type: string section: type: integer token: type: string url: type: string CreateClusterSdnDnsRequest: title: CreateClusterSdnDnsRequest type: object properties: dns: type: string fingerprint: type: string key: type: string lock-token: type: string reversemaskv6: type: integer reversev6mask: type: integer ttl: type: integer type: type: string url: type: string required: - dns - key - type - url UpdateClusterSdnDnsSingleRequest: title: UpdateClusterSdnDnsSingleRequest type: object properties: delete: type: string digest: type: string fingerprint: type: string key: type: string lock-token: type: string reversemaskv6: type: integer ttl: type: integer url: type: string CreateClusterSdnFabricsFabricRequest: title: CreateClusterSdnFabricsFabricRequest type: object properties: area: type: string csnp_interval: type: number digest: type: string hello_interval: type: number id: type: string ip6_prefix: type: string ip_prefix: type: string lock-token: type: string protocol: type: string required: - id - protocol UpdateClusterSdnFabricsFabricSingleRequest: title: UpdateClusterSdnFabricsFabricSingleRequest type: object properties: area: type: string csnp_interval: type: number delete: type: array digest: type: string hello_interval: type: number ip6_prefix: type: string ip_prefix: type: string lock-token: type: string protocol: type: string required: - delete - protocol CreateClusterSdnFabricsNodeSingleRequest: title: CreateClusterSdnFabricsNodeSingleRequest type: object properties: digest: type: string interfaces: type: array ip: type: string ip6: type: string lock-token: type: string node_id: type: string protocol: type: string required: - interfaces - node_id - protocol UpdateClusterSdnFabricsNodeSingleSingleRequest: title: UpdateClusterSdnFabricsNodeSingleSingleRequest type: object properties: delete: type: array items: type: string digest: type: string interfaces: type: array ip: type: string ip6: type: string lock-token: type: string protocol: type: string required: - interfaces - protocol CreateClusterSdnLockRequest: title: CreateClusterSdnLockRequest type: object properties: allow-pending: type: boolean CreateClusterSdnRollbackRequest: title: CreateClusterSdnRollbackRequest type: object properties: lock-token: type: string release-lock: type: boolean UpdateClusterOptionsRequest: title: UpdateClusterOptionsRequest type: object properties: bwlimit: type: string consent-text: type: string console: type: string crs: type: string delete: type: string description: type: string email_from: type: string fencing: type: string ha: type: string http_proxy: type: string keyboard: type: string language: type: string mac_prefix: type: string max_workers: type: integer migration: type: string migration_unsecure: type: boolean next-id: type: string notify: type: string registered-tags: type: string replication: type: string tag-style: type: string u2f: type: string user-tag-access: type: string webauthn: type: string CreateVMRequest: title: CreateVMRequest type: object properties: acpi: type: boolean affinity: type: string agent: type: string allow-ksm: type: boolean amd-sev: type: string arch: type: string archive: type: string args: type: string audio0: type: string autostart: type: boolean balloon: type: integer bios: type: string boot: type: string bootdisk: type: string bwlimit: type: integer cdrom: type: string cicustom: type: string cipassword: type: string citype: type: string ciupgrade: type: boolean ciuser: type: string cores: type: integer cpu: type: string cpulimit: type: number cpuunits: type: integer description: type: string efidisk0: type: string force: type: boolean freeze: type: boolean ha-managed: type: boolean hookscript: type: string hostpci0: type: string hostpci1: type: string hostpci2: type: string hostpci3: type: string hostpci4: type: string hostpci5: type: string hostpci6: type: string hostpci7: type: string hostpci8: type: string hostpci9: type: string hostpci10: type: string hostpci11: type: string hostpci12: type: string hostpci13: type: string hostpci14: type: string hostpci15: type: string hostpci16: type: string hostpci17: type: string hostpci18: type: string hostpci19: type: string hostpci20: type: string hostpci21: type: string hostpci22: type: string hostpci23: type: string hostpci24: type: string hostpci25: type: string hostpci26: type: string hostpci27: type: string hostpci28: type: string hostpci29: type: string hotplug: type: string hugepages: type: string ide0: type: string ide1: type: string ide2: type: string ide3: type: string ide4: type: string ide5: type: string ide6: type: string ide7: type: string ide8: type: string ide9: type: string ide10: type: string ide11: type: string ide12: type: string ide13: type: string ide14: type: string ide15: type: string ide16: type: string ide17: type: string ide18: type: string ide19: type: string ide20: type: string ide21: type: string ide22: type: string ide23: type: string ide24: type: string ide25: type: string ide26: type: string ide27: type: string ide28: type: string ide29: type: string import-working-storage: type: string intel-tdx: type: string ipconfig0: type: string ipconfig1: type: string ipconfig2: type: string ipconfig3: type: string ipconfig4: type: string ipconfig5: type: string ipconfig6: type: string ipconfig7: type: string ipconfig8: type: string ipconfig9: type: string ipconfig10: type: string ipconfig11: type: string ipconfig12: type: string ipconfig13: type: string ipconfig14: type: string ipconfig15: type: string ipconfig16: type: string ipconfig17: type: string ipconfig18: type: string ipconfig19: type: string ipconfig20: type: string ipconfig21: type: string ipconfig22: type: string ipconfig23: type: string ipconfig24: type: string ipconfig25: type: string ipconfig26: type: string ipconfig27: type: string ipconfig28: type: string ipconfig29: type: string ivshmem: type: string keephugepages: type: boolean keyboard: type: string kvm: type: boolean live-restore: type: boolean localtime: type: boolean lock: type: string machine: type: string memory: type: string migrate_downtime: type: number migrate_speed: type: integer name: type: string nameserver: type: string net0: type: string net1: type: string net2: type: string net3: type: string net4: type: string net5: type: string net6: type: string net7: type: string net8: type: string net9: type: string net10: type: string net11: type: string net12: type: string net13: type: string net14: type: string net15: type: string net16: type: string net17: type: string net18: type: string net19: type: string net20: type: string net21: type: string net22: type: string net23: type: string net24: type: string net25: type: string net26: type: string net27: type: string net28: type: string net29: type: string numa: type: boolean numa0: type: string numa1: type: string numa2: type: string numa3: type: string numa4: type: string numa5: type: string numa6: type: string numa7: type: string numa8: type: string numa9: type: string numa10: type: string numa11: type: string numa12: type: string numa13: type: string numa14: type: string numa15: type: string numa16: type: string numa17: type: string numa18: type: string numa19: type: string numa20: type: string numa21: type: string numa22: type: string numa23: type: string numa24: type: string numa25: type: string numa26: type: string numa27: type: string numa28: type: string numa29: type: string onboot: type: boolean ostype: type: string parallel0: type: string parallel1: type: string parallel2: type: string parallel3: type: string parallel4: type: string parallel5: type: string parallel6: type: string parallel7: type: string parallel8: type: string parallel9: type: string parallel10: type: string parallel11: type: string parallel12: type: string parallel13: type: string parallel14: type: string parallel15: type: string parallel16: type: string parallel17: type: string parallel18: type: string parallel19: type: string parallel20: type: string parallel21: type: string parallel22: type: string parallel23: type: string parallel24: type: string parallel25: type: string parallel26: type: string parallel27: type: string parallel28: type: string parallel29: type: string pool: type: string protection: type: boolean reboot: type: boolean rng0: type: string sata0: type: string sata1: type: string sata2: type: string sata3: type: string sata4: type: string sata5: type: string sata6: type: string sata7: type: string sata8: type: string sata9: type: string sata10: type: string sata11: type: string sata12: type: string sata13: type: string sata14: type: string sata15: type: string sata16: type: string sata17: type: string sata18: type: string sata19: type: string sata20: type: string sata21: type: string sata22: type: string sata23: type: string sata24: type: string sata25: type: string sata26: type: string sata27: type: string sata28: type: string sata29: type: string scsi0: type: string scsi1: type: string scsi2: type: string scsi3: type: string scsi4: type: string scsi5: type: string scsi6: type: string scsi7: type: string scsi8: type: string scsi9: type: string scsi10: type: string scsi11: type: string scsi12: type: string scsi13: type: string scsi14: type: string scsi15: type: string scsi16: type: string scsi17: type: string scsi18: type: string scsi19: type: string scsi20: type: string scsi21: type: string scsi22: type: string scsi23: type: string scsi24: type: string scsi25: type: string scsi26: type: string scsi27: type: string scsi28: type: string scsi29: type: string scsihw: type: string searchdomain: type: string serial0: type: string serial1: type: string serial2: type: string serial3: type: string serial4: type: string serial5: type: string serial6: type: string serial7: type: string serial8: type: string serial9: type: string serial10: type: string serial11: type: string serial12: type: string serial13: type: string serial14: type: string serial15: type: string serial16: type: string serial17: type: string serial18: type: string serial19: type: string serial20: type: string serial21: type: string serial22: type: string serial23: type: string serial24: type: string serial25: type: string serial26: type: string serial27: type: string serial28: type: string serial29: type: string shares: type: integer smbios1: type: string smp: type: integer sockets: type: integer spice_enhancements: type: string sshkeys: type: string start: type: boolean startdate: type: string startup: type: string storage: type: string tablet: type: boolean tags: type: string tdf: type: boolean template: type: boolean tpmstate0: type: string unique: type: boolean unused0: type: string unused1: type: string unused2: type: string unused3: type: string unused4: type: string unused5: type: string unused6: type: string unused7: type: string unused8: type: string unused9: type: string unused10: type: string unused11: type: string unused12: type: string unused13: type: string unused14: type: string unused15: type: string unused16: type: string unused17: type: string unused18: type: string unused19: type: string unused20: type: string unused21: type: string unused22: type: string unused23: type: string unused24: type: string unused25: type: string unused26: type: string unused27: type: string unused28: type: string unused29: type: string usb0: type: string usb1: type: string usb2: type: string usb3: type: string usb4: type: string usb5: type: string usb6: type: string usb7: type: string usb8: type: string usb9: type: string usb10: type: string usb11: type: string usb12: type: string usb13: type: string usb14: type: string usb15: type: string usb16: type: string usb17: type: string usb18: type: string usb19: type: string usb20: type: string usb21: type: string usb22: type: string usb23: type: string usb24: type: string usb25: type: string usb26: type: string usb27: type: string usb28: type: string usb29: type: string vcpus: type: integer vga: type: string virtio0: type: string virtio1: type: string virtio2: type: string virtio3: type: string virtio4: type: string virtio5: type: string virtio6: type: string virtio7: type: string virtio8: type: string virtio9: type: string virtio10: type: string virtio11: type: string virtio12: type: string virtio13: type: string virtio14: type: string virtio15: type: string virtio16: type: string virtio17: type: string virtio18: type: string virtio19: type: string virtio20: type: string virtio21: type: string virtio22: type: string virtio23: type: string virtio24: type: string virtio25: type: string virtio26: type: string virtio27: type: string virtio28: type: string virtio29: type: string virtiofs0: type: string virtiofs1: type: string virtiofs2: type: string virtiofs3: type: string virtiofs4: type: string virtiofs5: type: string virtiofs6: type: string virtiofs7: type: string virtiofs8: type: string virtiofs9: type: string virtiofs10: type: string virtiofs11: type: string virtiofs12: type: string virtiofs13: type: string virtiofs14: type: string virtiofs15: type: string virtiofs16: type: string virtiofs17: type: string virtiofs18: type: string virtiofs19: type: string virtiofs20: type: string virtiofs21: type: string virtiofs22: type: string virtiofs23: type: string virtiofs24: type: string virtiofs25: type: string virtiofs26: type: string virtiofs27: type: string virtiofs28: type: string virtiofs29: type: string vmgenid: type: string vmid: type: integer vmstatestorage: type: string watchdog: type: string required: - vmid CreateVMFirewallRuleRequest: title: CreateVMFirewallRuleRequest type: object properties: action: type: string comment: type: string dest: type: string digest: type: string dport: type: string enable: type: integer icmp-type: type: string iface: type: string log: type: string macro: type: string pos: type: integer proto: type: string source: type: string sport: type: string type: type: string required: - action - type UpdateVMFirewallRuleRequest: title: UpdateVMFirewallRuleRequest type: object properties: action: type: string comment: type: string delete: type: string dest: type: string digest: type: string dport: type: string enable: type: integer icmp-type: type: string iface: type: string log: type: string macro: type: string moveto: type: integer proto: type: string source: type: string sport: type: string type: type: string CreateNodesSingleQemuSingleFirewallAliasesRequest: title: CreateNodesSingleQemuSingleFirewallAliasesRequest type: object properties: cidr: type: string comment: type: string name: type: string required: - cidr - name UpdateNodesSingleQemuSingleFirewallAliasesSingleRequest: title: UpdateNodesSingleQemuSingleFirewallAliasesSingleRequest type: object properties: cidr: type: string comment: type: string digest: type: string rename: type: string required: - cidr CreateVMFirewallIPSetRequest: title: CreateVMFirewallIPSetRequest type: object properties: comment: type: string digest: type: string name: type: string rename: type: string required: - name AddVMFirewallIPSetIPRequest: title: AddVMFirewallIPSetIPRequest type: object properties: cidr: type: string comment: type: string nomatch: type: boolean required: - cidr UpdateVMFirewallIPSetIPRequest: title: UpdateVMFirewallIPSetIPRequest type: object properties: comment: type: string digest: type: string nomatch: type: boolean UpdateVMFirewallOptionsRequest: title: UpdateVMFirewallOptionsRequest type: object properties: delete: type: string dhcp: type: boolean digest: type: string enable: type: boolean ipfilter: type: boolean log_level_in: type: string log_level_out: type: string macfilter: type: boolean ndp: type: boolean policy_in: type: string policy_out: type: string radv: type: boolean CreateNodesSingleQemuSingleAgentRequest: title: CreateNodesSingleQemuSingleAgentRequest type: object properties: command: type: string required: - command CreateNodesSingleQemuSingleAgentFsfreezefreezeRequest: title: CreateNodesSingleQemuSingleAgentFsfreezefreezeRequest type: object properties: {} CreateNodesSingleQemuSingleAgentFsfreezestatusRequest: title: CreateNodesSingleQemuSingleAgentFsfreezestatusRequest type: object properties: {} CreateNodesSingleQemuSingleAgentFsfreezethawRequest: title: CreateNodesSingleQemuSingleAgentFsfreezethawRequest type: object properties: {} CreateNodesSingleQemuSingleAgentFstrimRequest: title: CreateNodesSingleQemuSingleAgentFstrimRequest type: object properties: {} CreateNodesSingleQemuSingleAgentPingRequest: title: CreateNodesSingleQemuSingleAgentPingRequest type: object properties: {} CreateNodesSingleQemuSingleAgentShutdownRequest: title: CreateNodesSingleQemuSingleAgentShutdownRequest type: object properties: {} CreateNodesSingleQemuSingleAgentSuspenddiskRequest: title: CreateNodesSingleQemuSingleAgentSuspenddiskRequest type: object properties: {} CreateNodesSingleQemuSingleAgentSuspendhybridRequest: title: CreateNodesSingleQemuSingleAgentSuspendhybridRequest type: object properties: {} CreateNodesSingleQemuSingleAgentSuspendramRequest: title: CreateNodesSingleQemuSingleAgentSuspendramRequest type: object properties: {} CreateNodesSingleQemuSingleAgentSetuserpasswordRequest: title: CreateNodesSingleQemuSingleAgentSetuserpasswordRequest type: object properties: crypted: type: boolean password: type: string username: type: string required: - password - username CreateNodesSingleQemuSingleAgentExecRequest: title: CreateNodesSingleQemuSingleAgentExecRequest type: object properties: command: type: array items: type: string input-data: type: string required: - command CreateNodesSingleQemuSingleAgentFilewriteRequest: title: CreateNodesSingleQemuSingleAgentFilewriteRequest type: object properties: content: type: string encode: type: boolean file: type: string required: - content - file UpdateVMConfigRequest: title: UpdateVMConfigRequest type: object properties: acpi: type: boolean affinity: type: string agent: type: string allow-ksm: type: boolean amd-sev: type: string arch: type: string args: type: string audio0: type: string autostart: type: boolean background_delay: type: integer balloon: type: integer bios: type: string boot: type: string bootdisk: type: string cdrom: type: string cicustom: type: string cipassword: type: string citype: type: string ciupgrade: type: boolean ciuser: type: string cores: type: integer cpu: type: string cpulimit: type: number cpuunits: type: integer delete: type: string description: type: string digest: type: string efidisk0: type: string force: type: boolean freeze: type: boolean hookscript: type: string hostpci0: type: string hostpci1: type: string hostpci2: type: string hostpci3: type: string hostpci4: type: string hostpci5: type: string hostpci6: type: string hostpci7: type: string hostpci8: type: string hostpci9: type: string hostpci10: type: string hostpci11: type: string hostpci12: type: string hostpci13: type: string hostpci14: type: string hostpci15: type: string hostpci16: type: string hostpci17: type: string hostpci18: type: string hostpci19: type: string hostpci20: type: string hostpci21: type: string hostpci22: type: string hostpci23: type: string hostpci24: type: string hostpci25: type: string hostpci26: type: string hostpci27: type: string hostpci28: type: string hostpci29: type: string hotplug: type: string hugepages: type: string ide0: type: string ide1: type: string ide2: type: string ide3: type: string ide4: type: string ide5: type: string ide6: type: string ide7: type: string ide8: type: string ide9: type: string ide10: type: string ide11: type: string ide12: type: string ide13: type: string ide14: type: string ide15: type: string ide16: type: string ide17: type: string ide18: type: string ide19: type: string ide20: type: string ide21: type: string ide22: type: string ide23: type: string ide24: type: string ide25: type: string ide26: type: string ide27: type: string ide28: type: string ide29: type: string import-working-storage: type: string intel-tdx: type: string ipconfig0: type: string ipconfig1: type: string ipconfig2: type: string ipconfig3: type: string ipconfig4: type: string ipconfig5: type: string ipconfig6: type: string ipconfig7: type: string ipconfig8: type: string ipconfig9: type: string ipconfig10: type: string ipconfig11: type: string ipconfig12: type: string ipconfig13: type: string ipconfig14: type: string ipconfig15: type: string ipconfig16: type: string ipconfig17: type: string ipconfig18: type: string ipconfig19: type: string ipconfig20: type: string ipconfig21: type: string ipconfig22: type: string ipconfig23: type: string ipconfig24: type: string ipconfig25: type: string ipconfig26: type: string ipconfig27: type: string ipconfig28: type: string ipconfig29: type: string ivshmem: type: string keephugepages: type: boolean keyboard: type: string kvm: type: boolean localtime: type: boolean lock: type: string machine: type: string memory: type: string migrate_downtime: type: number migrate_speed: type: integer name: type: string nameserver: type: string net0: type: string net1: type: string net2: type: string net3: type: string net4: type: string net5: type: string net6: type: string net7: type: string net8: type: string net9: type: string net10: type: string net11: type: string net12: type: string net13: type: string net14: type: string net15: type: string net16: type: string net17: type: string net18: type: string net19: type: string net20: type: string net21: type: string net22: type: string net23: type: string net24: type: string net25: type: string net26: type: string net27: type: string net28: type: string net29: type: string numa: type: boolean numa0: type: string numa1: type: string numa2: type: string numa3: type: string numa4: type: string numa5: type: string numa6: type: string numa7: type: string numa8: type: string numa9: type: string numa10: type: string numa11: type: string numa12: type: string numa13: type: string numa14: type: string numa15: type: string numa16: type: string numa17: type: string numa18: type: string numa19: type: string numa20: type: string numa21: type: string numa22: type: string numa23: type: string numa24: type: string numa25: type: string numa26: type: string numa27: type: string numa28: type: string numa29: type: string onboot: type: boolean ostype: type: string parallel0: type: string parallel1: type: string parallel2: type: string parallel3: type: string parallel4: type: string parallel5: type: string parallel6: type: string parallel7: type: string parallel8: type: string parallel9: type: string parallel10: type: string parallel11: type: string parallel12: type: string parallel13: type: string parallel14: type: string parallel15: type: string parallel16: type: string parallel17: type: string parallel18: type: string parallel19: type: string parallel20: type: string parallel21: type: string parallel22: type: string parallel23: type: string parallel24: type: string parallel25: type: string parallel26: type: string parallel27: type: string parallel28: type: string parallel29: type: string protection: type: boolean reboot: type: boolean revert: type: string rng0: type: string sata0: type: string sata1: type: string sata2: type: string sata3: type: string sata4: type: string sata5: type: string sata6: type: string sata7: type: string sata8: type: string sata9: type: string sata10: type: string sata11: type: string sata12: type: string sata13: type: string sata14: type: string sata15: type: string sata16: type: string sata17: type: string sata18: type: string sata19: type: string sata20: type: string sata21: type: string sata22: type: string sata23: type: string sata24: type: string sata25: type: string sata26: type: string sata27: type: string sata28: type: string sata29: type: string scsi0: type: string scsi1: type: string scsi2: type: string scsi3: type: string scsi4: type: string scsi5: type: string scsi6: type: string scsi7: type: string scsi8: type: string scsi9: type: string scsi10: type: string scsi11: type: string scsi12: type: string scsi13: type: string scsi14: type: string scsi15: type: string scsi16: type: string scsi17: type: string scsi18: type: string scsi19: type: string scsi20: type: string scsi21: type: string scsi22: type: string scsi23: type: string scsi24: type: string scsi25: type: string scsi26: type: string scsi27: type: string scsi28: type: string scsi29: type: string scsihw: type: string searchdomain: type: string serial0: type: string serial1: type: string serial2: type: string serial3: type: string serial4: type: string serial5: type: string serial6: type: string serial7: type: string serial8: type: string serial9: type: string serial10: type: string serial11: type: string serial12: type: string serial13: type: string serial14: type: string serial15: type: string serial16: type: string serial17: type: string serial18: type: string serial19: type: string serial20: type: string serial21: type: string serial22: type: string serial23: type: string serial24: type: string serial25: type: string serial26: type: string serial27: type: string serial28: type: string serial29: type: string shares: type: integer skiplock: type: boolean smbios1: type: string smp: type: integer sockets: type: integer spice_enhancements: type: string sshkeys: type: string startdate: type: string startup: type: string tablet: type: boolean tags: type: string tdf: type: boolean template: type: boolean tpmstate0: type: string unused0: type: string unused1: type: string unused2: type: string unused3: type: string unused4: type: string unused5: type: string unused6: type: string unused7: type: string unused8: type: string unused9: type: string unused10: type: string unused11: type: string unused12: type: string unused13: type: string unused14: type: string unused15: type: string unused16: type: string unused17: type: string unused18: type: string unused19: type: string unused20: type: string unused21: type: string unused22: type: string unused23: type: string unused24: type: string unused25: type: string unused26: type: string unused27: type: string unused28: type: string unused29: type: string usb0: type: string usb1: type: string usb2: type: string usb3: type: string usb4: type: string usb5: type: string usb6: type: string usb7: type: string usb8: type: string usb9: type: string usb10: type: string usb11: type: string usb12: type: string usb13: type: string usb14: type: string usb15: type: string usb16: type: string usb17: type: string usb18: type: string usb19: type: string usb20: type: string usb21: type: string usb22: type: string usb23: type: string usb24: type: string usb25: type: string usb26: type: string usb27: type: string usb28: type: string usb29: type: string vcpus: type: integer vga: type: string virtio0: type: string virtio1: type: string virtio2: type: string virtio3: type: string virtio4: type: string virtio5: type: string virtio6: type: string virtio7: type: string virtio8: type: string virtio9: type: string virtio10: type: string virtio11: type: string virtio12: type: string virtio13: type: string virtio14: type: string virtio15: type: string virtio16: type: string virtio17: type: string virtio18: type: string virtio19: type: string virtio20: type: string virtio21: type: string virtio22: type: string virtio23: type: string virtio24: type: string virtio25: type: string virtio26: type: string virtio27: type: string virtio28: type: string virtio29: type: string virtiofs0: type: string virtiofs1: type: string virtiofs2: type: string virtiofs3: type: string virtiofs4: type: string virtiofs5: type: string virtiofs6: type: string virtiofs7: type: string virtiofs8: type: string virtiofs9: type: string virtiofs10: type: string virtiofs11: type: string virtiofs12: type: string virtiofs13: type: string virtiofs14: type: string virtiofs15: type: string virtiofs16: type: string virtiofs17: type: string virtiofs18: type: string virtiofs19: type: string virtiofs20: type: string virtiofs21: type: string virtiofs22: type: string virtiofs23: type: string virtiofs24: type: string virtiofs25: type: string virtiofs26: type: string virtiofs27: type: string virtiofs28: type: string virtiofs29: type: string vmgenid: type: string vmstatestorage: type: string watchdog: type: string UpdateVMConfigSyncRequest: title: UpdateVMConfigSyncRequest type: object properties: acpi: type: boolean affinity: type: string agent: type: string allow-ksm: type: boolean amd-sev: type: string arch: type: string args: type: string audio0: type: string autostart: type: boolean balloon: type: integer bios: type: string boot: type: string bootdisk: type: string cdrom: type: string cicustom: type: string cipassword: type: string citype: type: string ciupgrade: type: boolean ciuser: type: string cores: type: integer cpu: type: string cpulimit: type: number cpuunits: type: integer delete: type: string description: type: string digest: type: string efidisk0: type: string force: type: boolean freeze: type: boolean hookscript: type: string hostpci0: type: string hostpci1: type: string hostpci2: type: string hostpci3: type: string hostpci4: type: string hostpci5: type: string hostpci6: type: string hostpci7: type: string hostpci8: type: string hostpci9: type: string hostpci10: type: string hostpci11: type: string hostpci12: type: string hostpci13: type: string hostpci14: type: string hostpci15: type: string hostpci16: type: string hostpci17: type: string hostpci18: type: string hostpci19: type: string hostpci20: type: string hostpci21: type: string hostpci22: type: string hostpci23: type: string hostpci24: type: string hostpci25: type: string hostpci26: type: string hostpci27: type: string hostpci28: type: string hostpci29: type: string hotplug: type: string hugepages: type: string ide0: type: string ide1: type: string ide2: type: string ide3: type: string ide4: type: string ide5: type: string ide6: type: string ide7: type: string ide8: type: string ide9: type: string ide10: type: string ide11: type: string ide12: type: string ide13: type: string ide14: type: string ide15: type: string ide16: type: string ide17: type: string ide18: type: string ide19: type: string ide20: type: string ide21: type: string ide22: type: string ide23: type: string ide24: type: string ide25: type: string ide26: type: string ide27: type: string ide28: type: string ide29: type: string intel-tdx: type: string ipconfig0: type: string ipconfig1: type: string ipconfig2: type: string ipconfig3: type: string ipconfig4: type: string ipconfig5: type: string ipconfig6: type: string ipconfig7: type: string ipconfig8: type: string ipconfig9: type: string ipconfig10: type: string ipconfig11: type: string ipconfig12: type: string ipconfig13: type: string ipconfig14: type: string ipconfig15: type: string ipconfig16: type: string ipconfig17: type: string ipconfig18: type: string ipconfig19: type: string ipconfig20: type: string ipconfig21: type: string ipconfig22: type: string ipconfig23: type: string ipconfig24: type: string ipconfig25: type: string ipconfig26: type: string ipconfig27: type: string ipconfig28: type: string ipconfig29: type: string ivshmem: type: string keephugepages: type: boolean keyboard: type: string kvm: type: boolean localtime: type: boolean lock: type: string machine: type: string memory: type: string migrate_downtime: type: number migrate_speed: type: integer name: type: string nameserver: type: string net0: type: string net1: type: string net2: type: string net3: type: string net4: type: string net5: type: string net6: type: string net7: type: string net8: type: string net9: type: string net10: type: string net11: type: string net12: type: string net13: type: string net14: type: string net15: type: string net16: type: string net17: type: string net18: type: string net19: type: string net20: type: string net21: type: string net22: type: string net23: type: string net24: type: string net25: type: string net26: type: string net27: type: string net28: type: string net29: type: string numa: type: boolean numa0: type: string numa1: type: string numa2: type: string numa3: type: string numa4: type: string numa5: type: string numa6: type: string numa7: type: string numa8: type: string numa9: type: string numa10: type: string numa11: type: string numa12: type: string numa13: type: string numa14: type: string numa15: type: string numa16: type: string numa17: type: string numa18: type: string numa19: type: string numa20: type: string numa21: type: string numa22: type: string numa23: type: string numa24: type: string numa25: type: string numa26: type: string numa27: type: string numa28: type: string numa29: type: string onboot: type: boolean ostype: type: string parallel0: type: string parallel1: type: string parallel2: type: string parallel3: type: string parallel4: type: string parallel5: type: string parallel6: type: string parallel7: type: string parallel8: type: string parallel9: type: string parallel10: type: string parallel11: type: string parallel12: type: string parallel13: type: string parallel14: type: string parallel15: type: string parallel16: type: string parallel17: type: string parallel18: type: string parallel19: type: string parallel20: type: string parallel21: type: string parallel22: type: string parallel23: type: string parallel24: type: string parallel25: type: string parallel26: type: string parallel27: type: string parallel28: type: string parallel29: type: string protection: type: boolean reboot: type: boolean revert: type: string rng0: type: string sata0: type: string sata1: type: string sata2: type: string sata3: type: string sata4: type: string sata5: type: string sata6: type: string sata7: type: string sata8: type: string sata9: type: string sata10: type: string sata11: type: string sata12: type: string sata13: type: string sata14: type: string sata15: type: string sata16: type: string sata17: type: string sata18: type: string sata19: type: string sata20: type: string sata21: type: string sata22: type: string sata23: type: string sata24: type: string sata25: type: string sata26: type: string sata27: type: string sata28: type: string sata29: type: string scsi0: type: string scsi1: type: string scsi2: type: string scsi3: type: string scsi4: type: string scsi5: type: string scsi6: type: string scsi7: type: string scsi8: type: string scsi9: type: string scsi10: type: string scsi11: type: string scsi12: type: string scsi13: type: string scsi14: type: string scsi15: type: string scsi16: type: string scsi17: type: string scsi18: type: string scsi19: type: string scsi20: type: string scsi21: type: string scsi22: type: string scsi23: type: string scsi24: type: string scsi25: type: string scsi26: type: string scsi27: type: string scsi28: type: string scsi29: type: string scsihw: type: string searchdomain: type: string serial0: type: string serial1: type: string serial2: type: string serial3: type: string serial4: type: string serial5: type: string serial6: type: string serial7: type: string serial8: type: string serial9: type: string serial10: type: string serial11: type: string serial12: type: string serial13: type: string serial14: type: string serial15: type: string serial16: type: string serial17: type: string serial18: type: string serial19: type: string serial20: type: string serial21: type: string serial22: type: string serial23: type: string serial24: type: string serial25: type: string serial26: type: string serial27: type: string serial28: type: string serial29: type: string shares: type: integer skiplock: type: boolean smbios1: type: string smp: type: integer sockets: type: integer spice_enhancements: type: string sshkeys: type: string startdate: type: string startup: type: string tablet: type: boolean tags: type: string tdf: type: boolean template: type: boolean tpmstate0: type: string unused0: type: string unused1: type: string unused2: type: string unused3: type: string unused4: type: string unused5: type: string unused6: type: string unused7: type: string unused8: type: string unused9: type: string unused10: type: string unused11: type: string unused12: type: string unused13: type: string unused14: type: string unused15: type: string unused16: type: string unused17: type: string unused18: type: string unused19: type: string unused20: type: string unused21: type: string unused22: type: string unused23: type: string unused24: type: string unused25: type: string unused26: type: string unused27: type: string unused28: type: string unused29: type: string usb0: type: string usb1: type: string usb2: type: string usb3: type: string usb4: type: string usb5: type: string usb6: type: string usb7: type: string usb8: type: string usb9: type: string usb10: type: string usb11: type: string usb12: type: string usb13: type: string usb14: type: string usb15: type: string usb16: type: string usb17: type: string usb18: type: string usb19: type: string usb20: type: string usb21: type: string usb22: type: string usb23: type: string usb24: type: string usb25: type: string usb26: type: string usb27: type: string usb28: type: string usb29: type: string vcpus: type: integer vga: type: string virtio0: type: string virtio1: type: string virtio2: type: string virtio3: type: string virtio4: type: string virtio5: type: string virtio6: type: string virtio7: type: string virtio8: type: string virtio9: type: string virtio10: type: string virtio11: type: string virtio12: type: string virtio13: type: string virtio14: type: string virtio15: type: string virtio16: type: string virtio17: type: string virtio18: type: string virtio19: type: string virtio20: type: string virtio21: type: string virtio22: type: string virtio23: type: string virtio24: type: string virtio25: type: string virtio26: type: string virtio27: type: string virtio28: type: string virtio29: type: string virtiofs0: type: string virtiofs1: type: string virtiofs2: type: string virtiofs3: type: string virtiofs4: type: string virtiofs5: type: string virtiofs6: type: string virtiofs7: type: string virtiofs8: type: string virtiofs9: type: string virtiofs10: type: string virtiofs11: type: string virtiofs12: type: string virtiofs13: type: string virtiofs14: type: string virtiofs15: type: string virtiofs16: type: string virtiofs17: type: string virtiofs18: type: string virtiofs19: type: string virtiofs20: type: string virtiofs21: type: string virtiofs22: type: string virtiofs23: type: string virtiofs24: type: string virtiofs25: type: string virtiofs26: type: string virtiofs27: type: string virtiofs28: type: string virtiofs29: type: string vmgenid: type: string vmstatestorage: type: string watchdog: type: string UpdateNodesSingleQemuSingleCloudinitRequest: title: UpdateNodesSingleQemuSingleCloudinitRequest type: object properties: {} UnlinkVMDiskImagesRequest: title: UnlinkVMDiskImagesRequest type: object properties: force: type: boolean idlist: type: string required: - idlist CreateNodesSingleQemuSingleVncproxyRequest: title: CreateNodesSingleQemuSingleVncproxyRequest type: object properties: generate-password: type: boolean websocket: type: boolean CreateNodesSingleQemuSingleTermproxyRequest: title: CreateNodesSingleQemuSingleTermproxyRequest type: object properties: serial: type: string CreateNodesSingleQemuSingleSpiceproxyRequest: title: CreateNodesSingleQemuSingleSpiceproxyRequest type: object properties: proxy: type: string StartVMRequest: title: StartVMRequest type: object properties: force-cpu: type: string machine: type: string migratedfrom: type: string migration_network: type: string migration_type: type: string nets-host-mtu: type: string skiplock: type: boolean stateuri: type: string targetstorage: type: string timeout: type: integer with-conntrack-state: type: boolean StopVMRequest: title: StopVMRequest type: object properties: keepActive: type: boolean migratedfrom: type: string overrule-shutdown: type: boolean skiplock: type: boolean timeout: type: integer ResetVMRequest: title: ResetVMRequest type: object properties: skiplock: type: boolean ShutdownVMRequest: title: ShutdownVMRequest type: object properties: forceStop: type: boolean keepActive: type: boolean skiplock: type: boolean timeout: type: integer RebootVMRequest: title: RebootVMRequest type: object properties: timeout: type: integer SuspendVMRequest: title: SuspendVMRequest type: object properties: skiplock: type: boolean statestorage: type: string todisk: type: boolean ResumeVMRequest: title: ResumeVMRequest type: object properties: nocheck: type: boolean skiplock: type: boolean UpdateNodesSingleQemuSingleSendkeyRequest: title: UpdateNodesSingleQemuSingleSendkeyRequest type: object properties: key: type: string skiplock: type: boolean required: - key CloneVMRequest: title: CloneVMRequest type: object properties: bwlimit: type: integer description: type: string format: type: string full: type: boolean name: type: string newid: type: integer pool: type: string snapname: type: string storage: type: string target: type: string required: - newid CreateNodesSingleQemuSingleMovediskRequest: title: CreateNodesSingleQemuSingleMovediskRequest type: object properties: bwlimit: type: integer delete: type: boolean digest: type: string disk: type: string format: type: string storage: type: string target-digest: type: string target-disk: type: string target-vmid: type: integer required: - disk CreateNodesSingleQemuSingleMigrateRequest: title: CreateNodesSingleQemuSingleMigrateRequest type: object properties: bwlimit: type: integer force: type: boolean migration_network: type: string migration_type: type: string online: type: boolean target: type: string targetstorage: type: string with-conntrack-state: type: boolean with-local-disks: type: boolean required: - target CreateNodesSingleQemuSingleRemotemigrateRequest: title: CreateNodesSingleQemuSingleRemotemigrateRequest type: object properties: bwlimit: type: integer delete: type: boolean online: type: boolean target-bridge: type: string target-endpoint: type: string target-storage: type: string target-vmid: type: integer required: - target-bridge - target-endpoint - target-storage CreateNodesSingleQemuSingleMonitorRequest: title: CreateNodesSingleQemuSingleMonitorRequest type: object properties: command: type: string required: - command ResizeVMDiskRequest: title: ResizeVMDiskRequest type: object properties: digest: type: string disk: type: string size: type: string skiplock: type: boolean required: - disk - size CreateVMSnapshotRequest: title: CreateVMSnapshotRequest type: object properties: description: type: string snapname: type: string vmstate: type: boolean required: - snapname UpdateVMSnapshotConfigRequest: title: UpdateVMSnapshotConfigRequest type: object properties: description: type: string RollbackVMSnapshotRequest: title: RollbackVMSnapshotRequest type: object properties: start: type: boolean CreateNodesSingleQemuSingleTemplateRequest: title: CreateNodesSingleQemuSingleTemplateRequest type: object properties: disk: type: string CreateNodesSingleQemuSingleMtunnelRequest: title: CreateNodesSingleQemuSingleMtunnelRequest type: object properties: bridges: type: string storages: type: string CreateNodesSingleQemuSingleDbusvmstateRequest: title: CreateNodesSingleQemuSingleDbusvmstateRequest type: object properties: action: type: string required: - action CreateNodesSingleLxcRequest: title: CreateNodesSingleLxcRequest type: object properties: arch: type: string bwlimit: type: number cmode: type: string console: type: boolean cores: type: integer cpulimit: type: number cpuunits: type: integer debug: type: boolean description: type: string dev0: type: string dev1: type: string dev2: type: string dev3: type: string dev4: type: string dev5: type: string dev6: type: string dev7: type: string dev8: type: string dev9: type: string dev10: type: string dev11: type: string dev12: type: string dev13: type: string dev14: type: string dev15: type: string dev16: type: string dev17: type: string dev18: type: string dev19: type: string dev20: type: string dev21: type: string dev22: type: string dev23: type: string dev24: type: string dev25: type: string dev26: type: string dev27: type: string dev28: type: string dev29: type: string entrypoint: type: string env: type: string features: type: string force: type: boolean ha-managed: type: boolean hookscript: type: string hostname: type: string ignore-unpack-errors: type: boolean lock: type: string memory: type: integer mp0: type: string mp1: type: string mp2: type: string mp3: type: string mp4: type: string mp5: type: string mp6: type: string mp7: type: string mp8: type: string mp9: type: string mp10: type: string mp11: type: string mp12: type: string mp13: type: string mp14: type: string mp15: type: string mp16: type: string mp17: type: string mp18: type: string mp19: type: string mp20: type: string mp21: type: string mp22: type: string mp23: type: string mp24: type: string mp25: type: string mp26: type: string mp27: type: string mp28: type: string mp29: type: string nameserver: type: string net0: type: string net1: type: string net2: type: string net3: type: string net4: type: string net5: type: string net6: type: string net7: type: string net8: type: string net9: type: string net10: type: string net11: type: string net12: type: string net13: type: string net14: type: string net15: type: string net16: type: string net17: type: string net18: type: string net19: type: string net20: type: string net21: type: string net22: type: string net23: type: string net24: type: string net25: type: string net26: type: string net27: type: string net28: type: string net29: type: string onboot: type: boolean ostemplate: type: string ostype: type: string password: type: string pool: type: string protection: type: boolean restore: type: boolean rootfs: type: string searchdomain: type: string ssh-public-keys: type: string start: type: boolean startup: type: string storage: type: string swap: type: integer tags: type: string template: type: boolean timezone: type: string tty: type: integer unique: type: boolean unprivileged: type: boolean unused0: type: string unused1: type: string unused2: type: string unused3: type: string unused4: type: string unused5: type: string unused6: type: string unused7: type: string unused8: type: string unused9: type: string unused10: type: string unused11: type: string unused12: type: string unused13: type: string unused14: type: string unused15: type: string unused16: type: string unused17: type: string unused18: type: string unused19: type: string unused20: type: string unused21: type: string unused22: type: string unused23: type: string unused24: type: string unused25: type: string unused26: type: string unused27: type: string unused28: type: string unused29: type: string vmid: type: integer required: - ostemplate - vmid UpdateNodesSingleLxcSingleConfigRequest: title: UpdateNodesSingleLxcSingleConfigRequest type: object properties: arch: type: string cmode: type: string console: type: boolean cores: type: integer cpulimit: type: number cpuunits: type: integer debug: type: boolean delete: type: string description: type: string dev0: type: string dev1: type: string dev2: type: string dev3: type: string dev4: type: string dev5: type: string dev6: type: string dev7: type: string dev8: type: string dev9: type: string dev10: type: string dev11: type: string dev12: type: string dev13: type: string dev14: type: string dev15: type: string dev16: type: string dev17: type: string dev18: type: string dev19: type: string dev20: type: string dev21: type: string dev22: type: string dev23: type: string dev24: type: string dev25: type: string dev26: type: string dev27: type: string dev28: type: string dev29: type: string digest: type: string entrypoint: type: string env: type: string features: type: string hookscript: type: string hostname: type: string lock: type: string memory: type: integer mp0: type: string mp1: type: string mp2: type: string mp3: type: string mp4: type: string mp5: type: string mp6: type: string mp7: type: string mp8: type: string mp9: type: string mp10: type: string mp11: type: string mp12: type: string mp13: type: string mp14: type: string mp15: type: string mp16: type: string mp17: type: string mp18: type: string mp19: type: string mp20: type: string mp21: type: string mp22: type: string mp23: type: string mp24: type: string mp25: type: string mp26: type: string mp27: type: string mp28: type: string mp29: type: string nameserver: type: string net0: type: string net1: type: string net2: type: string net3: type: string net4: type: string net5: type: string net6: type: string net7: type: string net8: type: string net9: type: string net10: type: string net11: type: string net12: type: string net13: type: string net14: type: string net15: type: string net16: type: string net17: type: string net18: type: string net19: type: string net20: type: string net21: type: string net22: type: string net23: type: string net24: type: string net25: type: string net26: type: string net27: type: string net28: type: string net29: type: string onboot: type: boolean ostype: type: string protection: type: boolean revert: type: string rootfs: type: string searchdomain: type: string startup: type: string swap: type: integer tags: type: string template: type: boolean timezone: type: string tty: type: integer unprivileged: type: boolean unused0: type: string unused1: type: string unused2: type: string unused3: type: string unused4: type: string unused5: type: string unused6: type: string unused7: type: string unused8: type: string unused9: type: string unused10: type: string unused11: type: string unused12: type: string unused13: type: string unused14: type: string unused15: type: string unused16: type: string unused17: type: string unused18: type: string unused19: type: string unused20: type: string unused21: type: string unused22: type: string unused23: type: string unused24: type: string unused25: type: string unused26: type: string unused27: type: string unused28: type: string unused29: type: string CreateNodesSingleLxcSingleStatusStartRequest: title: CreateNodesSingleLxcSingleStatusStartRequest type: object properties: debug: type: boolean skiplock: type: boolean CreateNodesSingleLxcSingleStatusStopRequest: title: CreateNodesSingleLxcSingleStatusStopRequest type: object properties: overrule-shutdown: type: boolean skiplock: type: boolean CreateNodesSingleLxcSingleStatusShutdownRequest: title: CreateNodesSingleLxcSingleStatusShutdownRequest type: object properties: forceStop: type: boolean timeout: type: integer CreateNodesSingleLxcSingleStatusSuspendRequest: title: CreateNodesSingleLxcSingleStatusSuspendRequest type: object properties: {} CreateNodesSingleLxcSingleStatusResumeRequest: title: CreateNodesSingleLxcSingleStatusResumeRequest type: object properties: {} CreateNodesSingleLxcSingleStatusRebootRequest: title: CreateNodesSingleLxcSingleStatusRebootRequest type: object properties: timeout: type: integer CreateNodesSingleLxcSingleSnapshotRequest: title: CreateNodesSingleLxcSingleSnapshotRequest type: object properties: description: type: string snapname: type: string required: - snapname CreateNodesSingleLxcSingleSnapshotSingleRollbackRequest: title: CreateNodesSingleLxcSingleSnapshotSingleRollbackRequest type: object properties: start: type: boolean UpdateNodesSingleLxcSingleSnapshotSingleConfigRequest: title: UpdateNodesSingleLxcSingleSnapshotSingleConfigRequest type: object properties: description: type: string CreateNodesSingleLxcSingleFirewallRulesRequest: title: CreateNodesSingleLxcSingleFirewallRulesRequest type: object properties: action: type: string comment: type: string dest: type: string digest: type: string dport: type: string enable: type: integer icmp-type: type: string iface: type: string log: type: string macro: type: string pos: type: integer proto: type: string source: type: string sport: type: string type: type: string required: - action - type UpdateNodesSingleLxcSingleFirewallRulesSingleRequest: title: UpdateNodesSingleLxcSingleFirewallRulesSingleRequest type: object properties: action: type: string comment: type: string delete: type: string dest: type: string digest: type: string dport: type: string enable: type: integer icmp-type: type: string iface: type: string log: type: string macro: type: string moveto: type: integer proto: type: string source: type: string sport: type: string type: type: string CreateNodesSingleLxcSingleFirewallAliasesRequest: title: CreateNodesSingleLxcSingleFirewallAliasesRequest type: object properties: cidr: type: string comment: type: string name: type: string required: - cidr - name UpdateNodesSingleLxcSingleFirewallAliasesSingleRequest: title: UpdateNodesSingleLxcSingleFirewallAliasesSingleRequest type: object properties: cidr: type: string comment: type: string digest: type: string rename: type: string required: - cidr CreateNodesSingleLxcSingleFirewallIpsetRequest: title: CreateNodesSingleLxcSingleFirewallIpsetRequest type: object properties: comment: type: string digest: type: string name: type: string rename: type: string required: - name CreateNodesSingleLxcSingleFirewallIpsetSingleRequest: title: CreateNodesSingleLxcSingleFirewallIpsetSingleRequest type: object properties: cidr: type: string comment: type: string nomatch: type: boolean required: - cidr UpdateNodesSingleLxcSingleFirewallIpsetSingleSingleRequest: title: UpdateNodesSingleLxcSingleFirewallIpsetSingleSingleRequest type: object properties: comment: type: string digest: type: string nomatch: type: boolean UpdateNodesSingleLxcSingleFirewallOptionsRequest: title: UpdateNodesSingleLxcSingleFirewallOptionsRequest type: object properties: delete: type: string dhcp: type: boolean digest: type: string enable: type: boolean ipfilter: type: boolean log_level_in: type: string log_level_out: type: string macfilter: type: boolean ndp: type: boolean policy_in: type: string policy_out: type: string radv: type: boolean CreateNodesSingleLxcSingleVncproxyRequest: title: CreateNodesSingleLxcSingleVncproxyRequest type: object properties: height: type: integer websocket: type: boolean width: type: integer CreateNodesSingleLxcSingleTermproxyRequest: title: CreateNodesSingleLxcSingleTermproxyRequest type: object properties: {} CreateNodesSingleLxcSingleSpiceproxyRequest: title: CreateNodesSingleLxcSingleSpiceproxyRequest type: object properties: proxy: type: string CreateNodesSingleLxcSingleRemotemigrateRequest: title: CreateNodesSingleLxcSingleRemotemigrateRequest type: object properties: bwlimit: type: number delete: type: boolean online: type: boolean restart: type: boolean target-bridge: type: string target-endpoint: type: string target-storage: type: string target-vmid: type: integer timeout: type: integer required: - target-bridge - target-endpoint - target-storage CreateNodesSingleLxcSingleMigrateRequest: title: CreateNodesSingleLxcSingleMigrateRequest type: object properties: bwlimit: type: number online: type: boolean restart: type: boolean target: type: string target-storage: type: string timeout: type: integer required: - target CreateNodesSingleLxcSingleTemplateRequest: title: CreateNodesSingleLxcSingleTemplateRequest type: object properties: {} CreateNodesSingleLxcSingleCloneRequest: title: CreateNodesSingleLxcSingleCloneRequest type: object properties: bwlimit: type: number description: type: string full: type: boolean hostname: type: string newid: type: integer pool: type: string snapname: type: string storage: type: string target: type: string required: - newid UpdateNodesSingleLxcSingleResizeRequest: title: UpdateNodesSingleLxcSingleResizeRequest type: object properties: digest: type: string disk: type: string size: type: string required: - disk - size CreateNodesSingleLxcSingleMovevolumeRequest: title: CreateNodesSingleLxcSingleMovevolumeRequest type: object properties: bwlimit: type: number delete: type: boolean digest: type: string storage: type: string target-digest: type: string target-vmid: type: integer target-volume: type: string volume: type: string required: - volume CreateNodesSingleLxcSingleMtunnelRequest: title: CreateNodesSingleLxcSingleMtunnelRequest type: object properties: bridges: type: string storages: type: string CreateNodesSingleCephOsdRequest: title: CreateNodesSingleCephOsdRequest type: object properties: crush-device-class: type: string db_dev: type: string db_dev_size: type: number dev: type: string encrypted: type: boolean osds-per-device: type: integer wal_dev: type: string wal_dev_size: type: number required: - dev CreateNodesSingleCephOsdSingleInRequest: title: CreateNodesSingleCephOsdSingleInRequest type: object properties: {} CreateNodesSingleCephOsdSingleOutRequest: title: CreateNodesSingleCephOsdSingleOutRequest type: object properties: {} CreateNodesSingleCephOsdSingleScrubRequest: title: CreateNodesSingleCephOsdSingleScrubRequest type: object properties: deep: type: boolean CreateNodesSingleCephMdsSingleRequest: title: CreateNodesSingleCephMdsSingleRequest type: object properties: hotstandby: type: boolean CreateNodesSingleCephMgrSingleRequest: title: CreateNodesSingleCephMgrSingleRequest type: object properties: {} CreateNodesSingleCephMonSingleRequest: title: CreateNodesSingleCephMonSingleRequest type: object properties: mon-address: type: string CreateNodesSingleCephFsSingleRequest: title: CreateNodesSingleCephFsSingleRequest type: object properties: add-storage: type: boolean pg_num: type: integer CreateNodesSingleCephPoolRequest: title: CreateNodesSingleCephPoolRequest type: object properties: add_storages: type: boolean application: type: string crush_rule: type: string erasure-coding: type: string min_size: type: integer name: type: string pg_autoscale_mode: type: string pg_num: type: integer pg_num_min: type: integer size: type: integer target_size: type: string target_size_ratio: type: number required: - name UpdateNodesSingleCephPoolSingleRequest: title: UpdateNodesSingleCephPoolSingleRequest type: object properties: application: type: string crush_rule: type: string min_size: type: integer pg_autoscale_mode: type: string pg_num: type: integer pg_num_min: type: integer size: type: integer target_size: type: string target_size_ratio: type: number CreateNodesSingleCephInitRequest: title: CreateNodesSingleCephInitRequest type: object properties: cluster-network: type: string disable_cephx: type: boolean min_size: type: integer network: type: string pg_bits: type: integer size: type: integer CreateNodesSingleCephStopRequest: title: CreateNodesSingleCephStopRequest type: object properties: service: type: string CreateNodesSingleCephStartRequest: title: CreateNodesSingleCephStartRequest type: object properties: service: type: string CreateNodesSingleCephRestartRequest: title: CreateNodesSingleCephRestartRequest type: object properties: service: type: string CreateNodesSingleVzdumpRequest: title: CreateNodesSingleVzdumpRequest type: object properties: all: type: boolean bwlimit: type: integer compress: type: string dumpdir: type: string exclude: type: string exclude-path: type: array items: type: string fleecing: type: string ionice: type: integer job-id: type: string lockwait: type: integer mailnotification: type: string mailto: type: string maxfiles: type: integer mode: type: string notes-template: type: string notification-mode: type: string pbs-change-detection-mode: type: string performance: type: string pigz: type: integer pool: type: string protected: type: boolean prune-backups: type: string quiet: type: boolean remove: type: boolean script: type: string stdexcludes: type: boolean stdout: type: boolean stop: type: boolean stopwait: type: integer storage: type: string tmpdir: type: string vmid: type: string zstd: type: integer CreateNodesSingleServicesSingleStartRequest: title: CreateNodesSingleServicesSingleStartRequest type: object properties: {} CreateNodesSingleServicesSingleStopRequest: title: CreateNodesSingleServicesSingleStopRequest type: object properties: {} CreateNodesSingleServicesSingleRestartRequest: title: CreateNodesSingleServicesSingleRestartRequest type: object properties: {} CreateNodesSingleServicesSingleReloadRequest: title: CreateNodesSingleServicesSingleReloadRequest type: object properties: {} CreateNodesSingleSubscriptionRequest: title: CreateNodesSingleSubscriptionRequest type: object properties: force: type: boolean UpdateNodesSingleSubscriptionRequest: title: UpdateNodesSingleSubscriptionRequest type: object properties: key: type: string required: - key CreateNodesSingleNetworkRequest: title: CreateNodesSingleNetworkRequest type: object properties: address: type: string address6: type: string autostart: type: boolean bond-primary: type: string bond_mode: type: string bond_xmit_hash_policy: type: string bridge_ports: type: string bridge_vids: type: string bridge_vlan_aware: type: boolean cidr: type: string cidr6: type: string comments: type: string comments6: type: string gateway: type: string gateway6: type: string iface: type: string mtu: type: integer netmask: type: string netmask6: type: integer ovs_bonds: type: string ovs_bridge: type: string ovs_options: type: string ovs_ports: type: string ovs_tag: type: integer slaves: type: string type: type: string vlan-id: type: integer vlan-raw-device: type: string required: - iface - type UpdateNodesSingleNetworkRequest: title: UpdateNodesSingleNetworkRequest type: object properties: regenerate-frr: type: boolean UpdateNodesSingleNetworkSingleRequest: title: UpdateNodesSingleNetworkSingleRequest type: object properties: address: type: string address6: type: string autostart: type: boolean bond-primary: type: string bond_mode: type: string bond_xmit_hash_policy: type: string bridge_ports: type: string bridge_vids: type: string bridge_vlan_aware: type: boolean cidr: type: string cidr6: type: string comments: type: string comments6: type: string delete: type: string gateway: type: string gateway6: type: string mtu: type: integer netmask: type: string netmask6: type: integer ovs_bonds: type: string ovs_bridge: type: string ovs_options: type: string ovs_ports: type: string ovs_tag: type: integer slaves: type: string type: type: string vlan-id: type: integer vlan-raw-device: type: string required: - type CreateNodesSingleStorageSingleContentRequest: title: CreateNodesSingleStorageSingleContentRequest type: object properties: filename: type: string format: type: string size: type: string vmid: type: integer required: - filename - size - vmid CreateNodesSingleStorageSingleContentSingleRequest: title: CreateNodesSingleStorageSingleContentSingleRequest type: object properties: target: type: string target_node: type: string required: - target UpdateNodesSingleStorageSingleContentSingleRequest: title: UpdateNodesSingleStorageSingleContentSingleRequest type: object properties: notes: type: string protected: type: boolean CreateNodesSingleStorageSingleUploadRequest: title: CreateNodesSingleStorageSingleUploadRequest type: object properties: checksum: type: string checksum-algorithm: type: string content: type: string filename: type: string tmpfilename: type: string required: - content - filename CreateNodesSingleStorageSingleDownloadurlRequest: title: CreateNodesSingleStorageSingleDownloadurlRequest type: object properties: checksum: type: string checksum-algorithm: type: string compression: type: string content: type: string filename: type: string url: type: string verify-certificates: type: boolean required: - content - filename - url CreateNodesSingleStorageSingleOciregistrypullRequest: title: CreateNodesSingleStorageSingleOciregistrypullRequest type: object properties: filename: type: string reference: type: string required: - reference CreateNodesSingleDisksLvmRequest: title: CreateNodesSingleDisksLvmRequest type: object properties: add_storage: type: boolean device: type: string name: type: string required: - device - name CreateNodesSingleDisksLvmthinRequest: title: CreateNodesSingleDisksLvmthinRequest type: object properties: add_storage: type: boolean device: type: string name: type: string required: - device - name CreateNodesSingleDisksDirectoryRequest: title: CreateNodesSingleDisksDirectoryRequest type: object properties: add_storage: type: boolean device: type: string filesystem: type: string name: type: string required: - device - name CreateNodesSingleDisksZfsRequest: title: CreateNodesSingleDisksZfsRequest type: object properties: add_storage: type: boolean ashift: type: integer compression: type: string devices: type: string draid-config: type: string name: type: string raidlevel: type: string required: - devices - name - raidlevel CreateNodesSingleDisksInitgptRequest: title: CreateNodesSingleDisksInitgptRequest type: object properties: disk: type: string uuid: type: string required: - disk UpdateNodesSingleDisksWipediskRequest: title: UpdateNodesSingleDisksWipediskRequest type: object properties: disk: type: string required: - disk CreateNodesSingleAptUpdateRequest: title: CreateNodesSingleAptUpdateRequest type: object properties: notify: type: boolean quiet: type: boolean CreateNodesSingleAptRepositoriesRequest: title: CreateNodesSingleAptRepositoriesRequest type: object properties: digest: type: string enabled: type: boolean index: type: integer path: type: string required: - index - path UpdateNodesSingleAptRepositoriesRequest: title: UpdateNodesSingleAptRepositoriesRequest type: object properties: digest: type: string handle: type: string required: - handle CreateNodeFirewallRuleRequest: title: CreateNodeFirewallRuleRequest type: object properties: action: type: string comment: type: string dest: type: string digest: type: string dport: type: string enable: type: integer icmp-type: type: string iface: type: string log: type: string macro: type: string pos: type: integer proto: type: string source: type: string sport: type: string type: type: string required: - action - type UpdateNodeFirewallRuleRequest: title: UpdateNodeFirewallRuleRequest type: object properties: action: type: string comment: type: string delete: type: string dest: type: string digest: type: string dport: type: string enable: type: integer icmp-type: type: string iface: type: string log: type: string macro: type: string moveto: type: integer proto: type: string source: type: string sport: type: string type: type: string UpdateNodeFirewallOptionsRequest: title: UpdateNodeFirewallOptionsRequest type: object properties: delete: type: string digest: type: string enable: type: boolean log_level_forward: type: string log_level_in: type: string log_level_out: type: string log_nf_conntrack: type: boolean ndp: type: boolean nf_conntrack_allow_invalid: type: boolean nf_conntrack_helpers: type: string nf_conntrack_max: type: integer nf_conntrack_tcp_timeout_established: type: integer nf_conntrack_tcp_timeout_syn_recv: type: integer nftables: type: boolean nosmurfs: type: boolean protection_synflood: type: boolean protection_synflood_burst: type: integer protection_synflood_rate: type: integer smurf_log_level: type: string tcp_flags_log_level: type: string tcpflags: type: boolean CreateNodesSingleReplicationSingleSchedulenowRequest: title: CreateNodesSingleReplicationSingleSchedulenowRequest type: object properties: {} CreateNodesSingleCertificatesAcmeCertificateRequest: title: CreateNodesSingleCertificatesAcmeCertificateRequest type: object properties: force: type: boolean UpdateNodesSingleCertificatesAcmeCertificateRequest: title: UpdateNodesSingleCertificatesAcmeCertificateRequest type: object properties: force: type: boolean CreateNodesSingleCertificatesCustomRequest: title: CreateNodesSingleCertificatesCustomRequest type: object properties: certificates: type: string force: type: boolean key: type: string restart: type: boolean required: - certificates UpdateNodesSingleConfigRequest: title: UpdateNodesSingleConfigRequest type: object properties: acme: type: string acmedomain0: type: string acmedomain1: type: string acmedomain2: type: string acmedomain3: type: string acmedomain4: type: string acmedomain5: type: string acmedomain6: type: string acmedomain7: type: string acmedomain8: type: string acmedomain9: type: string acmedomain10: type: string acmedomain11: type: string acmedomain12: type: string acmedomain13: type: string acmedomain14: type: string acmedomain15: type: string acmedomain16: type: string acmedomain17: type: string acmedomain18: type: string acmedomain19: type: string acmedomain20: type: string acmedomain21: type: string acmedomain22: type: string acmedomain23: type: string acmedomain24: type: string acmedomain25: type: string acmedomain26: type: string acmedomain27: type: string acmedomain28: type: string acmedomain29: type: string ballooning-target: type: integer delete: type: string description: type: string digest: type: string startall-onboot-delay: type: integer wakeonlan: type: string CreateNodesSingleStatusRequest: title: CreateNodesSingleStatusRequest type: object properties: command: type: string required: - command CreateNodesSingleExecuteRequest: title: CreateNodesSingleExecuteRequest type: object properties: commands: type: string required: - commands CreateNodesSingleWakeonlanRequest: title: CreateNodesSingleWakeonlanRequest type: object properties: {} CreateNodesSingleVncshellRequest: title: CreateNodesSingleVncshellRequest type: object properties: cmd: type: string cmd-opts: type: string height: type: integer websocket: type: boolean width: type: integer CreateNodesSingleTermproxyRequest: title: CreateNodesSingleTermproxyRequest type: object properties: cmd: type: string cmd-opts: type: string CreateNodesSingleSpiceshellRequest: title: CreateNodesSingleSpiceshellRequest type: object properties: cmd: type: string cmd-opts: type: string proxy: type: string UpdateNodesSingleDnsRequest: title: UpdateNodesSingleDnsRequest type: object properties: dns1: type: string dns2: type: string dns3: type: string search: type: string required: - search UpdateNodesSingleTimeRequest: title: UpdateNodesSingleTimeRequest type: object properties: timezone: type: string required: - timezone CreateNodesSingleAplinfoRequest: title: CreateNodesSingleAplinfoRequest type: object properties: storage: type: string template: type: string required: - storage - template CreateNodesSingleStartallRequest: title: CreateNodesSingleStartallRequest type: object properties: force: type: boolean vms: type: string CreateNodesSingleStopallRequest: title: CreateNodesSingleStopallRequest type: object properties: force-stop: type: boolean timeout: type: integer vms: type: string CreateNodesSingleSuspendallRequest: title: CreateNodesSingleSuspendallRequest type: object properties: vms: type: string CreateNodesSingleMigrateallRequest: title: CreateNodesSingleMigrateallRequest type: object properties: maxworkers: type: integer target: type: string vms: type: string with-local-disks: type: boolean required: - target CreateNodesSingleHostsRequest: title: CreateNodesSingleHostsRequest type: object properties: data: type: string digest: type: string required: - data CreateStorageRequest: title: CreateStorageRequest type: object properties: authsupported: type: string base: type: string blocksize: type: string bwlimit: type: string comstar_hg: type: string comstar_tg: type: string content: type: string content-dirs: type: string create-base-path: type: boolean create-subdirs: type: boolean data-pool: type: string datastore: type: string disable: type: boolean domain: type: string encryption-key: type: string export: type: string fingerprint: type: string format: type: string fs-name: type: string fuse: type: boolean is_mountpoint: type: string iscsiprovider: type: string keyring: type: string krbd: type: boolean lio_tpg: type: string master-pubkey: type: string max-protected-backups: type: integer mkdir: type: boolean monhost: type: string mountpoint: type: string namespace: type: string nocow: type: boolean nodes: type: string nowritecache: type: boolean options: type: string password: type: string path: type: string pool: type: string port: type: integer portal: type: string preallocation: type: string prune-backups: type: string saferemove: type: boolean saferemove-stepsize: type: integer saferemove_throughput: type: string server: type: string share: type: string shared: type: boolean skip-cert-verification: type: boolean smbversion: type: string snapshot-as-volume-chain: type: boolean sparse: type: boolean storage: type: string subdir: type: string tagged_only: type: boolean target: type: string thinpool: type: string type: type: string username: type: string vgname: type: string zfs-base-path: type: string required: - storage - type UpdateStorageSingleRequest: title: UpdateStorageSingleRequest type: object properties: blocksize: type: string bwlimit: type: string comstar_hg: type: string comstar_tg: type: string content: type: string content-dirs: type: string create-base-path: type: boolean create-subdirs: type: boolean data-pool: type: string delete: type: string digest: type: string disable: type: boolean domain: type: string encryption-key: type: string fingerprint: type: string format: type: string fs-name: type: string fuse: type: boolean is_mountpoint: type: string keyring: type: string krbd: type: boolean lio_tpg: type: string master-pubkey: type: string max-protected-backups: type: integer mkdir: type: boolean monhost: type: string mountpoint: type: string namespace: type: string nocow: type: boolean nodes: type: string nowritecache: type: boolean options: type: string password: type: string pool: type: string port: type: integer preallocation: type: string prune-backups: type: string saferemove: type: boolean saferemove-stepsize: type: integer saferemove_throughput: type: string server: type: string shared: type: boolean skip-cert-verification: type: boolean smbversion: type: string snapshot-as-volume-chain: type: boolean sparse: type: boolean subdir: type: string tagged_only: type: boolean username: type: string zfs-base-path: type: string CreateAccessUsersRequest: title: CreateAccessUsersRequest type: object properties: comment: type: string email: type: string enable: type: boolean expire: type: integer firstname: type: string groups: type: string keys: type: string lastname: type: string password: type: string userid: type: string required: - userid UpdateAccessUsersSingleRequest: title: UpdateAccessUsersSingleRequest type: object properties: append: type: boolean comment: type: string email: type: string enable: type: boolean expire: type: integer firstname: type: string groups: type: string keys: type: string lastname: type: string UpdateAccessUsersSingleUnlocktfaRequest: title: UpdateAccessUsersSingleUnlocktfaRequest type: object properties: {} CreateAccessUsersSingleTokenSingleRequest: title: CreateAccessUsersSingleTokenSingleRequest type: object properties: comment: type: string expire: type: integer privsep: type: boolean UpdateAccessUsersSingleTokenSingleRequest: title: UpdateAccessUsersSingleTokenSingleRequest type: object properties: comment: type: string delete: type: string expire: type: integer privsep: type: boolean CreateAccessGroupsRequest: title: CreateAccessGroupsRequest type: object properties: comment: type: string groupid: type: string required: - groupid UpdateAccessGroupsSingleRequest: title: UpdateAccessGroupsSingleRequest type: object properties: comment: type: string CreateAccessRolesRequest: title: CreateAccessRolesRequest type: object properties: privs: type: string roleid: type: string required: - roleid UpdateAccessRolesSingleRequest: title: UpdateAccessRolesSingleRequest type: object properties: append: type: boolean privs: type: string UpdateAccessAclRequest: title: UpdateAccessAclRequest type: object properties: delete: type: boolean groups: type: string path: type: string propagate: type: boolean roles: type: string tokens: type: string users: type: string required: - path - roles CreateAccessDomainsRequest: title: CreateAccessDomainsRequest type: object properties: acr-values: type: string autocreate: type: boolean base_dn: type: string bind_dn: type: string capath: type: string case-sensitive: type: boolean cert: type: string certkey: type: string check-connection: type: boolean client-id: type: string client-key: type: string comment: type: string default: type: boolean domain: type: string filter: type: string group_classes: type: string group_dn: type: string group_filter: type: string group_name_attr: type: string groups-autocreate: type: boolean groups-claim: type: string groups-overwrite: type: boolean issuer-url: type: string mode: type: string password: type: string port: type: integer prompt: type: string query-userinfo: type: boolean realm: type: string scopes: type: string secure: type: boolean server1: type: string server2: type: string sslversion: type: string sync-defaults-options: type: string sync_attributes: type: string tfa: type: string type: type: string user_attr: type: string user_classes: type: string username-claim: type: string verify: type: boolean required: - realm - type UpdateAccessDomainsSingleRequest: title: UpdateAccessDomainsSingleRequest type: object properties: acr-values: type: string autocreate: type: boolean base_dn: type: string bind_dn: type: string capath: type: string case-sensitive: type: boolean cert: type: string certkey: type: string check-connection: type: boolean client-id: type: string client-key: type: string comment: type: string default: type: boolean delete: type: string digest: type: string domain: type: string filter: type: string group_classes: type: string group_dn: type: string group_filter: type: string group_name_attr: type: string groups-autocreate: type: boolean groups-claim: type: string groups-overwrite: type: boolean issuer-url: type: string mode: type: string password: type: string port: type: integer prompt: type: string query-userinfo: type: boolean scopes: type: string secure: type: boolean server1: type: string server2: type: string sslversion: type: string sync-defaults-options: type: string sync_attributes: type: string tfa: type: string user_attr: type: string user_classes: type: string verify: type: boolean CreateAccessDomainsSingleSyncRequest: title: CreateAccessDomainsSingleSyncRequest type: object properties: dry-run: type: boolean enable-new: type: boolean full: type: boolean purge: type: boolean remove-vanished: type: string scope: type: string required: - enable-new - full - purge - remove-vanished - scope CreateAccessOpenidAuthurlRequest: title: CreateAccessOpenidAuthurlRequest type: object properties: realm: type: string redirect-url: type: string required: - realm - redirect-url CreateAccessOpenidLoginRequest: title: CreateAccessOpenidLoginRequest type: object properties: code: type: string redirect-url: type: string state: type: string required: - code - redirect-url - state CreateAccessTfaSingleRequest: title: CreateAccessTfaSingleRequest type: object properties: challenge: type: string description: type: string password: type: string totp: type: string type: type: string value: type: string required: - type UpdateAccessTfaSingleSingleRequest: title: UpdateAccessTfaSingleSingleRequest type: object properties: description: type: string enable: type: boolean password: type: string CreateAccessTicketRequest: title: CreateAccessTicketRequest type: object properties: new-format: type: boolean otp: type: string password: type: string path: type: string privs: type: string realm: type: string tfa-challenge: type: string username: type: string required: - password - username CreateAccessVncticketRequest: title: CreateAccessVncticketRequest type: object properties: authid: type: string path: type: string privs: type: string vncticket: type: string required: - authid - path - privs - vncticket UpdateAccessPasswordRequest: title: UpdateAccessPasswordRequest type: object properties: confirmation-password: type: string password: type: string userid: type: string required: - password - userid CreatePoolRequest: title: CreatePoolRequest type: object properties: comment: type: string poolid: type: string required: - poolid UpdatePoolsRequest: title: UpdatePoolsRequest type: object properties: allow-move: type: boolean comment: type: string delete: type: boolean poolid: type: string storage: type: string vms: type: string required: - poolid UpdatePoolRequest: title: UpdatePoolRequest type: object properties: allow-move: type: boolean comment: type: string delete: type: boolean storage: type: string vms: type: string responses: GetClusterResponse: description: GetClusterResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: {} GetClusterReplicationResponse: description: GetClusterReplicationResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: comment: type: string description: Description. disable: type: int64 description: Flag to disable/deactivate the entry. guest: type: int64 description: Guest ID. id: type: string description: >- Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '-'. jobnum: type: int64 description: "Unique, sequential ID assigned to each job." rate: type: number description: >- Rate limit in mbps (megabytes per second) as floating point number. remove_job: type: string description: >- Mark the replication job for removal. The job will remove all local replication snapshots. When set to 'full', it also tries to remove replicated volumes on the target. The job then removes itself from the configuration file. schedule: type: string description: >- Storage replication schedule. The format is a subset of `systemd` calendar events. source: type: string description: "For internal use, to detect if the guest was stolen." target: type: string description: Target node. type: type: string description: Section type. CreateClusterReplicationResponse: description: CreateClusterReplicationResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteClusterReplicationSingleResponse: description: DeleteClusterReplicationSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterReplicationSingleResponse: description: GetClusterReplicationSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: comment: type: string description: Description. digest: type: string description: >- Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. disable: type: int64 description: Flag to disable/deactivate the entry. guest: type: int64 description: Guest ID. id: type: string description: >- Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '-'. jobnum: type: int64 description: "Unique, sequential ID assigned to each job." rate: type: number description: >- Rate limit in mbps (megabytes per second) as floating point number. remove_job: type: string description: >- Mark the replication job for removal. The job will remove all local replication snapshots. When set to 'full', it also tries to remove replicated volumes on the target. The job then removes itself from the configuration file. schedule: type: string description: >- Storage replication schedule. The format is a subset of `systemd` calendar events. source: type: string description: "For internal use, to detect if the guest was stolen." target: type: string description: Target node. type: type: string description: Section type. UpdateClusterReplicationSingleResponse: description: UpdateClusterReplicationSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterMetricsResponse: description: GetClusterMetricsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: {} GetClusterMetricsServerResponse: description: GetClusterMetricsServerResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: disable: type: int64 description: Flag to disable the plugin. id: type: string description: The ID of the entry. port: type: int64 description: Server network port server: type: string description: Server dns name or IP address type: type: string description: Plugin type. DeleteClusterMetricsServerSingleResponse: description: DeleteClusterMetricsServerSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterMetricsServerSingleResponse: description: GetClusterMetricsServerSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" CreateClusterMetricsServerSingleResponse: description: CreateClusterMetricsServerSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" UpdateClusterMetricsServerSingleResponse: description: UpdateClusterMetricsServerSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterMetricsExportResponse: description: GetClusterMetricsExportResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: data: type: array description: >- Array of system metrics. Metrics are sorted by their timestamp. items: type: object description: "" properties: id: type: string description: >- Unique identifier for this metric object, for instance 'node/' or 'qemu/'. metric: type: string description: Name of the metric. timestamp: type: int64 description: Time at which this metric was observed type: type: string description: Type of the metric. value: type: number description: Metric value. GetClusterNotificationsResponse: description: GetClusterNotificationsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: {} GetClusterNotificationsMatcherfieldsResponse: description: GetClusterNotificationsMatcherfieldsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: name: type: string description: Name of the field. GetClusterNotificationsMatcherfieldvaluesResponse: description: GetClusterNotificationsMatcherfieldvaluesResponse 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: Additional comment for this value. field: type: string description: Field this value belongs to. value: type: string description: Notification metadata value known by the system. GetClusterNotificationsEndpointsResponse: description: GetClusterNotificationsEndpointsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: {} GetClusterNotificationsEndpointsSendmailResponse: description: GetClusterNotificationsEndpointsSendmailResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: author: type: string description: Author of the mail comment: type: string description: Comment disable: type: int64 description: Disable this target from-address: type: string description: "`From` address for the mail" mailto: type: array description: List of email recipients items: type: string description: "" mailto-user: type: array description: List of users items: type: string description: "" name: type: string description: The name of the endpoint. origin: type: string description: Show if this entry was created by a user or was built-in CreateClusterNotificationsEndpointsSendmailResponse: description: CreateClusterNotificationsEndpointsSendmailResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteClusterNotificationsEndpointsSendmailSingleResponse: description: DeleteClusterNotificationsEndpointsSendmailSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterNotificationsEndpointsSendmailSingleResponse: description: GetClusterNotificationsEndpointsSendmailSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: author: type: string description: Author of the mail comment: type: string description: Comment digest: type: string description: >- Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. disable: type: int64 description: Disable this target from-address: type: string description: "`From` address for the mail" mailto: type: array description: List of email recipients items: type: string description: "" mailto-user: type: array description: List of users items: type: string description: "" name: type: string description: The name of the endpoint. UpdateClusterNotificationsEndpointsSendmailSingleResponse: description: UpdateClusterNotificationsEndpointsSendmailSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterNotificationsEndpointsGotifyResponse: description: GetClusterNotificationsEndpointsGotifyResponse 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: Comment disable: type: int64 description: Disable this target name: type: string description: The name of the endpoint. origin: type: string description: Show if this entry was created by a user or was built-in server: type: string description: Server URL CreateClusterNotificationsEndpointsGotifyResponse: description: CreateClusterNotificationsEndpointsGotifyResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteClusterNotificationsEndpointsGotifySingleResponse: description: DeleteClusterNotificationsEndpointsGotifySingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterNotificationsEndpointsGotifySingleResponse: description: GetClusterNotificationsEndpointsGotifySingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: comment: type: string description: Comment digest: type: string description: >- Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. disable: type: int64 description: Disable this target name: type: string description: The name of the endpoint. server: type: string description: Server URL UpdateClusterNotificationsEndpointsGotifySingleResponse: description: UpdateClusterNotificationsEndpointsGotifySingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterNotificationsEndpointsSmtpResponse: description: GetClusterNotificationsEndpointsSmtpResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: author: type: string description: Author of the mail. Defaults to 'Proxmox VE'. comment: type: string description: Comment disable: type: int64 description: Disable this target from-address: type: string description: "`From` address for the mail" mailto: type: array description: List of email recipients items: type: string description: "" mailto-user: type: array description: List of users items: type: string description: "" mode: type: string description: >- Determine which encryption method shall be used for the connection. name: type: string description: The name of the endpoint. origin: type: string description: Show if this entry was created by a user or was built-in port: type: int64 description: >- The port to be used. Defaults to 465 for TLS based connections, 587 for STARTTLS based connections and port 25 for insecure plain-text connections. server: type: string description: The address of the SMTP server. username: type: string description: Username for SMTP authentication CreateClusterNotificationsEndpointsSmtpResponse: description: CreateClusterNotificationsEndpointsSmtpResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteClusterNotificationsEndpointsSmtpSingleResponse: description: DeleteClusterNotificationsEndpointsSmtpSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterNotificationsEndpointsSmtpSingleResponse: description: GetClusterNotificationsEndpointsSmtpSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: author: type: string description: Author of the mail. Defaults to 'Proxmox VE'. comment: type: string description: Comment digest: type: string description: >- Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. disable: type: int64 description: Disable this target from-address: type: string description: "`From` address for the mail" mailto: type: array description: List of email recipients items: type: string description: "" mailto-user: type: array description: List of users items: type: string description: "" mode: type: string description: >- Determine which encryption method shall be used for the connection. name: type: string description: The name of the endpoint. port: type: int64 description: >- The port to be used. Defaults to 465 for TLS based connections, 587 for STARTTLS based connections and port 25 for insecure plain-text connections. server: type: string description: The address of the SMTP server. username: type: string description: Username for SMTP authentication UpdateClusterNotificationsEndpointsSmtpSingleResponse: description: UpdateClusterNotificationsEndpointsSmtpSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterNotificationsEndpointsWebhookResponse: description: GetClusterNotificationsEndpointsWebhookResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: body: type: string description: "HTTP body, base64 encoded" comment: type: string description: Comment disable: type: int64 description: Disable this target header: type: array description: >- HTTP headers to set. These have to be formatted as a property string in the format name=,value= items: type: string description: "" method: type: string description: HTTP method name: type: string description: The name of the endpoint. origin: type: string description: Show if this entry was created by a user or was built-in secret: type: array description: >- Secrets to set. These have to be formatted as a property string in the format name=,value= items: type: string description: "" url: type: string description: Server URL CreateClusterNotificationsEndpointsWebhookResponse: description: CreateClusterNotificationsEndpointsWebhookResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteClusterNotificationsEndpointsWebhookSingleResponse: description: DeleteClusterNotificationsEndpointsWebhookSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterNotificationsEndpointsWebhookSingleResponse: description: GetClusterNotificationsEndpointsWebhookSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: body: type: string description: "HTTP body, base64 encoded" comment: type: string description: Comment digest: type: string description: >- Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. disable: type: int64 description: Disable this target header: type: array description: >- HTTP headers to set. These have to be formatted as a property string in the format name=,value= items: type: string description: "" method: type: string description: HTTP method name: type: string description: The name of the endpoint. secret: type: array description: >- Secrets to set. These have to be formatted as a property string in the format name=,value= items: type: string description: "" url: type: string description: Server URL UpdateClusterNotificationsEndpointsWebhookSingleResponse: description: UpdateClusterNotificationsEndpointsWebhookSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterNotificationsTargetsResponse: description: GetClusterNotificationsTargetsResponse 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: Comment disable: type: int64 description: Show if this target is disabled name: type: string description: Name of the target. origin: type: string description: Show if this entry was created by a user or was built-in type: type: string description: Type of the target. CreateClusterNotificationsTargetsSingleTestResponse: description: CreateClusterNotificationsTargetsSingleTestResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterNotificationsMatchersResponse: description: GetClusterNotificationsMatchersResponse 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: Comment disable: type: int64 description: Disable this matcher invert-match: type: int64 description: Invert match of the whole matcher match-calendar: type: array description: Match notification timestamp items: type: string description: "" match-field: type: array description: >- Metadata fields to match (regex or exact match). Must be in the form (regex|exact):= items: type: string description: "" match-severity: type: array description: Notification severities to match items: type: string description: "" mode: type: string description: >- Choose between 'all' and 'any' for when multiple properties are specified name: type: string description: Name of the matcher. origin: type: string description: Show if this entry was created by a user or was built-in target: type: array description: Targets to notify on match items: type: string description: "" CreateClusterNotificationsMatchersResponse: description: CreateClusterNotificationsMatchersResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteClusterNotificationsMatchersSingleResponse: description: DeleteClusterNotificationsMatchersSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterNotificationsMatchersSingleResponse: description: GetClusterNotificationsMatchersSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: comment: type: string description: Comment digest: type: string description: >- Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. disable: type: int64 description: Disable this matcher invert-match: type: int64 description: Invert match of the whole matcher match-calendar: type: array description: Match notification timestamp items: type: string description: "" match-field: type: array description: >- Metadata fields to match (regex or exact match). Must be in the form (regex|exact):= items: type: string description: "" match-severity: type: array description: Notification severities to match items: type: string description: "" mode: type: string description: >- Choose between 'all' and 'any' for when multiple properties are specified name: type: string description: Name of the matcher. target: type: array description: Targets to notify on match items: type: string description: "" UpdateClusterNotificationsMatchersSingleResponse: description: UpdateClusterNotificationsMatchersSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterConfigResponse: description: GetClusterConfigResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: {} CreateClusterConfigResponse: description: CreateClusterConfigResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterConfigApiversionResponse: description: GetClusterConfigApiversionResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: int64 description: "Cluster Join API version, currently 1" GetClusterConfigNodesResponse: description: GetClusterConfigNodesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: node: type: string description: "" DeleteClusterConfigNodesSingleResponse: description: DeleteClusterConfigNodesSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" CreateClusterConfigNodesSingleResponse: description: CreateClusterConfigNodesSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: corosync_authkey: type: string description: "" corosync_conf: type: string description: "" warnings: type: array description: "" items: type: string description: "" GetClusterConfigJoinResponse: description: GetClusterConfigJoinResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: config_digest: type: string description: "" nodelist: type: array description: "" items: type: object description: "" properties: name: type: string description: The cluster node name. nodeid: type: int64 description: Node id for this node. pve_addr: type: string description: "" pve_fp: type: string description: Certificate SHA 256 fingerprint. quorum_votes: type: int64 description: "" ring0_addr: type: string description: >- Address and priority information of a single corosync link. (up to 8 links supported; link0..link7) preferred_node: type: string description: The cluster node name. totem: type: object description: "" CreateClusterConfigJoinResponse: description: CreateClusterConfigJoinResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterConfigTotemResponse: description: GetClusterConfigTotemResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" GetClusterConfigQdeviceResponse: description: GetClusterConfigQdeviceResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" GetClusterFirewallResponse: description: GetClusterFirewallResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: {} GetClusterFirewallGroupsResponse: description: GetClusterFirewallGroupsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: comment: type: string description: "" digest: type: string description: >- Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. group: type: string description: Security Group name. CreateClusterFirewallGroupResponse: description: CreateClusterFirewallGroupResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteClusterFirewallGroupResponse: description: DeleteClusterFirewallGroupResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterFirewallGroupRulesResponse: description: GetClusterFirewallGroupRulesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: action: type: string description: >- Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name comment: type: string description: Descriptive comment dest: type: string description: Restrict packet destination address dport: type: string description: Restrict TCP/UDP destination port enable: type: int64 description: Flag to enable/disable a rule icmp-type: type: string description: >- Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp' iface: type: string description: >- Network interface name. You have to use network configuration key names for VMs and containers ipversion: type: int64 description: >- IP version (4 or 6) - automatically determined from source/dest addresses log: type: string description: Log level for firewall rule macro: type: string description: Use predefined standard macro pos: type: int64 description: Rule position in the ruleset proto: type: string description: >- IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols' source: type: string description: Restrict packet source address sport: type: string description: Restrict TCP/UDP source port type: type: string description: Rule type AddClusterFirewallGroupRuleResponse: description: AddClusterFirewallGroupRuleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" RemoveClusterFirewallGroupRuleResponse: description: RemoveClusterFirewallGroupRuleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterFirewallGroupRuleResponse: description: GetClusterFirewallGroupRuleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: action: type: string description: >- Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name comment: type: string description: Descriptive comment dest: type: string description: Restrict packet destination address dport: type: string description: Restrict TCP/UDP destination port enable: type: int64 description: Flag to enable/disable a rule icmp-type: type: string description: >- Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp' iface: type: string description: >- Network interface name. You have to use network configuration key names for VMs and containers ipversion: type: int64 description: >- IP version (4 or 6) - automatically determined from source/dest addresses log: type: string description: Log level for firewall rule macro: type: string description: Use predefined standard macro pos: type: int64 description: Rule position in the ruleset proto: type: string description: >- IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols' source: type: string description: Restrict packet source address sport: type: string description: Restrict TCP/UDP source port type: type: string description: Rule type UpdateClusterFirewallGroupRuleResponse: description: UpdateClusterFirewallGroupRuleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterFirewallRulesResponse: description: GetClusterFirewallRulesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: action: type: string description: >- Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name comment: type: string description: Descriptive comment dest: type: string description: Restrict packet destination address dport: type: string description: Restrict TCP/UDP destination port enable: type: int64 description: Flag to enable/disable a rule icmp-type: type: string description: >- Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp' iface: type: string description: >- Network interface name. You have to use network configuration key names for VMs and containers ipversion: type: int64 description: >- IP version (4 or 6) - automatically determined from source/dest addresses log: type: string description: Log level for firewall rule macro: type: string description: Use predefined standard macro pos: type: int64 description: Rule position in the ruleset proto: type: string description: >- IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols' source: type: string description: Restrict packet source address sport: type: string description: Restrict TCP/UDP source port type: type: string description: Rule type AddClusterFirewallRuleResponse: description: AddClusterFirewallRuleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" RemoveClusterFirewallRuleResponse: description: RemoveClusterFirewallRuleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterFirewallRuleResponse: description: GetClusterFirewallRuleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: action: type: string description: >- Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name comment: type: string description: Descriptive comment dest: type: string description: Restrict packet destination address dport: type: string description: Restrict TCP/UDP destination port enable: type: int64 description: Flag to enable/disable a rule icmp-type: type: string description: >- Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp' iface: type: string description: >- Network interface name. You have to use network configuration key names for VMs and containers ipversion: type: int64 description: >- IP version (4 or 6) - automatically determined from source/dest addresses log: type: string description: Log level for firewall rule macro: type: string description: Use predefined standard macro pos: type: int64 description: Rule position in the ruleset proto: type: string description: >- IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols' source: type: string description: Restrict packet source address sport: type: string description: Restrict TCP/UDP source port type: type: string description: Rule type UpdateClusterFirewallRuleResponse: description: UpdateClusterFirewallRuleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterFirewallIPSetsResponse: description: GetClusterFirewallIPSetsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: comment: type: string description: "" digest: type: string description: >- Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. name: type: string description: IP set name. CreateClusterFirewallIPSetResponse: description: CreateClusterFirewallIPSetResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteClusterFirewallIPSetResponse: description: DeleteClusterFirewallIPSetResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterFirewallIPSetResponse: description: GetClusterFirewallIPSetResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: cidr: type: string description: "" comment: type: string description: "" digest: type: string description: >- Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. nomatch: type: int64 description: "" AddClusterFirewallIPSetIPResponse: description: AddClusterFirewallIPSetIPResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" RemoveClusterFirewallIPSetIPResponse: description: RemoveClusterFirewallIPSetIPResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterFirewallIPSetIPResponse: description: GetClusterFirewallIPSetIPResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" UpdateClusterFirewallIPSetIPResponse: description: UpdateClusterFirewallIPSetIPResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterFirewallAliasesResponse: description: GetClusterFirewallAliasesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: cidr: type: string description: "" comment: type: string description: "" digest: type: string description: >- Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. name: type: string description: "" CreateClusterFirewallAliasesResponse: description: CreateClusterFirewallAliasesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteClusterFirewallAliasesSingleResponse: description: DeleteClusterFirewallAliasesSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterFirewallAliasesSingleResponse: description: GetClusterFirewallAliasesSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" UpdateClusterFirewallAliasesSingleResponse: description: UpdateClusterFirewallAliasesSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterFirewallOptionsResponse: description: GetClusterFirewallOptionsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: ebtables: type: int64 description: Enable ebtables rules cluster wide. enable: type: int64 description: Enable or disable the firewall cluster wide. log_ratelimit: type: string description: Log ratelimiting settings policy_forward: type: string description: Forward policy. policy_in: type: string description: Input policy. policy_out: type: string description: Output policy. UpdateClusterFirewallOptionsResponse: description: UpdateClusterFirewallOptionsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterFirewallMacrosResponse: description: GetClusterFirewallMacrosResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: descr: type: string description: More verbose description (if available). macro: type: string description: Macro name. GetClusterFirewallRefsResponse: description: GetClusterFirewallRefsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: comment: type: string description: "" name: type: string description: "" ref: type: string description: "" scope: type: string description: "" type: type: string description: "" GetClusterBackupResponse: description: GetClusterBackupResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: id: type: string description: The job ID. CreateClusterBackupResponse: description: CreateClusterBackupResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteClusterBackupSingleResponse: description: DeleteClusterBackupSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterBackupSingleResponse: description: GetClusterBackupSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" UpdateClusterBackupSingleResponse: description: UpdateClusterBackupSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterBackupSingleIncludedvolumesResponse: description: GetClusterBackupSingleIncludedvolumesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: >- Root node of the tree object. Children represent guests, grandchildren represent volumes of that guest. properties: children: type: array description: "" items: type: object description: "" properties: children: type: array description: >- The volumes of the guest with the information if they will be included in backups. items: type: object description: "" properties: id: type: string description: Configuration key of the volume. included: type: int64 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: int64 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: array description: Directory index. items: type: object description: "" properties: subdir: type: string description: API sub-directory endpoint 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: int64 description: VMID of the guest. GetClusterHaResponse: description: GetClusterHaResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: id: type: string description: "" GetClusterHaResourcesResponse: description: GetClusterHaResourcesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: sid: type: string description: "" CreateClusterHaResourcesResponse: description: CreateClusterHaResourcesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteClusterHaResourcesSingleResponse: description: DeleteClusterHaResourcesSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterHaResourcesSingleResponse: description: GetClusterHaResourcesSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: comment: type: string description: Description. digest: type: string description: Can be used to prevent concurrent modifications. failback: type: int64 description: >- The HA resource is automatically migrated to the node with the highest priority according to their node affinity rule, if a node with a higher priority than the current node comes online. group: type: string description: The HA group identifier. max_relocate: type: int64 description: >- Maximal number of service relocate tries when a service failes to start. max_restart: type: int64 description: >- Maximal number of tries to restart the service on a node after its start failed. sid: type: string description: >- HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100). state: type: string description: Requested resource state. type: type: string description: The type of the resources. UpdateClusterHaResourcesSingleResponse: description: UpdateClusterHaResourcesSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" CreateClusterHaResourcesSingleMigrateResponse: description: CreateClusterHaResourcesSingleMigrateResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: blocking-resources: type: array description: >- HA resources, which are blocking the given HA resource from being migrated to the requested target node. items: type: object description: A blocking HA resource properties: cause: type: string description: >- The reason why the HA resource is blocking the migration. sid: type: string description: The blocking HA resource id comigrated-resources: type: array description: >- HA resources, which are migrated to the same requested target node as the given HA resource, because these are in positive affinity with the HA resource. requested-node: type: string description: "Node, which was requested to be migrated to." sid: type: string description: "HA resource, which is requested to be migrated." CreateClusterHaResourcesSingleRelocateResponse: description: CreateClusterHaResourcesSingleRelocateResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: blocking-resources: type: array description: >- HA resources, which are blocking the given HA resource from being relocated to the requested target node. items: type: object description: A blocking HA resource properties: cause: type: string description: >- The reason why the HA resource is blocking the relocation. sid: type: string description: The blocking HA resource id comigrated-resources: type: array description: >- HA resources, which are relocated to the same requested target node as the given HA resource, because these are in positive affinity with the HA resource. items: type: string description: A comigrated HA resource requested-node: type: string description: "Node, which was requested to be relocated to." sid: type: string description: "HA resource, which is requested to be relocated." GetClusterHaGroupsResponse: description: GetClusterHaGroupsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: group: type: string description: "" CreateClusterHaGroupsResponse: description: CreateClusterHaGroupsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteClusterHaGroupsSingleResponse: description: DeleteClusterHaGroupsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterHaGroupsSingleResponse: description: GetClusterHaGroupsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" UpdateClusterHaGroupsSingleResponse: description: UpdateClusterHaGroupsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterHaRulesResponse: description: GetClusterHaRulesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: rule: type: string description: "" CreateClusterHaRulesResponse: description: CreateClusterHaRulesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteClusterHaRulesSingleResponse: description: DeleteClusterHaRulesSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterHaRulesSingleResponse: description: GetClusterHaRulesSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: rule: type: string description: HA rule identifier. type: type: string description: HA rule type. UpdateClusterHaRulesSingleResponse: description: UpdateClusterHaRulesSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterHaStatusResponse: description: GetClusterHaStatusResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: {} GetClusterHaStatusCurrentResponse: description: GetClusterHaStatusCurrentResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: crm_state: type: string description: For type 'service'. Service state as seen by the CRM. failback: type: int64 description: >- The HA resource is automatically migrated to the node with the highest priority according to their node affinity rule, if a node with a higher priority than the current node comes online. id: type: string description: >- Status entry ID (quorum, master, lrm:, service:). max_relocate: type: int64 description: For type 'service'. max_restart: type: int64 description: For type 'service'. node: type: string description: Node associated to status entry. quorate: type: int64 description: >- For type 'quorum'. Whether the cluster is quorate or not. request_state: type: string description: For type 'service'. Requested service state. sid: type: string description: For type 'service'. Service ID. state: type: string description: For type 'service'. Verbose service state. status: type: string description: Status of the entry (value depends on type). timestamp: type: int64 description: >- For type 'lrm','master'. Timestamp of the status information. type: type: string description: Type of status entry. GetClusterHaStatusManagerstatusResponse: description: GetClusterHaStatusManagerstatusResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" GetClusterAcmeResponse: description: GetClusterAcmeResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: {} GetClusterAcmePluginsResponse: description: GetClusterAcmePluginsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: api: type: string description: API plugin name data: type: string description: DNS plugin data. (base64 encoded) digest: type: string description: >- Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. disable: type: int64 description: Flag to disable the config. nodes: type: string description: List of cluster node names. plugin: type: string description: Unique identifier for ACME plugin instance. type: type: string description: ACME challenge type. validation-delay: type: int64 description: >- Extra delay in seconds to wait before requesting validation. Allows to cope with a long TTL of DNS records. CreateClusterAcmePluginsResponse: description: CreateClusterAcmePluginsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteClusterAcmePluginsSingleResponse: description: DeleteClusterAcmePluginsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterAcmePluginsSingleResponse: description: GetClusterAcmePluginsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: api: type: string description: API plugin name data: type: string description: DNS plugin data. (base64 encoded) digest: type: string description: >- Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. disable: type: int64 description: Flag to disable the config. nodes: type: string description: List of cluster node names. plugin: type: string description: Unique identifier for ACME plugin instance. type: type: string description: ACME challenge type. validation-delay: type: int64 description: >- Extra delay in seconds to wait before requesting validation. Allows to cope with a long TTL of DNS records. UpdateClusterAcmePluginsSingleResponse: description: UpdateClusterAcmePluginsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterAcmeAccountResponse: description: GetClusterAcmeAccountResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: {} CreateClusterAcmeAccountResponse: description: CreateClusterAcmeAccountResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteClusterAcmeAccountSingleResponse: description: DeleteClusterAcmeAccountSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterAcmeAccountSingleResponse: description: GetClusterAcmeAccountSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: account: type: object description: "" directory: type: string description: URL of ACME CA directory endpoint. location: type: string description: "" tos: type: string description: "" UpdateClusterAcmeAccountSingleResponse: description: UpdateClusterAcmeAccountSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterAcmeTosResponse: description: GetClusterAcmeTosResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: ACME TermsOfService URL. GetClusterAcmeMetaResponse: description: GetClusterAcmeMetaResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: caaIdentities: type: array description: Hostnames referring to the ACME servers. items: type: string description: "" externalAccountRequired: type: int64 description: EAB Required termsOfService: type: string description: ACME TermsOfService URL. website: type: string description: URL to more information about the ACME server. GetClusterAcmeDirectoriesResponse: description: GetClusterAcmeDirectoriesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: name: type: string description: "" url: type: string description: URL of ACME CA directory endpoint. GetClusterAcmeChallengeschemaResponse: description: GetClusterAcmeChallengeschemaResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: id: type: string description: "" name: type: string description: "Human readable name, falls back to id" schema: type: object description: "" type: type: string description: "" GetClusterCephResponse: description: GetClusterCephResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: {} GetClusterCephMetadataResponse: description: GetClusterCephMetadataResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: >- Items for each type of service containing objects for each instance. properties: mds: type: object description: >- Metadata servers configured in the cluster and their properties. properties: "{id}": type: object description: "Useful properties are listed, but not the full list." properties: addr: type: string description: Bind addresses and ports. ceph_release: type: string description: Ceph release codename currently used. ceph_version: type: string description: Version info currently used by the service. ceph_version_short: type: string description: >- Short version (numerical) info currently used by the service. hostname: type: string description: Hostname on which the service is running. mem_swap_kb: type: int64 description: Memory of the service currently in swap. mem_total_kb: type: int64 description: Memory consumption of the service. name: type: string description: Name of the service instance. mgr: type: object description: Managers configured in the cluster and their properties. properties: "{id}": type: object description: "Useful properties are listed, but not the full list." properties: addr: type: string description: Bind address ceph_release: type: string description: Ceph release codename currently used. ceph_version: type: string description: Version info currently used by the service. ceph_version_short: type: string description: >- Short version (numerical) info currently used by the service. hostname: type: string description: Hostname on which the service is running. mem_swap_kb: type: int64 description: Memory of the service currently in swap. mem_total_kb: type: int64 description: Memory consumption of the service. name: type: string description: Name of the service instance. mon: type: object description: Monitors configured in the cluster and their properties. properties: "{id}": type: object description: "Useful properties are listed, but not the full list." properties: addrs: type: string description: Bind addresses and ports. ceph_release: type: string description: Ceph release codename currently used. ceph_version: type: string description: Version info currently used by the service. ceph_version_short: type: string description: >- Short version (numerical) info currently used by the service. hostname: type: string description: Hostname on which the service is running. mem_swap_kb: type: int64 description: Memory of the service currently in swap. mem_total_kb: type: int64 description: Memory consumption of the service. name: type: string description: Name of the service instance. node: type: object description: Ceph version installed on the nodes. properties: "{node}": type: object description: "" properties: buildcommit: type: string description: GIT commit used for the build. version: type: object description: Version info. properties: parts: type: array description: "major, minor & patch" str: type: string description: Version as single string. osd: type: array description: OSDs configured in the cluster and their properties. GetClusterCephStatusResponse: description: GetClusterCephStatusResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" GetClusterCephFlagsResponse: description: GetClusterCephFlagsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: description: type: string description: Flag description. name: type: string description: Flag name. value: type: int64 description: Flag value. UpdateClusterCephFlagsResponse: description: UpdateClusterCephFlagsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterCephFlagsSingleResponse: description: GetClusterCephFlagsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: int64 description: "" UpdateClusterCephFlagsSingleResponse: description: UpdateClusterCephFlagsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterJobsResponse: description: GetClusterJobsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: Directory index. items: type: object description: "" properties: subdir: type: string description: API sub-directory endpoint GetClusterJobsRealmsyncResponse: description: GetClusterJobsRealmsyncResponse 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 for the job. enabled: type: int64 description: If the job is enabled or not. id: type: string description: The ID of the entry. last-run: type: int64 description: >- Last execution time of the job in seconds since the beginning of the UNIX epoch next-run: type: int64 description: >- Next planned execution time of the job in seconds since the beginning of the UNIX epoch. realm: type: string description: Authentication domain ID remove-vanished: type: string description: >- A semicolon-separated list of things to remove when they or the user vanishes during a sync. The following values are possible: 'entry' removes the user/group when not returned from the sync. 'properties' removes the set properties on existing user/group that do not appear in the source (even custom ones). 'acl' removes acls when the user/group is not returned from the sync. Instead of a list it also can be 'none' (the default). schedule: type: string description: The configured sync schedule. scope: type: string description: Select what to sync. DeleteClusterJobsRealmsyncSingleResponse: description: DeleteClusterJobsRealmsyncSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterJobsRealmsyncSingleResponse: description: GetClusterJobsRealmsyncSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" CreateClusterJobsRealmsyncSingleResponse: description: CreateClusterJobsRealmsyncSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" UpdateClusterJobsRealmsyncSingleResponse: description: UpdateClusterJobsRealmsyncSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterJobsScheduleanalyzeResponse: description: GetClusterJobsScheduleanalyzeResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: An array of the next events since . items: type: object description: "" properties: timestamp: type: int64 description: UNIX timestamp for the run. utc: type: string description: UTC timestamp for the run. GetClusterMappingResponse: description: GetClusterMappingResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" GetClusterMappingDirResponse: description: GetClusterMappingDirResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: checks: type: array description: "A list of checks, only present if 'check-node' is set." items: type: object description: "" properties: message: type: string description: The message of the error severity: type: string description: The severity of the error description: type: string description: A description of the logical mapping. id: type: string description: The logical ID of the mapping. map: type: array description: The entries of the mapping. items: type: string description: A mapping for a node. CreateClusterMappingDirResponse: description: CreateClusterMappingDirResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteClusterMappingDirSingleResponse: description: DeleteClusterMappingDirSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterMappingDirSingleResponse: description: GetClusterMappingDirSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" UpdateClusterMappingDirSingleResponse: description: UpdateClusterMappingDirSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterMappingPciResponse: description: GetClusterMappingPciResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: checks: type: array description: "A list of checks, only present if 'check_node' is set." items: type: object description: "" properties: message: type: string description: The message of the error severity: type: string description: The severity of the error description: type: string description: A description of the logical mapping. id: type: string description: The logical ID of the mapping. map: type: array description: The entries of the mapping. items: type: string description: A mapping for a node. CreateClusterMappingPciResponse: description: CreateClusterMappingPciResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteClusterMappingPciSingleResponse: description: DeleteClusterMappingPciSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterMappingPciSingleResponse: description: GetClusterMappingPciSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" UpdateClusterMappingPciSingleResponse: description: UpdateClusterMappingPciSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterMappingUsbResponse: description: GetClusterMappingUsbResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: description: type: string description: A description of the logical mapping. error: type: string description: A list of errors when 'check_node' is given. id: type: string description: The logical ID of the mapping. map: type: array description: The entries of the mapping. items: type: string description: A mapping for a node. CreateClusterMappingUsbResponse: description: CreateClusterMappingUsbResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteClusterMappingUsbSingleResponse: description: DeleteClusterMappingUsbSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterMappingUsbSingleResponse: description: GetClusterMappingUsbSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" UpdateClusterMappingUsbSingleResponse: description: UpdateClusterMappingUsbSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterBulkactionResponse: description: GetClusterBulkactionResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" GetClusterBulkactionGuestResponse: description: GetClusterBulkactionGuestResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: {} CreateClusterBulkactionGuestStartResponse: description: CreateClusterBulkactionGuestStartResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: UPID of the worker CreateClusterBulkactionGuestShutdownResponse: description: CreateClusterBulkactionGuestShutdownResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: UPID of the worker CreateClusterBulkactionGuestSuspendResponse: description: CreateClusterBulkactionGuestSuspendResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: UPID of the worker CreateClusterBulkactionGuestMigrateResponse: description: CreateClusterBulkactionGuestMigrateResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: UPID of the worker GetClusterSDNResponse: description: GetClusterSDNResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: id: type: string description: "" UpdateClusterSDNResponse: description: UpdateClusterSDNResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterSDNVnetsResponse: description: GetClusterSDNVnetsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: alias: type: string description: Alias name of the VNet. digest: type: string description: Digest of the VNet section. isolate-ports: type: int64 description: >- If true, sets the isolated property for all interfaces on the bridge of this VNet. pending: type: object description: >- Changes that have not yet been applied to the running configuration. properties: alias: type: string description: Alias name of the VNet. isolate-ports: type: int64 description: >- If true, sets the isolated property for all interfaces on the bridge of this VNet. tag: type: int64 description: >- VLAN Tag (for VLAN or QinQ zones) or VXLAN VNI (for VXLAN or EVPN zones). vlanaware: type: int64 description: Allow VLANs to pass through this VNet. zone: type: string description: Name of the zone this VNet belongs to. state: type: string description: State of the SDN configuration object. tag: type: int64 description: >- VLAN Tag (for VLAN or QinQ zones) or VXLAN VNI (for VXLAN or EVPN zones). type: type: string description: Type of the VNet. vlanaware: type: int64 description: Allow VLANs to pass through this VNet. vnet: type: string description: Name of the VNet. zone: type: string description: Name of the zone this VNet belongs to. CreateClusterSDNVnetResponse: description: CreateClusterSDNVnetResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteClusterSDNVnetResponse: description: DeleteClusterSDNVnetResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterSDNVnetResponse: description: GetClusterSDNVnetResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" UpdateClusterSDNVnetResponse: description: UpdateClusterSDNVnetResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterSdnVnetsSingleFirewallResponse: description: GetClusterSdnVnetsSingleFirewallResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: {} GetClusterSdnVnetsSingleFirewallRulesResponse: description: GetClusterSdnVnetsSingleFirewallRulesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: action: type: string description: >- Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name comment: type: string description: Descriptive comment dest: type: string description: Restrict packet destination address dport: type: string description: Restrict TCP/UDP destination port enable: type: int64 description: Flag to enable/disable a rule icmp-type: type: string description: >- Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp' iface: type: string description: >- Network interface name. You have to use network configuration key names for VMs and containers ipversion: type: int64 description: >- IP version (4 or 6) - automatically determined from source/dest addresses log: type: string description: Log level for firewall rule macro: type: string description: Use predefined standard macro pos: type: int64 description: Rule position in the ruleset proto: type: string description: >- IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols' source: type: string description: Restrict packet source address sport: type: string description: Restrict TCP/UDP source port type: type: string description: Rule type CreateClusterSdnVnetsSingleFirewallRulesResponse: description: CreateClusterSdnVnetsSingleFirewallRulesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteClusterSdnVnetsSingleFirewallRulesSingleResponse: description: DeleteClusterSdnVnetsSingleFirewallRulesSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterSdnVnetsSingleFirewallRulesSingleResponse: description: GetClusterSdnVnetsSingleFirewallRulesSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: action: type: string description: >- Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name comment: type: string description: Descriptive comment dest: type: string description: Restrict packet destination address dport: type: string description: Restrict TCP/UDP destination port enable: type: int64 description: Flag to enable/disable a rule icmp-type: type: string description: >- Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp' iface: type: string description: >- Network interface name. You have to use network configuration key names for VMs and containers ipversion: type: int64 description: >- IP version (4 or 6) - automatically determined from source/dest addresses log: type: string description: Log level for firewall rule macro: type: string description: Use predefined standard macro pos: type: int64 description: Rule position in the ruleset proto: type: string description: >- IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols' source: type: string description: Restrict packet source address sport: type: string description: Restrict TCP/UDP source port type: type: string description: Rule type UpdateClusterSdnVnetsSingleFirewallRulesSingleResponse: description: UpdateClusterSdnVnetsSingleFirewallRulesSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterSdnVnetsSingleFirewallOptionsResponse: description: GetClusterSdnVnetsSingleFirewallOptionsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: enable: type: int64 description: Enable/disable firewall rules. log_level_forward: type: string description: Log level for forwarded traffic. policy_forward: type: string description: Forward policy. UpdateClusterSdnVnetsSingleFirewallOptionsResponse: description: UpdateClusterSdnVnetsSingleFirewallOptionsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterSdnVnetsSingleSubnetsResponse: description: GetClusterSdnVnetsSingleSubnetsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: {} CreateClusterSdnVnetsSingleSubnetsResponse: description: CreateClusterSdnVnetsSingleSubnetsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteClusterSdnVnetsSingleSubnetsSingleResponse: description: DeleteClusterSdnVnetsSingleSubnetsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterSdnVnetsSingleSubnetsSingleResponse: description: GetClusterSdnVnetsSingleSubnetsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" UpdateClusterSdnVnetsSingleSubnetsSingleResponse: description: UpdateClusterSdnVnetsSingleSubnetsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteClusterSdnVnetsSingleIpsResponse: description: DeleteClusterSdnVnetsSingleIpsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" CreateClusterSdnVnetsSingleIpsResponse: description: CreateClusterSdnVnetsSingleIpsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" UpdateClusterSdnVnetsSingleIpsResponse: description: UpdateClusterSdnVnetsSingleIpsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterSDNZonesResponse: description: GetClusterSDNZonesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: advertise-subnets: type: int64 description: >- Advertise IP prefixes (Type-5 routes) instead of MAC/IP pairs (Type-2 routes). EVPN zone only. bridge: type: string description: >- the bridge for which VLANs should be managed. VLAN & QinQ zone only. bridge-disable-mac-learning: type: int64 description: Disable auto mac learning. VLAN zone only. controller: type: string description: ID of the controller for this zone. EVPN zone only. dhcp: type: string description: Name of DHCP server backend for this zone. digest: type: string description: Digest of the controller section. disable-arp-nd-suppression: type: int64 description: >- Suppress IPv4 ARP && IPv6 Neighbour Discovery messages. EVPN zone only. dns: type: string description: ID of the DNS server for this zone. dnszone: type: string description: Domain name for this zone. exitnodes: type: string description: >- List of PVE Nodes that should act as exit node for this zone. EVPN zone only. exitnodes-local-routing: type: int64 description: >- Create routes on the exit nodes, so they can connect to EVPN guests. EVPN zone only. exitnodes-primary: type: string description: >- Force traffic through this exitnode first. EVPN zone only. ipam: type: string description: ID of the IPAM for this zone. mac: type: string description: MAC address of the anycast router for this zone. mtu: type: int64 description: >- MTU of the zone, will be used for the created VNet bridges. nodes: type: string description: Nodes where this zone should be created. peers: type: string description: >- Comma-separated list of peers, that are part of the VXLAN zone. Usually the IPs of the nodes. VXLAN zone only. pending: type: object description: >- Changes that have not yet been applied to the running configuration. properties: advertise-subnets: type: int64 description: >- Advertise IP prefixes (Type-5 routes) instead of MAC/IP pairs (Type-2 routes). EVPN zone only. bridge: type: string description: >- the bridge for which VLANs should be managed. VLAN & QinQ zone only. bridge-disable-mac-learning: type: int64 description: Disable auto mac learning. VLAN zone only. controller: type: string description: ID of the controller for this zone. EVPN zone only. dhcp: type: string description: Name of DHCP server backend for this zone. disable-arp-nd-suppression: type: int64 description: >- Suppress IPv4 ARP && IPv6 Neighbour Discovery messages. EVPN zone only. dns: type: string description: ID of the DNS server for this zone. dnszone: type: string description: Domain name for this zone. exitnodes: type: string description: >- List of PVE Nodes that should act as exit node for this zone. EVPN zone only. exitnodes-local-routing: type: int64 description: >- Create routes on the exit nodes, so they can connect to EVPN guests. EVPN zone only. exitnodes-primary: type: string description: >- Force traffic through this exitnode first. EVPN zone only. ipam: type: string description: ID of the IPAM for this zone. mac: type: string description: MAC address of the anycast router for this zone. mtu: type: int64 description: >- MTU of the zone, will be used for the created VNet bridges. nodes: type: string description: Nodes where this zone should be created. peers: type: string description: >- Comma-separated list of peers, that are part of the VXLAN zone. Usually the IPs of the nodes. VXLAN zone only. reversedns: type: string description: ID of the reverse DNS server for this zone. rt-import: type: string description: >- Route-Targets that should be imported into the VRF of this zone via BGP. EVPN zone only. tag: type: int64 description: Service-VLAN Tag (outer VLAN). QinQ zone only vlan-protocol: type: string description: >- VLAN protocol for the creation of the QinQ zone. QinQ zone only. vrf-vxlan: type: int64 description: VNI for the zone VRF. EVPN zone only. vxlan-port: type: int64 description: >- UDP port that should be used for the VXLAN tunnel (default 4789). VXLAN zone only. reversedns: type: string description: ID of the reverse DNS server for this zone. rt-import: type: string description: >- Route-Targets that should be imported into the VRF of this zone via BGP. EVPN zone only. state: type: string description: State of the SDN configuration object. tag: type: int64 description: Service-VLAN Tag (outer VLAN). QinQ zone only type: type: string description: Type of the zone. vlan-protocol: type: string description: >- VLAN protocol for the creation of the QinQ zone. QinQ zone only. vrf-vxlan: type: int64 description: VNI for the zone VRF. EVPN zone only. vxlan-port: type: int64 description: >- UDP port that should be used for the VXLAN tunnel (default 4789). VXLAN zone only. zone: type: string description: Name of the zone. CreateClusterSDNZoneResponse: description: CreateClusterSDNZoneResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteClusterSDNZoneResponse: description: DeleteClusterSDNZoneResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterSDNZoneResponse: description: GetClusterSDNZoneResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" UpdateClusterSDNZoneResponse: description: UpdateClusterSDNZoneResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterSDNControllersResponse: description: GetClusterSDNControllersResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: asn: type: int64 description: The local ASN of the controller. BGP & EVPN only. bgp-multipath-as-relax: type: int64 description: >- Consider different AS paths of equal length for multipath computation. BGP only. controller: type: string description: Name of the controller. digest: type: string description: Digest of the controller section. ebgp: type: int64 description: Enable eBGP (remote-as external). BGP only. ebgp-multihop: type: int64 description: >- Set maximum amount of hops for eBGP peers. Needs ebgp set to 1. BGP only. isis-domain: type: string description: Name of the IS-IS domain. IS-IS only. isis-ifaces: type: string description: >- Comma-separated list of interfaces where IS-IS should be active. IS-IS only. isis-net: type: string description: >- Network Entity title for this node in the IS-IS network. IS-IS only. loopback: type: string description: >- Name of the loopback/dummy interface that provides the Router-IP. BGP only. node: type: string description: Node(s) where this controller is active. peers: type: string description: Comma-separated list of the peers IP addresses. pending: type: object description: >- Changes that have not yet been applied to the running configuration. properties: asn: type: int64 description: The local ASN of the controller. BGP & EVPN only. bgp-multipath-as-relax: type: int64 description: >- Consider different AS paths of equal length for multipath computation. BGP only. ebgp: type: int64 description: Enable eBGP (remote-as external). BGP only. ebgp-multihop: type: int64 description: >- Set maximum amount of hops for eBGP peers. Needs ebgp set to 1. BGP only. isis-domain: type: string description: Name of the IS-IS domain. IS-IS only. isis-ifaces: type: string description: >- Comma-separated list of interfaces where IS-IS should be active. IS-IS only. isis-net: type: string description: >- Network Entity title for this node in the IS-IS network. IS-IS only. loopback: type: string description: >- Name of the loopback/dummy interface that provides the Router-IP. BGP only. node: type: string description: Node(s) where this controller is active. peers: type: string description: Comma-separated list of the peers IP addresses. state: type: string description: State of the SDN configuration object. type: type: string description: Type of the controller CreateClusterSDNControllerResponse: description: CreateClusterSDNControllerResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteClusterSDNControllerResponse: description: DeleteClusterSDNControllerResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterSDNControllerResponse: description: GetClusterSDNControllerResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" UpdateClusterSDNControllerResponse: description: UpdateClusterSDNControllerResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterSdnIpamsResponse: description: GetClusterSdnIpamsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: ipam: type: string description: "" type: type: string description: "" CreateClusterSdnIpamsResponse: description: CreateClusterSdnIpamsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteClusterSdnIpamsSingleResponse: description: DeleteClusterSdnIpamsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterSdnIpamsSingleResponse: description: GetClusterSdnIpamsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" UpdateClusterSdnIpamsSingleResponse: description: UpdateClusterSdnIpamsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterSdnIpamsSingleStatusResponse: description: GetClusterSdnIpamsSingleStatusResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" GetClusterSdnDnsResponse: description: GetClusterSdnDnsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: dns: type: string description: "" type: type: string description: "" CreateClusterSdnDnsResponse: description: CreateClusterSdnDnsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteClusterSdnDnsSingleResponse: description: DeleteClusterSdnDnsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterSdnDnsSingleResponse: description: GetClusterSdnDnsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" UpdateClusterSdnDnsSingleResponse: description: UpdateClusterSdnDnsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterSdnFabricsResponse: description: GetClusterSdnFabricsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: subdir: type: string description: "" GetClusterSdnFabricsFabricResponse: description: GetClusterSdnFabricsFabricResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: area: type: string description: >- OSPF area. Either a IPv4 address or a 32-bit number. Gets validated in rust. csnp_interval: type: number description: The csnp_interval property for Openfabric digest: type: string description: >- Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. hello_interval: type: number description: The hello_interval property for Openfabric id: type: string description: Identifier for SDN fabrics ip6_prefix: type: string description: The IP prefix for Node IPs ip_prefix: type: string description: The IP prefix for Node IPs lock-token: type: string description: the token for unlocking the global SDN configuration protocol: type: string description: >- Type of configuration entry in an SDN Fabric section config CreateClusterSdnFabricsFabricResponse: description: CreateClusterSdnFabricsFabricResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteClusterSdnFabricsFabricSingleResponse: description: DeleteClusterSdnFabricsFabricSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterSdnFabricsFabricSingleResponse: description: GetClusterSdnFabricsFabricSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: area: type: string description: >- OSPF area. Either a IPv4 address or a 32-bit number. Gets validated in rust. csnp_interval: type: number description: The csnp_interval property for Openfabric digest: type: string description: >- Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. hello_interval: type: number description: The hello_interval property for Openfabric id: type: string description: Identifier for SDN fabrics ip6_prefix: type: string description: The IP prefix for Node IPs ip_prefix: type: string description: The IP prefix for Node IPs lock-token: type: string description: the token for unlocking the global SDN configuration protocol: type: string description: >- Type of configuration entry in an SDN Fabric section config UpdateClusterSdnFabricsFabricSingleResponse: description: UpdateClusterSdnFabricsFabricSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterSdnFabricsNodeResponse: description: GetClusterSdnFabricsNodeResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: digest: type: string description: >- Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. fabric_id: type: string description: Identifier for SDN fabrics interfaces: type: array description: "" ip: type: string description: IPv4 address for this node ip6: type: string description: IPv6 address for this node lock-token: type: string description: the token for unlocking the global SDN configuration node_id: type: string description: Identifier for nodes in an SDN fabric protocol: type: string description: >- Type of configuration entry in an SDN Fabric section config GetClusterSdnFabricsNodeSingleResponse: description: GetClusterSdnFabricsNodeSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: digest: type: string description: >- Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. fabric_id: type: string description: Identifier for SDN fabrics interfaces: type: array description: "" ip: type: string description: IPv4 address for this node ip6: type: string description: IPv6 address for this node lock-token: type: string description: the token for unlocking the global SDN configuration node_id: type: string description: Identifier for nodes in an SDN fabric protocol: type: string description: >- Type of configuration entry in an SDN Fabric section config CreateClusterSdnFabricsNodeSingleResponse: description: CreateClusterSdnFabricsNodeSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteClusterSdnFabricsNodeSingleSingleResponse: description: DeleteClusterSdnFabricsNodeSingleSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterSdnFabricsNodeSingleSingleResponse: description: GetClusterSdnFabricsNodeSingleSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" UpdateClusterSdnFabricsNodeSingleSingleResponse: description: UpdateClusterSdnFabricsNodeSingleSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterSdnFabricsAllResponse: description: GetClusterSdnFabricsAllResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: fabrics: type: array description: "" items: type: object description: "" properties: area: type: string description: >- OSPF area. Either a IPv4 address or a 32-bit number. Gets validated in rust. csnp_interval: type: number description: The csnp_interval property for Openfabric digest: type: string description: >- Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. hello_interval: type: number description: The hello_interval property for Openfabric id: type: string description: Identifier for SDN fabrics ip6_prefix: type: string description: The IP prefix for Node IPs ip_prefix: type: string description: The IP prefix for Node IPs lock-token: type: string description: the token for unlocking the global SDN configuration protocol: type: string description: >- Type of configuration entry in an SDN Fabric section config nodes: type: array description: "" items: type: object description: "" properties: digest: type: string description: >- Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. fabric_id: type: string description: Identifier for SDN fabrics interfaces: type: array description: "" ip: type: string description: IPv4 address for this node ip6: type: string description: IPv6 address for this node lock-token: type: string description: the token for unlocking the global SDN configuration node_id: type: string description: Identifier for nodes in an SDN fabric protocol: type: string description: >- Type of configuration entry in an SDN Fabric section config DeleteClusterSdnLockResponse: description: DeleteClusterSdnLockResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" CreateClusterSdnLockResponse: description: CreateClusterSdnLockResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" CreateClusterSdnRollbackResponse: description: CreateClusterSdnRollbackResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterLogResponse: description: GetClusterLogResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: {} GetClusterResourcesResponse: description: GetClusterResourcesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: cgroup-mode: type: int64 description: >- The cgroup mode the node operates under (for type 'node'). content: type: string description: Allowed storage content types (for type 'storage'). cpu: type: number description: "CPU utilization (for types 'node', 'qemu' and 'lxc')." disk: type: int64 description: >- Used disk space in bytes (for type 'storage'), used root image space for VMs (for types 'qemu' and 'lxc'). diskread: type: int64 description: >- The number of bytes the guest read from its block devices since the guest was started. This info is not available for all storage types. (for types 'qemu' and 'lxc') diskwrite: type: int64 description: >- The number of bytes the guest wrote to its block devices since the guest was started. This info is not available for all storage types. (for types 'qemu' and 'lxc') hastate: type: string description: HA service status (for HA managed VMs). id: type: string description: Resource id. level: type: string description: Support level (for type 'node'). lock: type: string description: >- The guest's current config lock (for types 'qemu' and 'lxc') maxcpu: type: number description: >- Number of available CPUs (for types 'node', 'qemu' and 'lxc'). maxdisk: type: int64 description: >- Storage size in bytes (for type 'storage'), root image size for VMs (for types 'qemu' and 'lxc'). maxmem: type: int64 description: >- Number of available memory in bytes (for types 'node', 'qemu' and 'lxc'). mem: type: int64 description: >- Used memory in bytes (for types 'node', 'qemu' and 'lxc'). memhost: type: int64 description: >- Used memory in bytes from the point of view of the host (for types 'qemu'). name: type: string description: Name of the resource. netin: type: int64 description: >- The amount of traffic in bytes that was sent to the guest over the network since it was started. (for types 'qemu' and 'lxc') netout: type: int64 description: >- The amount of traffic in bytes that was sent from the guest over the network since it was started. (for types 'qemu' and 'lxc') network: type: string description: The name of a Network entity (for type 'network'). network-type: type: string description: The type of network resource (for type 'network'). node: type: string description: >- The cluster node name (for types 'node', 'storage', 'qemu', and 'lxc'). plugintype: type: string description: "More specific type, if available." pool: type: string description: "The pool name (for types 'pool', 'qemu' and 'lxc')." protocol: type: string description: >- The protocol of a fabric (for type 'network', network-type 'fabric'). sdn: type: string description: The name of an SDN entity (for type 'sdn') status: type: string description: Resource type dependent status. storage: type: string description: The storage identifier (for type 'storage'). tags: type: string description: The guest's tags (for types 'qemu' and 'lxc') template: type: int64 description: >- Determines if the guest is a template. (for types 'qemu' and 'lxc') type: type: string description: Resource type. uptime: type: int64 description: >- Uptime of node or virtual guest in seconds (for types 'node', 'qemu' and 'lxc'). vmid: type: int64 description: The numerical vmid (for types 'qemu' and 'lxc'). zone-type: type: string description: The type of an SDN zone (for type 'sdn'). GetClusterTasksResponse: description: GetClusterTasksResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: upid: type: string description: "" GetClusterOptionsResponse: description: GetClusterOptionsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" UpdateClusterOptionsResponse: description: UpdateClusterOptionsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetClusterStatusResponse: description: GetClusterStatusResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: id: type: string description: "" ip: type: string description: "[node] IP of the resolved nodename." level: type: string description: >- [node] Proxmox VE Subscription level, indicates if eligible for enterprise support as well as access to the stable Proxmox VE Enterprise Repository. local: type: int64 description: "[node] Indicates if this is the responding node." name: type: string description: "" nodeid: type: int64 description: "[node] ID of the node from the corosync configuration." nodes: type: int64 description: "[cluster] Nodes count, including offline nodes." online: type: int64 description: "[node] Indicates if the node is online or offline." quorate: type: int64 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: int64 description: >- [cluster] Current version of the corosync configuration file. GetClusterNextidResponse: description: GetClusterNextidResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: int64 description: The next free VMID. GetNodesResponse: description: GetNodesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: cpu: type: number description: CPU utilization. level: type: string description: Support level. maxcpu: type: int64 description: Number of available CPUs. maxmem: type: int64 description: Number of available memory in bytes. mem: type: int64 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: int64 description: Node uptime in seconds. GetNodeResponse: description: GetNodeResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: {} GetVMsResponse: description: GetVMsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: cpu: type: number description: Current CPU usage. cpus: type: number description: Maximum usable CPUs. diskread: type: int64 description: >- The amount of bytes the guest read from it's block devices since the guest was started. (Note: This info is not available for all storage types.) diskwrite: type: int64 description: >- The amount of bytes the guest wrote from it's block devices since the guest was started. (Note: This info is not available for all storage types.) lock: type: string description: "The current config lock, if any." maxdisk: type: int64 description: Root disk size in bytes. maxmem: type: int64 description: Maximum memory in bytes. mem: type: int64 description: Currently used memory in bytes. memhost: type: int64 description: Current memory usage on the host. name: type: string description: VM (host)name. netin: type: int64 description: >- The amount of traffic in bytes that was sent to the guest over the network since it was started. netout: type: int64 description: >- The amount of traffic in bytes that was sent from the guest over the network since it was started. pid: type: int64 description: "PID of the QEMU process, if the VM is running." pressurecpufull: type: number description: >- CPU Full pressure stall average over the last 10 seconds. pressurecpusome: type: number description: >- CPU Some pressure stall average over the last 10 seconds. pressureiofull: type: number description: IO Full pressure stall average over the last 10 seconds. pressureiosome: type: number description: IO Some pressure stall average over the last 10 seconds. pressurememoryfull: type: number description: >- Memory Full pressure stall average over the last 10 seconds. pressurememorysome: type: number description: >- Memory Some pressure stall average over the last 10 seconds. qmpstatus: type: string description: >- VM run state from the 'query-status' QMP monitor command. running-machine: type: string description: The currently running machine type (if running). running-qemu: type: string description: The QEMU version the VM is currently using (if running). serial: type: int64 description: Guest has serial device configured. status: type: string description: QEMU process status. tags: type: string description: "The current configured tags, if any" template: type: int64 description: Determines if the guest is a template. uptime: type: int64 description: Uptime in seconds. vmid: type: int64 description: The (unique) ID of the VM. CreateVMResponse: description: CreateVMResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteVMResponse: description: DeleteVMResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetVMResponse: description: GetVMResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: subdir: type: string description: "" GetVMFirewallResponse: description: GetVMFirewallResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: {} GetVMFirewallRulesResponse: description: GetVMFirewallRulesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: action: type: string description: >- Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name comment: type: string description: Descriptive comment dest: type: string description: Restrict packet destination address dport: type: string description: Restrict TCP/UDP destination port enable: type: int64 description: Flag to enable/disable a rule icmp-type: type: string description: >- Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp' iface: type: string description: >- Network interface name. You have to use network configuration key names for VMs and containers ipversion: type: int64 description: >- IP version (4 or 6) - automatically determined from source/dest addresses log: type: string description: Log level for firewall rule macro: type: string description: Use predefined standard macro pos: type: int64 description: Rule position in the ruleset proto: type: string description: >- IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols' source: type: string description: Restrict packet source address sport: type: string description: Restrict TCP/UDP source port type: type: string description: Rule type CreateVMFirewallRuleResponse: description: CreateVMFirewallRuleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteVMFirewallRuleResponse: description: DeleteVMFirewallRuleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetVMFirewallRuleResponse: description: GetVMFirewallRuleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: action: type: string description: >- Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name comment: type: string description: Descriptive comment dest: type: string description: Restrict packet destination address dport: type: string description: Restrict TCP/UDP destination port enable: type: int64 description: Flag to enable/disable a rule icmp-type: type: string description: >- Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp' iface: type: string description: >- Network interface name. You have to use network configuration key names for VMs and containers ipversion: type: int64 description: >- IP version (4 or 6) - automatically determined from source/dest addresses log: type: string description: Log level for firewall rule macro: type: string description: Use predefined standard macro pos: type: int64 description: Rule position in the ruleset proto: type: string description: >- IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols' source: type: string description: Restrict packet source address sport: type: string description: Restrict TCP/UDP source port type: type: string description: Rule type UpdateVMFirewallRuleResponse: description: UpdateVMFirewallRuleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleQemuSingleFirewallAliasesResponse: description: GetNodesSingleQemuSingleFirewallAliasesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: cidr: type: string description: "" comment: type: string description: "" digest: type: string description: >- Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. name: type: string description: "" CreateNodesSingleQemuSingleFirewallAliasesResponse: description: CreateNodesSingleQemuSingleFirewallAliasesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteNodesSingleQemuSingleFirewallAliasesSingleResponse: description: DeleteNodesSingleQemuSingleFirewallAliasesSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleQemuSingleFirewallAliasesSingleResponse: description: GetNodesSingleQemuSingleFirewallAliasesSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" UpdateNodesSingleQemuSingleFirewallAliasesSingleResponse: description: UpdateNodesSingleQemuSingleFirewallAliasesSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetVMFirewallIPSetsResponse: description: GetVMFirewallIPSetsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: comment: type: string description: "" digest: type: string description: >- Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. name: type: string description: IP set name. CreateVMFirewallIPSetResponse: description: CreateVMFirewallIPSetResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteVMFirewallIPSetResponse: description: DeleteVMFirewallIPSetResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetVMFirewallIPSetResponse: description: GetVMFirewallIPSetResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: cidr: type: string description: "" comment: type: string description: "" digest: type: string description: >- Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. nomatch: type: int64 description: "" AddVMFirewallIPSetIPResponse: description: AddVMFirewallIPSetIPResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" RemoveVMFirewallIPSetIPResponse: description: RemoveVMFirewallIPSetIPResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetVMFirewallIPSetIPResponse: description: GetVMFirewallIPSetIPResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" UpdateVMFirewallIPSetIPResponse: description: UpdateVMFirewallIPSetIPResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetVMFirewallOptionsResponse: description: GetVMFirewallOptionsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: dhcp: type: int64 description: Enable DHCP. enable: type: int64 description: Enable/disable firewall rules. ipfilter: type: int64 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: int64 description: Enable/disable MAC address filter. ndp: type: int64 description: Enable NDP (Neighbor Discovery Protocol). policy_in: type: string description: Input policy. policy_out: type: string description: Output policy. radv: type: int64 description: Allow sending Router Advertisement. UpdateVMFirewallOptionsResponse: description: UpdateVMFirewallOptionsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleQemuSingleFirewallLogResponse: description: GetNodesSingleQemuSingleFirewallLogResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: "n": type: int64 description: Line number t: type: string description: Line text GetNodesSingleQemuSingleFirewallRefsResponse: description: GetNodesSingleQemuSingleFirewallRefsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: comment: type: string description: "" name: type: string description: "" ref: type: string description: "" scope: type: string description: "" type: type: string description: "" GetNodesSingleQemuSingleAgentResponse: description: GetNodesSingleQemuSingleAgentResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: Returns the list of QEMU Guest Agent commands items: type: object description: "" properties: {} CreateNodesSingleQemuSingleAgentResponse: description: CreateNodesSingleQemuSingleAgentResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Returns an object with a single `result` property. CreateNodesSingleQemuSingleAgentFsfreezefreezeResponse: description: CreateNodesSingleQemuSingleAgentFsfreezefreezeResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Returns an object with a single `result` property. CreateNodesSingleQemuSingleAgentFsfreezestatusResponse: description: CreateNodesSingleQemuSingleAgentFsfreezestatusResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Returns an object with a single `result` property. CreateNodesSingleQemuSingleAgentFsfreezethawResponse: description: CreateNodesSingleQemuSingleAgentFsfreezethawResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Returns an object with a single `result` property. CreateNodesSingleQemuSingleAgentFstrimResponse: description: CreateNodesSingleQemuSingleAgentFstrimResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Returns an object with a single `result` property. GetNodesSingleQemuSingleAgentGetfsinfoResponse: description: GetNodesSingleQemuSingleAgentGetfsinfoResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Returns an object with a single `result` property. GetNodesSingleQemuSingleAgentGethostnameResponse: description: GetNodesSingleQemuSingleAgentGethostnameResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Returns an object with a single `result` property. GetNodesSingleQemuSingleAgentGetmemoryblockinfoResponse: description: GetNodesSingleQemuSingleAgentGetmemoryblockinfoResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Returns an object with a single `result` property. GetNodesSingleQemuSingleAgentGetmemoryblocksResponse: description: GetNodesSingleQemuSingleAgentGetmemoryblocksResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Returns an object with a single `result` property. GetNodesSingleQemuSingleAgentGetosinfoResponse: description: GetNodesSingleQemuSingleAgentGetosinfoResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Returns an object with a single `result` property. GetNodesSingleQemuSingleAgentGettimeResponse: description: GetNodesSingleQemuSingleAgentGettimeResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Returns an object with a single `result` property. GetNodesSingleQemuSingleAgentGettimezoneResponse: description: GetNodesSingleQemuSingleAgentGettimezoneResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Returns an object with a single `result` property. GetNodesSingleQemuSingleAgentGetusersResponse: description: GetNodesSingleQemuSingleAgentGetusersResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Returns an object with a single `result` property. GetNodesSingleQemuSingleAgentGetvcpusResponse: description: GetNodesSingleQemuSingleAgentGetvcpusResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Returns an object with a single `result` property. GetNodesSingleQemuSingleAgentInfoResponse: description: GetNodesSingleQemuSingleAgentInfoResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Returns an object with a single `result` property. GetNodesSingleQemuSingleAgentNetworkgetinterfacesResponse: description: GetNodesSingleQemuSingleAgentNetworkgetinterfacesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Returns an object with a single `result` property. CreateNodesSingleQemuSingleAgentPingResponse: description: CreateNodesSingleQemuSingleAgentPingResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Returns an object with a single `result` property. CreateNodesSingleQemuSingleAgentShutdownResponse: description: CreateNodesSingleQemuSingleAgentShutdownResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Returns an object with a single `result` property. CreateNodesSingleQemuSingleAgentSuspenddiskResponse: description: CreateNodesSingleQemuSingleAgentSuspenddiskResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Returns an object with a single `result` property. CreateNodesSingleQemuSingleAgentSuspendhybridResponse: description: CreateNodesSingleQemuSingleAgentSuspendhybridResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Returns an object with a single `result` property. CreateNodesSingleQemuSingleAgentSuspendramResponse: description: CreateNodesSingleQemuSingleAgentSuspendramResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Returns an object with a single `result` property. CreateNodesSingleQemuSingleAgentSetuserpasswordResponse: description: CreateNodesSingleQemuSingleAgentSetuserpasswordResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Returns an object with a single `result` property. CreateNodesSingleQemuSingleAgentExecResponse: description: CreateNodesSingleQemuSingleAgentExecResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: pid: type: int64 description: The PID of the process started by the guest-agent. GetNodesSingleQemuSingleAgentExecstatusResponse: description: GetNodesSingleQemuSingleAgentExecstatusResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: err-data: type: string description: stderr of the process err-truncated: type: int64 description: true if stderr was not fully captured exitcode: type: int64 description: process exit code if it was normally terminated. exited: type: int64 description: Tells if the given command has exited yet. out-data: type: string description: stdout of the process out-truncated: type: int64 description: true if stdout was not fully captured signal: type: int64 description: >- signal number or exception code if the process was abnormally terminated. GetNodesSingleQemuSingleAgentFilereadResponse: description: GetNodesSingleQemuSingleAgentFilereadResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Returns an object with a `content` property. properties: content: type: string description: "The content of the file, maximum 16777216" truncated: type: int64 description: "If set to 1, the output is truncated and not complete" CreateNodesSingleQemuSingleAgentFilewriteResponse: description: CreateNodesSingleQemuSingleAgentFilewriteResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetVMRRDResponse: description: GetVMRRDResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: filename: type: string description: "" GetVMRRDDataResponse: description: GetVMRRDDataResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: {} GetVMConfigResponse: description: GetVMConfigResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: The VM configuration. properties: acpi: type: int64 description: Enable/disable ACPI. affinity: type: string description: >- List of host cores used to execute guest processes, for example: 0,5,8-11 agent: type: string description: >- Enable/disable communication with the QEMU Guest Agent and its properties. allow-ksm: type: int64 description: >- Allow memory pages of this guest to be merged via KSM (Kernel Samepage Merging). amd-sev: type: string description: Secure Encrypted Virtualization (SEV) features by AMD CPUs 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: int64 description: Automatic restart after crash (currently ignored). balloon: type: int64 description: >- Amount of target RAM for the VM in MiB. Using zero disables the ballon driver. bios: type: string description: Select BIOS implementation. boot: type: string description: >- Specify guest boot order. Use the 'order=' sub-property as 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. ciupgrade: type: int64 description: >- cloud-init: do an automatic package upgrade after the first boot. 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: int64 description: The number of cores per socket. cpu: type: string description: Emulated CPU type. cpulimit: type: number description: Limit of CPU usage. cpuunits: type: int64 description: >- CPU weight for a VM, will be clamped to [1, 10000] in cgroup v2. description: type: string description: >- Description for the VM. Shown in the web-interface VM's summary. 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: int64 description: >- Freeze CPU at startup (use 'c' monitor command to start execution). hookscript: type: string description: >- Script that will be executed during various steps in the vms lifetime. hostpci0: type: string description: Map host PCI devices into guest. hostpci1: type: string description: Map host PCI devices into guest. hostpci2: type: string description: Map host PCI devices into guest. hostpci3: type: string description: Map host PCI devices into guest. hostpci4: type: string description: Map host PCI devices into guest. hostpci5: type: string description: Map host PCI devices into guest. hostpci6: type: string description: Map host PCI devices into guest. hostpci7: type: string description: Map host PCI devices into guest. hostpci8: type: string description: Map host PCI devices into guest. hostpci9: type: string description: Map host PCI devices into guest. hostpci10: type: string description: Map host PCI devices into guest. hostpci11: type: string description: Map host PCI devices into guest. hostpci12: type: string description: Map host PCI devices into guest. hostpci13: type: string description: Map host PCI devices into guest. hostpci14: type: string description: Map host PCI devices into guest. hostpci15: type: string description: Map host PCI devices into guest. hostpci16: type: string description: Map host PCI devices into guest. hostpci17: type: string description: Map host PCI devices into guest. hostpci18: type: string description: Map host PCI devices into guest. hostpci19: type: string description: Map host PCI devices into guest. hostpci20: type: string description: Map host PCI devices into guest. hostpci21: type: string description: Map host PCI devices into guest. hostpci22: type: string description: Map host PCI devices into guest. hostpci23: type: string description: Map host PCI devices into guest. hostpci24: type: string description: Map host PCI devices into guest. hostpci25: type: string description: Map host PCI devices into guest. hostpci26: type: string description: Map host PCI devices into guest. hostpci27: type: string description: Map host PCI devices into guest. hostpci28: type: string description: Map host PCI devices into guest. hostpci29: type: string description: Map host PCI devices into guest. hotplug: type: string description: >- Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory', 'usb' and 'cloudinit'. Use '0' to disable hotplug completely. Using '1' as value is an alias for the default `network,disk,usb`. USB hotplugging is possible for guests with machine version >= 7.1 and ostype l26 or windows > 7. hugepages: type: string description: >- Enables hugepages memory. Sets the size of hugepages in MiB. If the value is set to 'any' then 1 GiB hugepages will be used if possible, otherwise the size will fall back to 2 MiB. ide0: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide1: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide2: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide3: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide4: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide5: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide6: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide7: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide8: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide9: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide10: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide11: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide12: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide13: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide14: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide15: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide16: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide17: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide18: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide19: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide20: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide21: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide22: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide23: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide24: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide25: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide26: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide27: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide28: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). ide29: type: string description: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). intel-tdx: type: string description: Trusted Domain Extension (TDX) features by Intel CPUs ipconfig0: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires cloud-init 19.4 or newer. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig1: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires cloud-init 19.4 or newer. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig2: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires cloud-init 19.4 or newer. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig3: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires cloud-init 19.4 or newer. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig4: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires cloud-init 19.4 or newer. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig5: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires cloud-init 19.4 or newer. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig6: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires cloud-init 19.4 or newer. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig7: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires cloud-init 19.4 or newer. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig8: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires cloud-init 19.4 or newer. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig9: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires cloud-init 19.4 or newer. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig10: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires cloud-init 19.4 or newer. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig11: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires cloud-init 19.4 or newer. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig12: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires cloud-init 19.4 or newer. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig13: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires cloud-init 19.4 or newer. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig14: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires cloud-init 19.4 or newer. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig15: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires cloud-init 19.4 or newer. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig16: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires cloud-init 19.4 or newer. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig17: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires cloud-init 19.4 or newer. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig18: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires cloud-init 19.4 or newer. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig19: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires cloud-init 19.4 or newer. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig20: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires cloud-init 19.4 or newer. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig21: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires cloud-init 19.4 or newer. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig22: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires cloud-init 19.4 or newer. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig23: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires cloud-init 19.4 or newer. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig24: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires cloud-init 19.4 or newer. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig25: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires cloud-init 19.4 or newer. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig26: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires cloud-init 19.4 or newer. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig27: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires cloud-init 19.4 or newer. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig28: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires cloud-init 19.4 or newer. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. ipconfig29: type: string description: > cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires cloud-init 19.4 or newer. 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: int64 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: >- Keyboard layout for VNC server. This option is generally not required and is often better handled from within the guest OS. kvm: type: int64 description: Enable/disable KVM hardware virtualization. localtime: type: int64 description: >- Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS. lock: type: string description: Lock/unlock the VM. machine: type: string description: Specify the QEMU machine. memory: type: string description: Memory properties. meta: type: string description: Some (read-only) meta-information about this guest. migrate_downtime: type: number description: >- Set maximum tolerated downtime (in seconds) for migrations. Should the migration not be able to converge in the very end, because too much newly dirtied RAM needs to be transferred, the limit will be increased automatically step-by-step until migration can converge. migrate_speed: type: int64 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 automatically use the setting from the host if neither searchdomain nor nameserver are set. net0: type: string description: Specify network devices. net1: type: string description: Specify network devices. net2: type: string description: Specify network devices. net3: type: string description: Specify network devices. net4: type: string description: Specify network devices. net5: type: string description: Specify network devices. net6: type: string description: Specify network devices. net7: type: string description: Specify network devices. net8: type: string description: Specify network devices. net9: type: string description: Specify network devices. net10: type: string description: Specify network devices. net11: type: string description: Specify network devices. net12: type: string description: Specify network devices. net13: type: string description: Specify network devices. net14: type: string description: Specify network devices. net15: type: string description: Specify network devices. net16: type: string description: Specify network devices. net17: type: string description: Specify network devices. net18: type: string description: Specify network devices. net19: type: string description: Specify network devices. net20: type: string description: Specify network devices. net21: type: string description: Specify network devices. net22: type: string description: Specify network devices. net23: type: string description: Specify network devices. net24: type: string description: Specify network devices. net25: type: string description: Specify network devices. net26: type: string description: Specify network devices. net27: type: string description: Specify network devices. net28: type: string description: Specify network devices. net29: type: string description: Specify network devices. numa: type: int64 description: Enable/disable NUMA. numa0: type: string description: NUMA topology. numa1: type: string description: NUMA topology. numa2: type: string description: NUMA topology. numa3: type: string description: NUMA topology. numa4: type: string description: NUMA topology. numa5: type: string description: NUMA topology. numa6: type: string description: NUMA topology. numa7: type: string description: NUMA topology. numa8: type: string description: NUMA topology. numa9: type: string description: NUMA topology. numa10: type: string description: NUMA topology. numa11: type: string description: NUMA topology. numa12: type: string description: NUMA topology. numa13: type: string description: NUMA topology. numa14: type: string description: NUMA topology. numa15: type: string description: NUMA topology. numa16: type: string description: NUMA topology. numa17: type: string description: NUMA topology. numa18: type: string description: NUMA topology. numa19: type: string description: NUMA topology. numa20: type: string description: NUMA topology. numa21: type: string description: NUMA topology. numa22: type: string description: NUMA topology. numa23: type: string description: NUMA topology. numa24: type: string description: NUMA topology. numa25: type: string description: NUMA topology. numa26: type: string description: NUMA topology. numa27: type: string description: NUMA topology. numa28: type: string description: NUMA topology. numa29: type: string description: NUMA topology. onboot: type: int64 description: >- Specifies whether a VM will be started during system bootup. ostype: type: string description: Specify guest operating system. parallel0: type: string description: Map host parallel devices (n is 0 to 2). parallel1: type: string description: Map host parallel devices (n is 0 to 2). parallel2: type: string description: Map host parallel devices (n is 0 to 2). parallel3: type: string description: Map host parallel devices (n is 0 to 2). parallel4: type: string description: Map host parallel devices (n is 0 to 2). parallel5: type: string description: Map host parallel devices (n is 0 to 2). parallel6: type: string description: Map host parallel devices (n is 0 to 2). parallel7: type: string description: Map host parallel devices (n is 0 to 2). parallel8: type: string description: Map host parallel devices (n is 0 to 2). parallel9: type: string description: Map host parallel devices (n is 0 to 2). parallel10: type: string description: Map host parallel devices (n is 0 to 2). parallel11: type: string description: Map host parallel devices (n is 0 to 2). parallel12: type: string description: Map host parallel devices (n is 0 to 2). parallel13: type: string description: Map host parallel devices (n is 0 to 2). parallel14: type: string description: Map host parallel devices (n is 0 to 2). parallel15: type: string description: Map host parallel devices (n is 0 to 2). parallel16: type: string description: Map host parallel devices (n is 0 to 2). parallel17: type: string description: Map host parallel devices (n is 0 to 2). parallel18: type: string description: Map host parallel devices (n is 0 to 2). parallel19: type: string description: Map host parallel devices (n is 0 to 2). parallel20: type: string description: Map host parallel devices (n is 0 to 2). parallel21: type: string description: Map host parallel devices (n is 0 to 2). parallel22: type: string description: Map host parallel devices (n is 0 to 2). parallel23: type: string description: Map host parallel devices (n is 0 to 2). parallel24: type: string description: Map host parallel devices (n is 0 to 2). parallel25: type: string description: Map host parallel devices (n is 0 to 2). parallel26: type: string description: Map host parallel devices (n is 0 to 2). parallel27: type: string description: Map host parallel devices (n is 0 to 2). parallel28: type: string description: Map host parallel devices (n is 0 to 2). parallel29: type: string description: Map host parallel devices (n is 0 to 2). parent: type: string description: >- Parent snapshot name. This is used internally, and should not be modified. protection: type: int64 description: >- Sets the protection flag of the VM. This will disable the remove VM and remove disk operations. reboot: type: int64 description: Allow reboot. If set to '0' the VM exit on reboot. rng0: type: string description: Configure a VirtIO-based Random Number Generator. running-nets-host-mtu: type: string description: >- List of VirtIO network devices and their effective host_mtu setting. A value of 0 means that the host_mtu parameter is to be avoided for the corresponding device. This is used internally for snapshots. runningcpu: type: string description: >- Specifies the QEMU '-cpu' parameter of the running vm. This is used internally for snapshots. runningmachine: type: string description: >- Specifies the QEMU machine type of the running vm. This is used internally for snapshots. sata0: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata1: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata2: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata3: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata4: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata5: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata6: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata7: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata8: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata9: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata10: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata11: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata12: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata13: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata14: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata15: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata16: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata17: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata18: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata19: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata20: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata21: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata22: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata23: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata24: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata25: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata26: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata27: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata28: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). sata29: type: string description: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). scsi0: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi1: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi2: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi3: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi4: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi5: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi6: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi7: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi8: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi9: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi10: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi11: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi12: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi13: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi14: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi15: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi16: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi17: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi18: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi19: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi20: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi21: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi22: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi23: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi24: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi25: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi26: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi27: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi28: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsi29: type: string description: Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). scsihw: type: string description: SCSI controller model searchdomain: type: string description: >- cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set. serial0: type: string description: Create a serial device inside the VM (n is 0 to 3) serial1: type: string description: Create a serial device inside the VM (n is 0 to 3) serial2: type: string description: Create a serial device inside the VM (n is 0 to 3) serial3: type: string description: Create a serial device inside the VM (n is 0 to 3) serial4: type: string description: Create a serial device inside the VM (n is 0 to 3) serial5: type: string description: Create a serial device inside the VM (n is 0 to 3) serial6: type: string description: Create a serial device inside the VM (n is 0 to 3) serial7: type: string description: Create a serial device inside the VM (n is 0 to 3) serial8: type: string description: Create a serial device inside the VM (n is 0 to 3) serial9: type: string description: Create a serial device inside the VM (n is 0 to 3) serial10: type: string description: Create a serial device inside the VM (n is 0 to 3) serial11: type: string description: Create a serial device inside the VM (n is 0 to 3) serial12: type: string description: Create a serial device inside the VM (n is 0 to 3) serial13: type: string description: Create a serial device inside the VM (n is 0 to 3) serial14: type: string description: Create a serial device inside the VM (n is 0 to 3) serial15: type: string description: Create a serial device inside the VM (n is 0 to 3) serial16: type: string description: Create a serial device inside the VM (n is 0 to 3) serial17: type: string description: Create a serial device inside the VM (n is 0 to 3) serial18: type: string description: Create a serial device inside the VM (n is 0 to 3) serial19: type: string description: Create a serial device inside the VM (n is 0 to 3) serial20: type: string description: Create a serial device inside the VM (n is 0 to 3) serial21: type: string description: Create a serial device inside the VM (n is 0 to 3) serial22: type: string description: Create a serial device inside the VM (n is 0 to 3) serial23: type: string description: Create a serial device inside the VM (n is 0 to 3) serial24: type: string description: Create a serial device inside the VM (n is 0 to 3) serial25: type: string description: Create a serial device inside the VM (n is 0 to 3) serial26: type: string description: Create a serial device inside the VM (n is 0 to 3) serial27: type: string description: Create a serial device inside the VM (n is 0 to 3) serial28: type: string description: Create a serial device inside the VM (n is 0 to 3) serial29: type: string description: Create a serial device inside the VM (n is 0 to 3) shares: type: int64 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: int64 description: The number of CPUs. Please use option -sockets instead. snaptime: type: int64 description: Timestamp for snapshots. sockets: type: int64 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: int64 description: Enable/disable the USB tablet device. tags: type: string description: Tags of the VM. This is only meta information. tdf: type: int64 description: Enable/disable time drift fix. template: type: int64 description: Enable/disable Template. tpmstate0: type: string description: >- Configure a Disk for storing TPM state. The format is fixed to 'raw'. unused0: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused1: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused2: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused3: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused4: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused5: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused6: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused7: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused8: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused9: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused10: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused11: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused12: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused13: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused14: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused15: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused16: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused17: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused18: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused19: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused20: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused21: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused22: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused23: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused24: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused25: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused26: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused27: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused28: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused29: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. usb0: type: string description: >- Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). usb1: type: string description: >- Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). usb2: type: string description: >- Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). usb3: type: string description: >- Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). usb4: type: string description: >- Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). usb5: type: string description: >- Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). usb6: type: string description: >- Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). usb7: type: string description: >- Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). usb8: type: string description: >- Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). usb9: type: string description: >- Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). usb10: type: string description: >- Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). usb11: type: string description: >- Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). usb12: type: string description: >- Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). usb13: type: string description: >- Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). usb14: type: string description: >- Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). usb15: type: string description: >- Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). usb16: type: string description: >- Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). usb17: type: string description: >- Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). usb18: type: string description: >- Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). usb19: type: string description: >- Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). usb20: type: string description: >- Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). usb21: type: string description: >- Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). usb22: type: string description: >- Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). usb23: type: string description: >- Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). usb24: type: string description: >- Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). usb25: type: string description: >- Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). usb26: type: string description: >- Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). usb27: type: string description: >- Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). usb28: type: string description: >- Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). usb29: type: string description: >- Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). vcpus: type: int64 description: Number of hotplugged vcpus. vga: type: string description: Configure the VGA hardware. virtio0: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio1: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio2: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio3: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio4: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio5: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio6: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio7: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio8: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio9: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio10: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio11: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio12: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio13: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio14: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio15: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio16: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio17: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio18: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio19: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio20: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio21: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio22: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio23: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio24: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio25: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio26: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio27: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio28: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtio29: type: string description: Use volume as VIRTIO hard disk (n is 0 to 15). virtiofs0: type: string description: >- Configuration for sharing a directory between host and guest using Virtio-fs. virtiofs1: type: string description: >- Configuration for sharing a directory between host and guest using Virtio-fs. virtiofs2: type: string description: >- Configuration for sharing a directory between host and guest using Virtio-fs. virtiofs3: type: string description: >- Configuration for sharing a directory between host and guest using Virtio-fs. virtiofs4: type: string description: >- Configuration for sharing a directory between host and guest using Virtio-fs. virtiofs5: type: string description: >- Configuration for sharing a directory between host and guest using Virtio-fs. virtiofs6: type: string description: >- Configuration for sharing a directory between host and guest using Virtio-fs. virtiofs7: type: string description: >- Configuration for sharing a directory between host and guest using Virtio-fs. virtiofs8: type: string description: >- Configuration for sharing a directory between host and guest using Virtio-fs. virtiofs9: type: string description: >- Configuration for sharing a directory between host and guest using Virtio-fs. virtiofs10: type: string description: >- Configuration for sharing a directory between host and guest using Virtio-fs. virtiofs11: type: string description: >- Configuration for sharing a directory between host and guest using Virtio-fs. virtiofs12: type: string description: >- Configuration for sharing a directory between host and guest using Virtio-fs. virtiofs13: type: string description: >- Configuration for sharing a directory between host and guest using Virtio-fs. virtiofs14: type: string description: >- Configuration for sharing a directory between host and guest using Virtio-fs. virtiofs15: type: string description: >- Configuration for sharing a directory between host and guest using Virtio-fs. virtiofs16: type: string description: >- Configuration for sharing a directory between host and guest using Virtio-fs. virtiofs17: type: string description: >- Configuration for sharing a directory between host and guest using Virtio-fs. virtiofs18: type: string description: >- Configuration for sharing a directory between host and guest using Virtio-fs. virtiofs19: type: string description: >- Configuration for sharing a directory between host and guest using Virtio-fs. virtiofs20: type: string description: >- Configuration for sharing a directory between host and guest using Virtio-fs. virtiofs21: type: string description: >- Configuration for sharing a directory between host and guest using Virtio-fs. virtiofs22: type: string description: >- Configuration for sharing a directory between host and guest using Virtio-fs. virtiofs23: type: string description: >- Configuration for sharing a directory between host and guest using Virtio-fs. virtiofs24: type: string description: >- Configuration for sharing a directory between host and guest using Virtio-fs. virtiofs25: type: string description: >- Configuration for sharing a directory between host and guest using Virtio-fs. virtiofs26: type: string description: >- Configuration for sharing a directory between host and guest using Virtio-fs. virtiofs27: type: string description: >- Configuration for sharing a directory between host and guest using Virtio-fs. virtiofs28: type: string description: >- Configuration for sharing a directory between host and guest using Virtio-fs. virtiofs29: type: string description: >- Configuration for sharing a directory between host and guest using Virtio-fs. vmgenid: type: string description: >- Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly. vmstate: type: string description: >- Reference to a volume which stores the VM state. This is used internally for snapshots. vmstatestorage: type: string description: Default storage for VM state volumes/files. watchdog: type: string description: Create a virtual hardware watchdog device. UpdateVMConfigResponse: description: UpdateVMConfigResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" UpdateVMConfigSyncResponse: description: UpdateVMConfigSyncResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetVMConfigPendingResponse: description: GetVMConfigPendingResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: delete: type: int64 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. GetNodesSingleQemuSingleCloudinitResponse: description: GetNodesSingleQemuSingleCloudinitResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: delete: type: int64 description: >- Indicates a pending delete request if present and not 0. key: type: string description: Configuration option name. pending: type: string description: The new pending value. value: type: string description: >- Value as it was used to generate the current cloudinit image. UpdateNodesSingleQemuSingleCloudinitResponse: description: UpdateNodesSingleQemuSingleCloudinitResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleQemuSingleCloudinitDumpResponse: description: GetNodesSingleQemuSingleCloudinitDumpResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" UnlinkVMDiskImagesResponse: description: UnlinkVMDiskImagesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" CreateNodesSingleQemuSingleVncproxyResponse: description: CreateNodesSingleQemuSingleVncproxyResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" CreateNodesSingleQemuSingleTermproxyResponse: description: CreateNodesSingleQemuSingleTermproxyResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleQemuSingleVncwebsocketResponse: description: GetNodesSingleQemuSingleVncwebsocketResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: port: type: string description: "" CreateNodesSingleQemuSingleSpiceproxyResponse: description: CreateNodesSingleQemuSingleSpiceproxyResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: >- Returned values can be directly passed to the 'remote-viewer' application. GetVMStatusResponse: description: GetVMStatusResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: subdir: type: string description: "" GetCurrentVMStatusResponse: description: GetCurrentVMStatusResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: agent: type: int64 description: QEMU Guest Agent is enabled in config. clipboard: type: string description: >- Enable a specific clipboard. If not set, depending on the display type the SPICE one will be added. cpu: type: number description: Current CPU usage. cpus: type: number description: Maximum usable CPUs. diskread: type: int64 description: >- The amount of bytes the guest read from it's block devices since the guest was started. (Note: This info is not available for all storage types.) diskwrite: type: int64 description: >- The amount of bytes the guest wrote from it's block devices since the guest was started. (Note: This info is not available for all storage types.) ha: type: object description: HA manager service status. lock: type: string description: "The current config lock, if any." maxdisk: type: int64 description: Root disk size in bytes. maxmem: type: int64 description: Maximum memory in bytes. mem: type: int64 description: Currently used memory in bytes. memhost: type: int64 description: Current memory usage on the host. name: type: string description: VM (host)name. netin: type: int64 description: >- The amount of traffic in bytes that was sent to the guest over the network since it was started. netout: type: int64 description: >- The amount of traffic in bytes that was sent from the guest over the network since it was started. pid: type: int64 description: "PID of the QEMU process, if the VM is running." pressurecpufull: type: number description: CPU Full pressure stall average over the last 10 seconds. pressurecpusome: type: number description: CPU Some pressure stall average over the last 10 seconds. pressureiofull: type: number description: IO Full pressure stall average over the last 10 seconds. pressureiosome: type: number description: IO Some pressure stall average over the last 10 seconds. pressurememoryfull: type: number description: >- Memory Full pressure stall average over the last 10 seconds. pressurememorysome: type: number description: >- Memory Some pressure stall average over the last 10 seconds. qmpstatus: type: string description: VM run state from the 'query-status' QMP monitor command. running-machine: type: string description: The currently running machine type (if running). running-qemu: type: string description: The QEMU version the VM is currently using (if running). serial: type: int64 description: Guest has serial device configured. spice: type: int64 description: QEMU VGA configuration supports spice. status: type: string description: QEMU process status. tags: type: string description: "The current configured tags, if any" template: type: int64 description: Determines if the guest is a template. uptime: type: int64 description: Uptime in seconds. vmid: type: int64 description: The (unique) ID of the VM. StartVMResponse: description: StartVMResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" StopVMResponse: description: StopVMResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" ResetVMResponse: description: ResetVMResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" ShutdownVMResponse: description: ShutdownVMResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" RebootVMResponse: description: RebootVMResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" SuspendVMResponse: description: SuspendVMResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" ResumeVMResponse: description: ResumeVMResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" UpdateNodesSingleQemuSingleSendkeyResponse: description: UpdateNodesSingleQemuSingleSendkeyResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleQemuSingleFeatureResponse: description: GetNodesSingleQemuSingleFeatureResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: hasFeature: type: int64 description: "" nodes: type: array description: "" items: type: string description: "" CloneVMResponse: description: CloneVMResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" CreateNodesSingleQemuSingleMovediskResponse: description: CreateNodesSingleQemuSingleMovediskResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: the task ID. MigrateVMResponse: description: MigrateVMResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: allowed_nodes: type: array description: List of nodes allowed for migration. items: type: string description: An allowed node dependent-ha-resources: type: array description: >- HA resources, which will be migrated to the same target node as the VM, because these are in positive affinity with the VM. items: type: string description: >- The ':' resource IDs of a HA resource with a positive affinity rule to this VM. has-dbus-vmstate: type: int64 description: >- Whether the VM host supports migrating additional VM state, such as conntrack entries. local_disks: type: array description: >- List local disks including CD-Rom, unused and not referenced disks items: type: object description: "" properties: cdrom: type: int64 description: True if the disk is a cdrom. is_unused: type: int64 description: True if the disk is unused. size: type: int64 description: The size of the disk in bytes. volid: type: string description: The volid of the disk. local_resources: type: array description: "List local resources (e.g. pci, usb) that block migration." items: type: string description: A local resource mapped-resource-info: type: object description: >- Object of mapped resources with additional information such if they're live migratable. mapped-resources: type: array description: >- List of mapped resources e.g. pci, usb. Deprecated, use 'mapped-resource-info' instead. items: type: string description: A mapped resource not_allowed_nodes: type: object description: List of not allowed nodes with additional information. properties: blocking-ha-resources: type: array description: >- HA resources, which are blocking the VM from being migrated to the node. items: type: object description: A blocking HA resource properties: cause: type: string description: >- The reason why the HA resource is blocking the migration. sid: type: string description: The blocking HA resource id unavailable_storages: type: array description: A list of not available storages. items: type: string description: A storage running: type: int64 description: Determines if the VM is running. CreateNodesSingleQemuSingleMigrateResponse: description: CreateNodesSingleQemuSingleMigrateResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: the task ID. CreateNodesSingleQemuSingleRemotemigrateResponse: description: CreateNodesSingleQemuSingleRemotemigrateResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: the task ID. CreateNodesSingleQemuSingleMonitorResponse: description: CreateNodesSingleQemuSingleMonitorResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" ResizeVMDiskResponse: description: ResizeVMDiskResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: the task ID. GetVMSnapshotsResponse: description: GetVMSnapshotsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: description: type: string description: Snapshot description. name: type: string description: >- Snapshot identifier. Value 'current' identifies the current VM. parent: type: string description: Parent snapshot identifier. snaptime: type: int64 description: Snapshot creation time vmstate: type: int64 description: Snapshot includes RAM. CreateVMSnapshotResponse: description: CreateVMSnapshotResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: the task ID. DeleteVMSnapshotResponse: description: DeleteVMSnapshotResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: the task ID. GetVMSnapshotResponse: description: GetVMSnapshotResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: {} GetVMSnapshotConfigResponse: description: GetVMSnapshotConfigResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" UpdateVMSnapshotConfigResponse: description: UpdateVMSnapshotConfigResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" RollbackVMSnapshotResponse: description: RollbackVMSnapshotResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: the task ID. CreateNodesSingleQemuSingleTemplateResponse: description: CreateNodesSingleQemuSingleTemplateResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: the task ID. CreateNodesSingleQemuSingleMtunnelResponse: description: CreateNodesSingleQemuSingleMtunnelResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleQemuSingleMtunnelwebsocketResponse: description: GetNodesSingleQemuSingleMtunnelwebsocketResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: port: type: string description: "" socket: type: string description: "" CreateNodesSingleQemuSingleDbusvmstateResponse: description: CreateNodesSingleQemuSingleDbusvmstateResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleLxcResponse: description: GetNodesSingleLxcResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: cpu: type: number description: Current CPU usage. cpus: type: number description: Maximum usable CPUs. disk: type: int64 description: Root disk image space-usage in bytes. diskread: type: int64 description: >- The amount of bytes the guest read from it's block devices since the guest was started. (Note: This info is not available for all storage types.) diskwrite: type: int64 description: >- The amount of bytes the guest wrote from it's block devices since the guest was started. (Note: This info is not available for all storage types.) lock: type: string description: "The current config lock, if any." maxdisk: type: int64 description: Root disk image size in bytes. maxmem: type: int64 description: Maximum memory in bytes. maxswap: type: int64 description: Maximum SWAP memory in bytes. mem: type: int64 description: Currently used memory in bytes. name: type: string description: Container name. netin: type: int64 description: >- The amount of traffic in bytes that was sent to the guest over the network since it was started. netout: type: int64 description: >- The amount of traffic in bytes that was sent from the guest over the network since it was started. pressurecpusome: type: number description: >- CPU Some pressure stall average over the last 10 seconds. pressureiofull: type: number description: IO Full pressure stall average over the last 10 seconds. pressureiosome: type: number description: IO Some pressure stall average over the last 10 seconds. pressurememoryfull: type: number description: >- Memory Full pressure stall average over the last 10 seconds. pressurememorysome: type: number description: >- Memory Some pressure stall average over the last 10 seconds. status: type: string description: LXC Container status. tags: type: string description: "The current configured tags, if any." template: type: int64 description: Determines if the guest is a template. uptime: type: int64 description: Uptime in seconds. vmid: type: int64 description: The (unique) ID of the VM. CreateNodesSingleLxcResponse: description: CreateNodesSingleLxcResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteNodesSingleLxcSingleResponse: description: DeleteNodesSingleLxcSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleLxcSingleResponse: description: GetNodesSingleLxcSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: subdir: type: string description: "" GetNodesSingleLxcSingleConfigResponse: description: GetNodesSingleLxcSingleConfigResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: arch: type: string description: OS architecture type. cmode: type: string description: >- Console mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login). console: type: int64 description: Attach a console device (/dev/console) to the container. cores: type: int64 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: int64 description: >- CPU weight for a container, will be clamped to [1, 10000] in cgroup v2. debug: type: int64 description: >- Try to be more verbose. For now this only enables debug log-level on start. description: type: string description: >- Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file. dev0: type: string description: Device to pass through to the container dev1: type: string description: Device to pass through to the container dev2: type: string description: Device to pass through to the container dev3: type: string description: Device to pass through to the container dev4: type: string description: Device to pass through to the container dev5: type: string description: Device to pass through to the container dev6: type: string description: Device to pass through to the container dev7: type: string description: Device to pass through to the container dev8: type: string description: Device to pass through to the container dev9: type: string description: Device to pass through to the container dev10: type: string description: Device to pass through to the container dev11: type: string description: Device to pass through to the container dev12: type: string description: Device to pass through to the container dev13: type: string description: Device to pass through to the container dev14: type: string description: Device to pass through to the container dev15: type: string description: Device to pass through to the container dev16: type: string description: Device to pass through to the container dev17: type: string description: Device to pass through to the container dev18: type: string description: Device to pass through to the container dev19: type: string description: Device to pass through to the container dev20: type: string description: Device to pass through to the container dev21: type: string description: Device to pass through to the container dev22: type: string description: Device to pass through to the container dev23: type: string description: Device to pass through to the container dev24: type: string description: Device to pass through to the container dev25: type: string description: Device to pass through to the container dev26: type: string description: Device to pass through to the container dev27: type: string description: Device to pass through to the container dev28: type: string description: Device to pass through to the container dev29: type: string description: Device to pass through to the container digest: type: string description: >- SHA1 digest of configuration file. This can be used to prevent concurrent modifications. entrypoint: type: string description: >- Command to run as init, optionally with arguments; may start with an absolute path, relative path, or a binary in $PATH. env: type: string description: >- The container runtime environment as NUL-separated list. Replaces any lxc.environment.runtime entries in the config. features: type: string description: Allow containers access to advanced features. hookscript: type: string description: >- Script that will be executed 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 container. lxc: type: array description: >- Array of lxc low-level configurations ([[key1, value1], [key2, value2] ...]). items: type: array description: "" items: type: string description: "" memory: type: int64 description: Amount of RAM for the container in MB. mp0: type: string description: >- Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. mp1: type: string description: >- Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. mp2: type: string description: >- Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. mp3: type: string description: >- Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. mp4: type: string description: >- Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. mp5: type: string description: >- Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. mp6: type: string description: >- Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. mp7: type: string description: >- Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. mp8: type: string description: >- Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. mp9: type: string description: >- Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. mp10: type: string description: >- Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. mp11: type: string description: >- Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. mp12: type: string description: >- Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. mp13: type: string description: >- Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. mp14: type: string description: >- Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. mp15: type: string description: >- Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. mp16: type: string description: >- Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. mp17: type: string description: >- Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. mp18: type: string description: >- Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. mp19: type: string description: >- Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. mp20: type: string description: >- Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. mp21: type: string description: >- Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. mp22: type: string description: >- Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. mp23: type: string description: >- Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. mp24: type: string description: >- Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. mp25: type: string description: >- Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. mp26: type: string description: >- Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. mp27: type: string description: >- Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. mp28: type: string description: >- Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. mp29: type: string description: >- Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. nameserver: type: string description: >- Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver. net0: type: string description: Specifies network interfaces for the container. net1: type: string description: Specifies network interfaces for the container. net2: type: string description: Specifies network interfaces for the container. net3: type: string description: Specifies network interfaces for the container. net4: type: string description: Specifies network interfaces for the container. net5: type: string description: Specifies network interfaces for the container. net6: type: string description: Specifies network interfaces for the container. net7: type: string description: Specifies network interfaces for the container. net8: type: string description: Specifies network interfaces for the container. net9: type: string description: Specifies network interfaces for the container. net10: type: string description: Specifies network interfaces for the container. net11: type: string description: Specifies network interfaces for the container. net12: type: string description: Specifies network interfaces for the container. net13: type: string description: Specifies network interfaces for the container. net14: type: string description: Specifies network interfaces for the container. net15: type: string description: Specifies network interfaces for the container. net16: type: string description: Specifies network interfaces for the container. net17: type: string description: Specifies network interfaces for the container. net18: type: string description: Specifies network interfaces for the container. net19: type: string description: Specifies network interfaces for the container. net20: type: string description: Specifies network interfaces for the container. net21: type: string description: Specifies network interfaces for the container. net22: type: string description: Specifies network interfaces for the container. net23: type: string description: Specifies network interfaces for the container. net24: type: string description: Specifies network interfaces for the container. net25: type: string description: Specifies network interfaces for the container. net26: type: string description: Specifies network interfaces for the container. net27: type: string description: Specifies network interfaces for the container. net28: type: string description: Specifies network interfaces for the container. net29: type: string description: Specifies network interfaces for the container. onboot: type: int64 description: >- Specifies whether a container 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: int64 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: int64 description: Amount of SWAP for the container in MB. tags: type: string description: Tags of the Container. This is only meta information. template: type: int64 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: int64 description: Specify the number of tty available to the container unprivileged: type: int64 description: >- Makes the container run as unprivileged user. For creation, the default is 1. For restore, the default is the value from the backup. (Should not be modified manually.) unused0: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused1: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused2: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused3: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused4: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused5: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused6: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused7: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused8: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused9: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused10: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused11: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused12: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused13: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused14: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused15: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused16: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused17: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused18: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused19: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused20: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused21: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused22: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused23: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused24: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused25: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused26: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused27: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused28: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. unused29: type: string description: >- Reference to unused volumes. This is used internally, and should not be modified manually. UpdateNodesSingleLxcSingleConfigResponse: description: UpdateNodesSingleLxcSingleConfigResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleLxcSingleStatusResponse: description: GetNodesSingleLxcSingleStatusResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: subdir: type: string description: "" GetNodesSingleLxcSingleStatusCurrentResponse: description: GetNodesSingleLxcSingleStatusCurrentResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: cpu: type: number description: Current CPU usage. cpus: type: number description: Maximum usable CPUs. disk: type: int64 description: Root disk image space-usage in bytes. diskread: type: int64 description: >- The amount of bytes the guest read from it's block devices since the guest was started. (Note: This info is not available for all storage types.) diskwrite: type: int64 description: >- The amount of bytes the guest wrote from it's block devices since the guest was started. (Note: This info is not available for all storage types.) ha: type: object description: HA manager service status. lock: type: string description: "The current config lock, if any." maxdisk: type: int64 description: Root disk image size in bytes. maxmem: type: int64 description: Maximum memory in bytes. maxswap: type: int64 description: Maximum SWAP memory in bytes. mem: type: int64 description: Currently used memory in bytes. name: type: string description: Container name. netin: type: int64 description: >- The amount of traffic in bytes that was sent to the guest over the network since it was started. netout: type: int64 description: >- The amount of traffic in bytes that was sent from the guest over the network since it was started. pressurecpusome: type: number description: CPU Some pressure stall average over the last 10 seconds. pressureiofull: type: number description: IO Full pressure stall average over the last 10 seconds. pressureiosome: type: number description: IO Some pressure stall average over the last 10 seconds. pressurememoryfull: type: number description: >- Memory Full pressure stall average over the last 10 seconds. pressurememorysome: type: number description: >- Memory Some pressure stall average over the last 10 seconds. status: type: string description: LXC Container status. tags: type: string description: "The current configured tags, if any." template: type: int64 description: Determines if the guest is a template. uptime: type: int64 description: Uptime in seconds. vmid: type: int64 description: The (unique) ID of the VM. CreateNodesSingleLxcSingleStatusStartResponse: description: CreateNodesSingleLxcSingleStatusStartResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" CreateNodesSingleLxcSingleStatusStopResponse: description: CreateNodesSingleLxcSingleStatusStopResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" CreateNodesSingleLxcSingleStatusShutdownResponse: description: CreateNodesSingleLxcSingleStatusShutdownResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" CreateNodesSingleLxcSingleStatusSuspendResponse: description: CreateNodesSingleLxcSingleStatusSuspendResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" CreateNodesSingleLxcSingleStatusResumeResponse: description: CreateNodesSingleLxcSingleStatusResumeResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" CreateNodesSingleLxcSingleStatusRebootResponse: description: CreateNodesSingleLxcSingleStatusRebootResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleLxcSingleSnapshotResponse: description: GetNodesSingleLxcSingleSnapshotResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: description: type: string description: Snapshot description. name: type: string description: >- Snapshot identifier. Value 'current' identifies the current VM. parent: type: string description: Parent snapshot identifier. snaptime: type: int64 description: Snapshot creation time CreateNodesSingleLxcSingleSnapshotResponse: description: CreateNodesSingleLxcSingleSnapshotResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: the task ID. DeleteNodesSingleLxcSingleSnapshotSingleResponse: description: DeleteNodesSingleLxcSingleSnapshotSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: the task ID. GetNodesSingleLxcSingleSnapshotSingleResponse: description: GetNodesSingleLxcSingleSnapshotSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: {} CreateNodesSingleLxcSingleSnapshotSingleRollbackResponse: description: CreateNodesSingleLxcSingleSnapshotSingleRollbackResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: the task ID. GetNodesSingleLxcSingleSnapshotSingleConfigResponse: description: GetNodesSingleLxcSingleSnapshotSingleConfigResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" UpdateNodesSingleLxcSingleSnapshotSingleConfigResponse: description: UpdateNodesSingleLxcSingleSnapshotSingleConfigResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleLxcSingleFirewallResponse: description: GetNodesSingleLxcSingleFirewallResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: {} GetNodesSingleLxcSingleFirewallRulesResponse: description: GetNodesSingleLxcSingleFirewallRulesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: action: type: string description: >- Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name comment: type: string description: Descriptive comment dest: type: string description: Restrict packet destination address dport: type: string description: Restrict TCP/UDP destination port enable: type: int64 description: Flag to enable/disable a rule icmp-type: type: string description: >- Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp' iface: type: string description: >- Network interface name. You have to use network configuration key names for VMs and containers ipversion: type: int64 description: >- IP version (4 or 6) - automatically determined from source/dest addresses log: type: string description: Log level for firewall rule macro: type: string description: Use predefined standard macro pos: type: int64 description: Rule position in the ruleset proto: type: string description: >- IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols' source: type: string description: Restrict packet source address sport: type: string description: Restrict TCP/UDP source port type: type: string description: Rule type CreateNodesSingleLxcSingleFirewallRulesResponse: description: CreateNodesSingleLxcSingleFirewallRulesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteNodesSingleLxcSingleFirewallRulesSingleResponse: description: DeleteNodesSingleLxcSingleFirewallRulesSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleLxcSingleFirewallRulesSingleResponse: description: GetNodesSingleLxcSingleFirewallRulesSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: action: type: string description: >- Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name comment: type: string description: Descriptive comment dest: type: string description: Restrict packet destination address dport: type: string description: Restrict TCP/UDP destination port enable: type: int64 description: Flag to enable/disable a rule icmp-type: type: string description: >- Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp' iface: type: string description: >- Network interface name. You have to use network configuration key names for VMs and containers ipversion: type: int64 description: >- IP version (4 or 6) - automatically determined from source/dest addresses log: type: string description: Log level for firewall rule macro: type: string description: Use predefined standard macro pos: type: int64 description: Rule position in the ruleset proto: type: string description: >- IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols' source: type: string description: Restrict packet source address sport: type: string description: Restrict TCP/UDP source port type: type: string description: Rule type UpdateNodesSingleLxcSingleFirewallRulesSingleResponse: description: UpdateNodesSingleLxcSingleFirewallRulesSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleLxcSingleFirewallAliasesResponse: description: GetNodesSingleLxcSingleFirewallAliasesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: cidr: type: string description: "" comment: type: string description: "" digest: type: string description: >- Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. name: type: string description: "" CreateNodesSingleLxcSingleFirewallAliasesResponse: description: CreateNodesSingleLxcSingleFirewallAliasesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteNodesSingleLxcSingleFirewallAliasesSingleResponse: description: DeleteNodesSingleLxcSingleFirewallAliasesSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleLxcSingleFirewallAliasesSingleResponse: description: GetNodesSingleLxcSingleFirewallAliasesSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" UpdateNodesSingleLxcSingleFirewallAliasesSingleResponse: description: UpdateNodesSingleLxcSingleFirewallAliasesSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleLxcSingleFirewallIpsetResponse: description: GetNodesSingleLxcSingleFirewallIpsetResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: comment: type: string description: "" digest: type: string description: >- Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. name: type: string description: IP set name. CreateNodesSingleLxcSingleFirewallIpsetResponse: description: CreateNodesSingleLxcSingleFirewallIpsetResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteNodesSingleLxcSingleFirewallIpsetSingleResponse: description: DeleteNodesSingleLxcSingleFirewallIpsetSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleLxcSingleFirewallIpsetSingleResponse: description: GetNodesSingleLxcSingleFirewallIpsetSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: cidr: type: string description: "" comment: type: string description: "" digest: type: string description: >- Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. nomatch: type: int64 description: "" CreateNodesSingleLxcSingleFirewallIpsetSingleResponse: description: CreateNodesSingleLxcSingleFirewallIpsetSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteNodesSingleLxcSingleFirewallIpsetSingleSingleResponse: description: DeleteNodesSingleLxcSingleFirewallIpsetSingleSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleLxcSingleFirewallIpsetSingleSingleResponse: description: GetNodesSingleLxcSingleFirewallIpsetSingleSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" UpdateNodesSingleLxcSingleFirewallIpsetSingleSingleResponse: description: UpdateNodesSingleLxcSingleFirewallIpsetSingleSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleLxcSingleFirewallOptionsResponse: description: GetNodesSingleLxcSingleFirewallOptionsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: dhcp: type: int64 description: Enable DHCP. enable: type: int64 description: Enable/disable firewall rules. ipfilter: type: int64 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: int64 description: Enable/disable MAC address filter. ndp: type: int64 description: Enable NDP (Neighbor Discovery Protocol). policy_in: type: string description: Input policy. policy_out: type: string description: Output policy. radv: type: int64 description: Allow sending Router Advertisement. UpdateNodesSingleLxcSingleFirewallOptionsResponse: description: UpdateNodesSingleLxcSingleFirewallOptionsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleLxcSingleFirewallLogResponse: description: GetNodesSingleLxcSingleFirewallLogResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: "n": type: int64 description: Line number t: type: string description: Line text GetNodesSingleLxcSingleFirewallRefsResponse: description: GetNodesSingleLxcSingleFirewallRefsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: comment: type: string description: "" name: type: string description: "" ref: type: string description: "" scope: type: string description: "" type: type: string description: "" GetNodesSingleLxcSingleRrdResponse: description: GetNodesSingleLxcSingleRrdResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: filename: type: string description: "" GetNodesSingleLxcSingleRrddataResponse: description: GetNodesSingleLxcSingleRrddataResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: {} CreateNodesSingleLxcSingleVncproxyResponse: description: CreateNodesSingleLxcSingleVncproxyResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" CreateNodesSingleLxcSingleTermproxyResponse: description: CreateNodesSingleLxcSingleTermproxyResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleLxcSingleVncwebsocketResponse: description: GetNodesSingleLxcSingleVncwebsocketResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: port: type: string description: "" CreateNodesSingleLxcSingleSpiceproxyResponse: description: CreateNodesSingleLxcSingleSpiceproxyResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: >- Returned values can be directly passed to the 'remote-viewer' application. CreateNodesSingleLxcSingleRemotemigrateResponse: description: CreateNodesSingleLxcSingleRemotemigrateResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: the task ID. GetNodesSingleLxcSingleMigrateResponse: description: GetNodesSingleLxcSingleMigrateResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: allowed-nodes: type: array description: List of nodes allowed for migration. items: type: string description: An allowed node dependent-ha-resources: type: array description: >- HA resources, which will be migrated to the same target node as the VM, because these are in positive affinity with the VM. items: type: string description: >- The ':' resource IDs of a HA resource with a positive affinity rule to this CT. not-allowed-nodes: type: object description: List of not allowed nodes with additional information. properties: blocking-ha-resources: type: array description: >- HA resources, which are blocking the container from being migrated to the node. items: type: object description: A blocking HA resource properties: cause: type: string description: >- The reason why the HA resource is blocking the migration. sid: type: string description: The blocking HA resource id running: type: int64 description: Determines if the container is running. CreateNodesSingleLxcSingleMigrateResponse: description: CreateNodesSingleLxcSingleMigrateResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: the task ID. GetNodesSingleLxcSingleFeatureResponse: description: GetNodesSingleLxcSingleFeatureResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: hasFeature: type: int64 description: "" CreateNodesSingleLxcSingleTemplateResponse: description: CreateNodesSingleLxcSingleTemplateResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" CreateNodesSingleLxcSingleCloneResponse: description: CreateNodesSingleLxcSingleCloneResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" UpdateNodesSingleLxcSingleResizeResponse: description: UpdateNodesSingleLxcSingleResizeResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: the task ID. CreateNodesSingleLxcSingleMovevolumeResponse: description: CreateNodesSingleLxcSingleMovevolumeResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleLxcSinglePendingResponse: description: GetNodesSingleLxcSinglePendingResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: delete: type: int64 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. GetNodesSingleLxcSingleInterfacesResponse: description: GetNodesSingleLxcSingleInterfacesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: hardware-address: type: string description: The MAC address of the interface hwaddr: type: string description: The MAC address of the interface inet: type: string description: The IPv4 address of the interface inet6: type: string description: The IPv6 address of the interface ip-addresses: type: array description: The addresses of the interface items: type: object description: "" properties: ip-address: type: string description: IP-Address ip-address-type: type: string description: IP-Family prefix: type: int64 description: IP-Prefix name: type: string description: The name of the interface CreateNodesSingleLxcSingleMtunnelResponse: description: CreateNodesSingleLxcSingleMtunnelResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleLxcSingleMtunnelwebsocketResponse: description: GetNodesSingleLxcSingleMtunnelwebsocketResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: port: type: string description: "" socket: type: string description: "" GetNodesSingleCephResponse: description: GetNodesSingleCephResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: {} GetNodesSingleCephCfgResponse: description: GetNodesSingleCephCfgResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: {} GetNodesSingleCephCfgRawResponse: description: GetNodesSingleCephCfgRawResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleCephCfgDbResponse: description: GetNodesSingleCephCfgDbResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: can_update_at_runtime: type: int64 description: "" level: type: string description: "" mask: type: string description: "" name: type: string description: "" section: type: string description: "" value: type: string description: "" GetNodesSingleCephCfgValueResponse: description: GetNodesSingleCephCfgValueResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "Contains {section}->{key} children with the values" GetNodesSingleCephOsdResponse: description: GetNodesSingleCephOsdResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" CreateNodesSingleCephOsdResponse: description: CreateNodesSingleCephOsdResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteNodesSingleCephOsdSingleResponse: description: DeleteNodesSingleCephOsdSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleCephOsdSingleResponse: description: GetNodesSingleCephOsdSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: {} GetNodesSingleCephOsdSingleMetadataResponse: description: GetNodesSingleCephOsdSingleMetadataResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: devices: type: array description: Array containing data about devices items: type: object description: "" properties: dev_node: type: string description: Device node device: type: string description: Kind of OSD device devices: type: string description: Physical disks used size: type: int64 description: Size in bytes support_discard: type: int64 description: Discard support of the physical device type: type: string description: "Type of device. For example, hdd or ssd" osd: type: object description: General information about the OSD properties: back_addr: type: string description: Address and port used to talk to other OSDs. front_addr: type: string description: Address and port used to talk to clients and monitors. hb_back_addr: type: string description: Heartbeat address and port for other OSDs. hb_front_addr: type: string description: Heartbeat address and port for clients and monitors. hostname: type: string description: Name of the host containing the OSD. id: type: int64 description: ID of the OSD. mem_usage: type: int64 description: Memory usage of the OSD service. osd_data: type: string description: Path to the OSD's data directory. osd_objectstore: type: string description: The type of object store used. pid: type: int64 description: OSD process ID. version: type: string description: Ceph version of the OSD service. GetNodesSingleCephOsdSingleLvinfoResponse: description: GetNodesSingleCephOsdSingleLvinfoResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: creation_time: type: string description: Creation time as reported by `lvs`. lv_name: type: string description: Name of the logical volume (LV). lv_path: type: string description: Path to the logical volume (LV). lv_size: type: int64 description: Size of the logical volume (LV). lv_uuid: type: string description: UUID of the logical volume (LV). vg_name: type: string description: Name of the volume group (VG). CreateNodesSingleCephOsdSingleInResponse: description: CreateNodesSingleCephOsdSingleInResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" CreateNodesSingleCephOsdSingleOutResponse: description: CreateNodesSingleCephOsdSingleOutResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" CreateNodesSingleCephOsdSingleScrubResponse: description: CreateNodesSingleCephOsdSingleScrubResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleCephMdsResponse: description: GetNodesSingleCephMdsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: addr: type: string description: "" host: type: string description: "" name: type: string description: The name (ID) for the MDS rank: type: int64 description: "" standby_replay: type: int64 description: >- If true, the standby MDS is polling the active MDS for faster recovery (hot standby). state: type: string description: State of the MDS DeleteNodesSingleCephMdsSingleResponse: description: DeleteNodesSingleCephMdsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" CreateNodesSingleCephMdsSingleResponse: description: CreateNodesSingleCephMdsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleCephMgrResponse: description: GetNodesSingleCephMgrResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: addr: type: string description: "" host: type: string description: "" name: type: string description: The name (ID) for the MGR state: type: string description: State of the MGR DeleteNodesSingleCephMgrSingleResponse: description: DeleteNodesSingleCephMgrSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" CreateNodesSingleCephMgrSingleResponse: description: CreateNodesSingleCephMgrSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleCephMonResponse: description: GetNodesSingleCephMonResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: addr: type: string description: "" ceph_version: type: string description: "" ceph_version_short: type: string description: "" direxists: type: string description: "" host: type: int64 description: "" name: type: string description: "" quorum: type: int64 description: "" rank: type: int64 description: "" service: type: int64 description: "" state: type: string description: "" DeleteNodesSingleCephMonSingleResponse: description: DeleteNodesSingleCephMonSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" CreateNodesSingleCephMonSingleResponse: description: CreateNodesSingleCephMonSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleCephFsResponse: description: GetNodesSingleCephFsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: data_pool: type: string description: The name of the data pool. metadata_pool: type: string description: The name of the metadata pool. name: type: string description: The ceph filesystem name. CreateNodesSingleCephFsSingleResponse: description: CreateNodesSingleCephFsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleCephPoolResponse: description: GetNodesSingleCephPoolResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: application_metadata: type: object description: "" autoscale_status: type: object description: "" bytes_used: type: int64 description: "" crush_rule: type: int64 description: "" crush_rule_name: type: string description: "" min_size: type: int64 description: "" percent_used: type: number description: "" pg_autoscale_mode: type: string description: "" pg_num: type: int64 description: "" pg_num_final: type: int64 description: "" pg_num_min: type: int64 description: "" pool: type: int64 description: "" pool_name: type: string description: "" size: type: int64 description: "" target_size: type: int64 description: "" target_size_ratio: type: number description: "" type: type: string description: "" CreateNodesSingleCephPoolResponse: description: CreateNodesSingleCephPoolResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteNodesSingleCephPoolSingleResponse: description: DeleteNodesSingleCephPoolSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleCephPoolSingleResponse: description: GetNodesSingleCephPoolSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: {} UpdateNodesSingleCephPoolSingleResponse: description: UpdateNodesSingleCephPoolSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleCephPoolSingleStatusResponse: description: GetNodesSingleCephPoolSingleStatusResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: application: type: string description: The application of the pool. application_list: type: array description: "" autoscale_status: type: object description: "" crush_rule: type: string description: >- The rule to use for mapping object placement in the cluster. fast_read: type: int64 description: "" hashpspool: type: int64 description: "" id: type: int64 description: "" min_size: type: int64 description: Minimum number of replicas per object name: type: string description: The name of the pool. It must be unique. nodeep-scrub: type: int64 description: "" nodelete: type: int64 description: "" nopgchange: type: int64 description: "" noscrub: type: int64 description: "" nosizechange: type: int64 description: "" pg_autoscale_mode: type: string description: The automatic PG scaling mode of the pool. pg_num: type: int64 description: Number of placement groups. pg_num_min: type: int64 description: Minimal number of placement groups. pgp_num: type: int64 description: "" size: type: int64 description: Number of replicas per object statistics: type: object description: "" target_size: type: string description: >- The estimated target size of the pool for the PG autoscaler. target_size_ratio: type: number description: >- The estimated target ratio of the pool for the PG autoscaler. use_gmt_hitset: type: int64 description: "" write_fadvise_dontneed: type: int64 description: "" CreateNodesSingleCephInitResponse: description: CreateNodesSingleCephInitResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" CreateNodesSingleCephStopResponse: description: CreateNodesSingleCephStopResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" CreateNodesSingleCephStartResponse: description: CreateNodesSingleCephStartResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" CreateNodesSingleCephRestartResponse: description: CreateNodesSingleCephRestartResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleCephStatusResponse: description: GetNodesSingleCephStatusResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" GetNodesSingleCephCrushResponse: description: GetNodesSingleCephCrushResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleCephLogResponse: description: GetNodesSingleCephLogResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: "n": type: int64 description: Line number t: type: string description: Line text GetNodesSingleCephRulesResponse: description: GetNodesSingleCephRulesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: name: type: string description: Name of the CRUSH rule. GetNodesSingleCephCmdsafetyResponse: description: GetNodesSingleCephCmdsafetyResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: safe: type: int64 description: If it is safe to run the command. status: type: string description: Status message given by Ceph. CreateNodesSingleVzdumpResponse: description: CreateNodesSingleVzdumpResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleVzdumpDefaultsResponse: description: GetNodesSingleVzdumpDefaultsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: all: type: int64 description: Backup all known guest systems on this host. bwlimit: type: int64 description: Limit I/O bandwidth (in KiB/s). compress: type: string description: Compress dump file. dumpdir: type: string description: Store resulting files to specified directory. exclude: type: string description: Exclude specified guest systems (assumes --all) exclude-path: type: array description: >- Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory. items: type: string description: "" fleecing: type: string description: Options for backup fleecing (VM only). ionice: type: int64 description: >- Set IO priority when using the BFQ scheduler. For snapshot and suspend mode backups of VMs, this only affects the compressor. A value of 8 means the idle priority is used, otherwise the best-effort priority is used with the specified value. lockwait: type: int64 description: Maximal time to wait for the global lock (minutes). mailnotification: type: string description: >- Deprecated: use notification targets/matchers instead. Specify when to send a notification mail mailto: type: string description: >- Deprecated: Use notification targets/matchers instead. Comma-separated list of email addresses or users that should receive email notifications. maxfiles: type: int64 description: >- Deprecated: use 'prune-backups' instead. Maximal number of backup files per guest system. mode: type: string description: Backup mode. node: type: string description: Only run if executed on this node. notes-template: type: string description: >- Template string for generating notes for the backup(s). It can contain variables which will be replaced by their values. Currently supported are {{cluster}}, {{guestname}}, {{node}}, and {{vmid}}, but more might be added in the future. Needs to be a single line, newline and backslash need to be escaped as '\n' and '\\' respectively. notification-mode: type: string description: >- Determine which notification system to use. If set to 'legacy-sendmail', vzdump will consider the mailto/mailnotification parameters and send emails to the specified address(es) via the 'sendmail' command. If set to 'notification-system', a notification will be sent via PVE's notification system, and the mailto and mailnotification will be ignored. If set to 'auto' (default setting), an email will be sent if mailto is set, and the notification system will be used if not. pbs-change-detection-mode: type: string description: >- PBS mode used to detect file changes and switch encoding format for container backups. performance: type: string description: Other performance-related settings. pigz: type: int64 description: >- Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count. pool: type: string description: >- Backup all known guest systems included in the specified pool. protected: type: int64 description: "If true, mark backup(s) as protected." prune-backups: type: string description: >- Use these retention options instead of those from the storage configuration. quiet: type: int64 description: Be quiet. remove: type: int64 description: Prune older backups according to 'prune-backups'. script: type: string description: Use specified hook script. stdexcludes: type: int64 description: Exclude temporary files and logs. stop: type: int64 description: Stop running backup jobs on this host. stopwait: type: int64 description: >- Maximal time to wait until a guest system is stopped (minutes). storage: type: string description: Store resulting file to this storage. tmpdir: type: string description: Store temporary files to specified directory. vmid: type: string description: The ID of the guest system you want to backup. zstd: type: int64 description: >- Zstd threads. N=0 uses half of the available cores, if N is set to a value bigger than 0, N is used as thread count. GetNodesSingleVzdumpExtractconfigResponse: description: GetNodesSingleVzdumpExtractconfigResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleServicesResponse: description: GetNodesSingleServicesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: active-state: type: string description: >- Current state of the service process (systemd ActiveState). desc: type: string description: Description of the service. name: type: string description: 'Short identifier for the service (e.g., "pveproxy").' service: type: string description: "Systemd unit name (e.g., pveproxy)." state: type: string description: Execution status of the service (systemd SubState). unit-state: type: string description: Whether the service is enabled (systemd UnitFileState). GetNodesSingleServicesSingleResponse: description: GetNodesSingleServicesSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: subdir: type: string description: "" GetNodesSingleServicesSingleStateResponse: description: GetNodesSingleServicesSingleStateResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: active-state: type: string description: >- Current state of the service process (systemd ActiveState). desc: type: string description: Description of the service. name: type: string description: 'Short identifier for the service (e.g., "pveproxy").' service: type: string description: "Systemd unit name (e.g., pveproxy)." state: type: string description: Execution status of the service (systemd SubState). unit-state: type: string description: Whether the service is enabled (systemd UnitFileState). CreateNodesSingleServicesSingleStartResponse: description: CreateNodesSingleServicesSingleStartResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" CreateNodesSingleServicesSingleStopResponse: description: CreateNodesSingleServicesSingleStopResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" CreateNodesSingleServicesSingleRestartResponse: description: CreateNodesSingleServicesSingleRestartResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" CreateNodesSingleServicesSingleReloadResponse: description: CreateNodesSingleServicesSingleReloadResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteNodesSingleSubscriptionResponse: description: DeleteNodesSingleSubscriptionResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleSubscriptionResponse: description: GetNodesSingleSubscriptionResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: checktime: type: int64 description: Timestamp of the last check done. key: type: string description: "The subscription key, if set and permitted to access." level: type: string description: A short code for the subscription level. message: type: string description: A more human readable status message. nextduedate: type: string description: Next due date of the set subscription. productname: type: string description: Human readable productname of the set subscription. regdate: type: string description: Register date of the set subscription. serverid: type: string description: "The server ID, if permitted to access." signature: type: string description: Signature for offline keys sockets: type: int64 description: The number of sockets for this host. status: type: string description: The current subscription status. url: type: string description: URL to the web shop. CreateNodesSingleSubscriptionResponse: description: CreateNodesSingleSubscriptionResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" UpdateNodesSingleSubscriptionResponse: description: UpdateNodesSingleSubscriptionResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteNodesSingleNetworkResponse: description: DeleteNodesSingleNetworkResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleNetworkResponse: description: GetNodesSingleNetworkResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: active: type: int64 description: Set to true if the interface is active. address: type: string description: IP address. address6: type: string description: IP address. autostart: type: int64 description: Automatically start interface on boot. bond-primary: type: string description: Specify the primary interface for active-backup bond. bond_mode: type: string description: Bonding mode. bond_xmit_hash_policy: type: string description: >- Selects the transmit hash policy to use for slave selection in balance-xor and 802.3ad modes. bridge-access: type: int64 description: The bridge port access VLAN. bridge-arp-nd-suppress: type: int64 description: Bridge port ARP/ND suppress flag. bridge-learning: type: int64 description: Bridge port learning flag. bridge-multicast-flood: type: int64 description: Bridge port multicast flood flag. bridge-unicast-flood: type: int64 description: Bridge port unicast flood flag. bridge_ports: type: string description: Specify the interfaces you want to add to your bridge. bridge_vids: type: string description: >- Specify the allowed VLANs. For example: '2 4 100-200'. Only used if the bridge is VLAN aware. bridge_vlan_aware: type: int64 description: Enable bridge vlan support. cidr: type: string description: IPv4 CIDR. cidr6: type: string description: IPv6 CIDR. comments: type: string description: Comments comments6: type: string description: Comments exists: type: int64 description: Set to true if the interface physically exists. families: type: array description: The network families. items: type: string description: A network family. gateway: type: string description: Default gateway address. gateway6: type: string description: Default ipv6 gateway address. iface: type: string description: Network interface name. link-type: type: string description: The link type. method: type: string description: The network configuration method for IPv4. method6: type: string description: The network configuration method for IPv6. mtu: type: int64 description: MTU. netmask: type: string description: Network mask. netmask6: type: int64 description: Network mask. options: type: array description: A list of additional interface options for IPv4. items: type: string description: An interface property. options6: type: array description: A list of additional interface options for IPv6. items: type: string description: An interface property. ovs_bonds: type: string description: Specify the interfaces used by the bonding device. ovs_bridge: type: string description: >- The OVS bridge associated with a OVS port. This is required when you create an OVS port. ovs_options: type: string description: OVS interface options. ovs_ports: type: string description: Specify the interfaces you want to add to your bridge. ovs_tag: type: int64 description: >- Specify a VLan tag (used by OVSPort, OVSIntPort, OVSBond) priority: type: int64 description: The order of the interface. slaves: type: string description: Specify the interfaces used by the bonding device. type: type: string description: Network interface type uplink-id: type: string description: The uplink ID. vlan-id: type: int64 description: >- vlan-id for a custom named vlan interface (ifupdown2 only). vlan-protocol: type: string description: The VLAN protocol. vlan-raw-device: type: string description: Specify the raw interface for the vlan interface. vxlan-id: type: int64 description: The VXLAN ID. vxlan-local-tunnelip: type: string description: The VXLAN local tunnel IP. vxlan-physdev: type: string description: The physical device for the VXLAN tunnel. vxlan-svcnodeip: type: string description: The VXLAN SVC node IP. CreateNodesSingleNetworkResponse: description: CreateNodesSingleNetworkResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" UpdateNodesSingleNetworkResponse: description: UpdateNodesSingleNetworkResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteNodesSingleNetworkSingleResponse: description: DeleteNodesSingleNetworkSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleNetworkSingleResponse: description: GetNodesSingleNetworkSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: method: type: string description: "" type: type: string description: "" UpdateNodesSingleNetworkSingleResponse: description: UpdateNodesSingleNetworkSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodeTasksResponse: description: GetNodeTasksResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: endtime: type: int64 description: "" id: type: string description: "" node: type: string description: "" pid: type: int64 description: "" pstart: type: int64 description: "" starttime: type: int64 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: int64 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: exitstatus: type: string description: "" id: type: string description: "" node: type: string description: "" pid: type: int64 description: "" pstart: type: int64 description: "" starttime: type: int64 description: "" status: type: string description: "" type: type: string description: "" upid: type: string description: "" user: type: string description: "" GetNodesSingleScanResponse: description: GetNodesSingleScanResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: method: type: string description: "" GetNodesSingleScanNfsResponse: description: GetNodesSingleScanNfsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: options: type: string description: NFS export options. path: type: string description: The exported path. GetNodesSingleScanCifsResponse: description: GetNodesSingleScanCifsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: description: type: string description: Descriptive text from server. share: type: string description: The cifs share name. GetNodesSingleScanPbsResponse: description: GetNodesSingleScanPbsResponse 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: Comment from server. store: type: string description: The datastore name. GetNodesSingleScanIscsiResponse: description: GetNodesSingleScanIscsiResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: portal: type: string description: The iSCSI portal name. target: type: string description: The iSCSI target name. GetNodesSingleScanLvmResponse: description: GetNodesSingleScanLvmResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: vg: type: string description: The LVM logical volume group name. GetNodesSingleScanLvmthinResponse: description: GetNodesSingleScanLvmthinResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: lv: type: string description: The LVM Thin Pool name (LVM logical volume). GetNodesSingleScanZfsResponse: description: GetNodesSingleScanZfsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: pool: type: string description: ZFS pool name. GetNodesSingleHardwareResponse: description: GetNodesSingleHardwareResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: type: type: string description: "" GetNodesSingleHardwarePciResponse: description: GetNodesSingleHardwarePciResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: class: type: string description: The PCI Class of the device. device: type: string description: The Device ID. device_name: type: string description: "" id: type: string description: The PCI ID. iommugroup: type: int64 description: >- The IOMMU group in which the device is in. If no IOMMU group is detected, it is set to -1. mdev: type: int64 description: >- If set, marks that the device is capable of creating mediated devices. subsystem_device: type: string description: The Subsystem Device ID. subsystem_device_name: type: string description: "" subsystem_vendor: type: string description: The Subsystem Vendor ID. subsystem_vendor_name: type: string description: "" vendor: type: string description: The Vendor ID. vendor_name: type: string description: "" GetNodesSingleHardwarePciSingleResponse: description: GetNodesSingleHardwarePciSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: method: type: string description: "" GetNodesSingleHardwarePciSingleMdevResponse: description: GetNodesSingleHardwarePciSingleMdevResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: available: type: int64 description: The number of still available instances of this type. description: type: string description: Additional description of the type. name: type: string description: A human readable name for the type. type: type: string description: The name of the mdev type. GetNodesSingleHardwareUsbResponse: description: GetNodesSingleHardwareUsbResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: busnum: type: int64 description: "" class: type: int64 description: "" devnum: type: int64 description: "" level: type: int64 description: "" manufacturer: type: string description: "" port: type: int64 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: "" GetNodesSingleCapabilitiesResponse: description: GetNodesSingleCapabilitiesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: {} GetNodesSingleCapabilitiesQemuResponse: description: GetNodesSingleCapabilitiesQemuResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: {} GetNodesSingleCapabilitiesQemuCpuResponse: description: GetNodesSingleCapabilitiesQemuCpuResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: custom: type: int64 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. GetNodesSingleCapabilitiesQemuCpuflagsResponse: description: GetNodesSingleCapabilitiesQemuCpuflagsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: description: type: string description: Description of the CPU flag. name: type: string description: Name of the CPU flag. GetNodesSingleCapabilitiesQemuMachinesResponse: description: GetNodesSingleCapabilitiesQemuMachinesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: changes: type: string description: >- Notable changes of a version, currently only set for +pveX versions. id: type: string description: Full name of machine type and version. type: type: string description: The machine type. version: type: string description: The machine version. GetNodesSingleCapabilitiesQemuMigrationResponse: description: GetNodesSingleCapabilitiesQemuMigrationResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: has-dbus-vmstate: type: int64 description: >- Whether the host supports live-migrating additional VM state via the dbus-vmstate helper. GetNodesSingleStorageResponse: description: GetNodesSingleStorageResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: active: type: int64 description: Set when storage is accessible. avail: type: int64 description: Available storage space in bytes. content: type: string description: Allowed storage content types. enabled: type: int64 description: Set when storage is enabled (not disabled). formats: type: object description: >- Lists the supported and default format. Use 'formats' instead. Only included if 'format' parameter is set. properties: default: type: string description: The default format of the storage. supported: type: array description: The list of supported formats items: type: string description: "" select_existing: type: int64 description: >- Instead of creating new volumes, one must select one that is already existing. Only included if 'format' parameter is set. shared: type: int64 description: Shared flag from storage configuration. storage: type: string description: The storage identifier. total: type: int64 description: Total storage space in bytes. type: type: string description: Storage type. used: type: int64 description: Used storage space in bytes. used_fraction: type: number description: Used fraction (used/total). GetNodesSingleStorageSingleResponse: description: GetNodesSingleStorageSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: subdir: type: string description: "" DeleteNodesSingleStorageSinglePrunebackupsResponse: description: DeleteNodesSingleStorageSinglePrunebackupsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleStorageSinglePrunebackupsResponse: description: GetNodesSingleStorageSinglePrunebackupsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: ctime: type: int64 description: >- Creation time of the backup (seconds since the UNIX epoch). mark: type: string description: >- Whether the backup would be kept or removed. Backups that are protected or don't use the standard naming scheme are not removed. type: type: string description: "One of 'qemu', 'lxc', 'openvz' or 'unknown'." vmid: type: int64 description: The VM the backup belongs to. volid: type: string description: Backup volume ID. GetNodesSingleStorageSingleContentResponse: description: GetNodesSingleStorageSingleContentResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: ctime: type: int64 description: Creation time (seconds since the UNIX Epoch). encrypted: type: string description: >- If whole backup is encrypted, value is the fingerprint or '1' if encrypted. Only useful for the Proxmox Backup Server storage type. format: type: string description: >- Format identifier ('raw', 'qcow2', 'subvol', 'iso', 'tgz' ...) notes: type: string description: >- Optional notes. If they contain multiple lines, only the first one is returned here. parent: type: string description: Volume identifier of parent (for linked cloned). protected: type: int64 description: Protection status. Currently only supported for backups. size: type: int64 description: Volume size in bytes. used: type: int64 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: int64 description: Associated Owner VMID. volid: type: string description: Volume identifier. CreateNodesSingleStorageSingleContentResponse: description: CreateNodesSingleStorageSingleContentResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: Volume identifier DeleteNodesSingleStorageSingleContentSingleResponse: description: DeleteNodesSingleStorageSingleContentSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleStorageSingleContentSingleResponse: description: GetNodesSingleStorageSingleContentSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: format: type: string description: >- Format identifier ('raw', 'qcow2', 'subvol', 'iso', 'tgz' ...) notes: type: string description: Optional notes. path: type: string description: The Path protected: type: int64 description: Protection status. Currently only supported for backups. size: type: int64 description: Volume size in bytes. used: type: int64 description: >- Used space. Please note that most storage plugins do not report anything useful here. CreateNodesSingleStorageSingleContentSingleResponse: description: CreateNodesSingleStorageSingleContentSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" UpdateNodesSingleStorageSingleContentSingleResponse: description: UpdateNodesSingleStorageSingleContentSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleStorageSingleFilerestoreListResponse: description: GetNodesSingleStorageSingleFilerestoreListResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: filepath: type: string description: base64 path of the current entry leaf: type: int64 description: If this entry is a leaf in the directory graph. mtime: type: int64 description: Entry last-modified time (unix timestamp). size: type: int64 description: Entry file size. text: type: string description: Entry display text. type: type: string description: Entry type. GetNodesSingleStorageSingleFilerestoreDownloadResponse: description: GetNodesSingleStorageSingleFilerestoreDownloadResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: any description: "" GetNodesSingleStorageSingleStatusResponse: description: GetNodesSingleStorageSingleStatusResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: active: type: int64 description: Set when storage is accessible. avail: type: int64 description: Available storage space in bytes. content: type: string description: Allowed storage content types. enabled: type: int64 description: Set when storage is enabled (not disabled). shared: type: int64 description: Shared flag from storage configuration. total: type: int64 description: Total storage space in bytes. type: type: string description: Storage type. used: type: int64 description: Used storage space in bytes. GetNodesSingleStorageSingleRrdResponse: description: GetNodesSingleStorageSingleRrdResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: filename: type: string description: "" GetNodesSingleStorageSingleRrddataResponse: description: GetNodesSingleStorageSingleRrddataResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: {} CreateNodesSingleStorageSingleUploadResponse: description: CreateNodesSingleStorageSingleUploadResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" CreateNodesSingleStorageSingleDownloadurlResponse: description: CreateNodesSingleStorageSingleDownloadurlResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" CreateNodesSingleStorageSingleOciregistrypullResponse: description: CreateNodesSingleStorageSingleOciregistrypullResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleStorageSingleImportmetadataResponse: description: GetNodesSingleStorageSingleImportmetadataResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Information about how to import a guest. properties: create-args: type: object description: >- Parameters which can be used in a call to create a VM or container. disks: type: object description: >- Recognised disk volumes as `$bus$id` => `$storeid:$path` map. net: type: object description: >- Recognised network interfaces as `net$id` => { ...params } object. source: type: string description: The type of the import-source of this guest volume. type: type: string description: The type of guest this is going to produce. warnings: type: array description: >- List of known issues that can affect the import of a guest. Note that lack of warning does not imply that there cannot be any problems. items: type: object description: "" properties: key: type: string description: Related subject (config) key of warning. type: type: string description: What this warning is about. value: type: string description: Related subject (config) value of warning. GetNodesSingleDisksResponse: description: GetNodesSingleDisksResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: {} GetNodesSingleDisksLvmResponse: description: GetNodesSingleDisksLvmResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: children: type: array description: "" items: type: object description: "" properties: children: type: array description: The underlying physical volumes items: type: object description: "" properties: free: type: int64 description: The free bytes in the physical volume leaf: type: int64 description: "" name: type: string description: The name of the physical volume size: type: int64 description: The size of the physical volume in bytes free: type: int64 description: The free bytes in the volume group leaf: type: int64 description: "" name: type: string description: The name of the volume group size: type: int64 description: The size of the volume group in bytes leaf: type: int64 description: "" CreateNodesSingleDisksLvmResponse: description: CreateNodesSingleDisksLvmResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteNodesSingleDisksLvmSingleResponse: description: DeleteNodesSingleDisksLvmSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleDisksLvmthinResponse: description: GetNodesSingleDisksLvmthinResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: lv: type: string description: The name of the thinpool. lv_size: type: int64 description: The size of the thinpool in bytes. metadata_size: type: int64 description: The size of the metadata lv in bytes. metadata_used: type: int64 description: The used bytes of the metadata lv. used: type: int64 description: The used bytes of the thinpool. vg: type: string description: The associated volume group. CreateNodesSingleDisksLvmthinResponse: description: CreateNodesSingleDisksLvmthinResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteNodesSingleDisksLvmthinSingleResponse: description: DeleteNodesSingleDisksLvmthinSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleDisksDirectoryResponse: description: GetNodesSingleDisksDirectoryResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: device: type: string description: The mounted device. options: type: string description: The mount options. path: type: string description: The mount path. type: type: string description: The filesystem type. unitfile: type: string description: The path of the mount unit. CreateNodesSingleDisksDirectoryResponse: description: CreateNodesSingleDisksDirectoryResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteNodesSingleDisksDirectorySingleResponse: description: DeleteNodesSingleDisksDirectorySingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleDisksZfsResponse: description: GetNodesSingleDisksZfsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: alloc: type: int64 description: "" dedup: type: number description: "" frag: type: int64 description: "" free: type: int64 description: "" health: type: string description: "" name: type: string description: "" size: type: int64 description: "" CreateNodesSingleDisksZfsResponse: description: CreateNodesSingleDisksZfsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteNodesSingleDisksZfsSingleResponse: description: DeleteNodesSingleDisksZfsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleDisksZfsSingleResponse: description: GetNodesSingleDisksZfsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: action: type: string description: Information about the recommended action to fix the state. children: type: array description: >- The pool configuration information, including the vdevs for each section (e.g. spares, cache), may be nested. items: type: object description: "" properties: cksum: type: number description: "" msg: type: string description: An optional message about the vdev. name: type: string description: The name of the vdev or section. read: type: number description: "" state: type: string description: The state of the vdev. write: type: number description: "" errors: type: string description: Information about the errors on the zpool. name: type: string description: The name of the zpool. scan: type: string description: Information about the last/current scrub. state: type: string description: The state of the zpool. status: type: string description: Information about the state of the zpool. GetNodesSingleDisksListResponse: description: GetNodesSingleDisksListResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: devpath: type: string description: The device path gpt: type: int64 description: "" health: type: string description: "" model: type: string description: "" mounted: type: int64 description: "" osdid: type: int64 description: "" osdid-list: type: array description: "" items: type: int64 description: "" parent: type: string description: >- For partitions only. The device path of the disk the partition resides on. serial: type: string description: "" size: type: int64 description: "" used: type: string description: "" vendor: type: string description: "" wwn: type: string description: "" GetNodesSingleDisksSmartResponse: description: GetNodesSingleDisksSmartResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: attributes: type: array description: "" health: type: string description: "" text: type: string description: "" type: type: string description: "" CreateNodesSingleDisksInitgptResponse: description: CreateNodesSingleDisksInitgptResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" UpdateNodesSingleDisksWipediskResponse: description: UpdateNodesSingleDisksWipediskResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleAptResponse: description: GetNodesSingleAptResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: id: type: string description: "" GetNodesSingleAptUpdateResponse: description: GetNodesSingleAptUpdateResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: Arch: type: string description: Package Architecture. Description: type: string description: Package description. NotifyStatus: type: string description: >- Version for which PVE has already sent an update notification for. OldVersion: type: string description: Old version currently installed. Origin: type: string description: "Package origin, e.g., 'Proxmox' or 'Debian'." Package: type: string description: Package name. Priority: type: string description: Package priority. Section: type: string description: Package section. Title: type: string description: Package title. Version: type: string description: New version to be updated to. CreateNodesSingleAptUpdateResponse: description: CreateNodesSingleAptUpdateResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleAptChangelogResponse: description: GetNodesSingleAptChangelogResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleAptRepositoriesResponse: description: GetNodesSingleAptRepositoriesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Result from parsing the APT repository files in /etc/apt/. properties: digest: type: string description: Common digest of all files. errors: type: array description: List of problematic repository files. items: type: object description: "" properties: error: type: string description: The error message path: type: string description: Path to the problematic file. files: type: array description: List of parsed repository files. items: type: object description: "" properties: digest: type: array description: Digest of the file as bytes. items: type: int64 description: "" file-type: type: string description: Format of the file. path: type: string description: Path to the problematic file. repositories: type: array description: The parsed repositories. items: type: object description: "" properties: Comment: type: string description: Associated comment Components: type: array description: List of repository components items: type: string description: "" Enabled: type: int64 description: Whether the repository is enabled or not FileType: type: string description: Format of the defining file. Options: type: array description: Additional options items: type: object description: "" properties: Key: type: string description: "" Values: type: array description: "" items: type: string description: "" Suites: type: array description: List of package distribuitions items: type: string description: "" Types: type: array description: List of package types. items: type: string description: "" URIs: type: array description: List of repository URIs. items: type: string description: "" infos: type: array description: Additional information/warnings for APT repositories. items: type: object description: "" properties: index: type: string description: Index of the associated repository within the file. kind: type: string description: Kind of the information (e.g. warning). message: type: string description: Information message. path: type: string description: Path to the associated file. property: type: string description: Property from which the info originates. standard-repos: type: array description: >- List of standard repositories and their configuration status items: type: object description: "" properties: handle: type: string description: Handle to identify the repository. name: type: string description: Full name of the repository. status: type: int64 description: >- Indicating enabled/disabled status, if the repository is configured. CreateNodesSingleAptRepositoriesResponse: description: CreateNodesSingleAptRepositoriesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" UpdateNodesSingleAptRepositoriesResponse: description: UpdateNodesSingleAptRepositoriesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleAptVersionsResponse: description: GetNodesSingleAptVersionsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: Arch: type: string description: Package Architecture. CurrentState: type: string description: Current state of the package installed on the system. Description: type: string description: Package description. ManagerVersion: type: string description: Version of the currently running pve-manager API server. NotifyStatus: type: string description: >- Version for which PVE has already sent an update notification for. OldVersion: type: string description: Old version currently installed. Origin: type: string description: "Package origin, e.g., 'Proxmox' or 'Debian'." Package: type: string description: Package name. Priority: type: string description: Package priority. RunningKernel: type: string description: "Kernel release, only for package 'proxmox-ve'." Section: type: string description: Package section. Title: type: string description: Package title. Version: type: string description: New version to be updated to. GetNodeFirewallResponse: description: GetNodeFirewallResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: {} GetNodeFirewallRulesResponse: description: GetNodeFirewallRulesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: action: type: string description: >- Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name comment: type: string description: Descriptive comment dest: type: string description: Restrict packet destination address dport: type: string description: Restrict TCP/UDP destination port enable: type: int64 description: Flag to enable/disable a rule icmp-type: type: string description: >- Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp' iface: type: string description: >- Network interface name. You have to use network configuration key names for VMs and containers ipversion: type: int64 description: >- IP version (4 or 6) - automatically determined from source/dest addresses log: type: string description: Log level for firewall rule macro: type: string description: Use predefined standard macro pos: type: int64 description: Rule position in the ruleset proto: type: string description: >- IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols' source: type: string description: Restrict packet source address sport: type: string description: Restrict TCP/UDP source port type: type: string description: Rule type CreateNodeFirewallRuleResponse: description: CreateNodeFirewallRuleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteNodeFirewallRuleResponse: description: DeleteNodeFirewallRuleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodeFirewallRuleResponse: description: GetNodeFirewallRuleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: action: type: string description: >- Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name comment: type: string description: Descriptive comment dest: type: string description: Restrict packet destination address dport: type: string description: Restrict TCP/UDP destination port enable: type: int64 description: Flag to enable/disable a rule icmp-type: type: string description: >- Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp' iface: type: string description: >- Network interface name. You have to use network configuration key names for VMs and containers ipversion: type: int64 description: >- IP version (4 or 6) - automatically determined from source/dest addresses log: type: string description: Log level for firewall rule macro: type: string description: Use predefined standard macro pos: type: int64 description: Rule position in the ruleset proto: type: string description: >- IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols' source: type: string description: Restrict packet source address sport: type: string description: Restrict TCP/UDP source port type: type: string description: Rule type UpdateNodeFirewallRuleResponse: description: UpdateNodeFirewallRuleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodeFirewallOptionsResponse: description: GetNodeFirewallOptionsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: enable: type: int64 description: Enable host firewall rules. log_level_forward: type: string description: Log level for forwarded traffic. 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: int64 description: Enable logging of conntrack information. ndp: type: int64 description: Enable NDP (Neighbor Discovery Protocol). nf_conntrack_allow_invalid: type: int64 description: Allow invalid packets on connection tracking. nf_conntrack_helpers: type: string description: >- Enable conntrack helpers for specific protocols. Supported protocols: amanda, ftp, irc, netbios-ns, pptp, sane, sip, snmp, tftp nf_conntrack_max: type: int64 description: Maximum number of tracked connections. nf_conntrack_tcp_timeout_established: type: int64 description: Conntrack established timeout. nf_conntrack_tcp_timeout_syn_recv: type: int64 description: Conntrack syn recv timeout. nftables: type: int64 description: Enable nftables based firewall (tech preview) nosmurfs: type: int64 description: Enable SMURFS filter. protection_synflood: type: int64 description: Enable synflood protection protection_synflood_burst: type: int64 description: Synflood protection rate burst by ip src. protection_synflood_rate: type: int64 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: int64 description: Filter illegal combinations of TCP flags. UpdateNodeFirewallOptionsResponse: description: UpdateNodeFirewallOptionsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleFirewallLogResponse: description: GetNodesSingleFirewallLogResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: "n": type: int64 description: Line number t: type: string description: Line text GetNodesSingleReplicationResponse: description: GetNodesSingleReplicationResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: id: type: string description: "" GetNodesSingleReplicationSingleResponse: description: GetNodesSingleReplicationSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: {} GetNodesSingleReplicationSingleStatusResponse: description: GetNodesSingleReplicationSingleStatusResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" GetNodesSingleReplicationSingleLogResponse: description: GetNodesSingleReplicationSingleLogResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: "n": type: int64 description: Line number t: type: string description: Line text CreateNodesSingleReplicationSingleSchedulenowResponse: description: CreateNodesSingleReplicationSingleSchedulenowResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleCertificatesResponse: description: GetNodesSingleCertificatesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: {} GetNodesSingleCertificatesAcmeResponse: description: GetNodesSingleCertificatesAcmeResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: {} DeleteNodesSingleCertificatesAcmeCertificateResponse: description: DeleteNodesSingleCertificatesAcmeCertificateResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" CreateNodesSingleCertificatesAcmeCertificateResponse: description: CreateNodesSingleCertificatesAcmeCertificateResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" UpdateNodesSingleCertificatesAcmeCertificateResponse: description: UpdateNodesSingleCertificatesAcmeCertificateResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleCertificatesInfoResponse: description: GetNodesSingleCertificatesInfoResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: filename: type: string description: "" fingerprint: type: string description: Certificate SHA 256 fingerprint. issuer: type: string description: Certificate issuer name. notafter: type: int64 description: Certificate's notAfter timestamp (UNIX epoch). notbefore: type: int64 description: Certificate's notBefore timestamp (UNIX epoch). pem: type: string description: Certificate in PEM format public-key-bits: type: int64 description: Certificate's public key size public-key-type: type: string description: Certificate's public key algorithm san: type: array description: List of Certificate's SubjectAlternativeName entries. items: type: string description: "" subject: type: string description: Certificate subject name. DeleteNodesSingleCertificatesCustomResponse: description: DeleteNodesSingleCertificatesCustomResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" CreateNodesSingleCertificatesCustomResponse: description: CreateNodesSingleCertificatesCustomResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: filename: type: string description: "" fingerprint: type: string description: Certificate SHA 256 fingerprint. issuer: type: string description: Certificate issuer name. notafter: type: int64 description: Certificate's notAfter timestamp (UNIX epoch). notbefore: type: int64 description: Certificate's notBefore timestamp (UNIX epoch). pem: type: string description: Certificate in PEM format public-key-bits: type: int64 description: Certificate's public key size public-key-type: type: string description: Certificate's public key algorithm san: type: array description: List of Certificate's SubjectAlternativeName entries. items: type: string description: "" subject: type: string description: Certificate subject name. GetNodesSingleConfigResponse: description: GetNodesSingleConfigResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: acme: type: string description: Node specific ACME settings. acmedomain0: type: string description: ACME domain and validation plugin acmedomain1: type: string description: ACME domain and validation plugin acmedomain2: type: string description: ACME domain and validation plugin acmedomain3: type: string description: ACME domain and validation plugin acmedomain4: type: string description: ACME domain and validation plugin acmedomain5: type: string description: ACME domain and validation plugin acmedomain6: type: string description: ACME domain and validation plugin acmedomain7: type: string description: ACME domain and validation plugin acmedomain8: type: string description: ACME domain and validation plugin acmedomain9: type: string description: ACME domain and validation plugin acmedomain10: type: string description: ACME domain and validation plugin acmedomain11: type: string description: ACME domain and validation plugin acmedomain12: type: string description: ACME domain and validation plugin acmedomain13: type: string description: ACME domain and validation plugin acmedomain14: type: string description: ACME domain and validation plugin acmedomain15: type: string description: ACME domain and validation plugin acmedomain16: type: string description: ACME domain and validation plugin acmedomain17: type: string description: ACME domain and validation plugin acmedomain18: type: string description: ACME domain and validation plugin acmedomain19: type: string description: ACME domain and validation plugin acmedomain20: type: string description: ACME domain and validation plugin acmedomain21: type: string description: ACME domain and validation plugin acmedomain22: type: string description: ACME domain and validation plugin acmedomain23: type: string description: ACME domain and validation plugin acmedomain24: type: string description: ACME domain and validation plugin acmedomain25: type: string description: ACME domain and validation plugin acmedomain26: type: string description: ACME domain and validation plugin acmedomain27: type: string description: ACME domain and validation plugin acmedomain28: type: string description: ACME domain and validation plugin acmedomain29: type: string description: ACME domain and validation plugin ballooning-target: type: int64 description: >- RAM usage target for ballooning (in percent of total memory) description: type: string description: >- Description for the Node. Shown in the web-interface node notes panel. This is saved as comment inside the configuration file. digest: type: string description: >- Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. startall-onboot-delay: type: int64 description: >- Initial delay in seconds, before starting all the Virtual Guests with on-boot enabled. wakeonlan: type: string description: Node specific wake on LAN settings. UpdateNodesSingleConfigResponse: description: UpdateNodesSingleConfigResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodeSDNResponse: description: GetNodeSDNResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: {} GetNodesSingleSdnFabricsSingleResponse: description: GetNodesSingleSdnFabricsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: subdir: type: string description: "" GetNodesSingleSdnFabricsSingleRoutesResponse: description: GetNodesSingleSdnFabricsSingleRoutesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: route: type: string description: The CIDR block for this routing table entry. via: type: array description: A list of nexthops for that route. items: type: string description: The IP address of the nexthop. GetNodesSingleSdnFabricsSingleNeighborsResponse: description: GetNodesSingleSdnFabricsSingleNeighborsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: neighbor: type: string description: The IP or hostname of the neighbor. status: type: string description: "The status of the neighbor, as returned by FRR." uptime: type: string description: >- The uptime of this neighbor, as returned by FRR (e.g. 8h24m12s). GetNodesSingleSdnFabricsSingleInterfacesResponse: description: GetNodesSingleSdnFabricsSingleInterfacesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: name: type: string description: The name of the network interface. state: type: string description: The current state of the interface. type: type: string description: >- The type of this interface in the fabric (e.g. Point-to-Point, Broadcast, ..). GetNodeSDNZonesResponse: description: GetNodeSDNZonesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: status: type: string description: Status of zone zone: type: string description: The SDN zone object identifier. GetNodeSDNZoneResponse: description: GetNodeSDNZoneResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: subdir: type: string description: "" GetNodeSDNZoneContentResponse: description: GetNodeSDNZoneContentResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: status: type: string description: Status. statusmsg: type: string description: Status details vnet: type: string description: Vnet identifier. GetNodesSingleSdnZonesSingleBridgesResponse: description: GetNodesSingleSdnZonesSingleBridgesResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: List of bridges contained in the SDN zone. properties: name: type: string description: Name of the bridge. ports: type: array description: All ports that are members of the bridge items: type: object description: Information about bridge ports. properties: index: type: string description: >- The index of the guests network device that this interface belongs to. name: type: string description: The name of the bridge port. primary_vlan: type: number description: >- The primary VLAN configured for the port of this bridge (= PVID). Only for VLAN-aware bridges. vlans: type: array description: >- A list of VLANs and VLAN ranges that are allowed for this bridge port in addition to the primary VLAN. Only for VLAN-aware bridges. items: type: string description: A single VLAN (123) or a VLAN range (234-435). vmid: type: number description: >- The ID of the guest that this interface belongs to. vlan_filtering: type: string description: >- Whether VLAN filtering is enabled for this bridge (= VLAN-aware). GetNodesSingleSdnZonesSingleIpvrfResponse: description: GetNodesSingleSdnZonesSingleIpvrfResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: >- All entries in the VRF table of zone {zone} of the node.This does not include /32 routes for guests on this host,since they are handled via the respective vnet bridge directly. items: type: object description: "" properties: ip: type: string description: The CIDR of the route table entry. metric: type: int64 description: This route's metric. nexthops: type: array description: A list of nexthops for the route table entry. items: type: string description: the interface name or ip address of the next hop protocol: type: string description: >- The protocol where this route was learned from (e.g. BGP). GetNodesSingleSdnVnetsSingleResponse: description: GetNodesSingleSdnVnetsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: subdir: type: string description: "" GetNodesSingleSdnVnetsSingleMacvrfResponse: description: GetNodesSingleSdnVnetsSingleMacvrfResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: >- All routes from the MAC VRF that this node self-originates or has learned via BGP. items: type: object description: "" properties: ip: type: string description: The IP address of the MAC VRF entry. mac: type: string description: The MAC address of the MAC VRF entry. nexthop: type: string description: The IP address of the nexthop. GetNodesSingleVersionResponse: description: GetNodesSingleVersionResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: release: type: string description: The current installed Proxmox VE Release repoid: type: string description: >- The short git commit hash ID from which this version was build version: type: string description: The current installed pve-manager package version GetNodesSingleStatusResponse: description: GetNodesSingleStatusResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: boot-info: type: object description: Meta-information about the boot mode. properties: mode: type: string description: Through which firmware the system got booted. secureboot: type: int64 description: >- System is booted in secure mode, only applicable for the "efi" mode. cpu: type: number description: The current cpu usage. cpuinfo: type: object description: "" properties: cores: type: int64 description: The number of physical cores of the CPU. cpus: type: int64 description: The number of logical threads of the CPU. model: type: string description: The CPU model sockets: type: int64 description: The number of logical threads of the CPU. current-kernel: type: object description: >- Meta-information about the currently booted kernel of this node. properties: machine: type: string description: Hardware (architecture) type release: type: string description: 'OS kernel release (e.g., "6.8.0")' sysname: type: string description: 'OS kernel name (e.g., "Linux")' version: type: string description: OS kernel version with build info loadavg: type: array description: "An array of load avg for 1, 5 and 15 minutes respectively." items: type: string description: The value of the load. memory: type: object description: "" properties: available: type: int64 description: The available memory in bytes. free: type: int64 description: The free memory in bytes. total: type: int64 description: The total memory in bytes. used: type: int64 description: The used memory in bytes. pveversion: type: string description: The PVE version string. rootfs: type: object description: "" properties: avail: type: int64 description: The available bytes in the root filesystem. free: type: int64 description: The free bytes on the root filesystem. total: type: int64 description: The total size of the root filesystem in bytes. used: type: int64 description: The used bytes in the root filesystem. CreateNodesSingleStatusResponse: description: CreateNodesSingleStatusResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleNetstatResponse: description: GetNodesSingleNetstatResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: {} CreateNodesSingleExecuteResponse: description: CreateNodesSingleExecuteResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: {} CreateNodesSingleWakeonlanResponse: description: CreateNodesSingleWakeonlanResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: MAC address used to assemble the WoL magic packet. GetNodeRRDResponse: description: GetNodeRRDResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: filename: type: string description: "" GetNodeRRDDataResponse: description: GetNodeRRDDataResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: {} GetNodesSingleSyslogResponse: description: GetNodesSingleSyslogResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: "n": type: int64 description: Line number t: type: string description: Line text GetNodesSingleJournalResponse: description: GetNodesSingleJournalResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: string description: "" CreateNodesSingleVncshellResponse: description: CreateNodesSingleVncshellResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" CreateNodesSingleTermproxyResponse: description: CreateNodesSingleTermproxyResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleVncwebsocketResponse: description: GetNodesSingleVncwebsocketResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: port: type: string description: "" CreateNodesSingleSpiceshellResponse: description: CreateNodesSingleSpiceshellResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: >- Returned values can be directly passed to the 'remote-viewer' application. GetNodesSingleDnsResponse: description: GetNodesSingleDnsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: dns1: type: string description: First name server IP address. dns2: type: string description: Second name server IP address. dns3: type: string description: Third name server IP address. search: type: string description: Search domain for host-name lookup. UpdateNodesSingleDnsResponse: description: UpdateNodesSingleDnsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleTimeResponse: description: GetNodesSingleTimeResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: localtime: type: int64 description: "Seconds since 1970-01-01 00:00:00 (local time)" time: type: int64 description: "Seconds since 1970-01-01 00:00:00 UTC." timezone: type: string description: Time zone UpdateNodesSingleTimeResponse: description: UpdateNodesSingleTimeResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleAplinfoResponse: description: GetNodesSingleAplinfoResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: {} CreateNodesSingleAplinfoResponse: description: CreateNodesSingleAplinfoResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleQueryocirepotagsResponse: description: GetNodesSingleQueryocirepotagsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: string description: "" GetNodesSingleQueryurlmetadataResponse: description: GetNodesSingleQueryurlmetadataResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: filename: type: string description: "" mimetype: type: string description: "" size: type: int64 description: "" GetNodesSingleReportResponse: description: GetNodesSingleReportResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" CreateNodesSingleStartallResponse: description: CreateNodesSingleStartallResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" CreateNodesSingleStopallResponse: description: CreateNodesSingleStopallResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" CreateNodesSingleSuspendallResponse: description: CreateNodesSingleSuspendallResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" CreateNodesSingleMigrateallResponse: description: CreateNodesSingleMigrateallResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetNodesSingleHostsResponse: description: GetNodesSingleHostsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: data: type: string description: The content of /etc/hosts. digest: type: string description: >- Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. CreateNodesSingleHostsResponse: description: CreateNodesSingleHostsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetStorageResponse: description: GetStorageResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: storage: type: string description: "" CreateStorageResponse: description: CreateStorageResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: config: type: object description: >- Partial, possibly server generated, configuration properties. properties: encryption-key: type: string description: "The, possibly auto-generated, encryption-key." storage: type: string description: The ID of the created storage. type: type: string description: The type of the created storage. DeleteStorageSingleResponse: description: DeleteStorageSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetStorageSingleResponse: description: GetStorageSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" UpdateStorageSingleResponse: description: UpdateStorageSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: config: type: object description: >- Partial, possibly server generated, configuration properties. properties: encryption-key: type: string description: "The, possibly auto-generated, encryption-key." storage: type: string description: The ID of the created storage. type: type: string description: The type of the created storage. GetAccessResponse: description: GetAccessResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: subdir: type: string description: "" GetAccessUsersResponse: description: GetAccessUsersResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: comment: type: string description: "" email: type: string description: "" enable: type: int64 description: >- Enable the account (default). You can set this to '0' to disable the account expire: type: int64 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: "" realm-type: type: string description: The type of the users realm tfa-locked-until: type: int64 description: >- Contains a timestamp until when a user is locked out of 2nd factors. tokens: type: array description: "" items: type: object description: "" properties: comment: type: string description: "" expire: type: int64 description: >- API token expiration date (seconds since epoch). '0' means no expiration date. privsep: type: int64 description: >- Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user. tokenid: type: string description: User-specific token identifier. totp-locked: type: int64 description: >- True if the user is currently locked out of TOTP factors. userid: type: string description: "Full User ID, in the `name@realm` format." CreateAccessUsersResponse: description: CreateAccessUsersResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteAccessUsersSingleResponse: description: DeleteAccessUsersSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetAccessUsersSingleResponse: description: GetAccessUsersSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: comment: type: string description: "" email: type: string description: "" enable: type: int64 description: >- Enable the account (default). You can set this to '0' to disable the account expire: type: int64 description: >- Account expiration date (seconds since epoch). '0' means no expiration date. firstname: type: string description: "" groups: type: array description: "" items: type: string description: "" keys: type: string description: Keys for two factor auth (yubico). lastname: type: string description: "" tokens: type: object description: "" UpdateAccessUsersSingleResponse: description: UpdateAccessUsersSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetAccessUsersSingleTfaResponse: description: GetAccessUsersSingleTfaResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: realm: type: string description: "The type of TFA the users realm has set, if any." types: type: array description: >- Array of the user configured TFA types, if any. Only available if 'multiple' was not passed. items: type: string description: A TFA type. user: type: string description: >- The type of TFA the user has set, if any. Only set if 'multiple' was not passed. UpdateAccessUsersSingleUnlocktfaResponse: description: UpdateAccessUsersSingleUnlocktfaResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: int64 description: "" GetAccessUsersSingleTokenResponse: description: GetAccessUsersSingleTokenResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: comment: type: string description: "" expire: type: int64 description: >- API token expiration date (seconds since epoch). '0' means no expiration date. privsep: type: int64 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: int64 description: >- API token expiration date (seconds since epoch). '0' means no expiration date. privsep: type: int64 description: >- Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user. CreateAccessUsersSingleTokenSingleResponse: description: CreateAccessUsersSingleTokenSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: full-tokenid: type: string description: The full token id. info: type: object description: "" properties: comment: type: string description: "" expire: type: int64 description: >- API token expiration date (seconds since epoch). '0' means no expiration date. privsep: type: int64 description: >- Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user. value: type: string description: API token value used for authentication. UpdateAccessUsersSingleTokenSingleResponse: description: UpdateAccessUsersSingleTokenSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: Updated token information. properties: comment: type: string description: "" expire: type: int64 description: >- API token expiration date (seconds since epoch). '0' means no expiration date. privsep: type: int64 description: >- Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user. GetAccessGroupsResponse: description: GetAccessGroupsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: comment: type: string description: "" groupid: type: string description: "" users: type: string description: list of users which form this group CreateAccessGroupsResponse: description: CreateAccessGroupsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteAccessGroupsSingleResponse: description: DeleteAccessGroupsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetAccessGroupsSingleResponse: description: GetAccessGroupsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: comment: type: string description: "" members: type: array description: "" items: type: string description: "Full User ID, in the `name@realm` format." 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: int64 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: int64 description: "" Datastore.AllocateSpace: type: int64 description: "" Datastore.AllocateTemplate: type: int64 description: "" Datastore.Audit: type: int64 description: "" Group.Allocate: type: int64 description: "" Mapping.Audit: type: int64 description: "" Mapping.Modify: type: int64 description: "" Mapping.Use: type: int64 description: "" Permissions.Modify: type: int64 description: "" Pool.Allocate: type: int64 description: "" Pool.Audit: type: int64 description: "" Realm.Allocate: type: int64 description: "" Realm.AllocateUser: type: int64 description: "" SDN.Allocate: type: int64 description: "" SDN.Audit: type: int64 description: "" SDN.Use: type: int64 description: "" Sys.AccessNetwork: type: int64 description: "" Sys.Audit: type: int64 description: "" Sys.Console: type: int64 description: "" Sys.Incoming: type: int64 description: "" Sys.Modify: type: int64 description: "" Sys.PowerMgmt: type: int64 description: "" Sys.Syslog: type: int64 description: "" User.Modify: type: int64 description: "" VM.Allocate: type: int64 description: "" VM.Audit: type: int64 description: "" VM.Backup: type: int64 description: "" VM.Clone: type: int64 description: "" VM.Config.CDROM: type: int64 description: "" VM.Config.CPU: type: int64 description: "" VM.Config.Cloudinit: type: int64 description: "" VM.Config.Disk: type: int64 description: "" VM.Config.HWType: type: int64 description: "" VM.Config.Memory: type: int64 description: "" VM.Config.Network: type: int64 description: "" VM.Config.Options: type: int64 description: "" VM.Console: type: int64 description: "" VM.GuestAgent.Audit: type: int64 description: "" VM.GuestAgent.FileRead: type: int64 description: "" VM.GuestAgent.FileSystemMgmt: type: int64 description: "" VM.GuestAgent.FileWrite: type: int64 description: "" VM.GuestAgent.Unrestricted: type: int64 description: "" VM.Migrate: type: int64 description: "" VM.PowerMgmt: type: int64 description: "" VM.Replicate: type: int64 description: "" VM.Snapshot: type: int64 description: "" VM.Snapshot.Rollback: type: int64 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: int64 description: Allow to propagate (inherit) permissions. roleid: type: string description: "" type: type: string description: "" ugid: type: string description: "" UpdateAccessAclResponse: description: UpdateAccessAclResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetAccessDomainsResponse: description: GetAccessDomainsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: comment: type: string description: >- A comment. The GUI use this text when you select a domain (Realm) on the login window. realm: type: string description: "" tfa: type: string description: Two-factor authentication provider. type: type: string description: "" CreateAccessDomainsResponse: description: CreateAccessDomainsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" DeleteAccessDomainsSingleResponse: description: DeleteAccessDomainsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetAccessDomainsSingleResponse: description: GetAccessDomainsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" UpdateAccessDomainsSingleResponse: description: UpdateAccessDomainsSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" CreateAccessDomainsSingleSyncResponse: description: CreateAccessDomainsSingleSyncResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: Worker Task-UPID GetAccessOpenidResponse: description: GetAccessOpenidResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: "" items: type: object description: "" properties: subdir: type: string description: "" CreateAccessOpenidAuthurlResponse: description: CreateAccessOpenidAuthurlResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: Redirection URL. CreateAccessOpenidLoginResponse: description: CreateAccessOpenidLoginResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetAccessTfaResponse: description: GetAccessTfaResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: The list tuples of user and TFA entries. items: type: object description: "" properties: entries: type: array description: "" items: type: object description: TFA Entry. properties: created: type: int64 description: Creation time of this entry as unix epoch. description: type: string description: User chosen description for this entry. enable: type: int64 description: Whether this TFA entry is currently enabled. id: type: string description: The id used to reference this entry. type: type: string description: TFA Entry Type. tfa-locked-until: type: int64 description: >- Contains a timestamp until when a user is locked out of 2nd factors. totp-locked: type: int64 description: >- True if the user is currently locked out of TOTP factors. userid: type: string description: User this entry belongs to. GetAccessTfaSingleResponse: description: GetAccessTfaSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: array description: A list of the user's TFA entries. items: type: object description: TFA Entry. properties: created: type: int64 description: Creation time of this entry as unix epoch. description: type: string description: User chosen description for this entry. enable: type: int64 description: Whether this TFA entry is currently enabled. id: type: string description: The id used to reference this entry. type: type: string description: TFA Entry Type. CreateAccessTfaSingleResponse: description: CreateAccessTfaSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: challenge: type: string description: >- When adding u2f entries, this contains a challenge the user must respond to in order to finish the registration. id: type: string description: The id of a newly added TFA entry. recovery: type: array description: >- When adding recovery codes, this contains the list of codes to be displayed to the user items: type: string description: A recovery entry. DeleteAccessTfaSingleSingleResponse: description: DeleteAccessTfaSingleSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetAccessTfaSingleSingleResponse: description: GetAccessTfaSingleSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: TFA Entry. properties: created: type: int64 description: Creation time of this entry as unix epoch. description: type: string description: User chosen description for this entry. enable: type: int64 description: Whether this TFA entry is currently enabled. id: type: string description: The id used to reference this entry. type: type: string description: TFA Entry Type. UpdateAccessTfaSingleSingleResponse: description: UpdateAccessTfaSingleSingleResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" 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: "" CreateAccessVncticketResponse: description: CreateAccessVncticketResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" UpdateAccessPasswordResponse: description: UpdateAccessPasswordResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string 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"). DeletePoolsResponse: description: DeletePoolsResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" 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: 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: int64 description: "" poolid: type: string description: "" CreatePoolResponse: description: CreatePoolResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" UpdatePoolsResponse: description: UpdatePoolsResponse 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: int64 description: "" UpdatePoolResponse: description: UpdatePoolResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: string description: "" GetVersionResponse: description: GetVersionResponse content: application/json: schema: type: object properties: errors: type: array items: type: string data: type: object description: "" properties: console: type: string description: The default console viewer to use. release: type: string description: The current Proxmox VE point release in `x.y` format. repoid: type: string description: The short git revision from which this version was build. version: type: string description: The full pve-manager package version of this node.