HypervisorRequest Data Type

Properties
name data type constraints description
password string max size: 255, min size: 0
hvManager NameAndGuid  
cluster NameAndGuid  
dataCenter NameAndGuid  
type HypervisorType required
host string required, max size: 255, min size: 1
sshPort number  
nodeConfig NameAndGuid required
sshKeyPath string max size: 1024, min size: 0
user string max size: 255, min size: 0
vmExportImportMode VmExportImportMode  
transferNicAddress string max size: 255, min size: 0
dataCenterName string max size: 255, min size: 0
vmOwner string max size: 255, min size: 0
vmOwningGroup string max size: 255, min size: 0
storageProvider NameAndGuid  
storageType StorageType  
licenseCovered boolean required
useNetcat boolean required
libvirtSettings LibvirtSettingsRequest required
citrixSettings CitrixSettingsRequest required
proxmoxSettings ProxmoxSettingsRequest required
hvHypervSettings HvHypervSettingsRequest required
trustAllCerts boolean required

Example

{
  "password" : "...",
  "hvManager" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "cluster" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "dataCenter" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "host" : "...",
  "sshPort" : 12345,
  "nodeConfig" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "sshKeyPath" : "...",
  "user" : "...",
  "vmExportImportMode" : "DISK_IMAGE_TRANSFER",
  "transferNicAddress" : "...",
  "dataCenterName" : "...",
  "vmOwner" : "...",
  "vmOwningGroup" : "...",
  "storageProvider" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "storageType" : "DEFAULT",
  "licenseCovered" : true,
  "useNetcat" : true,
  "libvirtSettings" : {
    "libvirtSshTimeout" : 12345,
    "libvirtSshKnownHostsPath" : "...",
    "libvirtSshProgressRefreshRate" : 12345,
    "libvirtLvmSnapshotSize" : "...",
    "libvirtLvmSnapshotExtents" : "...",
    "libvirtAlwaysExportFullIfVmTurnedOff" : true
  },
  "citrixSettings" : {
    "citrixExportRefreshRate" : 12345,
    "citrixEnableXvaCompression" : true,
    "citrixSnapshotRemovalTimeout" : 12345
  },
  "proxmoxSettings" : {
    "proxmoxBackupStorage" : "...",
    "proxmoxCompressionType" : "DISABLED",
    "proxmoxNbdBufferReleaseMaxAttempts" : 12345,
    "proxmoxNbdBufferReleaseTimeout" : 12345,
    "proxmoxNbdBufferReleaseWaitPeriod" : 12345,
    "proxmoxAvailableNbdWaitPeriod" : 12345,
    "proxmoxConnectQcow2ToNbdWaitPeriod" : 12345
  },
  "hvHypervSettings" : {
    "hypervExportChunksNumber" : 12345
  },
  "trustAllCerts" : true
}