Jump to

• Request
• Response

Create KVM

post

/kvm/vm

Creates a new VM in Oracle Database Appliance using VmCreateParams. Pre-requisites : Ensure vmstorage and vm cpu pool are present in the system.

Request

Supported Media Types

• application/json

Body ()

Parameters to create a VM

Root Schema : VmCreateParams

Type: object

Show Source

• cpuPoolName(optional): string
• cpusToPin(optional): array cpusToPin
• description(optional): string
• diskSize(optional): string
• extraArgs(optional): string
• extraSrcs(optional): string
• graphicsSettings(optional): string
• maxMemorySize(optional): string
• maxVcpuCount(optional): integer
• memorySize(optional): string
• name(optional): string
• osType(optional): string
• osVariant(optional): string
• prefNode(optional): string
• source(optional): string
• vcpuCount(optional): integer
• vdiskNames(optional): array vdiskNames
• vmStorageName(optional): string
• vnetworkNames(optional): array vnetworkNames

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "diskSize":{
            "type":"string"
        },
        "vmStorageName":{
            "type":"string"
        },
        "source":{
            "type":"string"
        },
        "memorySize":{
            "type":"string"
        },
        "maxMemorySize":{
            "type":"string"
        },
        "vnetworkNames":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "vdiskNames":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "vcpuCount":{
            "type":"integer"
        },
        "maxVcpuCount":{
            "type":"integer"
        },
        "cpuPoolName":{
            "type":"string"
        },
        "cpusToPin":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "graphicsSettings":{
            "type":"string"
        },
        "osType":{
            "type":"string"
        },
        "osVariant":{
            "type":"string"
        },
        "prefNode":{
            "type":"string"
        },
        "extraArgs":{
            "type":"string"
        },
        "extraSrcs":{
            "type":"string"
        }
    }
}

Nested Schema : cpusToPin

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : vdiskNames

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : vnetworkNames

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : KvmJob

Type: object

Show Source

• jobId(optional): string
• jobReport(optional): object ServiceJobReport
  Job Request Status
• syncJob(optional): boolean

{
    "type":"object",
    "properties":{
        "syncJob":{
            "type":"boolean"
        },
        "jobId":{
            "type":"string"
        },
        "jobReport":{
            "$ref":"#/definitions/ServiceJobReport"
        }
    }
}

Nested Schema : ServiceJobReport

Type: object

Job Request Status

Show Source

• createTimestamp(optional): string(date-time)
  Job creation timestamp
• description(optional): string
  Job description
• jobId(optional): string
  Job ID
• message(optional): string
  Job message
• reports(optional): array reports
• resourceList(optional): array resourceList
• status(optional): string
  Allowed Values: [ "Created", "Scheduled", "Running", "Success", "Failure", "Retrying", "Waiting", "InternalError", "Reverting", "Reverted", "NodeDisconnectedFailure" ]

  Job status
• updatedTime(optional): string(date-time)
  Job modification timestamp

{
    "description":"Job Request Status",
    "properties":{
        "jobId":{
            "type":"string",
            "description":"Job ID"
        },
        "status":{
            "type":"string",
            "description":"Job status",
            "enum":[
                "Created",
                "Scheduled",
                "Running",
                "Success",
                "Failure",
                "Retrying",
                "Waiting",
                "InternalError",
                "Reverting",
                "Reverted",
                "NodeDisconnectedFailure"
            ]
        },
        "message":{
            "description":"Job message",
            "type":"string"
        },
        "reports":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TaskReport"
            }
        },
        "createTimestamp":{
            "type":"string",
            "description":"Job creation timestamp",
            "format":"date-time"
        },
        "resourceList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/JobResourceInfo"
            }
        },
        "description":{
            "type":"string",
            "description":"Job description"
        },
        "updatedTime":{
            "type":"string",
            "description":"Job modification timestamp",
            "format":"date-time"
        }
    }
}

Nested Schema : reports

Type: array

Show Source

• Array of: object TaskReport

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/TaskReport"
    }
}

Nested Schema : resourceList

Type: array

Show Source

• Array of: object JobResourceInfo
  Resource information

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/JobResourceInfo"
    }
}

Nested Schema : TaskReport

Type: object

Show Source

• endTime(optional): string(date-time)
  Task completion timestamp
• jobId(optional): string
  Task associated with a job ID
• parentTaskId(optional): string
  Task ID of parent task
• reportLevel(optional): string
  Allowed Values: [ "Verbose", "Info", "Error" ]

  Task report level
• startTime(optional): string(date-time)
  Task creation timestamp
• status(optional): string
  Allowed Values: [ "Created", "Scheduled", "Running", "Success", "Failure", "Retrying", "Waiting", "InternalError", "Reverting", "Reverted", "NodeDisconnectedFailure" ]

  Task status
• tags(optional): array tags
• taskDescription(optional): string
  Task description
• taskId(optional): string
  Task ID
• taskName(optional): string
  Task name
• taskResult(optional): string
  Task result
• updatedTime(optional): string(date-time)
  Task updation timestamp

{
    "properties":{
        "taskId":{
            "type":"string",
            "description":"Task ID"
        },
        "taskName":{
            "type":"string",
            "description":"Task name"
        },
        "taskResult":{
            "type":"string",
            "description":"Task result"
        },
        "startTime":{
            "type":"string",
            "description":"Task creation timestamp",
            "format":"date-time"
        },
        "endTime":{
            "type":"string",
            "description":"Task completion timestamp",
            "format":"date-time"
        },
        "status":{
            "type":"string",
            "description":"Task status",
            "enum":[
                "Created",
                "Scheduled",
                "Running",
                "Success",
                "Failure",
                "Retrying",
                "Waiting",
                "InternalError",
                "Reverting",
                "Reverted",
                "NodeDisconnectedFailure"
            ]
        },
        "taskDescription":{
            "type":"string",
            "description":"Task description"
        },
        "parentTaskId":{
            "type":"string",
            "description":"Task ID of parent task"
        },
        "jobId":{
            "type":"string",
            "description":"Task associated with a job ID"
        },
        "tags":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "reportLevel":{
            "type":"string",
            "description":"Task report level",
            "enum":[
                "Verbose",
                "Info",
                "Error"
            ]
        },
        "updatedTime":{
            "type":"string",
            "description":"Task updation timestamp",
            "format":"date-time"
        }
    }
}

Nested Schema : tags

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : JobResourceInfo

Type: object

Resource information

Show Source

• jobId(optional): string
  Job ID
• resourceId(optional): string
  Resource ID
• resourceNewType(optional): string
• resourceType(optional): string
  Allowed Values: [ "Backup", "BackupConfig", "DB", "DbHome", "Grid", "Recovery", "Report", "Tde", "ObjectStoreSwift" ]

  Resource type
• updatedTime(optional): string(date-time)
  Last updated timestamp

{
    "description":"Resource information",
    "properties":{
        "resourceId":{
            "type":"string",
            "description":"Resource ID"
        },
        "resourceType":{
            "type":"string",
            "description":"Resource type",
            "enum":[
                "Backup",
                "BackupConfig",
                "DB",
                "DbHome",
                "Grid",
                "Recovery",
                "Report",
                "Tde",
                "ObjectStoreSwift"
            ]
        },
        "resourceNewType":{
            "type":"string"
        },
        "jobId":{
            "type":"string",
            "description":"Job ID"
        },
        "updatedTime":{
            "type":"string",
            "description":"Last updated timestamp",
            "format":"date-time"
        }
    }
}

Default Response

An unexpected error has occurred

Body ()

Root Schema : Error

Type: object

Show Source

• code: string
• message: string

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        }
    }
}

Back to Top