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
  Name of the CPU Pool
• cpusToPin(optional): array cpusToPin
  CPUs to pin
• description(optional): string
  Description of the VM
• diskSize(optional): string
  Size of the VM disk
• extraArgs(optional): string
  Extra arguments for the VM installer
• extraSrcs(optional): string
  Extra sources for the guest, they are mounted as cdrom devices
• graphicsSettings(optional): string
  Graphics settings for the VM
• maxMemorySize(optional): string
  Maximum size of the VM memory
• maxVcpuCount(optional): integer
  Maximum number of virtual CPUs to use
• memorySize(optional): string
  Size of the VM memory
• name(optional): string
  Name of the VM
• osVariant(optional): string
  OS variant
• prefNode(optional): string
  Preferred node to run the VM
• source(optional): string
  Source installation. If local it can be an ISO or a bootable disk image. If remote it can be a URI pointing to an install tree hosted remotely over HTTP, HTTPS, FTP or NFS
• vcpuCount(optional): integer
  Number of virtual CPUs to use
• vdiskNames(optional): array vdiskNames
  Names of the virtual Disks to use
• vmStorageName(optional): string
  Storage name of the VM
• vnetworkNames(optional): array vnetworkNames
  Names of the virtual Networks to use

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the VM"
        },
        "description":{
            "type":"string",
            "description":"Description of the VM"
        },
        "diskSize":{
            "type":"string",
            "description":"Size of the VM disk"
        },
        "vmStorageName":{
            "type":"string",
            "description":"Storage name of the VM"
        },
        "source":{
            "type":"string",
            "description":"Source installation. If local it can be an ISO or a bootable disk image. If remote it can be a URI pointing to an install tree hosted remotely over HTTP, HTTPS, FTP or NFS"
        },
        "memorySize":{
            "type":"string",
            "description":"Size of the VM memory"
        },
        "maxMemorySize":{
            "type":"string",
            "description":"Maximum size of the VM memory"
        },
        "vnetworkNames":{
            "type":"array",
            "description":"Names of the virtual Networks to use",
            "items":{
                "type":"string"
            }
        },
        "vdiskNames":{
            "type":"array",
            "description":"Names of the virtual Disks to use",
            "items":{
                "type":"string"
            }
        },
        "vcpuCount":{
            "type":"integer",
            "description":"Number of virtual CPUs to use"
        },
        "maxVcpuCount":{
            "type":"integer",
            "description":"Maximum number of virtual CPUs to use"
        },
        "cpuPoolName":{
            "type":"string",
            "description":"Name of the CPU Pool"
        },
        "cpusToPin":{
            "type":"array",
            "description":"CPUs to pin",
            "items":{
                "type":"string"
            }
        },
        "graphicsSettings":{
            "type":"string",
            "description":"Graphics settings for the VM"
        },
        "osVariant":{
            "type":"string",
            "description":"OS variant"
        },
        "prefNode":{
            "type":"string",
            "description":"Preferred node to run the VM"
        },
        "extraArgs":{
            "type":"string",
            "description":"Extra arguments for the VM installer"
        },
        "extraSrcs":{
            "type":"string",
            "description":"Extra sources for the guest, they are mounted as cdrom devices"
        }
    }
}

Nested Schema : cpusToPin

Type: array

CPUs to pin

Show Source

• Array of: string

{
    "type":"array",
    "description":"CPUs to pin",
    "items":{
        "type":"string"
    }
}

Nested Schema : vdiskNames

Type: array

Names of the virtual Disks to use

Show Source

• Array of: string

{
    "type":"array",
    "description":"Names of the virtual Disks to use",
    "items":{
        "type":"string"
    }
}

Nested Schema : vnetworkNames

Type: array

Names of the virtual Networks to use

Show Source

• Array of: string

{
    "type":"array",
    "description":"Names of the virtual Networks to use",
    "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)
• description(optional): string
• jobId(optional): string
• jobType(optional): string
• message(optional): string
• reports(optional): array reports
• resourceList(optional): array resourceList
• status(optional): string
  Allowed Values: [ "Created", "Scheduled", "Running", "Success", "Failure", "Retrying", "Waiting", "InternalError", "Reverting", "Reverted", "NodeDisconnectedFailure" ]
• updatedTime(optional): string(date-time)

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

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

• duration(optional): string
• endTime(optional): string(date-time)
• jobId(optional): string
• nodeName(optional): string
• parentTaskId(optional): string
• reportLevel(optional): string
  Allowed Values: [ "Verbose", "Info", "Error" ]
• startTime(optional): string(date-time)
• status(optional): string
  Allowed Values: [ "Created", "Scheduled", "Running", "Success", "Failure", "Retrying", "Waiting", "InternalError", "Reverting", "Reverted", "NodeDisconnectedFailure", "Skipped" ]
• tags(optional): array tags
• taskDescription(optional): string
• taskId(optional): string
• taskName(optional): string
• taskResult(optional): string
• updatedTime(optional): string(date-time)

{
    "properties":{
        "taskId":{
            "type":"string"
        },
        "taskName":{
            "type":"string"
        },
        "nodeName":{
            "type":"string"
        },
        "taskResult":{
            "type":"string"
        },
        "startTime":{
            "type":"string",
            "format":"date-time"
        },
        "endTime":{
            "type":"string",
            "format":"date-time"
        },
        "duration":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "enum":[
                "Created",
                "Scheduled",
                "Running",
                "Success",
                "Failure",
                "Retrying",
                "Waiting",
                "InternalError",
                "Reverting",
                "Reverted",
                "NodeDisconnectedFailure",
                "Skipped"
            ]
        },
        "taskDescription":{
            "type":"string"
        },
        "parentTaskId":{
            "type":"string"
        },
        "jobId":{
            "type":"string"
        },
        "tags":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "reportLevel":{
            "type":"string",
            "enum":[
                "Verbose",
                "Info",
                "Error"
            ]
        },
        "updatedTime":{
            "type":"string",
            "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
• resourceId(optional): string
• resourceNewType(optional): string
• resourceType(optional): string
  Allowed Values: [ "Backup", "BackupConfig", "DB", "DbHome", "Grid", "Pdb", "Recovery", "Report", "Tde", "ObjectStoreSwift" ]
• updatedTime(optional): string(date-time)

{
    "description":"resource information",
    "properties":{
        "resourceId":{
            "type":"string"
        },
        "resourceType":{
            "type":"string",
            "enum":[
                "Backup",
                "BackupConfig",
                "DB",
                "DbHome",
                "Grid",
                "Pdb",
                "Recovery",
                "Report",
                "Tde",
                "ObjectStoreSwift"
            ]
        },
        "resourceNewType":{
            "type":"string"
        },
        "jobId":{
            "type":"string"
        },
        "updatedTime":{
            "type":"string",
            "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