CreateComputeResourceModel

Details for creating a compute resource.

Properties

NameDescription Additional information
Name

Name of the new compute resource. Must be unique. Required.

Type: String

ShortName

Short name of the new compute resource. Must be unique. Optional. See Short Names.

Type: String

Description

Description. Optional.

Type: String

DataCenterId

Data center where the compute resource resides. Required.

Type: String

ComputeResourceType

Type of the compute resource. Required.

Type: ComputeResourceType

Address

Address of the hypervisor, hypervisor pool, or management API. Required.

Type: String

UserNameOrApiKey

Admin user of the hypervisor or hypervisor pool. Required.

Type: String

PasswordBase64OrSecretKey

Password for the admin of the hypervisor or hypervisor pool. Must be Base64-encoded. Required.

Type: String

MaxVirtualMachinesToProvision

The maximum number of virtual machines to provision on the compute resource before considering it to be "full".

Type: Number

UseLocalStorage

If true, the operating system disk for virtual machines provisioned on this compute resource will be stored on the local storage of the hypervisor. If false, the operating system disk for virtual machines provisioned on this compute resource will be stored on a storage pool as defined by the VirtualMachineStorage property. Defaults to false if not specified.

Type: Boolean

VirtualMachineStorage

Names(s) of the shared storage pool(s) to use for operating system disks for virtual machines provisioned on the compute resource. Only used if UseLocalStorage is false. If multiple storage pools are specified, virtual machines will be balanced between the specified storage pools. If not specified, all shared storage is used.

Type: Array of String

PersonalVDiskStorage

Names(s) of the shared storage pool(s) to use for personal virtual disks for virtual machines provisioned on the compute resource. If multiple storage pools are specified, virtual machines will be balanced between the specified storage pools. If not specified, will use the same store as VirtualMachineStorage, unless UseLocalStorage is true, in which case all shared storage pools are used.

Type: Array of String

Cluster

Cluster within the hypervisor pool where virtual machines will be provisioned. Only used for compute resources of type 'HyperV' or 'VMWare'. If not specified, the root cluster (representing the entire hypervisor pool) will be used.

Type: ClusterModel

HaServers

Backup servers to contact in case the primary server address cannot be contacted. Only used for compute resources of type 'XenServer'. If not specified, all servers that exist in the pool at the time when it is created will be used.

Type: Array of String

Tags

See Tags and Custom Properties.

Type: Array of String

CustomProperties

See Tags and Custom Properties.

Type: Array of CustomPropertyModel

Sample

application/json

Sample:
{
  "Name": "SCVMM",
  "ShortName": "SCVMM",
  "Description": "My SCVMM cluster",
  "DataCenterId": "af1fc9c4-dee5-4b0d-836c-9e1c5b57a88a",
  "ComputeResourceType": "HyperV",
  "Address": "https://10.1.1.10",
  "UserNameOrApiKey": "DOMAIN\\scvmm",
  "PasswordBase64OrSecretKey": "cGFzc3dvcmQ=",
  "MaxVirtualMachinesToProvision": 100,
  "UseLocalStorage": true,
  "PersonalVDiskStorage": [
    "PVD Storage"
  ],
  "Cluster": {
    "Href": "[api:ComputeResources(ab32f043-4682-4953-8dea-a0489b839f80)/ClusterTree",
    "Name": "ClusterRoot",
    "FullPath": "/ClusterRoot",
    "CanBeProvisioningTarget": true,
    "Children": [
      {
        "Name": "Cluster1",
        "FullPath": "/ClusterRoot/Cluster1",
        "CanBeProvisioningTarget": true
      },
      {
        "Name": "Cluster2",
        "FullPath": "/ClusterRoot/Cluster2",
        "CanBeProvisioningTarget": true
      }
    ]
  },
  "Tags": [
    "tag"
  ],
  "CustomProperties": [
    {
      "Name": "myProperty",
      "Value": "myValue"
    }
  ]
}