openapi.json

{"openapi":"3.0.0","info":{"title":"Scale Computing HyperCore API","description":"API for command, control, and automation of a system running Scale Computing HyperCore\n\n#### Legend  \nFields marked with _**DEPRECATED**_ or _**INTERNAL**_ should not be used and may cause unintended side effects.  \nFields marked with _**CREATE-ONLY**_ cannot be modified after creation.  \n<a href=\"/rest/v1/openapi.json\" target=\"_blank\">OpenAPI Specification  Full JSON Schema</a>  \n<a href=\"https://github.com/ScaleComputing/RestAPIExamples\" target=\"_blank\">Scale Computing RestAPI Examples</a>","version":"1.1.0"},"servers":[{"url":"/rest/v1","description":"Node endpoint"}],"components":{"schemas":{"TaskTag":{"description":"Unique identifier of _TaskTagStatus_ and parent identifier of _TaskStatus_","type":"string"},"TaskState":{"description":"State of a _TaskStatus_ and _TaskTagStatus_\nName | Description\n- | -\nUNINITIALIZED | Task hasn't been initialized or is not present *\n | \nQUEUED | Waiting to run\n | \nRUNNING | Running\n | \nCOMPLETE | Completed successfully\n | \nERROR | Failed to complete successfully\n | ","type":"string","enum":["UNINITIALIZED","QUEUED","RUNNING","COMPLETE","ERROR"]},"TaskTagStatus":{"title":"TaskTagStatus","type":"object","properties":{"taskTag":{"$ref":"#/components/schemas/TaskTag"},"progressPercent":{"description":"Task group completion percentage (0-100) ","type":"integer","readOnly":true},"state":{"$ref":"#/components/schemas/TaskState"},"formattedDescription":{"description":"Human-readable description with format parameters specified in _TaskTagStatus.descriptionParameters_ ","type":"string","readOnly":true},"descriptionParameters":{"description":"Substitution values used in _TaskTagStatus.formattedDescription_ ","type":"array","items":{"type":"string"},"readOnly":true},"formattedMessage":{"description":"Human-readable description with format parameters specified in _TaskTagStatus.messageParameters_ ","type":"string","readOnly":true},"messageParameters":{"description":"Substitution values used in _TaskTagStatus.formattedMessage_ ","type":"array","items":{"type":"string"},"readOnly":true},"objectUUID":{"description":"Unique identifier of object tasks were generated for (could be empty) ","type":"string","readOnly":true},"created":{"description":"Unix timestamp of when top-level task was created ","type":"integer","readOnly":true},"modified":{"description":"Unix timestamp of when top-level task was modified ","type":"integer","readOnly":true},"completed":{"description":"Unix timestamp of when top-level task completed ","type":"integer","readOnly":true},"sessionID":{"description":"Unique identifier of the authenticated session for the _User_ initiating the task ","type":"string","readOnly":true},"nodeUUIDs":{"description":"Unique identifiers of the _Node_ instances where tasks are running ","type":"array","items":{"type":"string"},"readOnly":true}}},"AlertSMTPConfig":{"title":"AlertSMTPConfig","type":"object","properties":{"uuid":{"description":"Unique identifier ","type":"string","readOnly":true},"smtpServer":{"description":"IP address or hostname of the SMTP server ","type":"string"},"port":{"description":"TCP port of the SMTP server ","type":"integer"},"useSSL":{"description":"Enable SSL encryption","type":"boolean"},"useAuth":{"description":"Enable authentication with _AlertSMTPConfig.authUser_ and _AlertSMTPConfig.authPassword_","type":"boolean"},"authUser":{"description":"Username for authentication if _AlertSMTPConfig.useAuth_ is true","type":"string"},"authPassword":{"description":"Password for authentication if _AlertSMTPConfig.useAuth_ is true","type":"string"},"latestTaskTag":{"$ref":"#/components/schemas/TaskTagStatus"},"fromAddress":{"description":"Email address the system alerts will be sent from","type":"string"}},"required":["smtpServer","port"]},"Result":{"title":"Result","type":"object","properties":{"taskTag":{"$ref":"#/components/schemas/TaskTag"},"createdUUID":{"description":"Unique identifier of object created. ","type":"string","readOnly":true}}},"AlertEmailTarget":{"title":"AlertEmailTarget","type":"object","properties":{"uuid":{"description":"Unique identifer ","type":"string","readOnly":true},"alertTagUUID":{"description":"Unique identifier for an _AlertTag_ _**INTERNAL**_","type":"string"},"emailAddress":{"description":"Email address of the alert recipient ","type":"string"},"resendDelay":{"description":"Alert resend delay in seconds","type":"integer"},"silentPeriod":{"description":"Alerts will not resend if there are additional event triggers within this time in seconds","type":"integer"},"latestTaskTag":{"$ref":"#/components/schemas/TaskTagStatus"}},"required":["emailAddress"]},"SyslogProtocol":{"description":"Network protocol used to send syslog alerts\nName | Description\n- | -\nSYSLOG_PROTOCOL_UDP | Rsyslog default UDP port 514\n | \nSYSLOG_PROTOCOL_TCP | Rsyslog TCP port 514 for reliable transfer\n | ","type":"string","enum":["SYSLOG_PROTOCOL_UDP","SYSLOG_PROTOCOL_TCP"]},"AlertSyslogTarget":{"title":"AlertSyslogTarget","type":"object","properties":{"uuid":{"description":"Unique identifer ","type":"string","readOnly":true},"alertTagUUID":{"description":"Unique identifier for an _AlertTag_ _**INTERNAL**_","type":"string"},"host":{"description":"IP address or hostname of the syslog server ","type":"string"},"port":{"description":"Network port of the syslog server","type":"integer"},"protocol":{"$ref":"#/components/schemas/SyslogProtocol"},"latestTaskTag":{"$ref":"#/components/schemas/TaskTagStatus"},"resendDelay":{"description":"Alert resend delay in seconds","type":"integer"},"silentPeriod":{"description":"Alerts will not resend if there are additional event triggers within this time in seconds","type":"integer"}},"required":["host"]},"Cluster":{"title":"Cluster","type":"object","properties":{"uuid":{"description":"Unique identifier ","type":"string","readOnly":true},"filesystemID":{"description":"ID assigned by the clustered filesystem ","type":"string","readOnly":true},"clusterName":{"description":"Human-readable assigned name to the system. Must be a valid hostname (see RFC 952 and RFC 1123)","type":"string"},"icosVersion":{"description":"The version number of the firmware. Represented as majorVersion.minorVersion.revision.buildID _IcosUpdate_ ","type":"string","readOnly":true},"latestTaskTag":{"$ref":"#/components/schemas/TaskTagStatus"},"brand":{"description":"OEM specific brand marker ","type":"string","readOnly":true},"isRESTAPIEnabled":{"description":"_**DEPRECATED**_","type":"boolean"}}},"SeverityLevel":{"description":"\nName | Description\n- | -\nEMERGENCY | \n | \nALERT | \n | \nCRITICAL | \n | \nERROR | \n | \nWARNING | \n | \nNOTICE | \n | \nINFO | \n | \nDEBUG | \n | ","type":"string","enum":["EMERGENCY","ALERT","CRITICAL","ERROR","WARNING","NOTICE","INFO","DEBUG"]},"Condition":{"title":"Condition","type":"object","properties":{"name":{"description":"The unique name of the condition. ","type":"string","readOnly":true},"description":{"description":"A description of the condition which is presentable to the end-user. ","type":"string","readOnly":true},"value":{"description":"The boolean value of the condition.  \n True indicates the condition is currently SET.  \n False indicates the condition is currently CLEAR.  \n NOTE:  If the isOK bool is false, this value MUST be ignored. ","type":"boolean","readOnly":true},"nodeUUID":{"description":"The UUID of the node this condition refers to. ","type":"string","readOnly":true},"nodeLANIP":{"description":"The LAN IP address of the node this condition refers to. ","type":"string","readOnly":true},"modified":{"description":"The time at which this conditions value was last modified, in milliseconds of real time since the UNIX epoch. ","type":"integer","readOnly":true},"userVisible":{"description":"Indicates whether this condition should be made visible to the end user ","type":"boolean","readOnly":true},"techNotes":{"description":"Details targeted towards Scale Support team ","type":"string","readOnly":true},"pollInterval":{"description":"The interval with which the condition is being polled, in milliseconds. ","type":"integer","readOnly":true},"expirationInterval":{"description":"Given no successful polls, this is the interval after which the condition will expire, in milliseconds. ","type":"integer","readOnly":true},"setDelay":{"description":"The interval in milliseconds between the decision function first returning true and when the condition will become SET. ","type":"integer","readOnly":true},"clearDelay":{"description":"The interval in milliseconds between the decision function first returning false and when the condition becoming CLEAR. ","type":"integer","readOnly":true},"lastSetTime":{"description":"The time at which the condition last transitioned from CLEAR to SET, in realtime milliseconds from the UNIX epoch. ","type":"integer","readOnly":true},"lastClearTime":{"description":"The time at which the condition last transitioned from SET to CLEAR, in realtime milliseconds from the UNIX epoch. ","type":"integer","readOnly":true},"guaranteedValidTime":{"description":"The time at which the condition was guaranteed to be valid, in realtime milliseconds from the UNIX epoch. ","type":"integer","readOnly":true},"isExpired":{"description":"Indicates whether the condition has expired. ","type":"boolean","readOnly":true},"lastPollFailed":{"description":"Indicates whether the last poll for the condition has failed. ","type":"boolean","readOnly":true},"isInitialized":{"description":"Indicates whether the condition has ever been initialized. ","type":"boolean","readOnly":true},"isOK":{"description":"The state of the condition in summary. A value of true implies the condition is not expired,  \n the last poll has not failed, and the condition has been initialized. ","type":"boolean","readOnly":true},"nodeBackplaneIP":{"description":"Backplane IP address of the _Node_ this condition refers to. ","type":"string","readOnly":true},"severity":{"$ref":"#/components/schemas/SeverityLevel"},"tags":{"description":"The list of tags a condition is associated with","type":"array","items":{"type":"string"}}}},"NucleusKey":{"title":"NucleusKey","type":"object","properties":{"uuid":{"type":"string"},"value":{"type":"string"}}},"DNSConfig":{"title":"DNSConfig","type":"object","properties":{"uuid":{"description":"Unique identifer ","type":"string","readOnly":true},"searchDomains":{"description":"Domain search list used to resolve fully qualified domain names","type":"array","items":{"type":"string"}},"serverIPs":{"description":"IP address or hostname of DNS servers ","type":"array","items":{"type":"string"}},"latestTaskTag":{"$ref":"#/components/schemas/TaskTagStatus"}},"required":["serverIPs"]},"DriveType":{"description":"\nName | Description\n- | -\nUNKNOWN | \n | \nSATA | \n | \nSAS | \n | \nVIRTUAL | \n | \nSSD | \n | ","type":"string","enum":["UNKNOWN","SATA","SAS","VIRTUAL","SSD"]},"DriveDisposition":{"description":"\nName | Description\n- | -\nUNKNOWN | \n | \nIN | \n | \nOUT | \n | ","type":"string","enum":["UNKNOWN","IN","OUT"]},"FileSystemDisk":{"title":"FileSystemDisk","type":"object","properties":{"fsName":{"type":"string"},"driveUUID":{"type":"string"},"availability":{"type":"string"},"state":{"type":"string"},"isReachable":{"type":"boolean"},"capacityBytes":{"type":"integer"},"usedBytes":{"type":"integer"}}},"Drive":{"title":"Drive","type":"object","properties":{"uuid":{"type":"string"},"slot":{"type":"integer"},"serialNumber":{"type":"string"},"type":{"$ref":"#/components/schemas/DriveType"},"nodeUUID":{"type":"string"},"desiredDisposition":{"$ref":"#/components/schemas/DriveDisposition"},"currentDisposition":{"$ref":"#/components/schemas/DriveDisposition"},"capacityBytes":{"type":"integer"},"usedBytes":{"type":"integer"},"disks":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/FileSystemDisk"}},"isHealthy":{"type":"boolean"},"reallocatedSectors":{"type":"integer"},"errorCount":{"type":"integer"},"blockDevicePath":{"type":"string"},"hasTemperature":{"type":"boolean"},"temperature":{"type":"integer"},"hasMaxTemperature":{"type":"boolean"},"maxTemperature":{"type":"integer"},"hasTemperatureThreshold":{"type":"boolean"},"temperatureThreshold":{"type":"integer"}}},"GPUProfile":{"title":"GPUProfile","type":"object","properties":{"name":{"description":"Name of the profile ","type":"string","readOnly":true},"maxInstances":{"description":"Maximum number of vGPU profile instances available for VMs ","type":"integer","readOnly":true}}},"GPU":{"title":"GPU","type":"object","properties":{"uuid":{"description":"Unique Identifier ","type":"string","readOnly":true},"nodeUUID":{"description":"Unique identifier of the node the card is slotted in ","type":"string","readOnly":true},"profile":{"$ref":"#/components/schemas/GPUProfile"},"availableInstances":{"description":"The remaining number of profile instances this GPU can provide to VMs ","type":"integer","readOnly":true}}},"IcosUpdate":{"title":"IcosUpdate","type":"object","properties":{"uuid":{"description":"Unique identifier   \n Format is majorVersion.minorVersion.revision.buildID","type":"string","readOnly":true},"description":{"description":"Human-readable name for the update ","type":"string","readOnly":true},"changeLog":{"description":"Description of all changes that are in this update, in HTML format ","type":"string","readOnly":true},"buildID":{"description":"ID of the build which corresponds to this update ","type":"integer","readOnly":true},"majorVersion":{"description":"Major version number ","type":"integer","readOnly":true},"minorVersion":{"description":"Minor version number ","type":"integer","readOnly":true},"revision":{"description":"Revision number ","type":"integer","readOnly":true},"timestamp":{"description":"Unix timestamp when the update was released ","type":"integer","readOnly":true}}},"ISOMount":{"title":"ISOMount","type":"object","properties":{"vmUUID":{"description":"_VirDomain.uuid_","type":"string"},"vmName":{"description":"_VirDomain.name_","type":"string"}}},"ISO":{"title":"ISO","type":"object","properties":{"uuid":{"description":"Unique identifier ","type":"string","readOnly":true},"name":{"description":"Filename of the image, must end in \".iso\" ","type":"string"},"size":{"description":"Size of the ISO file, in bytes _**CREATE-ONLY**_ ","type":"integer"},"mounts":{"description":"VMs this image is attached to ","type":"array","items":{"$ref":"#/components/schemas/ISOMount"},"readOnly":true},"readyForInsert":{"description":"Set this to true ( _ISOUpdate_ ) only after all data has been copied over ( _ISOUpload_ ) ","type":"boolean"},"path":{"description":"Storage device used in conjunction with _VirDomainBlockDevice.path_ ","type":"string","readOnly":true}},"required":["name","readyForInsert"]},"MonitoringPublisher":{"title":"MonitoringPublisher","type":"object","properties":{"name":{"type":"string"}}},"MonitoringSubscriber":{"title":"MonitoringSubscriber","type":"object","properties":{"host":{"type":"string"},"port":{"type":"integer"},"type":{"type":"string"},"db":{"type":"string"},"user":{"type":"string"},"password":{"type":"string"},"sslMode":{"type":"string"},"writer":{"type":"string"},"commitInterval":{"type":"integer"},"CACert":{"type":"string"},"certificateFile":{"type":"string"},"certificateKeyFile":{"type":"string"}}},"MonitoringConfig":{"title":"MonitoringConfig","type":"object","properties":{"uuid":{"description":"Unique identifer ","type":"string","readOnly":true},"clusterName":{"type":"string"},"interval":{"type":"integer","default":60},"publishers":{"type":"array","items":{"$ref":"#/components/schemas/MonitoringPublisher"}},"subscribers":{"type":"array","items":{"$ref":"#/components/schemas/MonitoringSubscriber"}},"latestTaskTag":{"$ref":"#/components/schemas/TaskTagStatus"}}},"NodeNetworkStatus":{"description":"Status of a node's network connection\nName | Description\n- | -\nONLINE | Online and communicating\n | \nOFFLINE | Not connected to the network\n | \nUNKNOWN | Status cannot be determined\n | ","type":"string","enum":["ONLINE","OFFLINE","UNKNOWN"]},"NodeDisposition":{"description":"\nName | Description\n- | -\nIN | \n | \nEVACUATED | \n | \nOUT | \n | \nUNKNOWN | \n | ","type":"string","enum":["IN","EVACUATED","OUT","UNKNOWN"]},"Node":{"title":"Node","type":"object","properties":{"uuid":{"description":"Unique identifier ","type":"string","readOnly":true},"backplaneIP":{"description":"IP address on the backplane network ","type":"string","readOnly":true},"lanIP":{"description":"IP address on the LAN network ","type":"string","readOnly":true},"configState":{"description":"Current configuration state _**INTERNAL**_ ","type":"integer","readOnly":true},"activeVersion":{"description":"Version of the configuration currently active _**INTERNAL**_ ","type":"integer","readOnly":true},"capacity":{"description":"Storage capacity, in bytes ","type":"integer","readOnly":true},"drives":{"description":"Drives currently attached to the node ","type":"array","items":{"$ref":"#/components/schemas/Drive"},"readOnly":true},"vips":{"description":"_**DEPRECATED**_","type":"array","items":{"type":"string"}},"memSize":{"description":"Amount of memory installed, in bytes ","type":"integer","readOnly":true},"numCPUs":{"description":"Number of CPUs installed ","type":"integer","readOnly":true},"CPUhz":{"description":"Clock frequency of the CPUs, in Hertz ","type":"integer","readOnly":true},"numNUMANodes":{"description":"Number of non-uniform-memory-access nodes ","type":"integer","readOnly":true},"numSockets":{"description":"Number of CPU sockets ","type":"integer","readOnly":true},"numCores":{"description":"Number of CPU cores ","type":"integer","readOnly":true},"numThreads":{"description":"Number of hardware threads (hyperthreads) ","type":"integer","readOnly":true},"networkStatus":{"$ref":"#/components/schemas/NodeNetworkStatus"},"supportsVirtualization":{"description":"Supports virtualization","type":"boolean"},"virtualizationOnline":{"description":"Ready to accept and start vms ","type":"boolean","readOnly":true},"pairedNodeUUID":{"description":"_**DEPRECATED**_","type":"string"},"scribeInstanceName":{"description":"Associated Scribe instance's name ","type":"string","readOnly":true},"peerID":{"description":"Cluster map peer identifier ","type":"integer","readOnly":true},"numSlots":{"description":"Number of physical drive slots ","type":"integer","readOnly":true},"systemMemUsageBytes":{"description":"Total system memory being used (not including VMs), in bytes ","type":"integer","readOnly":true},"memUsagePercentage":{"description":"Percentage of total memory being used (0-100) ","type":"number","readOnly":true},"gpus":{"description":"GPU devices attached to the node ","type":"array","items":{"$ref":"#/components/schemas/GPU"},"readOnly":true},"currentDisposition":{"$ref":"#/components/schemas/NodeDisposition"},"desiredDisposition":{"$ref":"#/components/schemas/NodeDisposition"},"cpuUsage":{"description":"Percentage of Node CPU Usage","type":"number"},"totalMemUsageBytes":{"description":"Total Memory used in bytes (System and VM)","type":"integer"},"allowRunningVMs":{"description":"VMs can start and migrate to this node. When set to false, any running VMs are evacuated to other nodes and will be returned when set back to true","type":"boolean","default":true}}},"OIDCConfig":{"title":"OIDCConfig","type":"object","properties":{"uuid":{"description":"Unique identifer ","type":"string","readOnly":true},"clientID":{"description":"Provided by authentication server when configuring a new client","type":"string"},"sharedSecret":{"description":"Provided by authentication server for client authentication ","type":"string","writeOnly":true},"certificate":{"description":"Plain text of the X.509 PEM-encode certificate","type":"string"},"configurationURL":{"description":"The OpenID Connect Provider Configuration Information endpoint ","type":"string"},"scopes":{"description":"Scopes required to obtain necessary claims ","type":"string"},"authorizationURL":{"description":"The OpenID Connect Provider Authorization endpoint ","type":"string","readOnly":true},"tokenURL":{"description":"The OpenID Connect Provider Token Endpoint ","type":"string","readOnly":true},"logoutURL":{"description":"The OpenID Connect Provider End Session Endpoint ","type":"string","readOnly":true}},"required":["configurationURL","scopes"]},"ClusterRegistrationData":{"title":"ClusterRegistrationData","type":"object","properties":{"xmlToSubmit":{"description":"Server generated xml data to submit to registration system ","type":"string","readOnly":true},"clusterID":{"description":"Server generated clusterID to submit to registration system ","type":"string","readOnly":true}}},"Registration":{"title":"Registration","type":"object","properties":{"uuid":{"description":"Unique identifer ","type":"string","readOnly":true},"companyName":{"description":"Name of the company registering the cluster","type":"string"},"contact":{"description":"Name of the person registering the cluster","type":"string"},"phone":{"description":"Phone number for company contact","type":"string"},"email":{"description":"Email address for company contact","type":"string"},"latestTaskTag":{"$ref":"#/components/schemas/TaskTagStatus"},"clusterID":{"description":"Unique identifer for cluster ","type":"string","readOnly":true},"clusterData":{"description":"Server generated xml data about a system ","type":"string","readOnly":true},"clusterDataHash":{"description":"Server generated hash of xml data ","type":"string","readOnly":true},"clusterDataHashAccepted":{"description":"Last successfully submitted registration data hash ","type":"string","readOnly":true}}},"RemoteClusterAuthInfo":{"title":"RemoteClusterAuthInfo","type":"object","properties":{"ipAddress":{"description":"Ip address where we need to perform the auth WO*","type":"string"},"sessionID":{"description":"The sessionID to use when communicating with ipAddress *","type":"string"},"username":{"description":"If sessionID is not provided, use username and password to create session *","type":"string"},"password":{"description":"If sessionID is not provided, use username and password to create session *","type":"string"},"associatedConnectionUUID":{"description":"If there is an associated connectionUUID from the remote side *","type":"string"},"connectionTimeoutSeconds":{"description":"Timeout to use to keep trying to establish connection *","type":"integer"},"secureConnection":{"description":"Bool to indicate if we want a secure communication channel *","type":"boolean","default":true},"receiveTimeoutSeconds":{"description":"Time we can be in recv before connection is considered dead *","type":"integer","default":0}}},"RemoteClusterConnectionStatus":{"description":"\nName | Description\n- | -\nUNKNOWN | \n | \nINITIALIZING | \n | \nESTABLISHED | \n | \nDISCONNECTED | \n | \nDELETING | \n | \nUPDATING | \n | ","type":"string","enum":["UNKNOWN","INITIALIZING","ESTABLISHED","DISCONNECTED","DELETING","UPDATING"]},"RemoteClusterConnectionSecurePortStatus":{"description":"\nName | Description\n- | -\nUNKNOWN | \n | \nINITIALIZING | \n | \nOPEN | \n | \nCLOSED | \n | \nDELETING | \n | ","type":"string","enum":["UNKNOWN","INITIALIZING","OPEN","CLOSED","DELETING"]},"RemoteClusterConnectionSecurePort":{"title":"RemoteClusterConnectionSecurePort","type":"object","properties":{"portNumber":{"description":"port number RW *","type":"integer"},"portStatus":{"$ref":"#/components/schemas/RemoteClusterConnectionSecurePortStatus"},"remotePortAvailable":{"description":"indicates whether port on remote cluster has been created already RW*","type":"boolean","default":false},"compression":{"description":"indicates compression is enabled *","type":"boolean"}}},"RemoteConnectionState":{"description":"\nName | Description\n- | -\nAVAILABLE | \n | \nUNAVAILABLE | \n | ","type":"string","enum":["AVAILABLE","UNAVAILABLE"]},"RemoteClusterConnectionSecureMapping":{"title":"RemoteClusterConnectionSecureMapping","type":"object","properties":{"targetIP":{"description":"The target cluster node ip *","type":"string"},"targetPort":{"description":"The target cluster port *","type":"integer"},"mappedIP":{"description":"The mapped IP for the targetIP *","type":"string"},"mappedPort":{"description":"The mapped port for the targetPort *","type":"integer"},"state":{"$ref":"#/components/schemas/RemoteConnectionState"}}},"RemoteClusterConnectionCreateOptions":{"title":"RemoteClusterConnectionCreateOptions","type":"object","properties":{"cleanupOnFailure":{"type":"boolean","default":true}}},"RemoteClusterConnection":{"title":"RemoteClusterConnection","type":"object","properties":{"uuid":{"description":"The uuid associated with this connection  *","type":"string","readOnly":true},"label":{"description":"Descriptive label _**INTERNAL**_ *","type":"string"},"authInfo":{"$ref":"#/components/schemas/RemoteClusterAuthInfo"},"connectionStatus":{"$ref":"#/components/schemas/RemoteClusterConnectionStatus"},"remoteClusterInfo":{"$ref":"#/components/schemas/Cluster"},"remoteNodeIPs":{"description":"The ipAddresses of the remote nodes   *","type":"array","items":{"type":"string"},"readOnly":true},"securePorts":{"description":"If secureConnection option is used, then these are the list of secure ports _**INTERNAL**_  *","type":"array","items":{"$ref":"#/components/schemas/RemoteClusterConnectionSecurePort"}},"secureMappings":{"description":"If secureConnection option is used, these are the mappings to use to connect _**INTERNAL**_ *","type":"array","items":{"$ref":"#/components/schemas/RemoteClusterConnectionSecureMapping"}},"remoteNodeConnectionStates":{"description":"The states of the remote connections  *","type":"array","items":{"$ref":"#/components/schemas/RemoteConnectionState"},"readOnly":true},"compression":{"description":"indicates if compression is enabled _**INTERNAL**_ *","type":"boolean"},"remoteNodeUUIDs":{"description":"The uuids of the the remote nodes  *","type":"array","items":{"type":"string"},"readOnly":true},"createOptions":{"$ref":"#/components/schemas/RemoteClusterConnectionCreateOptions"},"replicationOK":{"description":"Indicates if the remote system is able to accept additional replication work  *","type":"boolean","default":true,"readOnly":true}}},"TimeSource":{"title":"TimeSource","type":"object","properties":{"uuid":{"description":"Unique identifer ","type":"string","readOnly":true},"host":{"description":"IP address or hostname of the time source server ","type":"string"},"latestTaskTag":{"$ref":"#/components/schemas/TaskTagStatus"}},"required":["host"]},"TimeZone":{"title":"TimeZone","type":"object","properties":{"uuid":{"description":"Unique identifer ","type":"string","readOnly":true},"timeZone":{"description":"Time zone ","type":"string"},"latestTaskTag":{"$ref":"#/components/schemas/TaskTagStatus"}},"required":["timeZone"]},"User":{"title":"User","type":"object","properties":{"uuid":{"description":"Unique identifer ","type":"string","readOnly":true},"username":{"description":"Human-readable unique identifier for authentication ","type":"string"},"password":{"description":"Plain text password for authentication ","type":"string","writeOnly":true},"fullName":{"description":"Human-readable display name","type":"string"},"roleUUIDs":{"description":"_Role_ identifiers this user is a member of","type":"array","items":{"type":"string"}},"sessionLimit":{"description":"The maximum number of _Sessions_ this user may have at one time","type":"integer"}},"required":["username"]},"Permission":{"title":"Permission","type":"object","properties":{"functionName":{"description":"Scaled endpoint","type":"string"}}},"Role":{"title":"Role","type":"object","properties":{"uuid":{"description":"Unique identifier ","type":"string","readOnly":true},"name":{"description":"Human-readable unique name","type":"string"},"description":{"description":"Human-readable description","type":"string"},"permissions":{"description":"Permissions granted to a _User_","type":"array","items":{"$ref":"#/components/schemas/Permission"}},"oidcName":{"description":"External identifier configured in Authentication Server","type":"string"}}},"VirDomainState":{"description":"Current state of a VM\nName | Description\n- | -\nRUNNING | Currently running\n | \nBLOCKED | Blocked on a resource\n | \nPAUSED | Paused by the user\n | \nSHUTDOWN | Shutting down\n | \nSHUTOFF | Shut off\n | \nCRASHED | Crashed\n | ","type":"string","enum":["RUNNING","BLOCKED","PAUSED","SHUTDOWN","SHUTOFF","CRASHED"]},"VirDomainDisposition":{"description":"Desired state of a VM\nName | Description\n- | -\nSHUTOFF | Shut off\n | \nRUNNING | Currently running\n | \nPAUSED | Paused by the user\n | ","type":"string","enum":["SHUTOFF","RUNNING","PAUSED"]},"VirDomainConsoleType":{"description":"Protocol/System use to transmit console\nName | Description\n- | -\nVNC | 'Virtual Network Computing' remote display\n | ","type":"string","enum":["VNC"]},"VirDomainConsole":{"title":"VirDomainConsole","type":"object","properties":{"type":{"$ref":"#/components/schemas/VirDomainConsoleType"},"ip":{"description":"IP address (if applicable to the given console type)","type":"string"},"port":{"description":"port (if applicable to the given console type)","type":"integer"},"keymap":{"description":"keymap locale","type":"string","default":"en-us"}}},"VirDomainBlockDeviceType":{"description":"The bus type the VirDomainBlockDevice will use\nName | Description\n- | -\nIDE_DISK | IDE drive type, used for compatibility when VIRTIO drivers are not available\n | \nSCSI_DISK | VIRTIO SCSI bus type _**INTERNAL**_\n | \nVIRTIO_DISK | VIRTIO bus type\n | \nIDE_CDROM | IDE CD-ROM bus type\n | \nIDE_FLOPPY | IDE Floppy bus type, used to mount .vfd files _**DEPRECATED**_ _**INTERNAL**_\n | \nNVRAM | NVRAM type, used to mount NVRAM VSDs for VMs that use UEFI\n | \nVTPM | VTPM type, used to mount VSDs as an emulated Trusted Platform Module for VMs _**INTERNAL**_\n | ","type":"string","enum":["IDE_DISK","SCSI_DISK","VIRTIO_DISK","IDE_CDROM","IDE_FLOPPY","NVRAM","VTPM"]},"VirDomainBlockDeviceCacheMode":{"description":"The cache mode the VirDomainBlockDevice will use\nName | Description\n- | -\nNONE | Disabled cache mode\n | \nWRITEBACK | Read and Write cache mode\n | \nWRITETHROUGH | Synchronous Write and Read cache mode\n | ","type":"string","enum":["NONE","WRITEBACK","WRITETHROUGH"]},"VirDomainBlockDevice":{"title":"VirDomainBlockDevice","type":"object","properties":{"uuid":{"description":"Unique Identifier ","type":"string","readOnly":true},"virDomainUUID":{"description":"Identifier of the VirDomain this device is attached to _**CREATE-ONLY**_   \n This may be left blank if this block device is being created as part of a VirDomainCreate call","type":"string"},"type":{"$ref":"#/components/schemas/VirDomainBlockDeviceType"},"cacheMode":{"$ref":"#/components/schemas/VirDomainBlockDeviceCacheMode"},"capacity":{"description":"Logical size of the device in bytes, and can be increased on update or clone ","type":"integer"},"allocation":{"description":"Total amount of disk space in use in bytes ","type":"integer","readOnly":true},"physical":{"description":"Physical size of the backing virtual storage device in bytes ","type":"integer","readOnly":true},"shareUUID":{"description":"_**DEPRECATED**_ _**INTERNAL**_","type":"string"},"path":{"description":"Path to the backing storage device, in the format of scribe/uuid  \n UUID is either a VirDomainBlockDevice or ISO UUID  \n Only devices of type IDE_CDROM can have their path changed, and only to a valid ISO path","type":"string"},"slot":{"description":"Virtual slot the drive will occupy. For behavior _VirDomainBlockDeviceCreate._ _**CREATE-ONLY**_","type":"integer","default":-1},"name":{"description":"Name of the virtual storage device  \n Only devices of type IDE_CDROM can have their name changed, and must end in '.iso'","type":"string"},"disableSnapshotting":{"description":"Disables the ability to snapshot the drive","type":"boolean"},"tieringPriorityFactor":{"description":" * SSD tiering priority factor for block placement. Check the tiering documentation for best practices.  \n  * It is recommended to follow the Hypercore UI settings:  \n | UI Setting | Priority Factor Value |  \n | ---------- | --------------------- |  \n | 0          |                     0 |  \n | 1          |                     1 |  \n | 2          |                     2 |  \n | 3          |                     4 |  \n | 4          |           (default) 8 |  \n | 5          |                    16 |  \n | 6          |                    32 |  \n | 7          |                    64 |  \n | 8          |                   128 |  \n | 9          |                   256 |  \n | 10         |                  1024 |  \n | 11         |                 10240 |","type":"integer","default":8},"mountPoints":{"description":"Mount points of the drive in the guest OS, populated by the guest-agent ","type":"array","items":{"type":"string"},"readOnly":true},"createdTimestamp":{"description":"Unix timestamp of the drive's creation time  ","type":"integer","readOnly":true},"readOnly":{"description":"When true, this device was created via _VirDomainSnapshotBlockDeviceCreate_ with _VirDomainSnapshotBlockDeviceCreateOptions.readOnly_ ","type":"boolean","readOnly":true}},"required":["type","capacity"]},"VirDomainNetDeviceType":{"description":"Virtualized network device types  \n All types require drivers in the guest\nName | Description\n- | -\nRTL8139 | Emulate Realtek 8139. This is selected by kvm if no model is specified\n | \nINTEL_E1000 | Emulate Intel E1000. This is default, more-compatible option\n | \nVIRTIO | KVM VirtIO. Higher performance\n | \nPCNET | Emulate a PCNet NIC. This is provided for earlier Operating System support\n | ","type":"string","enum":["RTL8139","INTEL_E1000","VIRTIO","PCNET"]},"VirDomainNetDevice":{"title":"VirDomainNetDevice","type":"object","properties":{"uuid":{"description":"Unique identifier ","type":"string","readOnly":true},"virDomainUUID":{"description":"Unique identifier of the _VirDomain_ this device is attached to _**CREATE-ONLY**_  \n May be left blank if this net device is being created as part of _VirDomainCreate_","type":"string"},"type":{"$ref":"#/components/schemas/VirDomainNetDeviceType"},"macAddress":{"description":"MAC address of the virtual network device.  \n Leave blank for one to be generated","type":"string"},"vlan":{"description":"VLAN tag of the interface  \n Valid values are 0-4094  \n 0 is the default, and means bridged (sees all VLANs, including tagged traffic)","type":"integer","default":0},"connected":{"description":"Enabled and can make connections","type":"boolean","default":true},"ipv4Addresses":{"description":"IPv4 addresses registered with this device ","type":"array","items":{"type":"string"},"readOnly":true}}},"StatsSourceType":{"description":"Types of statistics available to various stat read calls\nName | Description\n- | -\nVIR_DOMAIN_CPU | 15 second decaying average of _VirDomain_ CPU usage, given in hundredths of a percent of total available\n | \nVIR_DOMAIN_MEM_CURRENT | Current _VirDomain_ RAM use, in bytes\n | \nVIR_DOMAIN_MEM_SWAPPED | Amount of _VirDomain_ RAM use which has been swapped to disk, in bytes\n | \nVIR_DOMAIN_NET | 15 second decaying average of a _VirDomain's_ total network throughput (in + out) given in bytes per second\n | \nVIR_DOMAIN_STOR | Total _VirDomain_ used storage, in bytes.\n | \nVIR_DOMAIN_UPTIME | System Uptime of the _VirDomain,_ in seconds. _StatsDatum.maxValue_ will be returned as zero.\n | ","type":"string","enum":["VIR_DOMAIN_CPU","VIR_DOMAIN_MEM_CURRENT","VIR_DOMAIN_MEM_SWAPPED","VIR_DOMAIN_NET","VIR_DOMAIN_STOR","VIR_DOMAIN_UPTIME"]},"StatsDatum":{"title":"StatsDatum","type":"object","properties":{"type":{"$ref":"#/components/schemas/StatsSourceType"},"currentValue":{"description":"Current value","type":"integer"},"maxValue":{"description":"Maximum value, or zero, if not applicable","type":"integer"}}},"StatsData":{"description":"Collection of individual stats","type":"array","items":{"$ref":"#/components/schemas/StatsDatum"}},"VirDomainUIState":{"description":"State or transition state of a VM\nName | Description\n- | -\nRUNNING | Currently running\n | \nBLOCKED | Blocked on a resource\n | \nPAUSED | Paused by the user\n | \nSHUTDOWN | Shutting down\n | \nSHUTOFF | Shut off\n | \nCRASHED | Crashed\n | \nSTARTING | Starting up\n | \nPAUSING | Pausing\n | \nSTOPPING | Stopping\n | \nMIGRATING | Migrating to another node\n | ","type":"string","enum":["RUNNING","BLOCKED","PAUSED","SHUTDOWN","SHUTOFF","CRASHED","STARTING","PAUSING","STOPPING","MIGRATING"]},"GuestAgentState":{"description":"_VirDomain_ in-guest agent availability state\nName | Description\n- | -\nUNKNOWN | state cannot be determined\n | \nUNAVAILABLE | Not running or cannot communicate\n | \nAVAILABLE | Running and communicating\n | ","type":"string","enum":["UNKNOWN","UNAVAILABLE","AVAILABLE"]},"VirDomainAffinityStrategy":{"title":"VirDomainAffinityStrategy","type":"object","properties":{"strictAffinity":{"description":"Enable or disable strict enforcement of affinity strategy. The VirDomain will only run on preferred or backup node.","type":"boolean"},"preferredNodeUUID":{"description":"Unique identifier of preferred node to run the VirDomain","type":"string"},"backupNodeUUID":{"description":"Unique identifier of backup node in the event that preferredNode is unavailable","type":"string"}}},"CloudInitData":{"title":"CloudInitData","type":"object","properties":{"userData":{"description":"Configuration user-data to be used by cloud-init (Linux) or cloudbase-init (Windows). When non-empty will create an extra _ISO_ device attached to _VirDomain_ as a NoCloud datasource.  \n NOTE: This must be base64 encoded and valid YAML syntax. ","type":"string"},"metaData":{"description":"Configuration meta-data to be used by cloud-init (Linux) or cloudbase-init (Windows). When non-empty will create an extra _ISO_ device attached to _VirDomain_ as a NoCloud datasource.  \n NOTE: This must be base64 encoded and valid YAML syntax. ","type":"string"}}},"VirDomain":{"title":"VirDomain","type":"object","properties":{"uuid":{"description":"Unique identifier ","type":"string","readOnly":true},"nodeUUID":{"description":"Unique identifier of the _Node_ this is currently hosted on ","type":"string","readOnly":true},"name":{"description":"Human-readable name","type":"string"},"description":{"description":"Human-readable description ","type":"string"},"operatingSystem":{"description":"Operating system name. Used to select drivers package","type":"string"},"state":{"$ref":"#/components/schemas/VirDomainState"},"desiredDisposition":{"$ref":"#/components/schemas/VirDomainDisposition"},"console":{"$ref":"#/components/schemas/VirDomainConsole"},"mem":{"description":"Amount of memory reserved, in bytes.  \n May only be modified if the domain is in the _VirDomainState.SHUTOFF_ or _VirDomainState.CRASHED_ states","type":"integer"},"numVCPU":{"description":"Number of allotted virtual CPUs.  \n May only be modified if the domain is in the SHUTOFF or CRASHED states","type":"integer"},"blockDevs":{"description":"Attached virtual block devices _**CREATE-ONLY**_  \n Use _VirDomainBlockDeviceCreate,_ _VirDomainBlockDeviceUpdate,_ or _VirDomainBlockDeviceDelete_","type":"array","items":{"$ref":"#/components/schemas/VirDomainBlockDevice"}},"netDevs":{"description":"Attached virtual network devices _**CREATE-ONLY**_  \n Use _VirDomainNetDeviceCreate,_ _VirDomainNetDeviceUpdate,_ or _VirDomainNetDeviceDelete_","type":"array","items":{"$ref":"#/components/schemas/VirDomainNetDevice"}},"deprecated_stats":{"$ref":"#/components/schemas/StatsData"},"created":{"description":"Unix timestamp of creation time ","type":"integer","readOnly":true},"modified":{"description":"Unix timestamp of Last modified time ","type":"integer","readOnly":true},"latestTaskTag":{"$ref":"#/components/schemas/TaskTagStatus"},"tags":{"description":"User-modifiable words for organizing a group of VMs. Multiple tags should be comma-separated.","type":"string"},"bootDevices":{"description":"Unique identifiers of the bootable block and net devices, in the order that they will boot","type":"array","items":{"type":"string"}},"uiState":{"$ref":"#/components/schemas/VirDomainUIState"},"snapUUIDs":{"description":"Unique identifiers of current snapshots taken of this VM ","type":"array","items":{"type":"string"},"readOnly":true},"snapshotSerialNumber":{"description":"Serial number of the most recent snapshot _**INTERNAL**_","type":"integer"},"replicationUUIDs":{"description":"Unique identifiers of replication targets _**INTERNAL**_","type":"array","items":{"type":"string"}},"sourceVirDomainUUID":{"description":"Unique identifier of the replication source _VirDomain_ (non-empty indicates this is a replication target) ","type":"string","readOnly":true},"snapshotListSerialNumber":{"description":"Generation of the snapshot list _**INTERNAL**_","type":"integer"},"snapshotScheduleUUID":{"description":"Unique identifier of the  _VirDomainSnapshotSchedule_ for automated snapshots","type":"string"},"machineType":{"description":"Scale 'Hardware' version. Use _VirDomainCreateOptions_ machineTypeKeyword instead.  Possible values include:  \n | machineType | Description |  \n | ----------- | ----------- |  \n | scale-7.2 | BIOS |  \n | scale-8.10 | UEFI |  \n | scale-uefi-tpm-9.2 | vTPM+UEFI (Experiemental) |","type":"string"},"cpuType":{"description":"Scale 'CPU Model' Possible values include:  \n | cpuType | Description |  \n | ------- | ----------- |  \n | clusterBaseline-7.3 | (default) Largest feature set that can run in on any node in a cluster |  \n | HC1150-9.2 | Constant feature set that can run on all scale hardware running 9.2 |","type":"string"},"snapshotAllocationBlocks":{"description":"Total number of blocks actually used by snapshots ","type":"integer","readOnly":true},"guestAgentState":{"$ref":"#/components/schemas/GuestAgentState"},"lastSeenRunningOnNodeUUID":{"description":"Unique identifier of the _Node_ where this VM last ran ","type":"string","readOnly":true},"isTransient":{"description":"This is set for VMs that are temporary _**INTERNAL**_","type":"boolean","default":false},"affinityStrategy":{"$ref":"#/components/schemas/VirDomainAffinityStrategy"},"vsdUUIDsToDelete":{"description":"VSDs to be deleted _**INTERNAL**_","type":"array","items":{"type":"string"}},"cloudInitData":{"$ref":"#/components/schemas/CloudInitData"},"initialCloneSnapshotUUID":{"description":"If this VM was cloned, the _VirDomainSnapshot.uuid_ of the replication optimiziation snapshot _**INTERNAL**_","type":"string"},"machineTypeKeyword":{"description":"Computed keyword matching the VM's current machine type. see @VirDomainCreateOptions ","type":"string","readOnly":true}}},"VirDomainVSDSnapshot":{"title":"VirDomainVSDSnapshot","type":"object","properties":{"uuid":{"description":"Unique identifier ","type":"string","readOnly":true},"timestamp":{"description":"Unix timestamp of when snapshot was created ","type":"integer","readOnly":true},"serialNumber":{"description":"Serial number of the package of snapshots ","type":"integer","readOnly":true},"blockCountDiff":{"description":"Number of changed blocks from previous snapshot ","type":"integer","readOnly":true},"identifier":{"description":"_VirDomainSnapshot.uuid_ ","type":"string","readOnly":true},"checksum":{"description":"Result of a CRC-32 check _**INTERNAL**_","type":"string"}}},"VirDomainSnapshotType":{"description":"\nName | Description\n- | -\nUSER | \n | \nAUTOMATED | \n | \nSUPPORT | \n | ","type":"string","enum":["USER","AUTOMATED","SUPPORT"]},"VirDomainSnapshotState":{"description":"\nName | Description\n- | -\nCREATED | \n | \nDELETING | \n | \nCREATING | \n | ","type":"string","enum":["CREATED","DELETING","CREATING"]},"VirDomainSnapshot":{"title":"VirDomainSnapshot","type":"object","properties":{"uuid":{"description":"Unique identifier ","type":"string","readOnly":true},"domainUUID":{"description":"Unique identifier of source VM _VirDomain.uuid_  _**CREATE-ONLY**_","type":"string"},"timestamp":{"description":"Unix timestamp of when snapshot was created ","type":"integer","readOnly":true},"label":{"description":"User-readable label describing the snapshot _**CREATE-ONLY**_","type":"string"},"domain":{"$ref":"#/components/schemas/VirDomain"},"deviceSnapshots":{"description":"Snapshots of each _VirDomainBlockDevice_ ","type":"array","items":{"$ref":"#/components/schemas/VirDomainVSDSnapshot"},"readOnly":true},"unavailable":{"description":"Snapshot is available to be cloned from in the client/UI ","type":"boolean","readOnly":true},"type":{"$ref":"#/components/schemas/VirDomainSnapshotType"},"blockCountDiff":{"description":"Number of changed blocks from previous snapshot ","type":"integer","readOnly":true},"automatedTriggerTimestamp":{"description":"Unix timestamp used when determining which automated snapshots to retain _**INTERNAL**_","type":"integer"},"localRetainUntilTimestamp":{"description":"Unix timestamp indicating when automated snapshots will be automatically removed","type":"integer"},"state":{"$ref":"#/components/schemas/VirDomainSnapshotState"},"quiesced":{"description":"In-guest quiescing was used to freeze the file system ","type":"boolean","readOnly":true},"remoteRetainUntilTimestamp":{"description":"Unix timestamp indicating when remote automated snapshots will be removed","type":"integer"},"blockCountDiffFromSerialNumber":{"description":"Snapshot serial number of the previous snapshot used to calculate _VirDomainSnapshot.blockCountDiff_","type":"integer","default":-1},"replication":{"description":"When false, will not replicate snapshot to a remote system if replication is configured","type":"boolean","default":true}}},"VirDomainReplicationProgress":{"title":"VirDomainReplicationProgress","type":"object","properties":{"valid":{"description":"Indicates whether VirDomainReplicationProgress can be trusted. Will be either 0 or 1 accordingly ","type":"integer","readOnly":true},"snapshotFrom":{"$ref":"#/components/schemas/VirDomainSnapshot"},"snapshotTo":{"$ref":"#/components/schemas/VirDomainSnapshot"},"blockCountDiff":{"description":"Count of block differences between _VirDomainReplicationProgress.snapshotFrom_ and _VirDomainReplicationProgress.snapshotTo_ ","type":"integer","readOnly":true},"blockCountSent":{"description":"Count of blocks sent to replication target ","type":"integer","readOnly":true},"percentComplete":{"description":"Progress complete percentage ","type":"integer","readOnly":true}}},"VirDomainReplication":{"title":"VirDomainReplication","type":"object","properties":{"uuid":{"description":"Unique identifier ","type":"string","readOnly":true},"sourceDomainUUID":{"description":"Source _VirDomain.uuid_ _**CREATE-ONLY**_ ","type":"string"},"targetDomainUUID":{"description":"Remote target _VirDomain.uuid_ ","type":"string","readOnly":true},"connectionUUID":{"description":"Remote connection unique identifier ","type":"string"},"enable":{"description":"Enable or disable replication ","type":"boolean"},"label":{"description":"Human-readable label describing the replication purpose","type":"string"},"deprecated_sourceVSDInitialSerialNumber":{"description":"_**DEPRECATED**_","type":"integer"},"progress":{"$ref":"#/components/schemas/VirDomainReplicationProgress"}},"required":["connectionUUID","enable"]},"VirDomainSnapshotRecurrenceRule":{"title":"VirDomainSnapshotRecurrenceRule","type":"object","properties":{"uuid":{"description":"Unique identifier ","type":"string","readOnly":true},"dtstart":{"description":"Local timezone timestamp (2010-01-01 00:00:00) of when a _VirDomainSnapshot_ is to be taken ","type":"string"},"rrule":{"description":"_VirDomainSnapshot_ frequency based on RFC-2445 (FREQ=MINUTELY;INTERVAL=5) ","type":"string"},"localRetentionDurationSeconds":{"description":"Number in seconds before _VirDomainSnapshots_ are removed ","type":"integer"},"name":{"description":"Human-readable name ","type":"string"},"remoteRetentionDurationSeconds":{"description":"When non-zero: number in seconds before _VirDomainSnapshots_ are removed on a replication target","type":"integer","default":0},"replication":{"description":"When false, will not replicate snapshot to a remote system if replication is configured","type":"boolean","default":true}},"required":["dtstart","rrule","localRetentionDurationSeconds","name"]},"VirDomainSnapshotSchedule":{"title":"VirDomainSnapshotSchedule","type":"object","properties":{"uuid":{"description":"Unique identifier ","type":"string","readOnly":true},"name":{"description":"Human-readable name ","type":"string"},"rrules":{"description":"Snapshot scheduling rules ","type":"array","items":{"$ref":"#/components/schemas/VirDomainSnapshotRecurrenceRule"}}},"required":["name","rrules"]},"IOPerformanceRate":{"title":"IOPerformanceRate","type":"object","properties":{"decaySeconds":{"type":"integer"},"millireadsPerSecond":{"type":"integer"},"milliwritesPerSecond":{"type":"integer"},"readKibibytesPerSecond":{"type":"integer"},"writeKibibytesPerSecond":{"type":"integer"},"meanReadSizeBytes":{"type":"integer"},"meanWriteSizeBytes":{"type":"integer"},"meanReadLatencyMicroseconds":{"type":"integer"},"meanWriteLatencyMicroseconds":{"type":"integer"}}},"VSDStats":{"title":"VSDStats","type":"object","properties":{"uuid":{"type":"string"},"rates":{"type":"array","items":{"$ref":"#/components/schemas/IOPerformanceRate"}}}},"VirDomainStats":{"title":"VirDomainStats","type":"object","properties":{"uuid":{"description":"VM's unique identifier ","type":"string","readOnly":true},"vsdStats":{"description":"Stats of each block device attached to the VM ","type":"array","items":{"$ref":"#/components/schemas/VSDStats"},"readOnly":true},"cpuUsage":{"description":"CPU usage percentage (0-100) ","type":"number","default":0,"readOnly":true},"rxBitRate":{"description":"Network receive bit rate ","type":"integer","default":0,"readOnly":true},"txBitRate":{"description":"Network transmit bit rate ","type":"integer","default":0,"readOnly":true}}},"VirDomainExportTarget":{"title":"VirDomainExportTarget","type":"object","properties":{"pathURI":{"description":"URI path - the basename will be created ","type":"string"},"format":{"description":"format of the target, empty defaults to qcow2","type":"string"},"definitionFileName":{"description":"name of the file of the domain definition","type":"string"},"compress":{"description":"compress the exported target image","type":"boolean"},"compat":{"description":"compatibility version number, ie: 0.10","type":"string"},"allowNonSequentialWrites":{"description":"allow non sequential writes, which may improve performance","type":"boolean","default":true},"parallelCountPerTransfer":{"description":"number of parallel jobs for each transfer","type":"integer"}},"required":["pathURI"]},"VirDomainImportSource":{"title":"VirDomainImportSource","type":"object","properties":{"pathURI":{"description":"URI path  ","type":"string"},"format":{"description":"format of the input, empty defaults to qcow2","type":"string"},"definitionFileName":{"description":"name of the file of the domain definition","type":"string"},"allowNonSequentialWrites":{"description":"allow non sequential writes, which may improve performance","type":"boolean","default":true},"parallelCountPerTransfer":{"description":"number of parallel jobs for each transfer","type":"integer"}},"required":["pathURI"]},"VirDomainActionType":{"description":"State related actions that can be performed on a VM\nName | Description\n- | -\nSTART | Start a domain  \n ||  The domain must be in the PAUSED, SHUTOFF, or CRASHED state  \n ||  If _VirDomainActionDescription.nodeUUID_ is specified, the domain is not PAUSED, and the specified node has sufficient resources, the domain will be started on the specified node\n | \nSHUTDOWN | Stop a domain via ACPI shutdown  \n ||  The domain must be in the RUNNING state  \n ||  Note: Windows VMs may ignore ACPI requests\n | \nSTOP | Immediately halt a domain  \n ||  The domain must be in the RUNNING, SHUTDOWN, or PAUSED state\n | \nPAUSE | Suspend a domain _**INTERNAL**_\n | \nREBOOT | Reboot a domain via ACPI shutdown  \n ||  The domain must be in the RUNNING state  \n ||  If _VirDomainActionDescription.nodeUUID_ is specified, and the given node has sufficient resources, the domain will be started on that node  \n ||  Note: Windows VMs may ignore ACPI requests\n | \nRESET | Reset a domain immediately without any guest OS shutdown  \n ||  The domain must be in the RUNNING or SHUTDOWN state\n | \nLIVEMIGRATE | Live migrate a running domain to the given node  \n ||  The domain must currently be in the RUNNING state  \n ||  The target node must have sufficient resources to migrate to\n | \nNMI | Send a Non-Maskable Interrupt to the VM  \n ||  The domain must be in the RUNNING state  \n ||  This sends an interrupt to the Virtual CPU that will always run a handler  \n ||  Note: This is generally a diagnostic tool, Check OS documentation for specifics\n | ","type":"string","enum":["START","SHUTDOWN","STOP","PAUSE","REBOOT","RESET","LIVEMIGRATE","NMI"]},"VirDomainActionDescription":{"title":"VirDomainActionDescription","type":"object","properties":{"virDomainUUID":{"description":"UUID of VirDomain on which to take action ","type":"string"},"actionType":{"$ref":"#/components/schemas/VirDomainActionType"},"nodeUUID":{"description":"The node UUID.  The meaning depends on the type of action  \n being taken. _VirDomainActionType_","type":"string"},"cause":{"description":"A cause or reason for why the action is being triggered, or at least  \n what system is doing so, for traceability _**INTERNAL**_","type":"string"}},"required":["virDomainUUID"]},"VirDomainSnapshotBlockDeviceCreateOptions":{"title":"VirDomainSnapshotBlockDeviceCreateOptions","type":"object","properties":{"regenerateDiskID":{"description":"Regenerate the disk ID, e.g. GPT UUID or MBR signature","type":"boolean","default":true},"readOnly":{"description":"Mount the new block device as read-only","type":"boolean","default":false}}},"VirDomainCreateOptions":{"title":"VirDomainCreateOptions","type":"object","properties":{"attachGuestToolsISO":{"description":"If supported by _VirDomain.operatingSystem,_ create an extra device to attach the Scale Guest OS tools ISO","type":"boolean","default":true},"machineTypeKeyword":{"description":"Key word to use when creating the machine  \n | keyword | Description |  \n | ----------- | ----------- |  \n | bios | BIOS |  \n | uefi | UEFI |  \n | tpm | vTPM+UEFI |  \n | tpm-compatible | vTPM+UEFI (Compatibility) |","type":"string","default":""}}},"VSD":{"title":"VSD","type":"object","properties":{"uuid":{"description":"Unique identifier ","type":"string","readOnly":true},"capacityBytes":{"description":"Total capacity, in bytes","type":"integer"},"totalAllocationBytes":{"description":"Storage space in use, in bytes","type":"integer"},"blockSize":{"description":"Size of individual blocks (the smallest unit of measurement for VSDs) on the drive, in bytes ","type":"integer","readOnly":true},"replicationFactor":{"description":"How many copies of each block are stored on physical drives ","type":"integer","readOnly":true},"name":{"description":"Name identifier","type":"string"}}}},"responses":{"EInvalidSession":{"description":"API call requires a valid _Session_  \n Either expired session or no session was passed in","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Brief description of the error"}}}}}},"EServiceFailure":{"description":"Internal service error has occurred","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Brief description of the error"}}}}}},"EValidationError":{"description":"Arguments passed to a function were incorrectly formatted  \n e.g. passing an invalid IP address--for example: 10.0.0.a.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Brief description of the error"}}}}}},"EPermissionDenied":{"description":"User does not have permission to call function","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Brief description of the error"}}}}}}},"securitySchemes":{"basic":{"type":"http","scheme":"basic"}}},"security":[{"basic":[]}],"paths":{"/ping":{"get":{"x-operation":"ping","x-controller":"rest","description":"Check the state of the rest API","operationId":"ping","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"Service Status","readOnly":true}}}}}}}}},"/login":{"post":{"x-operation":"Login","x-controller":"rest","description":"Authenticate and create a session to the Scale System","operationId":"Login","requestBody":{"required":true,"description":"A JSON object containing login credentials","content":{"application/json":{"schema":{"type":"object","properties":{"username":{"type":"string"},"password":{"type":"string"},"useOIDC":{"type":"boolean","description":"Instead of local authentication, use the configured OpenID Connect server (RFC-6749 secion 4.3)","default":false}},"required":["username","password"]}}}},"security":[],"responses":{"200":{"description":"Successfully authenticated. The session ID is returned in a cookie named `sessionID`. You need to include this cookie in subsequent requests.","headers":{"Set-Cookie":{"schema":{"description":"RFC-6265","type":"string","example":"sessionID=abcde12345; Path=/"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"sessionID":{"type":"string","description":"The created sessionID."}}}}}}}}},"/logout":{"post":{"x-operation":"Logout","x-controller":"rest","description":"Log out and destroy the current session","operationId":"Logout","responses":{"200":{"description":"Success"}}}},"/AlertSMTPConfig":{"post":{"tags":["AlertSMTPConfig"],"summary":"AlertSMTPConfigCreate","x-operation":"AlertSMTPConfigCreate","x-controller":"rest","description":"Create an SMTP Alert Configuration","operationId":"AlertSMTPConfigCreate","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"AlertSMTPConfig","type":"object","properties":{"smtpServer":{"description":"IP address or hostname of the SMTP server ","type":"string"},"port":{"description":"TCP port of the SMTP server ","type":"integer"},"useSSL":{"description":"Enable SSL encryption","type":"boolean"},"useAuth":{"description":"Enable authentication with _AlertSMTPConfig.authUser_ and _AlertSMTPConfig.authPassword_","type":"boolean"},"authUser":{"description":"Username for authentication if _AlertSMTPConfig.useAuth_ is true","type":"string"},"authPassword":{"description":"Password for authentication if _AlertSMTPConfig.useAuth_ is true","type":"string"},"fromAddress":{"description":"Email address the system alerts will be sent from","type":"string"}},"required":["smtpServer","port"],"additionalProperties":false}}},"required":true}},"get":{"tags":["AlertSMTPConfig"],"summary":"AlertSMTPConfigRead","x-operation":"AlertSMTPConfigRead","x-controller":"rest","description":"Get a list of SMTP Alert Configurations","operationId":"AlertSMTPConfigRead_read","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AlertSMTPConfig"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/AlertSMTPConfig/{uuid}":{"get":{"tags":["AlertSMTPConfig"],"summary":"AlertSMTPConfigRead","x-operation":"AlertSMTPConfigRead","x-controller":"rest","description":"Get a list of SMTP Alert Configurations","operationId":"AlertSMTPConfigRead_uuid","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AlertSMTPConfig"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}},"post":{"tags":["AlertSMTPConfig"],"summary":"AlertSMTPConfigUpdate","x-operation":"AlertSMTPConfigUpdate","x-controller":"rest","description":"Edit the SMTP Alert Configuration","operationId":"AlertSMTPConfigUpdate","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"AlertSMTPConfig","type":"object","properties":{"uuid":{"description":"Unique identifier ","type":"string","readOnly":true},"smtpServer":{"description":"IP address or hostname of the SMTP server ","type":"string"},"port":{"description":"TCP port of the SMTP server ","type":"integer"},"useSSL":{"description":"Enable SSL encryption","type":"boolean"},"useAuth":{"description":"Enable authentication with _AlertSMTPConfig.authUser_ and _AlertSMTPConfig.authPassword_","type":"boolean"},"authUser":{"description":"Username for authentication if _AlertSMTPConfig.useAuth_ is true","type":"string"},"authPassword":{"description":"Password for authentication if _AlertSMTPConfig.useAuth_ is true","type":"string"},"latestTaskTag":{"$ref":"#/components/schemas/TaskTagStatus"},"fromAddress":{"description":"Email address the system alerts will be sent from","type":"string"}},"required":["smtpServer","port"],"additionalProperties":false}}},"required":true}},"patch":{"tags":["AlertSMTPConfig"],"summary":"AlertSMTPConfigUpdate","x-operation":"AlertSMTPConfigUpdate","x-controller":"rest","description":"Edit the SMTP Alert Configuration","operationId":"AlertSMTPConfigUpdate_patch","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"AlertSMTPConfig","type":"object","properties":{"smtpServer":{"description":"IP address or hostname of the SMTP server ","type":"string"},"port":{"description":"TCP port of the SMTP server ","type":"integer"},"useSSL":{"description":"Enable SSL encryption","type":"boolean"},"useAuth":{"description":"Enable authentication with _AlertSMTPConfig.authUser_ and _AlertSMTPConfig.authPassword_","type":"boolean"},"authUser":{"description":"Username for authentication if _AlertSMTPConfig.useAuth_ is true","type":"string"},"authPassword":{"description":"Password for authentication if _AlertSMTPConfig.useAuth_ is true","type":"string"},"fromAddress":{"description":"Email address the system alerts will be sent from","type":"string"}},"additionalProperties":false}}},"required":true}},"delete":{"tags":["AlertSMTPConfig"],"summary":"AlertSMTPConfigDelete","x-operation":"AlertSMTPConfigDelete","x-controller":"rest","description":"Delete the SMTP Alert Configuration","operationId":"AlertSMTPConfigDelete_delete","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/AlertEmailTarget":{"post":{"tags":["AlertEmailTarget"],"summary":"AlertEmailTargetCreate","x-operation":"AlertEmailTargetCreate","x-controller":"rest","description":"Create a new alert email target","operationId":"AlertEmailTargetCreate","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"AlertEmailTarget","type":"object","properties":{"alertTagUUID":{"description":"Unique identifier for an _AlertTag_ _**INTERNAL**_","type":"string"},"emailAddress":{"description":"Email address of the alert recipient ","type":"string"},"resendDelay":{"description":"Alert resend delay in seconds","type":"integer"},"silentPeriod":{"description":"Alerts will not resend if there are additional event triggers within this time in seconds","type":"integer"}},"required":["emailAddress"],"additionalProperties":false}}},"required":true}},"get":{"tags":["AlertEmailTarget"],"summary":"AlertEmailTargetRead","x-operation":"AlertEmailTargetRead","x-controller":"rest","description":"Get a list of alert email targets","operationId":"AlertEmailTargetRead_read","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AlertEmailTarget"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/AlertEmailTarget/{uuid}":{"get":{"tags":["AlertEmailTarget"],"summary":"AlertEmailTargetRead","x-operation":"AlertEmailTargetRead","x-controller":"rest","description":"Get a list of alert email targets","operationId":"AlertEmailTargetRead_uuid","parameters":[{"name":"uuid","description":"_AlertEmailTarget.uuid_","in":"path","required":true,"schema":{"description":"_AlertEmailTarget.uuid_","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AlertEmailTarget"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}},"post":{"tags":["AlertEmailTarget"],"summary":"AlertEmailTargetUpdate","x-operation":"AlertEmailTargetUpdate","x-controller":"rest","description":"Edit an alert email target","operationId":"AlertEmailTargetUpdate","parameters":[{"name":"uuid","description":"_AlertEmailTarget.uuid_","in":"path","required":true,"schema":{"description":"_AlertEmailTarget.uuid_","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"AlertEmailTarget","type":"object","properties":{"uuid":{"description":"Unique identifer ","type":"string","readOnly":true},"alertTagUUID":{"description":"Unique identifier for an _AlertTag_ _**INTERNAL**_","type":"string"},"emailAddress":{"description":"Email address of the alert recipient ","type":"string"},"resendDelay":{"description":"Alert resend delay in seconds","type":"integer"},"silentPeriod":{"description":"Alerts will not resend if there are additional event triggers within this time in seconds","type":"integer"},"latestTaskTag":{"$ref":"#/components/schemas/TaskTagStatus"}},"required":["emailAddress"],"additionalProperties":false}}},"required":true}},"patch":{"tags":["AlertEmailTarget"],"summary":"AlertEmailTargetUpdate","x-operation":"AlertEmailTargetUpdate","x-controller":"rest","description":"Edit an alert email target","operationId":"AlertEmailTargetUpdate_patch","parameters":[{"name":"uuid","description":"_AlertEmailTarget.uuid_","in":"path","required":true,"schema":{"description":"_AlertEmailTarget.uuid_","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"AlertEmailTarget","type":"object","properties":{"emailAddress":{"description":"Email address of the alert recipient ","type":"string"},"resendDelay":{"description":"Alert resend delay in seconds","type":"integer"},"silentPeriod":{"description":"Alerts will not resend if there are additional event triggers within this time in seconds","type":"integer"}},"additionalProperties":false}}},"required":true}},"delete":{"tags":["AlertEmailTarget"],"summary":"AlertEmailTargetDelete","x-operation":"AlertEmailTargetDelete","x-controller":"rest","description":"Delete an alert email target","operationId":"AlertEmailTargetDelete_delete","parameters":[{"name":"uuid","description":"_AlertEmailTarget.uuid_","in":"path","required":true,"schema":{"description":"_AlertEmailTarget.uuid_","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/AlertSyslogTarget":{"post":{"tags":["AlertSyslogTarget"],"summary":"AlertSyslogTargetCreate","x-operation":"AlertSyslogTargetCreate","x-controller":"rest","description":"Create a new alert syslog target","operationId":"AlertSyslogTargetCreate","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"AlertSyslogTarget","type":"object","properties":{"alertTagUUID":{"description":"Unique identifier for an _AlertTag_ _**INTERNAL**_","type":"string"},"host":{"description":"IP address or hostname of the syslog server ","type":"string"},"port":{"description":"Network port of the syslog server","type":"integer"},"protocol":{"$ref":"#/components/schemas/SyslogProtocol"},"resendDelay":{"description":"Alert resend delay in seconds","type":"integer"},"silentPeriod":{"description":"Alerts will not resend if there are additional event triggers within this time in seconds","type":"integer"}},"required":["host"],"additionalProperties":false}}},"required":true}},"get":{"tags":["AlertSyslogTarget"],"summary":"AlertSyslogTargetRead","x-operation":"AlertSyslogTargetRead","x-controller":"rest","description":"Get a list of Alert Syslog Targets","operationId":"AlertSyslogTargetRead_read","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AlertSyslogTarget"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/AlertSyslogTarget/{uuid}":{"get":{"tags":["AlertSyslogTarget"],"summary":"AlertSyslogTargetRead","x-operation":"AlertSyslogTargetRead","x-controller":"rest","description":"Get a list of Alert Syslog Targets","operationId":"AlertSyslogTargetRead_uuid","parameters":[{"name":"uuid","description":"Unique identifer of the _AlertSyslogTarget_","in":"path","required":true,"schema":{"description":"Unique identifer of the _AlertSyslogTarget_","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AlertSyslogTarget"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}},"post":{"tags":["AlertSyslogTarget"],"summary":"AlertSyslogTargetUpdate","x-operation":"AlertSyslogTargetUpdate","x-controller":"rest","description":"Edit an alert syslog target","operationId":"AlertSyslogTargetUpdate","parameters":[{"name":"uuid","description":"Unique identifer of the _AlertSyslogTarget_","in":"path","required":true,"schema":{"description":"Unique identifer of the _AlertSyslogTarget_","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"AlertSyslogTarget","type":"object","properties":{"uuid":{"description":"Unique identifer ","type":"string","readOnly":true},"alertTagUUID":{"description":"Unique identifier for an _AlertTag_ _**INTERNAL**_","type":"string"},"host":{"description":"IP address or hostname of the syslog server ","type":"string"},"port":{"description":"Network port of the syslog server","type":"integer"},"protocol":{"$ref":"#/components/schemas/SyslogProtocol"},"latestTaskTag":{"$ref":"#/components/schemas/TaskTagStatus"},"resendDelay":{"description":"Alert resend delay in seconds","type":"integer"},"silentPeriod":{"description":"Alerts will not resend if there are additional event triggers within this time in seconds","type":"integer"}},"required":["host"],"additionalProperties":false}}},"required":true}},"patch":{"tags":["AlertSyslogTarget"],"summary":"AlertSyslogTargetUpdate","x-operation":"AlertSyslogTargetUpdate","x-controller":"rest","description":"Edit an alert syslog target","operationId":"AlertSyslogTargetUpdate_patch","parameters":[{"name":"uuid","description":"Unique identifer of the _AlertSyslogTarget_","in":"path","required":true,"schema":{"description":"Unique identifer of the _AlertSyslogTarget_","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"AlertSyslogTarget","type":"object","properties":{"host":{"description":"IP address or hostname of the syslog server ","type":"string"},"port":{"description":"Network port of the syslog server","type":"integer"},"protocol":{"$ref":"#/components/schemas/SyslogProtocol"},"resendDelay":{"description":"Alert resend delay in seconds","type":"integer"},"silentPeriod":{"description":"Alerts will not resend if there are additional event triggers within this time in seconds","type":"integer"}},"additionalProperties":false}}},"required":true}},"delete":{"tags":["AlertSyslogTarget"],"summary":"AlertSyslogTargetDelete","x-operation":"AlertSyslogTargetDelete","x-controller":"rest","description":"Delete an alert syslog target","operationId":"AlertSyslogTargetDelete_delete","parameters":[{"name":"uuid","description":"Unique identifer of the _AlertSyslogTarget_","in":"path","required":true,"schema":{"description":"Unique identifer of the _AlertSyslogTarget_","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/Cluster":{"get":{"tags":["Cluster"],"summary":"ClusterRead","x-operation":"ClusterRead","x-controller":"rest","description":"Get information about a given system","operationId":"ClusterRead_read","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/Cluster/{uuid}":{"get":{"tags":["Cluster"],"summary":"ClusterRead","x-operation":"ClusterRead","x-controller":"rest","description":"Get information about a given system","operationId":"ClusterRead_uuid","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Cluster"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}},"post":{"tags":["Cluster"],"summary":"ClusterUpdate","x-operation":"ClusterUpdate","x-controller":"rest","description":"Edit a cluster","operationId":"ClusterUpdate","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"Cluster","type":"object","properties":{"uuid":{"description":"Unique identifier ","type":"string","readOnly":true},"filesystemID":{"description":"ID assigned by the clustered filesystem ","type":"string","readOnly":true},"clusterName":{"description":"Human-readable assigned name to the system. Must be a valid hostname (see RFC 952 and RFC 1123)","type":"string"},"icosVersion":{"description":"The version number of the firmware. Represented as majorVersion.minorVersion.revision.buildID _IcosUpdate_ ","type":"string","readOnly":true},"latestTaskTag":{"$ref":"#/components/schemas/TaskTagStatus"},"brand":{"description":"OEM specific brand marker ","type":"string","readOnly":true},"isRESTAPIEnabled":{"description":"_**DEPRECATED**_","type":"boolean"}},"additionalProperties":false}}},"required":true}},"patch":{"tags":["Cluster"],"summary":"ClusterUpdate","x-operation":"ClusterUpdate","x-controller":"rest","description":"Edit a cluster","operationId":"ClusterUpdate_patch","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"Cluster","type":"object","properties":{"clusterName":{"description":"Human-readable assigned name to the system. Must be a valid hostname (see RFC 952 and RFC 1123)","type":"string"}},"additionalProperties":false}}},"required":true}}},"/Condition":{"get":{"tags":["Condition"],"summary":"ConditionRead","x-operation":"ConditionRead","x-controller":"rest","description":"Retrieve a list of Conditions","operationId":"ConditionRead_read","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Condition"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/Condition/{name}":{"get":{"tags":["Condition"],"summary":"ConditionRead","x-operation":"ConditionRead","x-controller":"rest","description":"Retrieve a list of Conditions","operationId":"ConditionRead_uuid","parameters":[{"name":"name","description":"A regular expression to match the condition names ","in":"path","required":true,"schema":{"description":"A regular expression to match the condition names ","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Condition"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/NucleusKey":{"post":{"tags":["NucleusKey"],"summary":"NucleusKeyCreate","x-operation":"NucleusKeyCreate","x-controller":"rest","description":"Create a Nucleus key. This is used by the node to register with the Nucleus  \n web service.","operationId":"NucleusKeyCreate","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"NucleusKey","type":"object","properties":{"uuid":{"type":"string"},"value":{"type":"string"}},"additionalProperties":false}}},"required":true}},"get":{"tags":["NucleusKey"],"summary":"NucleusKeyRead","x-operation":"NucleusKeyRead","x-controller":"rest","description":"Get a list of Nucleus keys. This public API is here for REST compatibility. It does not return the actual key data. Instead, it just returns the name of the key.","operationId":"NucleusKeyRead_read","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/NucleusKey/{uuid}":{"get":{"tags":["NucleusKey"],"summary":"NucleusKeyRead","x-operation":"NucleusKeyRead","x-controller":"rest","description":"Get a list of Nucleus keys. This public API is here for REST compatibility. It does not return the actual key data. Instead, it just returns the name of the key.","operationId":"NucleusKeyRead_uuid","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}},"post":{"tags":["NucleusKey"],"summary":"NucleusKeyUpdate","x-operation":"NucleusKeyUpdate","x-controller":"rest","description":"Edit a Nucleus key","operationId":"NucleusKeyUpdate","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"NucleusKey","type":"object","properties":{"uuid":{"type":"string"},"value":{"type":"string"}},"additionalProperties":false}}},"required":true}},"patch":{"tags":["NucleusKey"],"summary":"NucleusKeyUpdate","x-operation":"NucleusKeyUpdate","x-controller":"rest","description":"Edit a Nucleus key","operationId":"NucleusKeyUpdate_patch","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"NucleusKey","type":"object","properties":{"uuid":{"type":"string"},"value":{"type":"string"}},"additionalProperties":false}}},"required":true}},"delete":{"tags":["NucleusKey"],"summary":"NucleusKeyDelete","x-operation":"NucleusKeyDelete","x-controller":"rest","description":"Delete a Nucleus key","operationId":"NucleusKeyDelete_delete","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/Cluster/shutdown":{"post":{"tags":["Cluster"],"summary":"ClusterShutdown","x-operation":"ClusterShutdown","x-controller":"rest","description":"Shutdown the system. All running _VirDomains_ will be restarted on next system boot.","operationId":"ClusterShutdown","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"forceShutdown":{"description":"Bypasses attempts to gracefully shut down all runnning _VirDomains_ before system shutdown. ","type":"boolean"}},"required":["forceShutdown"]}}}}}},"/DNSConfig":{"post":{"tags":["DNSConfig"],"summary":"DNSConfigCreate","x-operation":"DNSConfigCreate","x-controller":"rest","description":"Create a DNS configuration","operationId":"DNSConfigCreate","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"DNSConfig","type":"object","properties":{"searchDomains":{"description":"Domain search list used to resolve fully qualified domain names","type":"array","items":{"type":"string"}},"serverIPs":{"description":"IP address or hostname of DNS servers ","type":"array","items":{"type":"string"}}},"required":["serverIPs"],"additionalProperties":false}}},"required":true}},"get":{"tags":["DNSConfig"],"summary":"DNSConfigRead","x-operation":"DNSConfigRead","x-controller":"rest","description":"Get a list of DNS configurations","operationId":"DNSConfigRead_read","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DNSConfig"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/DNSConfig/{uuid}":{"get":{"tags":["DNSConfig"],"summary":"DNSConfigRead","x-operation":"DNSConfigRead","x-controller":"rest","description":"Get a list of DNS configurations","operationId":"DNSConfigRead_uuid","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DNSConfig"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}},"post":{"tags":["DNSConfig"],"summary":"DNSConfigUpdate","x-operation":"DNSConfigUpdate","x-controller":"rest","description":"Edit a DNS configuration","operationId":"DNSConfigUpdate","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"DNSConfig","type":"object","properties":{"uuid":{"description":"Unique identifer ","type":"string","readOnly":true},"searchDomains":{"description":"Domain search list used to resolve fully qualified domain names","type":"array","items":{"type":"string"}},"serverIPs":{"description":"IP address or hostname of DNS servers ","type":"array","items":{"type":"string"}},"latestTaskTag":{"$ref":"#/components/schemas/TaskTagStatus"}},"required":["serverIPs"],"additionalProperties":false}}},"required":true}},"patch":{"tags":["DNSConfig"],"summary":"DNSConfigUpdate","x-operation":"DNSConfigUpdate","x-controller":"rest","description":"Edit a DNS configuration","operationId":"DNSConfigUpdate_patch","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"DNSConfig","type":"object","properties":{"searchDomains":{"description":"Domain search list used to resolve fully qualified domain names","type":"array","items":{"type":"string"}},"serverIPs":{"description":"IP address or hostname of DNS servers ","type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"required":true}},"delete":{"tags":["DNSConfig"],"summary":"DNSConfigDelete","x-operation":"DNSConfigDelete","x-controller":"rest","description":"Delete a DNS configuration","operationId":"DNSConfigDelete_delete","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/Drive":{"get":{"tags":["Drive"],"summary":"DriveRead","x-operation":"DriveRead","x-controller":"rest","description":"Get a list of drives in the cluster","operationId":"DriveRead_read","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Drive"}}}}},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/Drive/{uuid}":{"get":{"tags":["Drive"],"summary":"DriveRead","x-operation":"DriveRead","x-controller":"rest","description":"Get a list of drives in the cluster","operationId":"DriveRead_uuid","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Drive"}}}}},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/GPU":{"get":{"tags":["GPU"],"summary":"GPURead","x-operation":"GPURead","x-controller":"rest","description":"Get a list of physical _GPU_ cards in the system","operationId":"GPURead_read","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GPU"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/GPU/{uuid}":{"get":{"tags":["GPU"],"summary":"GPURead","x-operation":"GPURead","x-controller":"rest","description":"Get a list of physical _GPU_ cards in the system","operationId":"GPURead_uuid","parameters":[{"name":"uuid","description":"GPU's unique identifier","in":"path","required":true,"schema":{"description":"GPU's unique identifier","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GPU"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/GPUProfile":{"get":{"tags":["GPUProfile"],"summary":"GPUProfileRead","x-operation":"GPUProfileRead","x-controller":"rest","description":"Get a list of the GPU profiles that may be used with a _VirDomain_ on the system","operationId":"GPUProfileRead_read","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GPUProfile"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/GPUProfile/{gpuUUID}":{"get":{"tags":["GPUProfile"],"summary":"GPUProfileRead","x-operation":"GPUProfileRead","x-controller":"rest","description":"Get a list of the GPU profiles that may be used with a _VirDomain_ on the system","operationId":"GPUProfileRead_uuid","parameters":[{"name":"gpuUUID","description":"GPU's unique identifier","in":"path","required":true,"schema":{"description":"GPU's unique identifier","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GPUProfile"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/Update":{"get":{"tags":["Update"],"summary":"IcosUpdateRead","x-operation":"IcosUpdateRead","x-controller":"rest","description":"Get a list of updates that can be applied to this cluster","operationId":"IcosUpdateRead_read","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IcosUpdate"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/Update/{uuid}":{"get":{"tags":["Update"],"summary":"IcosUpdateRead","x-operation":"IcosUpdateRead","x-controller":"rest","description":"Get a list of updates that can be applied to this cluster","operationId":"IcosUpdateRead_uuid","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IcosUpdate"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/ISO":{"post":{"tags":["ISO"],"summary":"ISOCreate","x-operation":"ISOCreate","x-controller":"rest","description":"Create an ISO","operationId":"ISOCreate","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"ISO","type":"object","properties":{"name":{"description":"Filename of the image, must end in \".iso\" ","type":"string"},"size":{"description":"Size of the ISO file, in bytes _**CREATE-ONLY**_ ","type":"integer"},"readyForInsert":{"description":"Set this to true ( _ISOUpdate_ ) only after all data has been copied over ( _ISOUpload_ ) ","type":"boolean"}},"required":["name","readyForInsert"],"additionalProperties":false}}},"required":true}},"get":{"tags":["ISO"],"summary":"ISORead","x-operation":"ISORead","x-controller":"rest","description":"Get a list of ISOs","operationId":"ISORead_read","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ISO"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/ISO/{uuid}":{"get":{"tags":["ISO"],"summary":"ISORead","x-operation":"ISORead","x-controller":"rest","description":"Get a list of ISOs","operationId":"ISORead_uuid","parameters":[{"name":"uuid","description":"Unique Identifier for an ISO _ISO.uuid_","in":"path","required":true,"schema":{"description":"Unique Identifier for an ISO _ISO.uuid_","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ISO"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}},"post":{"tags":["ISO"],"summary":"ISOUpdate","x-operation":"ISOUpdate","x-controller":"rest","description":"Edit an ISO","operationId":"ISOUpdate","parameters":[{"name":"uuid","description":"Unique Identifier for an ISO _ISO.uuid_","in":"path","required":true,"schema":{"description":"Unique Identifier for an ISO _ISO.uuid_","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"ISO","type":"object","properties":{"uuid":{"description":"Unique identifier ","type":"string","readOnly":true},"name":{"description":"Filename of the image, must end in \".iso\" ","type":"string"},"size":{"description":"Size of the ISO file, in bytes _**CREATE-ONLY**_ ","type":"integer"},"mounts":{"description":"VMs this image is attached to ","type":"array","items":{"$ref":"#/components/schemas/ISOMount"},"readOnly":true},"readyForInsert":{"description":"Set this to true ( _ISOUpdate_ ) only after all data has been copied over ( _ISOUpload_ ) ","type":"boolean"},"path":{"description":"Storage device used in conjunction with _VirDomainBlockDevice.path_ ","type":"string","readOnly":true}},"required":["name","readyForInsert"],"additionalProperties":false}}},"required":true}},"patch":{"tags":["ISO"],"summary":"ISOUpdate","x-operation":"ISOUpdate","x-controller":"rest","description":"Edit an ISO","operationId":"ISOUpdate_patch","parameters":[{"name":"uuid","description":"Unique Identifier for an ISO _ISO.uuid_","in":"path","required":true,"schema":{"description":"Unique Identifier for an ISO _ISO.uuid_","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"ISO","type":"object","properties":{"name":{"description":"Filename of the image, must end in \".iso\" ","type":"string"},"size":{"description":"Size of the ISO file, in bytes _**CREATE-ONLY**_ ","type":"integer"},"readyForInsert":{"description":"Set this to true ( _ISOUpdate_ ) only after all data has been copied over ( _ISOUpload_ ) ","type":"boolean"}},"additionalProperties":false}}},"required":true}},"delete":{"tags":["ISO"],"summary":"ISODelete","x-operation":"ISODelete","x-controller":"rest","description":"Delete an ISO","operationId":"ISODelete_delete","parameters":[{"name":"uuid","description":"Unique Identifier for an ISO _ISO.uuid_","in":"path","required":true,"schema":{"description":"Unique Identifier for an ISO _ISO.uuid_","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/MonitoringConfig":{"post":{"tags":["MonitoringConfig"],"summary":"MonitoringConfigCreate","x-operation":"MonitoringConfigCreate","x-controller":"rest","description":"Create a Monitoring configuration","operationId":"MonitoringConfigCreate","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"MonitoringConfig","type":"object","properties":{"clusterName":{"type":"string"},"interval":{"type":"integer","default":60},"publishers":{"type":"array","items":{"$ref":"#/components/schemas/MonitoringPublisher"}},"subscribers":{"type":"array","items":{"$ref":"#/components/schemas/MonitoringSubscriber"}}},"additionalProperties":false}}},"required":true}},"get":{"tags":["MonitoringConfig"],"summary":"MonitoringConfigRead","x-operation":"MonitoringConfigRead","x-controller":"rest","description":"Get a list of Monitoring configurations","operationId":"MonitoringConfigRead_read","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MonitoringConfig"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/MonitoringConfig/{uuid}":{"get":{"tags":["MonitoringConfig"],"summary":"MonitoringConfigRead","x-operation":"MonitoringConfigRead","x-controller":"rest","description":"Get a list of Monitoring configurations","operationId":"MonitoringConfigRead_uuid","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MonitoringConfig"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}},"post":{"tags":["MonitoringConfig"],"summary":"MonitoringConfigUpdate","x-operation":"MonitoringConfigUpdate","x-controller":"rest","description":"Edit a Monitoring configuration","operationId":"MonitoringConfigUpdate","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"MonitoringConfig","type":"object","properties":{"uuid":{"description":"Unique identifer ","type":"string","readOnly":true},"clusterName":{"type":"string"},"interval":{"type":"integer","default":60},"publishers":{"type":"array","items":{"$ref":"#/components/schemas/MonitoringPublisher"}},"subscribers":{"type":"array","items":{"$ref":"#/components/schemas/MonitoringSubscriber"}},"latestTaskTag":{"$ref":"#/components/schemas/TaskTagStatus"}},"additionalProperties":false}}},"required":true}},"patch":{"tags":["MonitoringConfig"],"summary":"MonitoringConfigUpdate","x-operation":"MonitoringConfigUpdate","x-controller":"rest","description":"Edit a Monitoring configuration","operationId":"MonitoringConfigUpdate_patch","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"MonitoringConfig","type":"object","properties":{"clusterName":{"type":"string"},"interval":{"type":"integer","default":60},"publishers":{"type":"array","items":{"$ref":"#/components/schemas/MonitoringPublisher"}},"subscribers":{"type":"array","items":{"$ref":"#/components/schemas/MonitoringSubscriber"}}},"additionalProperties":false}}},"required":true}},"delete":{"tags":["MonitoringConfig"],"summary":"MonitoringConfigDelete","x-operation":"MonitoringConfigDelete","x-controller":"rest","description":"Delete a Monitoring configuration","operationId":"MonitoringConfigDelete_delete","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/Node":{"get":{"tags":["Node"],"summary":"NodeRead","x-operation":"NodeRead","x-controller":"rest","description":"Get a list of nodes in the system","operationId":"NodeRead_read","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Node"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/Node/{uuid}":{"get":{"tags":["Node"],"summary":"NodeRead","x-operation":"NodeRead","x-controller":"rest","description":"Get a list of nodes in the system","operationId":"NodeRead_uuid","parameters":[{"name":"uuid","description":"Node's unique identifier","in":"path","required":true,"schema":{"description":"Node's unique identifier","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Node"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/OIDCConfig":{"post":{"tags":["OIDCConfig"],"summary":"OIDCConfigCreate","x-operation":"OIDCConfigCreate","x-controller":"rest","description":"Create an OpenID Connect configuration","operationId":"OIDCConfigCreate","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"OIDCConfig","type":"object","properties":{"clientID":{"description":"Provided by authentication server when configuring a new client","type":"string"},"sharedSecret":{"description":"Provided by authentication server for client authentication ","type":"string","writeOnly":true},"certificate":{"description":"Plain text of the X.509 PEM-encode certificate","type":"string"},"configurationURL":{"description":"The OpenID Connect Provider Configuration Information endpoint ","type":"string"},"scopes":{"description":"Scopes required to obtain necessary claims ","type":"string"}},"required":["configurationURL","scopes"],"additionalProperties":false}}},"required":true}},"get":{"tags":["OIDCConfig"],"summary":"OIDCConfigRead","x-operation":"OIDCConfigRead","x-controller":"rest","description":"Get a list of OpenID Connect configurations","operationId":"OIDCConfigRead_read","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OIDCConfig"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/OIDCConfig/{uuid}":{"get":{"tags":["OIDCConfig"],"summary":"OIDCConfigRead","x-operation":"OIDCConfigRead","x-controller":"rest","description":"Get a list of OpenID Connect configurations","operationId":"OIDCConfigRead_uuid","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OIDCConfig"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}},"post":{"tags":["OIDCConfig"],"summary":"OIDCConfigUpdate","x-operation":"OIDCConfigUpdate","x-controller":"rest","description":"Edit an OpenID Connect configuration","operationId":"OIDCConfigUpdate","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"OIDCConfig","type":"object","properties":{"uuid":{"description":"Unique identifer ","type":"string","readOnly":true},"clientID":{"description":"Provided by authentication server when configuring a new client","type":"string"},"sharedSecret":{"description":"Provided by authentication server for client authentication ","type":"string","writeOnly":true},"certificate":{"description":"Plain text of the X.509 PEM-encode certificate","type":"string"},"configurationURL":{"description":"The OpenID Connect Provider Configuration Information endpoint ","type":"string"},"scopes":{"description":"Scopes required to obtain necessary claims ","type":"string"},"authorizationURL":{"description":"The OpenID Connect Provider Authorization endpoint ","type":"string","readOnly":true},"tokenURL":{"description":"The OpenID Connect Provider Token Endpoint ","type":"string","readOnly":true},"logoutURL":{"description":"The OpenID Connect Provider End Session Endpoint ","type":"string","readOnly":true}},"required":["configurationURL","scopes"],"additionalProperties":false}}},"required":true}},"patch":{"tags":["OIDCConfig"],"summary":"OIDCConfigUpdate","x-operation":"OIDCConfigUpdate","x-controller":"rest","description":"Edit an OpenID Connect configuration","operationId":"OIDCConfigUpdate_patch","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"OIDCConfig","type":"object","properties":{"clientID":{"description":"Provided by authentication server when configuring a new client","type":"string"},"sharedSecret":{"description":"Provided by authentication server for client authentication ","type":"string","writeOnly":true},"certificate":{"description":"Plain text of the X.509 PEM-encode certificate","type":"string"},"configurationURL":{"description":"The OpenID Connect Provider Configuration Information endpoint ","type":"string"},"scopes":{"description":"Scopes required to obtain necessary claims ","type":"string"}},"additionalProperties":false}}},"required":true}}},"/ClusterRegistrationData":{"get":{"tags":["ClusterRegistrationData"],"summary":"ClusterRegistrationDataRead","x-operation":"ClusterRegistrationDataRead","x-controller":"rest","description":"Get a list of exportable cluster registration data","operationId":"ClusterRegistrationDataRead_read","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ClusterRegistrationData"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/ClusterRegistrationData/{clusterID}":{"get":{"tags":["ClusterRegistrationData"],"summary":"ClusterRegistrationDataRead","x-operation":"ClusterRegistrationDataRead","x-controller":"rest","description":"Get a list of exportable cluster registration data","operationId":"ClusterRegistrationDataRead_uuid","parameters":[{"name":"clusterID","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ClusterRegistrationData"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/Registration":{"post":{"tags":["Registration"],"summary":"RegistrationCreate","x-operation":"RegistrationCreate","x-controller":"rest","description":"Create a new cluster registration","operationId":"RegistrationCreate","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"Registration","type":"object","properties":{"companyName":{"description":"Name of the company registering the cluster","type":"string"},"contact":{"description":"Name of the person registering the cluster","type":"string"},"phone":{"description":"Phone number for company contact","type":"string"},"email":{"description":"Email address for company contact","type":"string"}},"additionalProperties":false}}},"required":true}},"get":{"tags":["Registration"],"summary":"RegistrationRead","x-operation":"RegistrationRead","x-controller":"rest","description":"Get a list of cluster registrations","operationId":"RegistrationRead_read","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Registration"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/Registration/{uuid}":{"get":{"tags":["Registration"],"summary":"RegistrationRead","x-operation":"RegistrationRead","x-controller":"rest","description":"Get a list of cluster registrations","operationId":"RegistrationRead_uuid","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Registration"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}},"post":{"tags":["Registration"],"summary":"RegistrationUpdate","x-operation":"RegistrationUpdate","x-controller":"rest","description":"Edit the cluster registration","operationId":"RegistrationUpdate","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"Registration","type":"object","properties":{"uuid":{"description":"Unique identifer ","type":"string","readOnly":true},"companyName":{"description":"Name of the company registering the cluster","type":"string"},"contact":{"description":"Name of the person registering the cluster","type":"string"},"phone":{"description":"Phone number for company contact","type":"string"},"email":{"description":"Email address for company contact","type":"string"},"latestTaskTag":{"$ref":"#/components/schemas/TaskTagStatus"},"clusterID":{"description":"Unique identifer for cluster ","type":"string","readOnly":true},"clusterData":{"description":"Server generated xml data about a system ","type":"string","readOnly":true},"clusterDataHash":{"description":"Server generated hash of xml data ","type":"string","readOnly":true},"clusterDataHashAccepted":{"description":"Last successfully submitted registration data hash ","type":"string","readOnly":true}},"additionalProperties":false}}},"required":true}},"patch":{"tags":["Registration"],"summary":"RegistrationUpdate","x-operation":"RegistrationUpdate","x-controller":"rest","description":"Edit the cluster registration","operationId":"RegistrationUpdate_patch","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"Registration","type":"object","properties":{"companyName":{"description":"Name of the company registering the cluster","type":"string"},"contact":{"description":"Name of the person registering the cluster","type":"string"},"phone":{"description":"Phone number for company contact","type":"string"},"email":{"description":"Email address for company contact","type":"string"}},"additionalProperties":false}}},"required":true}},"delete":{"tags":["Registration"],"summary":"RegistrationDelete","x-operation":"RegistrationDelete","x-controller":"rest","description":"Delete the cluster registration","operationId":"RegistrationDelete_delete","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/RemoteClusterConnection":{"get":{"tags":["RemoteClusterConnection"],"summary":"RemoteClusterConnectionRead","x-operation":"RemoteClusterConnectionRead","x-controller":"rest","description":"Get a list of secure connections to other clusters","operationId":"RemoteClusterConnectionRead_read","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RemoteClusterConnection"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/RemoteClusterConnection/{uuid}":{"get":{"tags":["RemoteClusterConnection"],"summary":"RemoteClusterConnectionRead","x-operation":"RemoteClusterConnectionRead","x-controller":"rest","description":"Get a list of secure connections to other clusters","operationId":"RemoteClusterConnectionRead_uuid","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RemoteClusterConnection"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/TaskTag":{"get":{"tags":["TaskTag"],"summary":"TaskTagStatusRead","x-operation":"TaskTagStatusRead","x-controller":"rest","description":"Get a list of Task Tag Status","operationId":"TaskTagStatusRead_read","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TaskTagStatus"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/TaskTag/{taskTag}":{"get":{"tags":["TaskTag"],"summary":"TaskTagStatusRead","x-operation":"TaskTagStatusRead","x-controller":"rest","description":"Get a list of Task Tag Status","operationId":"TaskTagStatusRead_uuid","parameters":[{"name":"taskTag","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TaskTag"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TaskTagStatus"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/TimeSource":{"post":{"tags":["TimeSource"],"summary":"TimeSourceCreate","x-operation":"TimeSourceCreate","x-controller":"rest","description":"Create a new time source configuration","operationId":"TimeSourceCreate","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"TimeSource","type":"object","properties":{"host":{"description":"IP address or hostname of the time source server ","type":"string"}},"required":["host"],"additionalProperties":false}}},"required":true}},"get":{"tags":["TimeSource"],"summary":"TimeSourceRead","x-operation":"TimeSourceRead","x-controller":"rest","description":"Get a list of Time Source configurations","operationId":"TimeSourceRead_read","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TimeSource"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/TimeSource/{uuid}":{"get":{"tags":["TimeSource"],"summary":"TimeSourceRead","x-operation":"TimeSourceRead","x-controller":"rest","description":"Get a list of Time Source configurations","operationId":"TimeSourceRead_uuid","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TimeSource"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}},"post":{"tags":["TimeSource"],"summary":"TimeSourceUpdate","x-operation":"TimeSourceUpdate","x-controller":"rest","description":"Edit a time source configuration","operationId":"TimeSourceUpdate","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"TimeSource","type":"object","properties":{"uuid":{"description":"Unique identifer ","type":"string","readOnly":true},"host":{"description":"IP address or hostname of the time source server ","type":"string"},"latestTaskTag":{"$ref":"#/components/schemas/TaskTagStatus"}},"required":["host"],"additionalProperties":false}}},"required":true}},"patch":{"tags":["TimeSource"],"summary":"TimeSourceUpdate","x-operation":"TimeSourceUpdate","x-controller":"rest","description":"Edit a time source configuration","operationId":"TimeSourceUpdate_patch","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"TimeSource","type":"object","properties":{"host":{"description":"IP address or hostname of the time source server ","type":"string"}},"additionalProperties":false}}},"required":true}},"delete":{"tags":["TimeSource"],"summary":"TimeSourceDelete","x-operation":"TimeSourceDelete","x-controller":"rest","description":"Delete a time source configuration","operationId":"TimeSourceDelete_delete","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/TimeZone":{"post":{"tags":["TimeZone"],"summary":"TimeZoneCreate","x-operation":"TimeZoneCreate","x-controller":"rest","description":"Create a new time zone configuration","operationId":"TimeZoneCreate","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"TimeZone","type":"object","properties":{"timeZone":{"description":"Time zone ","type":"string"}},"required":["timeZone"],"additionalProperties":false}}},"required":true}},"get":{"tags":["TimeZone"],"summary":"TimeZoneRead","x-operation":"TimeZoneRead","x-controller":"rest","description":"Get a list of Time Zones","operationId":"TimeZoneRead_read","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TimeZone"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/TimeZone/{uuid}":{"get":{"tags":["TimeZone"],"summary":"TimeZoneRead","x-operation":"TimeZoneRead","x-controller":"rest","description":"Get a list of Time Zones","operationId":"TimeZoneRead_uuid","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TimeZone"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}},"post":{"tags":["TimeZone"],"summary":"TimeZoneUpdate","x-operation":"TimeZoneUpdate","x-controller":"rest","description":"Edit a time zone configuration","operationId":"TimeZoneUpdate","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"TimeZone","type":"object","properties":{"uuid":{"description":"Unique identifer ","type":"string","readOnly":true},"timeZone":{"description":"Time zone ","type":"string"},"latestTaskTag":{"$ref":"#/components/schemas/TaskTagStatus"}},"required":["timeZone"],"additionalProperties":false}}},"required":true}},"patch":{"tags":["TimeZone"],"summary":"TimeZoneUpdate","x-operation":"TimeZoneUpdate","x-controller":"rest","description":"Edit a time zone configuration","operationId":"TimeZoneUpdate_patch","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"TimeZone","type":"object","properties":{"timeZone":{"description":"Time zone ","type":"string"}},"additionalProperties":false}}},"required":true}},"delete":{"tags":["TimeZone"],"summary":"TimeZoneDelete","x-operation":"TimeZoneDelete","x-controller":"rest","description":"Delete a time zone configuration","operationId":"TimeZoneDelete_delete","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/User":{"post":{"tags":["User"],"summary":"UserCreate","x-operation":"UserCreate","x-controller":"rest","description":"Create a User","operationId":"UserCreate","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"User","type":"object","properties":{"username":{"description":"Human-readable unique identifier for authentication ","type":"string"},"password":{"description":"Plain text password for authentication ","type":"string","writeOnly":true},"fullName":{"description":"Human-readable display name","type":"string"},"roleUUIDs":{"description":"_Role_ identifiers this user is a member of","type":"array","items":{"type":"string"}},"sessionLimit":{"description":"The maximum number of _Sessions_ this user may have at one time","type":"integer"}},"required":["username"],"additionalProperties":false}}},"required":true}},"get":{"tags":["User"],"summary":"UserRead","x-operation":"UserRead","x-controller":"rest","description":"Get a list of users","operationId":"UserRead_read","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/User"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/User/{uuid}":{"get":{"tags":["User"],"summary":"UserRead","x-operation":"UserRead","x-controller":"rest","description":"Get a list of users","operationId":"UserRead_uuid","parameters":[{"name":"uuid","description":"_User's_ unique identifer","in":"path","required":true,"schema":{"description":"_User's_ unique identifer","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/User"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}},"post":{"tags":["User"],"summary":"UserUpdate","x-operation":"UserUpdate","x-controller":"rest","description":"Edit User Information","operationId":"UserUpdate","parameters":[{"name":"uuid","description":"_User's_ unique identifer","in":"path","required":true,"schema":{"description":"_User's_ unique identifer","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"User","type":"object","properties":{"uuid":{"description":"Unique identifer ","type":"string","readOnly":true},"username":{"description":"Human-readable unique identifier for authentication ","type":"string"},"password":{"description":"Plain text password for authentication ","type":"string","writeOnly":true},"fullName":{"description":"Human-readable display name","type":"string"},"roleUUIDs":{"description":"_Role_ identifiers this user is a member of","type":"array","items":{"type":"string"}},"sessionLimit":{"description":"The maximum number of _Sessions_ this user may have at one time","type":"integer"}},"required":["username"],"additionalProperties":false}}},"required":true}},"patch":{"tags":["User"],"summary":"UserUpdate","x-operation":"UserUpdate","x-controller":"rest","description":"Edit User Information","operationId":"UserUpdate_patch","parameters":[{"name":"uuid","description":"_User's_ unique identifer","in":"path","required":true,"schema":{"description":"_User's_ unique identifer","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"User","type":"object","properties":{"username":{"description":"Human-readable unique identifier for authentication ","type":"string"},"password":{"description":"Plain text password for authentication ","type":"string","writeOnly":true},"fullName":{"description":"Human-readable display name","type":"string"},"roleUUIDs":{"description":"_Role_ identifiers this user is a member of","type":"array","items":{"type":"string"}},"sessionLimit":{"description":"The maximum number of _Sessions_ this user may have at one time","type":"integer"}},"additionalProperties":false}}},"required":true}},"delete":{"tags":["User"],"summary":"UserDelete","x-operation":"UserDelete","x-controller":"rest","description":"Delete a User","operationId":"UserDelete_delete","parameters":[{"name":"uuid","description":"_User's_ unique identifer","in":"path","required":true,"schema":{"description":"_User's_ unique identifer","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/Role":{"get":{"tags":["Role"],"summary":"RoleRead","x-operation":"RoleRead","x-controller":"rest","description":"Get a list of roles","operationId":"RoleRead_read","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Role"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/Role/{uuid}":{"get":{"tags":["Role"],"summary":"RoleRead","x-operation":"RoleRead","x-controller":"rest","description":"Get a list of roles","operationId":"RoleRead_uuid","parameters":[{"name":"uuid","description":"_Role's_ unique identifier","in":"path","required":true,"schema":{"description":"_Role's_ unique identifier","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Role"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/VirDomain":{"get":{"tags":["VirDomain"],"summary":"VirDomainRead","x-operation":"VirDomainRead","x-controller":"rest","description":"Get a list of VMs","operationId":"VirDomainRead_read","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VirDomain"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}},"post":{"tags":["VirDomain"],"summary":"VirDomainCreate","x-operation":"VirDomainCreate","x-controller":"rest","description":"Create a new VM","operationId":"VirDomainCreate","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"dom":{"title":"VirDomain","type":"object","properties":{"uuid":{"description":"Unique identifier ","type":"string","readOnly":true},"nodeUUID":{"description":"Unique identifier of the _Node_ this is currently hosted on ","type":"string","readOnly":true},"name":{"description":"Human-readable name","type":"string"},"description":{"description":"Human-readable description ","type":"string"},"operatingSystem":{"description":"Operating system name. Used to select drivers package","type":"string"},"state":{"$ref":"#/components/schemas/VirDomainState"},"desiredDisposition":{"$ref":"#/components/schemas/VirDomainDisposition"},"console":{"$ref":"#/components/schemas/VirDomainConsole"},"mem":{"description":"Amount of memory reserved, in bytes.  \n May only be modified if the domain is in the _VirDomainState.SHUTOFF_ or _VirDomainState.CRASHED_ states","type":"integer"},"numVCPU":{"description":"Number of allotted virtual CPUs.  \n May only be modified if the domain is in the SHUTOFF or CRASHED states","type":"integer"},"blockDevs":{"description":"Attached virtual block devices _**CREATE-ONLY**_  \n Use _VirDomainBlockDeviceCreate,_ _VirDomainBlockDeviceUpdate,_ or _VirDomainBlockDeviceDelete_","type":"array","items":{"$ref":"#/components/schemas/VirDomainBlockDevice"}},"netDevs":{"description":"Attached virtual network devices _**CREATE-ONLY**_  \n Use _VirDomainNetDeviceCreate,_ _VirDomainNetDeviceUpdate,_ or _VirDomainNetDeviceDelete_","type":"array","items":{"$ref":"#/components/schemas/VirDomainNetDevice"}},"deprecated_stats":{"$ref":"#/components/schemas/StatsData"},"created":{"description":"Unix timestamp of creation time ","type":"integer","readOnly":true},"modified":{"description":"Unix timestamp of Last modified time ","type":"integer","readOnly":true},"latestTaskTag":{"$ref":"#/components/schemas/TaskTagStatus"},"tags":{"description":"User-modifiable words for organizing a group of VMs. Multiple tags should be comma-separated.","type":"string"},"bootDevices":{"description":"Unique identifiers of the bootable block and net devices, in the order that they will boot","type":"array","items":{"type":"string"}},"uiState":{"$ref":"#/components/schemas/VirDomainUIState"},"snapUUIDs":{"description":"Unique identifiers of current snapshots taken of this VM ","type":"array","items":{"type":"string"},"readOnly":true},"snapshotSerialNumber":{"description":"Serial number of the most recent snapshot _**INTERNAL**_","type":"integer"},"replicationUUIDs":{"description":"Unique identifiers of replication targets _**INTERNAL**_","type":"array","items":{"type":"string"}},"sourceVirDomainUUID":{"description":"Unique identifier of the replication source _VirDomain_ (non-empty indicates this is a replication target) ","type":"string","readOnly":true},"snapshotListSerialNumber":{"description":"Generation of the snapshot list _**INTERNAL**_","type":"integer"},"snapshotScheduleUUID":{"description":"Unique identifier of the  _VirDomainSnapshotSchedule_ for automated snapshots","type":"string"},"machineType":{"description":"Scale 'Hardware' version. Use _VirDomainCreateOptions_ machineTypeKeyword instead.  Possible values include:  \n | machineType | Description |  \n | ----------- | ----------- |  \n | scale-7.2 | BIOS |  \n | scale-8.10 | UEFI |  \n | scale-uefi-tpm-9.2 | vTPM+UEFI (Experiemental) |","type":"string"},"cpuType":{"description":"Scale 'CPU Model' Possible values include:  \n | cpuType | Description |  \n | ------- | ----------- |  \n | clusterBaseline-7.3 | (default) Largest feature set that can run in on any node in a cluster |  \n | HC1150-9.2 | Constant feature set that can run on all scale hardware running 9.2 |","type":"string"},"snapshotAllocationBlocks":{"description":"Total number of blocks actually used by snapshots ","type":"integer","readOnly":true},"guestAgentState":{"$ref":"#/components/schemas/GuestAgentState"},"lastSeenRunningOnNodeUUID":{"description":"Unique identifier of the _Node_ where this VM last ran ","type":"string","readOnly":true},"isTransient":{"description":"This is set for VMs that are temporary _**INTERNAL**_","type":"boolean","default":false},"affinityStrategy":{"$ref":"#/components/schemas/VirDomainAffinityStrategy"},"vsdUUIDsToDelete":{"description":"VSDs to be deleted _**INTERNAL**_","type":"array","items":{"type":"string"}},"cloudInitData":{"$ref":"#/components/schemas/CloudInitData"},"initialCloneSnapshotUUID":{"description":"If this VM was cloned, the _VirDomainSnapshot.uuid_ of the replication optimiziation snapshot _**INTERNAL**_","type":"string"},"machineTypeKeyword":{"description":"Computed keyword matching the VM's current machine type. see @VirDomainCreateOptions ","type":"string","readOnly":true}}},"options":{"title":"VirDomainCreateOptions","type":"object","properties":{"attachGuestToolsISO":{"description":"If supported by _VirDomain.operatingSystem,_ create an extra device to attach the Scale Guest OS tools ISO","type":"boolean","default":true},"machineTypeKeyword":{"description":"Key word to use when creating the machine  \n | keyword | Description |  \n | ----------- | ----------- |  \n | bios | BIOS |  \n | uefi | UEFI |  \n | tpm | vTPM+UEFI |  \n | tpm-compatible | vTPM+UEFI (Compatibility) |","type":"string","default":""}},"additionalProperties":false}},"required":["dom","options"],"additionalProperties":false}}},"required":true}}},"/VirDomain/{virDomainUUID}":{"get":{"tags":["VirDomain"],"summary":"VirDomainRead","x-operation":"VirDomainRead","x-controller":"rest","description":"Get a list of VMs","operationId":"VirDomainRead_uuid","parameters":[{"name":"virDomainUUID","description":"VM's Unique identifier","in":"path","required":true,"schema":{"description":"VM's Unique identifier","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VirDomain"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}},"post":{"tags":["VirDomain"],"summary":"VirDomainUpdate","x-operation":"VirDomainUpdate","x-controller":"rest","description":"Edit a VM","operationId":"VirDomainUpdate","parameters":[{"name":"virDomainUUID","description":"VM's Unique identifier","in":"path","required":true,"schema":{"description":"VM's Unique identifier","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"VirDomain","type":"object","properties":{"uuid":{"description":"Unique identifier ","type":"string","readOnly":true},"nodeUUID":{"description":"Unique identifier of the _Node_ this is currently hosted on ","type":"string","readOnly":true},"name":{"description":"Human-readable name","type":"string"},"description":{"description":"Human-readable description ","type":"string"},"operatingSystem":{"description":"Operating system name. Used to select drivers package","type":"string"},"state":{"$ref":"#/components/schemas/VirDomainState"},"desiredDisposition":{"$ref":"#/components/schemas/VirDomainDisposition"},"console":{"$ref":"#/components/schemas/VirDomainConsole"},"mem":{"description":"Amount of memory reserved, in bytes.  \n May only be modified if the domain is in the _VirDomainState.SHUTOFF_ or _VirDomainState.CRASHED_ states","type":"integer"},"numVCPU":{"description":"Number of allotted virtual CPUs.  \n May only be modified if the domain is in the SHUTOFF or CRASHED states","type":"integer"},"blockDevs":{"description":"Attached virtual block devices _**CREATE-ONLY**_  \n Use _VirDomainBlockDeviceCreate,_ _VirDomainBlockDeviceUpdate,_ or _VirDomainBlockDeviceDelete_","type":"array","items":{"$ref":"#/components/schemas/VirDomainBlockDevice"}},"netDevs":{"description":"Attached virtual network devices _**CREATE-ONLY**_  \n Use _VirDomainNetDeviceCreate,_ _VirDomainNetDeviceUpdate,_ or _VirDomainNetDeviceDelete_","type":"array","items":{"$ref":"#/components/schemas/VirDomainNetDevice"}},"deprecated_stats":{"$ref":"#/components/schemas/StatsData"},"created":{"description":"Unix timestamp of creation time ","type":"integer","readOnly":true},"modified":{"description":"Unix timestamp of Last modified time ","type":"integer","readOnly":true},"latestTaskTag":{"$ref":"#/components/schemas/TaskTagStatus"},"tags":{"description":"User-modifiable words for organizing a group of VMs. Multiple tags should be comma-separated.","type":"string"},"bootDevices":{"description":"Unique identifiers of the bootable block and net devices, in the order that they will boot","type":"array","items":{"type":"string"}},"uiState":{"$ref":"#/components/schemas/VirDomainUIState"},"snapUUIDs":{"description":"Unique identifiers of current snapshots taken of this VM ","type":"array","items":{"type":"string"},"readOnly":true},"snapshotSerialNumber":{"description":"Serial number of the most recent snapshot _**INTERNAL**_","type":"integer"},"replicationUUIDs":{"description":"Unique identifiers of replication targets _**INTERNAL**_","type":"array","items":{"type":"string"}},"sourceVirDomainUUID":{"description":"Unique identifier of the replication source _VirDomain_ (non-empty indicates this is a replication target) ","type":"string","readOnly":true},"snapshotListSerialNumber":{"description":"Generation of the snapshot list _**INTERNAL**_","type":"integer"},"snapshotScheduleUUID":{"description":"Unique identifier of the  _VirDomainSnapshotSchedule_ for automated snapshots","type":"string"},"machineType":{"description":"Scale 'Hardware' version. Use _VirDomainCreateOptions_ machineTypeKeyword instead.  Possible values include:  \n | machineType | Description |  \n | ----------- | ----------- |  \n | scale-7.2 | BIOS |  \n | scale-8.10 | UEFI |  \n | scale-uefi-tpm-9.2 | vTPM+UEFI (Experiemental) |","type":"string"},"cpuType":{"description":"Scale 'CPU Model' Possible values include:  \n | cpuType | Description |  \n | ------- | ----------- |  \n | clusterBaseline-7.3 | (default) Largest feature set that can run in on any node in a cluster |  \n | HC1150-9.2 | Constant feature set that can run on all scale hardware running 9.2 |","type":"string"},"snapshotAllocationBlocks":{"description":"Total number of blocks actually used by snapshots ","type":"integer","readOnly":true},"guestAgentState":{"$ref":"#/components/schemas/GuestAgentState"},"lastSeenRunningOnNodeUUID":{"description":"Unique identifier of the _Node_ where this VM last ran ","type":"string","readOnly":true},"isTransient":{"description":"This is set for VMs that are temporary _**INTERNAL**_","type":"boolean","default":false},"affinityStrategy":{"$ref":"#/components/schemas/VirDomainAffinityStrategy"},"vsdUUIDsToDelete":{"description":"VSDs to be deleted _**INTERNAL**_","type":"array","items":{"type":"string"}},"cloudInitData":{"$ref":"#/components/schemas/CloudInitData"},"initialCloneSnapshotUUID":{"description":"If this VM was cloned, the _VirDomainSnapshot.uuid_ of the replication optimiziation snapshot _**INTERNAL**_","type":"string"},"machineTypeKeyword":{"description":"Computed keyword matching the VM's current machine type. see @VirDomainCreateOptions ","type":"string","readOnly":true}},"additionalProperties":false}}},"required":true}},"patch":{"tags":["VirDomain"],"summary":"VirDomainUpdate","x-operation":"VirDomainUpdate","x-controller":"rest","description":"Edit a VM","operationId":"VirDomainUpdate_patch","parameters":[{"name":"virDomainUUID","description":"VM's Unique identifier","in":"path","required":true,"schema":{"description":"VM's Unique identifier","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"VirDomain","type":"object","properties":{"name":{"description":"Human-readable name","type":"string"},"description":{"description":"Human-readable description ","type":"string"},"operatingSystem":{"description":"Operating system name. Used to select drivers package","type":"string"},"mem":{"description":"Amount of memory reserved, in bytes.  \n May only be modified if the domain is in the _VirDomainState.SHUTOFF_ or _VirDomainState.CRASHED_ states","type":"integer"},"numVCPU":{"description":"Number of allotted virtual CPUs.  \n May only be modified if the domain is in the SHUTOFF or CRASHED states","type":"integer"},"blockDevs":{"description":"Attached virtual block devices _**CREATE-ONLY**_  \n Use _VirDomainBlockDeviceCreate,_ _VirDomainBlockDeviceUpdate,_ or _VirDomainBlockDeviceDelete_","type":"array","items":{"$ref":"#/components/schemas/VirDomainBlockDevice"}},"netDevs":{"description":"Attached virtual network devices _**CREATE-ONLY**_  \n Use _VirDomainNetDeviceCreate,_ _VirDomainNetDeviceUpdate,_ or _VirDomainNetDeviceDelete_","type":"array","items":{"$ref":"#/components/schemas/VirDomainNetDevice"}},"tags":{"description":"User-modifiable words for organizing a group of VMs. Multiple tags should be comma-separated.","type":"string"},"bootDevices":{"description":"Unique identifiers of the bootable block and net devices, in the order that they will boot","type":"array","items":{"type":"string"}},"snapshotScheduleUUID":{"description":"Unique identifier of the  _VirDomainSnapshotSchedule_ for automated snapshots","type":"string"},"machineType":{"description":"Scale 'Hardware' version. Use _VirDomainCreateOptions_ machineTypeKeyword instead.  Possible values include:  \n | machineType | Description |  \n | ----------- | ----------- |  \n | scale-7.2 | BIOS |  \n | scale-8.10 | UEFI |  \n | scale-uefi-tpm-9.2 | vTPM+UEFI (Experiemental) |","type":"string"},"cpuType":{"description":"Scale 'CPU Model' Possible values include:  \n | cpuType | Description |  \n | ------- | ----------- |  \n | clusterBaseline-7.3 | (default) Largest feature set that can run in on any node in a cluster |  \n | HC1150-9.2 | Constant feature set that can run on all scale hardware running 9.2 |","type":"string"},"affinityStrategy":{"$ref":"#/components/schemas/VirDomainAffinityStrategy"},"cloudInitData":{"$ref":"#/components/schemas/CloudInitData"}},"additionalProperties":false}}},"required":true}},"delete":{"tags":["VirDomain"],"summary":"VirDomainDelete","x-operation":"VirDomainDelete","x-controller":"rest","description":"Delete a VM","operationId":"VirDomainDelete_delete","parameters":[{"name":"virDomainUUID","description":"VM's Unique identifier","in":"path","required":true,"schema":{"description":"VM's Unique identifier","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/VirDomainBlockDevice":{"post":{"tags":["VirDomainBlockDevice"],"summary":"VirDomainBlockDeviceCreate","x-operation":"VirDomainBlockDeviceCreate","x-controller":"rest","description":"Create a new _VirDomainBlockDevice_","operationId":"VirDomainBlockDeviceCreate","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"VirDomainBlockDevice","type":"object","properties":{"virDomainUUID":{"description":"Identifier of the VirDomain this device is attached to _**CREATE-ONLY**_   \n This may be left blank if this block device is being created as part of a VirDomainCreate call","type":"string"},"type":{"$ref":"#/components/schemas/VirDomainBlockDeviceType"},"cacheMode":{"$ref":"#/components/schemas/VirDomainBlockDeviceCacheMode"},"capacity":{"description":"Logical size of the device in bytes, and can be increased on update or clone ","type":"integer"},"shareUUID":{"description":"_**DEPRECATED**_ _**INTERNAL**_","type":"string"},"path":{"description":"Path to the backing storage device, in the format of scribe/uuid  \n UUID is either a VirDomainBlockDevice or ISO UUID  \n Only devices of type IDE_CDROM can have their path changed, and only to a valid ISO path","type":"string"},"slot":{"description":"Virtual slot the drive will occupy. For behavior _VirDomainBlockDeviceCreate._ _**CREATE-ONLY**_","type":"integer","default":-1},"name":{"description":"Name of the virtual storage device  \n Only devices of type IDE_CDROM can have their name changed, and must end in '.iso'","type":"string"},"disableSnapshotting":{"description":"Disables the ability to snapshot the drive","type":"boolean"},"tieringPriorityFactor":{"description":" * SSD tiering priority factor for block placement. Check the tiering documentation for best practices.  \n  * It is recommended to follow the Hypercore UI settings:  \n | UI Setting | Priority Factor Value |  \n | ---------- | --------------------- |  \n | 0          |                     0 |  \n | 1          |                     1 |  \n | 2          |                     2 |  \n | 3          |                     4 |  \n | 4          |           (default) 8 |  \n | 5          |                    16 |  \n | 6          |                    32 |  \n | 7          |                    64 |  \n | 8          |                   128 |  \n | 9          |                   256 |  \n | 10         |                  1024 |  \n | 11         |                 10240 |","type":"integer","default":8}},"required":["type","capacity"],"additionalProperties":false}}},"required":true}},"get":{"tags":["VirDomainBlockDevice"],"summary":"VirDomainBlockDeviceRead","x-operation":"VirDomainBlockDeviceRead","x-controller":"rest","description":"Get a list of _VirDomainBlockDevices_","operationId":"VirDomainBlockDeviceRead_read","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VirDomainBlockDevice"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/VirDomainBlockDevice/{uuid}":{"get":{"tags":["VirDomainBlockDevice"],"summary":"VirDomainBlockDeviceRead","x-operation":"VirDomainBlockDeviceRead","x-controller":"rest","description":"Get a list of _VirDomainBlockDevices_","operationId":"VirDomainBlockDeviceRead_uuid","parameters":[{"name":"uuid","description":"_VirDomainBlockDevice_ unique identifier","in":"path","required":true,"schema":{"description":"_VirDomainBlockDevice_ unique identifier","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VirDomainBlockDevice"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}},"post":{"tags":["VirDomainBlockDevice"],"summary":"VirDomainBlockDeviceUpdate","x-operation":"VirDomainBlockDeviceUpdate","x-controller":"rest","description":"Edit a _VirDomainBlockDevice_","operationId":"VirDomainBlockDeviceUpdate","parameters":[{"name":"uuid","description":"_VirDomainBlockDevice_ unique identifier","in":"path","required":true,"schema":{"description":"_VirDomainBlockDevice_ unique identifier","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"VirDomainBlockDevice","type":"object","properties":{"uuid":{"description":"Unique Identifier ","type":"string","readOnly":true},"virDomainUUID":{"description":"Identifier of the VirDomain this device is attached to _**CREATE-ONLY**_   \n This may be left blank if this block device is being created as part of a VirDomainCreate call","type":"string"},"type":{"$ref":"#/components/schemas/VirDomainBlockDeviceType"},"cacheMode":{"$ref":"#/components/schemas/VirDomainBlockDeviceCacheMode"},"capacity":{"description":"Logical size of the device in bytes, and can be increased on update or clone ","type":"integer"},"allocation":{"description":"Total amount of disk space in use in bytes ","type":"integer","readOnly":true},"physical":{"description":"Physical size of the backing virtual storage device in bytes ","type":"integer","readOnly":true},"shareUUID":{"description":"_**DEPRECATED**_ _**INTERNAL**_","type":"string"},"path":{"description":"Path to the backing storage device, in the format of scribe/uuid  \n UUID is either a VirDomainBlockDevice or ISO UUID  \n Only devices of type IDE_CDROM can have their path changed, and only to a valid ISO path","type":"string"},"slot":{"description":"Virtual slot the drive will occupy. For behavior _VirDomainBlockDeviceCreate._ _**CREATE-ONLY**_","type":"integer","default":-1},"name":{"description":"Name of the virtual storage device  \n Only devices of type IDE_CDROM can have their name changed, and must end in '.iso'","type":"string"},"disableSnapshotting":{"description":"Disables the ability to snapshot the drive","type":"boolean"},"tieringPriorityFactor":{"description":" * SSD tiering priority factor for block placement. Check the tiering documentation for best practices.  \n  * It is recommended to follow the Hypercore UI settings:  \n | UI Setting | Priority Factor Value |  \n | ---------- | --------------------- |  \n | 0          |                     0 |  \n | 1          |                     1 |  \n | 2          |                     2 |  \n | 3          |                     4 |  \n | 4          |           (default) 8 |  \n | 5          |                    16 |  \n | 6          |                    32 |  \n | 7          |                    64 |  \n | 8          |                   128 |  \n | 9          |                   256 |  \n | 10         |                  1024 |  \n | 11         |                 10240 |","type":"integer","default":8},"mountPoints":{"description":"Mount points of the drive in the guest OS, populated by the guest-agent ","type":"array","items":{"type":"string"},"readOnly":true},"createdTimestamp":{"description":"Unix timestamp of the drive's creation time  ","type":"integer","readOnly":true},"readOnly":{"description":"When true, this device was created via _VirDomainSnapshotBlockDeviceCreate_ with _VirDomainSnapshotBlockDeviceCreateOptions.readOnly_ ","type":"boolean","readOnly":true}},"required":["type","capacity"],"additionalProperties":false}}},"required":true}},"patch":{"tags":["VirDomainBlockDevice"],"summary":"VirDomainBlockDeviceUpdate","x-operation":"VirDomainBlockDeviceUpdate","x-controller":"rest","description":"Edit a _VirDomainBlockDevice_","operationId":"VirDomainBlockDeviceUpdate_patch","parameters":[{"name":"uuid","description":"_VirDomainBlockDevice_ unique identifier","in":"path","required":true,"schema":{"description":"_VirDomainBlockDevice_ unique identifier","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"VirDomainBlockDevice","type":"object","properties":{"virDomainUUID":{"description":"Identifier of the VirDomain this device is attached to _**CREATE-ONLY**_   \n This may be left blank if this block device is being created as part of a VirDomainCreate call","type":"string"},"type":{"$ref":"#/components/schemas/VirDomainBlockDeviceType"},"cacheMode":{"$ref":"#/components/schemas/VirDomainBlockDeviceCacheMode"},"capacity":{"description":"Logical size of the device in bytes, and can be increased on update or clone ","type":"integer"},"path":{"description":"Path to the backing storage device, in the format of scribe/uuid  \n UUID is either a VirDomainBlockDevice or ISO UUID  \n Only devices of type IDE_CDROM can have their path changed, and only to a valid ISO path","type":"string"},"slot":{"description":"Virtual slot the drive will occupy. For behavior _VirDomainBlockDeviceCreate._ _**CREATE-ONLY**_","type":"integer","default":-1},"name":{"description":"Name of the virtual storage device  \n Only devices of type IDE_CDROM can have their name changed, and must end in '.iso'","type":"string"},"disableSnapshotting":{"description":"Disables the ability to snapshot the drive","type":"boolean"},"tieringPriorityFactor":{"description":" * SSD tiering priority factor for block placement. Check the tiering documentation for best practices.  \n  * It is recommended to follow the Hypercore UI settings:  \n | UI Setting | Priority Factor Value |  \n | ---------- | --------------------- |  \n | 0          |                     0 |  \n | 1          |                     1 |  \n | 2          |                     2 |  \n | 3          |                     4 |  \n | 4          |           (default) 8 |  \n | 5          |                    16 |  \n | 6          |                    32 |  \n | 7          |                    64 |  \n | 8          |                   128 |  \n | 9          |                   256 |  \n | 10         |                  1024 |  \n | 11         |                 10240 |","type":"integer","default":8}},"additionalProperties":false}}},"required":true}},"delete":{"tags":["VirDomainBlockDevice"],"summary":"VirDomainBlockDeviceDelete","x-operation":"VirDomainBlockDeviceDelete","x-controller":"rest","description":"Delete a _VirDomainBlockDevice_","operationId":"VirDomainBlockDeviceDelete_delete","parameters":[{"name":"uuid","description":"_VirDomainBlockDevice_ unique identifier","in":"path","required":true,"schema":{"description":"_VirDomainBlockDevice_ unique identifier","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/VirDomainNetDevice":{"post":{"tags":["VirDomainNetDevice"],"summary":"VirDomainNetDeviceCreate","x-operation":"VirDomainNetDeviceCreate","x-controller":"rest","description":"Create and attach a new virtual network device  \n VM must be shutoff when adding a new network device","operationId":"VirDomainNetDeviceCreate","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"VirDomainNetDevice","type":"object","properties":{"virDomainUUID":{"description":"Unique identifier of the _VirDomain_ this device is attached to _**CREATE-ONLY**_  \n May be left blank if this net device is being created as part of _VirDomainCreate_","type":"string"},"type":{"$ref":"#/components/schemas/VirDomainNetDeviceType"},"macAddress":{"description":"MAC address of the virtual network device.  \n Leave blank for one to be generated","type":"string"},"vlan":{"description":"VLAN tag of the interface  \n Valid values are 0-4094  \n 0 is the default, and means bridged (sees all VLANs, including tagged traffic)","type":"integer","default":0},"connected":{"description":"Enabled and can make connections","type":"boolean","default":true}},"additionalProperties":false}}},"required":true}},"get":{"tags":["VirDomainNetDevice"],"summary":"VirDomainNetDeviceRead","x-operation":"VirDomainNetDeviceRead","x-controller":"rest","description":"Retrieve a list of virtual network devices","operationId":"VirDomainNetDeviceRead_read","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VirDomainNetDevice"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/VirDomainNetDevice/{uuid}":{"get":{"tags":["VirDomainNetDevice"],"summary":"VirDomainNetDeviceRead","x-operation":"VirDomainNetDeviceRead","x-controller":"rest","description":"Retrieve a list of virtual network devices","operationId":"VirDomainNetDeviceRead_uuid","parameters":[{"name":"uuid","description":"_VirDomainNetDevice_ unique identifier","in":"path","required":true,"schema":{"description":"_VirDomainNetDevice_ unique identifier","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VirDomainNetDevice"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}},"post":{"tags":["VirDomainNetDevice"],"summary":"VirDomainNetDeviceUpdate","x-operation":"VirDomainNetDeviceUpdate","x-controller":"rest","description":"Edit a virtual network device","operationId":"VirDomainNetDeviceUpdate","parameters":[{"name":"uuid","description":"_VirDomainNetDevice_ unique identifier","in":"path","required":true,"schema":{"description":"_VirDomainNetDevice_ unique identifier","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"VirDomainNetDevice","type":"object","properties":{"uuid":{"description":"Unique identifier ","type":"string","readOnly":true},"virDomainUUID":{"description":"Unique identifier of the _VirDomain_ this device is attached to _**CREATE-ONLY**_  \n May be left blank if this net device is being created as part of _VirDomainCreate_","type":"string"},"type":{"$ref":"#/components/schemas/VirDomainNetDeviceType"},"macAddress":{"description":"MAC address of the virtual network device.  \n Leave blank for one to be generated","type":"string"},"vlan":{"description":"VLAN tag of the interface  \n Valid values are 0-4094  \n 0 is the default, and means bridged (sees all VLANs, including tagged traffic)","type":"integer","default":0},"connected":{"description":"Enabled and can make connections","type":"boolean","default":true},"ipv4Addresses":{"description":"IPv4 addresses registered with this device ","type":"array","items":{"type":"string"},"readOnly":true}},"additionalProperties":false}}},"required":true}},"patch":{"tags":["VirDomainNetDevice"],"summary":"VirDomainNetDeviceUpdate","x-operation":"VirDomainNetDeviceUpdate","x-controller":"rest","description":"Edit a virtual network device","operationId":"VirDomainNetDeviceUpdate_patch","parameters":[{"name":"uuid","description":"_VirDomainNetDevice_ unique identifier","in":"path","required":true,"schema":{"description":"_VirDomainNetDevice_ unique identifier","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"VirDomainNetDevice","type":"object","properties":{"virDomainUUID":{"description":"Unique identifier of the _VirDomain_ this device is attached to _**CREATE-ONLY**_  \n May be left blank if this net device is being created as part of _VirDomainCreate_","type":"string"},"type":{"$ref":"#/components/schemas/VirDomainNetDeviceType"},"macAddress":{"description":"MAC address of the virtual network device.  \n Leave blank for one to be generated","type":"string"},"vlan":{"description":"VLAN tag of the interface  \n Valid values are 0-4094  \n 0 is the default, and means bridged (sees all VLANs, including tagged traffic)","type":"integer","default":0},"connected":{"description":"Enabled and can make connections","type":"boolean","default":true}},"additionalProperties":false}}},"required":true}},"delete":{"tags":["VirDomainNetDevice"],"summary":"VirDomainNetDeviceDelete","x-operation":"VirDomainNetDeviceDelete","x-controller":"rest","description":"Delete a virtual network device  \n VM must be shutoff when deleting a network device","operationId":"VirDomainNetDeviceDelete_delete","parameters":[{"name":"uuid","description":"_VirDomainNetDevice_ unique identifier","in":"path","required":true,"schema":{"description":"_VirDomainNetDevice_ unique identifier","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/VirDomainReplication":{"post":{"tags":["VirDomainReplication"],"summary":"VirDomainReplicationCreate","x-operation":"VirDomainReplicationCreate","x-controller":"rest","description":"Create and initiate a VM Replication to a remote (target) system","operationId":"VirDomainReplicationCreate","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"VirDomainReplication","type":"object","properties":{"sourceDomainUUID":{"description":"Source _VirDomain.uuid_ _**CREATE-ONLY**_ ","type":"string"},"connectionUUID":{"description":"Remote connection unique identifier ","type":"string"},"enable":{"description":"Enable or disable replication ","type":"boolean"},"label":{"description":"Human-readable label describing the replication purpose","type":"string"},"deprecated_sourceVSDInitialSerialNumber":{"description":"_**DEPRECATED**_","type":"integer"}},"required":["connectionUUID","enable"],"additionalProperties":false}}},"required":true}},"get":{"tags":["VirDomainReplication"],"summary":"VirDomainReplicationRead","x-operation":"VirDomainReplicationRead","x-controller":"rest","description":"Get a list of VM Replications","operationId":"VirDomainReplicationRead_read","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VirDomainReplication"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/VirDomainReplication/{uuid}":{"get":{"tags":["VirDomainReplication"],"summary":"VirDomainReplicationRead","x-operation":"VirDomainReplicationRead","x-controller":"rest","description":"Get a list of VM Replications","operationId":"VirDomainReplicationRead_uuid","parameters":[{"name":"uuid","description":"UUID of the VirDomainReplication","in":"path","required":true,"schema":{"description":"UUID of the VirDomainReplication","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VirDomainReplication"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}},"post":{"tags":["VirDomainReplication"],"summary":"VirDomainReplicationUpdate","x-operation":"VirDomainReplicationUpdate","x-controller":"rest","description":"Edit a VM Replication to a remote (target) system","operationId":"VirDomainReplicationUpdate","parameters":[{"name":"uuid","description":"UUID of the VirDomainReplication","in":"path","required":true,"schema":{"description":"UUID of the VirDomainReplication","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"VirDomainReplication","type":"object","properties":{"uuid":{"description":"Unique identifier ","type":"string","readOnly":true},"sourceDomainUUID":{"description":"Source _VirDomain.uuid_ _**CREATE-ONLY**_ ","type":"string"},"targetDomainUUID":{"description":"Remote target _VirDomain.uuid_ ","type":"string","readOnly":true},"connectionUUID":{"description":"Remote connection unique identifier ","type":"string"},"enable":{"description":"Enable or disable replication ","type":"boolean"},"label":{"description":"Human-readable label describing the replication purpose","type":"string"},"deprecated_sourceVSDInitialSerialNumber":{"description":"_**DEPRECATED**_","type":"integer"},"progress":{"$ref":"#/components/schemas/VirDomainReplicationProgress"}},"required":["connectionUUID","enable"],"additionalProperties":false}}},"required":true}},"patch":{"tags":["VirDomainReplication"],"summary":"VirDomainReplicationUpdate","x-operation":"VirDomainReplicationUpdate","x-controller":"rest","description":"Edit a VM Replication to a remote (target) system","operationId":"VirDomainReplicationUpdate_patch","parameters":[{"name":"uuid","description":"UUID of the VirDomainReplication","in":"path","required":true,"schema":{"description":"UUID of the VirDomainReplication","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"VirDomainReplication","type":"object","properties":{"sourceDomainUUID":{"description":"Source _VirDomain.uuid_ _**CREATE-ONLY**_ ","type":"string"},"connectionUUID":{"description":"Remote connection unique identifier ","type":"string"},"enable":{"description":"Enable or disable replication ","type":"boolean"},"label":{"description":"Human-readable label describing the replication purpose","type":"string"}},"additionalProperties":false}}},"required":true}}},"/VirDomainSnapshot":{"post":{"tags":["VirDomainSnapshot"],"summary":"VirDomainSnapshotCreate2","x-operation":"VirDomainSnapshotCreate2","x-controller":"rest","description":"Capture a persistent copy of the state of a VM  \n Excludes RAM/running state","operationId":"VirDomainSnapshotCreate2","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"VirDomainSnapshot","type":"object","properties":{"domainUUID":{"description":"Unique identifier of source VM _VirDomain.uuid_  _**CREATE-ONLY**_","type":"string"},"label":{"description":"User-readable label describing the snapshot _**CREATE-ONLY**_","type":"string"},"type":{"$ref":"#/components/schemas/VirDomainSnapshotType"},"automatedTriggerTimestamp":{"description":"Unix timestamp used when determining which automated snapshots to retain _**INTERNAL**_","type":"integer"},"localRetainUntilTimestamp":{"description":"Unix timestamp indicating when automated snapshots will be automatically removed","type":"integer"},"remoteRetainUntilTimestamp":{"description":"Unix timestamp indicating when remote automated snapshots will be removed","type":"integer"},"blockCountDiffFromSerialNumber":{"description":"Snapshot serial number of the previous snapshot used to calculate _VirDomainSnapshot.blockCountDiff_","type":"integer","default":-1},"replication":{"description":"When false, will not replicate snapshot to a remote system if replication is configured","type":"boolean","default":true}},"additionalProperties":false}}},"required":true}},"get":{"tags":["VirDomainSnapshot"],"summary":"VirDomainSnapshotRead","x-operation":"VirDomainSnapshotRead","x-controller":"rest","description":"Get a list of VM snapshots","operationId":"VirDomainSnapshotRead_read","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VirDomainSnapshot"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/VirDomainSnapshot/{uuid}":{"get":{"tags":["VirDomainSnapshot"],"summary":"VirDomainSnapshotRead","x-operation":"VirDomainSnapshotRead","x-controller":"rest","description":"Get a list of VM snapshots","operationId":"VirDomainSnapshotRead_uuid","parameters":[{"name":"uuid","description":"_VirDomainSnapshot.uuid_","in":"path","required":true,"schema":{"description":"_VirDomainSnapshot.uuid_","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VirDomainSnapshot"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}},"delete":{"tags":["VirDomainSnapshot"],"summary":"VirDomainSnapshotDelete","x-operation":"VirDomainSnapshotDelete","x-controller":"rest","description":"Delete a VM Snapshot","operationId":"VirDomainSnapshotDelete_delete","parameters":[{"name":"uuid","description":"_VirDomainSnapshot.uuid_","in":"path","required":true,"schema":{"description":"_VirDomainSnapshot.uuid_","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/VirDomainSnapshotSchedule":{"post":{"tags":["VirDomainSnapshotSchedule"],"summary":"VirDomainSnapshotScheduleCreate","x-operation":"VirDomainSnapshotScheduleCreate","x-controller":"rest","description":"Create an automated VM Snapshot Schedule","operationId":"VirDomainSnapshotScheduleCreate","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"VirDomainSnapshotSchedule","type":"object","properties":{"name":{"description":"Human-readable name ","type":"string"},"rrules":{"description":"Snapshot scheduling rules ","type":"array","items":{"$ref":"#/components/schemas/VirDomainSnapshotRecurrenceRule"}}},"required":["name","rrules"],"additionalProperties":false}}},"required":true}},"get":{"tags":["VirDomainSnapshotSchedule"],"summary":"VirDomainSnapshotScheduleRead","x-operation":"VirDomainSnapshotScheduleRead","x-controller":"rest","description":"Get a list of automated VM Snapshot Schedules","operationId":"VirDomainSnapshotScheduleRead_read","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VirDomainSnapshotSchedule"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/VirDomainSnapshotSchedule/{uuid}":{"get":{"tags":["VirDomainSnapshotSchedule"],"summary":"VirDomainSnapshotScheduleRead","x-operation":"VirDomainSnapshotScheduleRead","x-controller":"rest","description":"Get a list of automated VM Snapshot Schedules","operationId":"VirDomainSnapshotScheduleRead_uuid","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VirDomainSnapshotSchedule"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}},"post":{"tags":["VirDomainSnapshotSchedule"],"summary":"VirDomainSnapshotScheduleUpdate","x-operation":"VirDomainSnapshotScheduleUpdate","x-controller":"rest","description":"Edit an automated VM Snapshot Schedule","operationId":"VirDomainSnapshotScheduleUpdate","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"VirDomainSnapshotSchedule","type":"object","properties":{"uuid":{"description":"Unique identifier ","type":"string","readOnly":true},"name":{"description":"Human-readable name ","type":"string"},"rrules":{"description":"Snapshot scheduling rules ","type":"array","items":{"$ref":"#/components/schemas/VirDomainSnapshotRecurrenceRule"}}},"required":["name","rrules"],"additionalProperties":false}}},"required":true}},"patch":{"tags":["VirDomainSnapshotSchedule"],"summary":"VirDomainSnapshotScheduleUpdate","x-operation":"VirDomainSnapshotScheduleUpdate","x-controller":"rest","description":"Edit an automated VM Snapshot Schedule","operationId":"VirDomainSnapshotScheduleUpdate_patch","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"title":"VirDomainSnapshotSchedule","type":"object","properties":{"name":{"description":"Human-readable name ","type":"string"},"rrules":{"description":"Snapshot scheduling rules ","type":"array","items":{"$ref":"#/components/schemas/VirDomainSnapshotRecurrenceRule"}}},"additionalProperties":false}}},"required":true}},"delete":{"tags":["VirDomainSnapshotSchedule"],"summary":"VirDomainSnapshotScheduleDelete","x-operation":"VirDomainSnapshotScheduleDelete","x-controller":"rest","description":"Delete an automated VM Snapshot Schedule","operationId":"VirDomainSnapshotScheduleDelete_delete","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/VirDomainStats":{"get":{"tags":["VirDomainStats"],"summary":"VirDomainStatsRead","x-operation":"VirDomainStatsRead","x-controller":"rest","description":"Retreive stats for a VM","operationId":"VirDomainStatsRead_read","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VirDomainStats"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/VirDomainStats/{virDomainUUID}":{"get":{"tags":["VirDomainStats"],"summary":"VirDomainStatsRead","x-operation":"VirDomainStatsRead","x-controller":"rest","description":"Retreive stats for a VM","operationId":"VirDomainStatsRead_uuid","parameters":[{"name":"virDomainUUID","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VirDomainStats"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/VirDomain/{virDomainUUID}/export":{"post":{"tags":["VirDomain"],"summary":"VirDomainExport","x-operation":"VirDomainExport","x-controller":"rest","description":"Export a VM","operationId":"VirDomainExport","parameters":[{"name":"virDomainUUID","description":"_VirDomain.uuid_ ","in":"path","required":true,"schema":{"description":"_VirDomain.uuid_ ","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"target":{"title":"VirDomainExportTarget","type":"object","properties":{"pathURI":{"description":"URI path - the basename will be created ","type":"string"},"format":{"description":"format of the target, empty defaults to qcow2","type":"string"},"definitionFileName":{"description":"name of the file of the domain definition","type":"string"},"compress":{"description":"compress the exported target image","type":"boolean"},"compat":{"description":"compatibility version number, ie: 0.10","type":"string"},"allowNonSequentialWrites":{"description":"allow non sequential writes, which may improve performance","type":"boolean","default":true},"parallelCountPerTransfer":{"description":"number of parallel jobs for each transfer","type":"integer"}},"required":["pathURI"],"additionalProperties":false},"snapUUID":{"description":"_VirDomainSnapshot.uuid_ *","type":"string"},"template":{"title":"VirDomain","type":"object","properties":{"uuid":{"description":"Unique identifier ","type":"string","readOnly":true},"nodeUUID":{"description":"Unique identifier of the _Node_ this is currently hosted on ","type":"string","readOnly":true},"name":{"description":"Human-readable name","type":"string"},"description":{"description":"Human-readable description ","type":"string"},"operatingSystem":{"description":"Operating system name. Used to select drivers package","type":"string"},"state":{"$ref":"#/components/schemas/VirDomainState"},"desiredDisposition":{"$ref":"#/components/schemas/VirDomainDisposition"},"console":{"$ref":"#/components/schemas/VirDomainConsole"},"mem":{"description":"Amount of memory reserved, in bytes.  \n May only be modified if the domain is in the _VirDomainState.SHUTOFF_ or _VirDomainState.CRASHED_ states","type":"integer"},"numVCPU":{"description":"Number of allotted virtual CPUs.  \n May only be modified if the domain is in the SHUTOFF or CRASHED states","type":"integer"},"blockDevs":{"description":"Attached virtual block devices _**CREATE-ONLY**_  \n Use _VirDomainBlockDeviceCreate,_ _VirDomainBlockDeviceUpdate,_ or _VirDomainBlockDeviceDelete_","type":"array","items":{"$ref":"#/components/schemas/VirDomainBlockDevice"}},"netDevs":{"description":"Attached virtual network devices _**CREATE-ONLY**_  \n Use _VirDomainNetDeviceCreate,_ _VirDomainNetDeviceUpdate,_ or _VirDomainNetDeviceDelete_","type":"array","items":{"$ref":"#/components/schemas/VirDomainNetDevice"}},"deprecated_stats":{"$ref":"#/components/schemas/StatsData"},"created":{"description":"Unix timestamp of creation time ","type":"integer","readOnly":true},"modified":{"description":"Unix timestamp of Last modified time ","type":"integer","readOnly":true},"latestTaskTag":{"$ref":"#/components/schemas/TaskTagStatus"},"tags":{"description":"User-modifiable words for organizing a group of VMs. Multiple tags should be comma-separated.","type":"string"},"bootDevices":{"description":"Unique identifiers of the bootable block and net devices, in the order that they will boot","type":"array","items":{"type":"string"}},"uiState":{"$ref":"#/components/schemas/VirDomainUIState"},"snapUUIDs":{"description":"Unique identifiers of current snapshots taken of this VM ","type":"array","items":{"type":"string"},"readOnly":true},"snapshotSerialNumber":{"description":"Serial number of the most recent snapshot _**INTERNAL**_","type":"integer"},"replicationUUIDs":{"description":"Unique identifiers of replication targets _**INTERNAL**_","type":"array","items":{"type":"string"}},"sourceVirDomainUUID":{"description":"Unique identifier of the replication source _VirDomain_ (non-empty indicates this is a replication target) ","type":"string","readOnly":true},"snapshotListSerialNumber":{"description":"Generation of the snapshot list _**INTERNAL**_","type":"integer"},"snapshotScheduleUUID":{"description":"Unique identifier of the  _VirDomainSnapshotSchedule_ for automated snapshots","type":"string"},"machineType":{"description":"Scale 'Hardware' version. Use _VirDomainCreateOptions_ machineTypeKeyword instead.  Possible values include:  \n | machineType | Description |  \n | ----------- | ----------- |  \n | scale-7.2 | BIOS |  \n | scale-8.10 | UEFI |  \n | scale-uefi-tpm-9.2 | vTPM+UEFI (Experiemental) |","type":"string"},"cpuType":{"description":"Scale 'CPU Model' Possible values include:  \n | cpuType | Description |  \n | ------- | ----------- |  \n | clusterBaseline-7.3 | (default) Largest feature set that can run in on any node in a cluster |  \n | HC1150-9.2 | Constant feature set that can run on all scale hardware running 9.2 |","type":"string"},"snapshotAllocationBlocks":{"description":"Total number of blocks actually used by snapshots ","type":"integer","readOnly":true},"guestAgentState":{"$ref":"#/components/schemas/GuestAgentState"},"lastSeenRunningOnNodeUUID":{"description":"Unique identifier of the _Node_ where this VM last ran ","type":"string","readOnly":true},"isTransient":{"description":"This is set for VMs that are temporary _**INTERNAL**_","type":"boolean","default":false},"affinityStrategy":{"$ref":"#/components/schemas/VirDomainAffinityStrategy"},"vsdUUIDsToDelete":{"description":"VSDs to be deleted _**INTERNAL**_","type":"array","items":{"type":"string"}},"cloudInitData":{"$ref":"#/components/schemas/CloudInitData"},"initialCloneSnapshotUUID":{"description":"If this VM was cloned, the _VirDomainSnapshot.uuid_ of the replication optimiziation snapshot _**INTERNAL**_","type":"string"},"machineTypeKeyword":{"description":"Computed keyword matching the VM's current machine type. see @VirDomainCreateOptions ","type":"string","readOnly":true}},"additionalProperties":false}},"required":["target"]}}},"required":true}}},"/VirDomain/import":{"post":{"tags":["VirDomain"],"summary":"VirDomainImport","x-operation":"VirDomainImport","x-controller":"rest","description":"Import a VM","operationId":"VirDomainImport","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"source":{"title":"VirDomainImportSource","type":"object","properties":{"pathURI":{"description":"URI path  ","type":"string"},"format":{"description":"format of the input, empty defaults to qcow2","type":"string"},"definitionFileName":{"description":"name of the file of the domain definition","type":"string"},"allowNonSequentialWrites":{"description":"allow non sequential writes, which may improve performance","type":"boolean","default":true},"parallelCountPerTransfer":{"description":"number of parallel jobs for each transfer","type":"integer"}},"required":["pathURI"],"additionalProperties":false},"template":{"title":"VirDomain","type":"object","properties":{"uuid":{"description":"Unique identifier ","type":"string","readOnly":true},"nodeUUID":{"description":"Unique identifier of the _Node_ this is currently hosted on ","type":"string","readOnly":true},"name":{"description":"Human-readable name","type":"string"},"description":{"description":"Human-readable description ","type":"string"},"operatingSystem":{"description":"Operating system name. Used to select drivers package","type":"string"},"state":{"$ref":"#/components/schemas/VirDomainState"},"desiredDisposition":{"$ref":"#/components/schemas/VirDomainDisposition"},"console":{"$ref":"#/components/schemas/VirDomainConsole"},"mem":{"description":"Amount of memory reserved, in bytes.  \n May only be modified if the domain is in the _VirDomainState.SHUTOFF_ or _VirDomainState.CRASHED_ states","type":"integer"},"numVCPU":{"description":"Number of allotted virtual CPUs.  \n May only be modified if the domain is in the SHUTOFF or CRASHED states","type":"integer"},"blockDevs":{"description":"Attached virtual block devices _**CREATE-ONLY**_  \n Use _VirDomainBlockDeviceCreate,_ _VirDomainBlockDeviceUpdate,_ or _VirDomainBlockDeviceDelete_","type":"array","items":{"$ref":"#/components/schemas/VirDomainBlockDevice"}},"netDevs":{"description":"Attached virtual network devices _**CREATE-ONLY**_  \n Use _VirDomainNetDeviceCreate,_ _VirDomainNetDeviceUpdate,_ or _VirDomainNetDeviceDelete_","type":"array","items":{"$ref":"#/components/schemas/VirDomainNetDevice"}},"deprecated_stats":{"$ref":"#/components/schemas/StatsData"},"created":{"description":"Unix timestamp of creation time ","type":"integer","readOnly":true},"modified":{"description":"Unix timestamp of Last modified time ","type":"integer","readOnly":true},"latestTaskTag":{"$ref":"#/components/schemas/TaskTagStatus"},"tags":{"description":"User-modifiable words for organizing a group of VMs. Multiple tags should be comma-separated.","type":"string"},"bootDevices":{"description":"Unique identifiers of the bootable block and net devices, in the order that they will boot","type":"array","items":{"type":"string"}},"uiState":{"$ref":"#/components/schemas/VirDomainUIState"},"snapUUIDs":{"description":"Unique identifiers of current snapshots taken of this VM ","type":"array","items":{"type":"string"},"readOnly":true},"snapshotSerialNumber":{"description":"Serial number of the most recent snapshot _**INTERNAL**_","type":"integer"},"replicationUUIDs":{"description":"Unique identifiers of replication targets _**INTERNAL**_","type":"array","items":{"type":"string"}},"sourceVirDomainUUID":{"description":"Unique identifier of the replication source _VirDomain_ (non-empty indicates this is a replication target) ","type":"string","readOnly":true},"snapshotListSerialNumber":{"description":"Generation of the snapshot list _**INTERNAL**_","type":"integer"},"snapshotScheduleUUID":{"description":"Unique identifier of the  _VirDomainSnapshotSchedule_ for automated snapshots","type":"string"},"machineType":{"description":"Scale 'Hardware' version. Use _VirDomainCreateOptions_ machineTypeKeyword instead.  Possible values include:  \n | machineType | Description |  \n | ----------- | ----------- |  \n | scale-7.2 | BIOS |  \n | scale-8.10 | UEFI |  \n | scale-uefi-tpm-9.2 | vTPM+UEFI (Experiemental) |","type":"string"},"cpuType":{"description":"Scale 'CPU Model' Possible values include:  \n | cpuType | Description |  \n | ------- | ----------- |  \n | clusterBaseline-7.3 | (default) Largest feature set that can run in on any node in a cluster |  \n | HC1150-9.2 | Constant feature set that can run on all scale hardware running 9.2 |","type":"string"},"snapshotAllocationBlocks":{"description":"Total number of blocks actually used by snapshots ","type":"integer","readOnly":true},"guestAgentState":{"$ref":"#/components/schemas/GuestAgentState"},"lastSeenRunningOnNodeUUID":{"description":"Unique identifier of the _Node_ where this VM last ran ","type":"string","readOnly":true},"isTransient":{"description":"This is set for VMs that are temporary _**INTERNAL**_","type":"boolean","default":false},"affinityStrategy":{"$ref":"#/components/schemas/VirDomainAffinityStrategy"},"vsdUUIDsToDelete":{"description":"VSDs to be deleted _**INTERNAL**_","type":"array","items":{"type":"string"}},"cloudInitData":{"$ref":"#/components/schemas/CloudInitData"},"initialCloneSnapshotUUID":{"description":"If this VM was cloned, the _VirDomainSnapshot.uuid_ of the replication optimiziation snapshot _**INTERNAL**_","type":"string"},"machineTypeKeyword":{"description":"Computed keyword matching the VM's current machine type. see @VirDomainCreateOptions ","type":"string","readOnly":true}},"additionalProperties":false}},"required":["source"]}}},"required":true}}},"/VirDomain/{virDomainUUID}/clone":{"post":{"tags":["VirDomain"],"summary":"VirDomainCloneSnapshot","x-operation":"VirDomainCloneSnapshot","x-controller":"rest","description":"Clone a VM from snapshot","operationId":"VirDomainCloneSnapshot","parameters":[{"name":"virDomainUUID","description":"The _VirDomain.uuid_ to be cloned from","in":"path","required":true,"schema":{"description":"The _VirDomain.uuid_ to be cloned from","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"snapUUID":{"description":"Clone from this _VirDomainSnapshot.uuid,_ otherwise a new snapshot will be created to clone from","type":"string"},"template":{"title":"VirDomain","type":"object","properties":{"uuid":{"description":"Unique identifier ","type":"string","readOnly":true},"nodeUUID":{"description":"Unique identifier of the _Node_ this is currently hosted on ","type":"string","readOnly":true},"name":{"description":"Human-readable name","type":"string"},"description":{"description":"Human-readable description ","type":"string"},"operatingSystem":{"description":"Operating system name. Used to select drivers package","type":"string"},"state":{"$ref":"#/components/schemas/VirDomainState"},"desiredDisposition":{"$ref":"#/components/schemas/VirDomainDisposition"},"console":{"$ref":"#/components/schemas/VirDomainConsole"},"mem":{"description":"Amount of memory reserved, in bytes.  \n May only be modified if the domain is in the _VirDomainState.SHUTOFF_ or _VirDomainState.CRASHED_ states","type":"integer"},"numVCPU":{"description":"Number of allotted virtual CPUs.  \n May only be modified if the domain is in the SHUTOFF or CRASHED states","type":"integer"},"blockDevs":{"description":"Attached virtual block devices _**CREATE-ONLY**_  \n Use _VirDomainBlockDeviceCreate,_ _VirDomainBlockDeviceUpdate,_ or _VirDomainBlockDeviceDelete_","type":"array","items":{"$ref":"#/components/schemas/VirDomainBlockDevice"}},"netDevs":{"description":"Attached virtual network devices _**CREATE-ONLY**_  \n Use _VirDomainNetDeviceCreate,_ _VirDomainNetDeviceUpdate,_ or _VirDomainNetDeviceDelete_","type":"array","items":{"$ref":"#/components/schemas/VirDomainNetDevice"}},"deprecated_stats":{"$ref":"#/components/schemas/StatsData"},"created":{"description":"Unix timestamp of creation time ","type":"integer","readOnly":true},"modified":{"description":"Unix timestamp of Last modified time ","type":"integer","readOnly":true},"latestTaskTag":{"$ref":"#/components/schemas/TaskTagStatus"},"tags":{"description":"User-modifiable words for organizing a group of VMs. Multiple tags should be comma-separated.","type":"string"},"bootDevices":{"description":"Unique identifiers of the bootable block and net devices, in the order that they will boot","type":"array","items":{"type":"string"}},"uiState":{"$ref":"#/components/schemas/VirDomainUIState"},"snapUUIDs":{"description":"Unique identifiers of current snapshots taken of this VM ","type":"array","items":{"type":"string"},"readOnly":true},"snapshotSerialNumber":{"description":"Serial number of the most recent snapshot _**INTERNAL**_","type":"integer"},"replicationUUIDs":{"description":"Unique identifiers of replication targets _**INTERNAL**_","type":"array","items":{"type":"string"}},"sourceVirDomainUUID":{"description":"Unique identifier of the replication source _VirDomain_ (non-empty indicates this is a replication target) ","type":"string","readOnly":true},"snapshotListSerialNumber":{"description":"Generation of the snapshot list _**INTERNAL**_","type":"integer"},"snapshotScheduleUUID":{"description":"Unique identifier of the  _VirDomainSnapshotSchedule_ for automated snapshots","type":"string"},"machineType":{"description":"Scale 'Hardware' version. Use _VirDomainCreateOptions_ machineTypeKeyword instead.  Possible values include:  \n | machineType | Description |  \n | ----------- | ----------- |  \n | scale-7.2 | BIOS |  \n | scale-8.10 | UEFI |  \n | scale-uefi-tpm-9.2 | vTPM+UEFI (Experiemental) |","type":"string"},"cpuType":{"description":"Scale 'CPU Model' Possible values include:  \n | cpuType | Description |  \n | ------- | ----------- |  \n | clusterBaseline-7.3 | (default) Largest feature set that can run in on any node in a cluster |  \n | HC1150-9.2 | Constant feature set that can run on all scale hardware running 9.2 |","type":"string"},"snapshotAllocationBlocks":{"description":"Total number of blocks actually used by snapshots ","type":"integer","readOnly":true},"guestAgentState":{"$ref":"#/components/schemas/GuestAgentState"},"lastSeenRunningOnNodeUUID":{"description":"Unique identifier of the _Node_ where this VM last ran ","type":"string","readOnly":true},"isTransient":{"description":"This is set for VMs that are temporary _**INTERNAL**_","type":"boolean","default":false},"affinityStrategy":{"$ref":"#/components/schemas/VirDomainAffinityStrategy"},"vsdUUIDsToDelete":{"description":"VSDs to be deleted _**INTERNAL**_","type":"array","items":{"type":"string"}},"cloudInitData":{"$ref":"#/components/schemas/CloudInitData"},"initialCloneSnapshotUUID":{"description":"If this VM was cloned, the _VirDomainSnapshot.uuid_ of the replication optimiziation snapshot _**INTERNAL**_","type":"string"},"machineTypeKeyword":{"description":"Computed keyword matching the VM's current machine type. see @VirDomainCreateOptions ","type":"string","readOnly":true}},"additionalProperties":false}}}}},"required":true}}},"/AlertEmailTarget/{uuid}/test":{"post":{"tags":["AlertEmailTarget"],"summary":"AlertEmailTargetTest","x-operation":"AlertEmailTargetTest","x-controller":"rest","description":"Send a test email alert","operationId":"AlertEmailTargetTest","parameters":[{"name":"uuid","description":"_AlertEmailTarget.uuid_","in":"path","required":true,"schema":{"description":"_AlertEmailTarget.uuid_","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/Update/{uuid}/apply":{"post":{"tags":["Update"],"summary":"IcosUpdateApply","x-operation":"IcosUpdateApply","x-controller":"rest","description":"Install an update on the cluster.","operationId":"IcosUpdateApply","parameters":[{"name":"uuid","description":"_IcosUpdate.uuid_","in":"path","required":true,"schema":{"description":"_IcosUpdate.uuid_","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/Certificate":{"post":{"tags":["Certificate"],"summary":"NodeCertificateUpdate","x-operation":"NodeCertificateUpdate","x-controller":"rest","description":"Update the Certificate for on the node receiving the call","operationId":"NodeCertificateUpdate","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"certificate":{"description":"Plain text of the X.509 PEM-encode certificate","type":"string"},"privateKey":{"description":"Plain text of the RSA PEM-encoded private key","type":"string"}}}}},"required":true}}},"/VirDomain/action":{"post":{"tags":["VirDomain"],"summary":"VirDomainAction","x-operation":"VirDomainAction","x-controller":"rest","description":"Take action upon or change the state of a VM","operationId":"VirDomainAction","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VirDomainActionDescription"}}}},"required":true}}},"/ISO/{uuid}/data":{"put":{"tags":["ISO"],"summary":"ISOUpload","x-operation":"ISOUpload","x-controller":"rest","description":"Upload Data to an ISO","operationId":"ISOUpload","parameters":[{"name":"uuid","description":"Unique identifier [READ-ONLY]","in":"path","required":true,"schema":{"type":"string"}},{"name":"content-length","description":"Size in bytes of the ISO file to be uploaded","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}},"requestBody":{"content":{"application/octet-stream":{}},"required":true}}},"/VirDomainBlockDevice/{uuid}/clone":{"post":{"tags":["VirDomainBlockDevice"],"summary":"VirDomainSnapshotBlockDeviceCreate","x-operation":"VirDomainSnapshotBlockDeviceCreate","x-controller":"rest","description":"Create a new _VirDomainBlockDevice_ from a _VirDomainSnapshot_","operationId":"VirDomainSnapshotBlockDeviceCreate","parameters":[{"name":"uuid","description":"Unique Identifier [READ-ONLY]","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"options":{"title":"VirDomainSnapshotBlockDeviceCreateOptions","type":"object","properties":{"regenerateDiskID":{"description":"Regenerate the disk ID, e.g. GPT UUID or MBR signature","type":"boolean","default":true},"readOnly":{"description":"Mount the new block device as read-only","type":"boolean","default":false}},"additionalProperties":false},"snapUUID":{"description":"Unique identifier [READ-ONLY]","type":"string"},"template":{"title":"VirDomainBlockDevice","type":"object","properties":{"virDomainUUID":{"description":"Identifier of the VirDomain this device is attached to _**CREATE-ONLY**_   \n This may be left blank if this block device is being created as part of a VirDomainCreate call","type":"string"},"type":{"$ref":"#/components/schemas/VirDomainBlockDeviceType"},"cacheMode":{"$ref":"#/components/schemas/VirDomainBlockDeviceCacheMode"},"capacity":{"description":"Logical size of the device in bytes, and can be increased on update or clone ","type":"integer"},"allocation":{"description":"Total amount of disk space in use in bytes ","type":"integer","readOnly":true},"physical":{"description":"Physical size of the backing virtual storage device in bytes ","type":"integer","readOnly":true},"shareUUID":{"description":"_**DEPRECATED**_ _**INTERNAL**_","type":"string"},"path":{"description":"Path to the backing storage device, in the format of scribe/uuid  \n UUID is either a VirDomainBlockDevice or ISO UUID  \n Only devices of type IDE_CDROM can have their path changed, and only to a valid ISO path","type":"string"},"slot":{"description":"Virtual slot the drive will occupy. For behavior _VirDomainBlockDeviceCreate._ _**CREATE-ONLY**_","type":"integer","default":-1},"name":{"description":"Name of the virtual storage device  \n Only devices of type IDE_CDROM can have their name changed, and must end in '.iso'","type":"string"},"disableSnapshotting":{"description":"Disables the ability to snapshot the drive","type":"boolean"},"tieringPriorityFactor":{"description":" * SSD tiering priority factor for block placement. Check the tiering documentation for best practices.  \n  * It is recommended to follow the Hypercore UI settings:  \n | UI Setting | Priority Factor Value |  \n | ---------- | --------------------- |  \n | 0          |                     0 |  \n | 1          |                     1 |  \n | 2          |                     2 |  \n | 3          |                     4 |  \n | 4          |           (default) 8 |  \n | 5          |                    16 |  \n | 6          |                    32 |  \n | 7          |                    64 |  \n | 8          |                   128 |  \n | 9          |                   256 |  \n | 10         |                  1024 |  \n | 11         |                 10240 |","type":"integer","default":8},"mountPoints":{"description":"Mount points of the drive in the guest OS, populated by the guest-agent ","type":"array","items":{"type":"string"},"readOnly":true},"createdTimestamp":{"description":"Unix timestamp of the drive's creation time  ","type":"integer","readOnly":true},"readOnly":{"description":"When true, this device was created via _VirDomainSnapshotBlockDeviceCreate_ with _VirDomainSnapshotBlockDeviceCreateOptions.readOnly_ ","type":"boolean","readOnly":true}},"required":["virDomainUUID","type","capacity"],"description":"A template to provide parameters for the new block device"}},"required":["options","snapUUID","template"],"additionalProperties":false}}},"required":true}}},"/Condition/filter":{"get":{"tags":["Condition"],"summary":"ConditionRead","x-operation":"ConditionRead","x-controller":"rest","description":"Retrieve a list of Conditions","operationId":"ConditionRead_filter","parameters":[{"name":"name","description":"A regular expression to match the condition names ","in":"query","schema":{"description":"A regular expression to match the condition names ","type":"string"}},{"name":"nodeUUIDs","description":"A list of _Node.uuids_ to include conditions from. When empty, all nodes are included. ","in":"query","schema":{"description":"A list of _Node.uuids_ to include conditions from. When empty, all nodes are included. ","type":"array","items":{"type":"string"}}},{"name":"includeSet","description":"If true, only return SET conditions ","in":"query","schema":{"description":"If true, only return SET conditions ","type":"boolean"}},{"name":"includeNotOK","description":"If true, only return notOK conditions ","in":"query","schema":{"description":"If true, only return notOK conditions ","type":"boolean"}},{"name":"singleNodeOnly","description":"Only conditions local to the node are returned ","in":"query","schema":{"description":"Only conditions local to the node are returned ","type":"boolean"}},{"name":"includeModifiedWithin","description":"When true, only return conditions changed within _modifiedWithin_ time since last modified. ","in":"query","schema":{"description":"When true, only return conditions changed within _modifiedWithin_ time since last modified. ","type":"boolean"}},{"name":"modifiedWithin","description":"The number of seconds since modified time to match conditions. To be used with _includeModifiedWithin_ ","in":"query","schema":{"description":"The number of seconds since modified time to match conditions. To be used with _includeModifiedWithin_ ","type":"integer"}},{"name":"includeTags","description":"A list of tags that a condition must match against under a OR relationship ","in":"query","schema":{"description":"A list of tags that a condition must match against under a OR relationship ","type":"array","items":{"type":"string"}}},{"name":"excludeTags","description":"A list of tags that if a condition match against under a OR relationship will be excluded ","in":"query","schema":{"description":"A list of tags that if a condition match against under a OR relationship will be excluded ","type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Condition"}}}}},"400":{"$ref":"#/components/responses/EValidationError"},"403":{"$ref":"#/components/responses/EPermissionDenied"},"500":{"$ref":"#/components/responses/EServiceFailure"},"503":{"$ref":"#/components/responses/EInvalidSession"}}}},"/VirtualDisk":{"get":{"tags":["VirtualDisk"],"summary":"VSDRead","x-operation":"VSDRead","x-controller":"rest","description":"Get an uploaded VirtualDisk","operationId":"VSDRead_read","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VSD"}}}}}}}},"/VirtualDisk/{uuid}":{"get":{"tags":["VirtualDisk"],"summary":"VSDRead","x-operation":"VSDRead","x-controller":"rest","description":"Get an uploaded VirtualDisk","operationId":"VSDRead_uuid","parameters":[{"name":"uuid","description":"Unique Identifer of an uploaded VirtualDisk","in":"path","required":true,"schema":{"description":"Unique Identifer of an uploaded VirtualDisk","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VSD"}}}}}}},"delete":{"tags":["VirtualDisk"],"summary":"VSDDelete","x-operation":"VSDDelete","x-controller":"rest","description":"Delete an uploaded VirtualDisk","operationId":"VSDDelete","parameters":[{"name":"uuid","description":"Unique Identifer of an uploaded VirtualDisk","in":"path","required":true,"schema":{"description":"Unique Identifer of an uploaded VirtualDisk","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}}}}},"/VirtualDisk/{uuid}/attach":{"post":{"tags":["VirtualDisk"],"summary":"VirDomainSnapshotBlockDeviceCreate","x-operation":"VirDomainSnapshotBlockDeviceCreate","x-controller":"rest","description":"Clone an uploaded VirtualDisk and attach to a Virtual Machine","operationId":"VSDAttach","parameters":[{"name":"uuid","description":"Unique Identifer of an uploaded VirtualDisk","in":"path","required":true,"schema":{"description":"Unique Identifer of an uploaded VirtualDisk","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"options":{"title":"VirDomainSnapshotBlockDeviceCreateOptions","type":"object","properties":{"regenerateDiskID":{"description":"Regenerate the disk ID, e.g. GPT UUID or MBR signature","type":"boolean","default":true},"readOnly":{"description":"Mount the new block device as read-only","type":"boolean","default":false}},"additionalProperties":false},"template":{"title":"VirDomainBlockDevice","type":"object","properties":{"virDomainUUID":{"description":"Identifier of the VirDomain this device is attached to _**CREATE-ONLY**_   \n This may be left blank if this block device is being created as part of a VirDomainCreate call","type":"string"},"type":{"$ref":"#/components/schemas/VirDomainBlockDeviceType"},"cacheMode":{"$ref":"#/components/schemas/VirDomainBlockDeviceCacheMode"},"capacity":{"description":"Logical size of the device in bytes, and can be increased on update or clone ","type":"integer"},"allocation":{"description":"Total amount of disk space in use in bytes ","type":"integer","readOnly":true},"physical":{"description":"Physical size of the backing virtual storage device in bytes ","type":"integer","readOnly":true},"shareUUID":{"description":"_**DEPRECATED**_ _**INTERNAL**_","type":"string"},"path":{"description":"Path to the backing storage device, in the format of scribe/uuid  \n UUID is either a VirDomainBlockDevice or ISO UUID  \n Only devices of type IDE_CDROM can have their path changed, and only to a valid ISO path","type":"string"},"slot":{"description":"Virtual slot the drive will occupy. For behavior _VirDomainBlockDeviceCreate._ _**CREATE-ONLY**_","type":"integer","default":-1},"name":{"description":"Name of the virtual storage device  \n Only devices of type IDE_CDROM can have their name changed, and must end in '.iso'","type":"string"},"disableSnapshotting":{"description":"Disables the ability to snapshot the drive","type":"boolean"},"tieringPriorityFactor":{"description":" * SSD tiering priority factor for block placement. Check the tiering documentation for best practices.  \n  * It is recommended to follow the Hypercore UI settings:  \n | UI Setting | Priority Factor Value |  \n | ---------- | --------------------- |  \n | 0          |                     0 |  \n | 1          |                     1 |  \n | 2          |                     2 |  \n | 3          |                     4 |  \n | 4          |           (default) 8 |  \n | 5          |                    16 |  \n | 6          |                    32 |  \n | 7          |                    64 |  \n | 8          |                   128 |  \n | 9          |                   256 |  \n | 10         |                  1024 |  \n | 11         |                 10240 |","type":"integer","default":8},"mountPoints":{"description":"Mount points of the drive in the guest OS, populated by the guest-agent ","type":"array","items":{"type":"string"},"readOnly":true},"createdTimestamp":{"description":"Unix timestamp of the drive's creation time  ","type":"integer","readOnly":true},"readOnly":{"description":"When true, this device was created via _VirDomainSnapshotBlockDeviceCreate_ with _VirDomainSnapshotBlockDeviceCreateOptions.readOnly_ ","type":"boolean","readOnly":true}},"required":["virDomainUUID","type","capacity"],"description":"A template to provide parameters for the new block device"}},"required":["options","template"]}}},"required":true}}},"/VirtualDisk/upload":{"put":{"tags":["VirtualDisk"],"summary":"VSDUpload","x-operation":"VSDUpload","x-controller":"rest","description":"Create and Upload Data to a new Virtual Disk","operationId":"VSDUpload","parameters":[{"name":"filename","description":"Name of the disk image file to be uploaded (must include a valid file extension)","in":"query","required":true,"schema":{"type":"string"}},{"name":"filesize","description":"Size in bytes of the disk image file to be uploaded","in":"query","required":true,"schema":{"type":"integer"}},{"name":"content-length","description":"Size in bytes of the disk image file to be uploaded","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"400":{"$ref":"#/components/responses/EValidationError"}},"requestBody":{"content":{"application/octet-stream":{}},"required":true}}}}}