CreateSessionMachineCatalogModel
Details for creating a session machine catalog.
Properties
| Name | Description | Additional information |
|---|---|---|
| Name | Name of the session machine catalog to create; must be unique. Required. |
Type: String |
| ShortName | See Short Names. |
Type: String |
| Description | Description. |
Type: String |
| MachineType | Type of session machines contained in the catalog. Required. |
Type: MachineType |
| AllocationType | Allocation type for session machines in the catalog. If not specified, assumes 'Random'. |
Type: AllocationType |
| LoadBalancingSettings | Load balancing settings for session machines in the catalog. Required if the MachineType is MultiUserVda or ImaSessionHost. |
Type: SetLoadBalancingSettings |
| AutoProvision | If true, App Orchestration will automatically use integrated provisioning to create machines on available, compatible compute resources on-demand. If false, App Orchestration will raise notifications (see GET DashboardData/Notifications) when additional session machines are required, and additional session machines must be created externally and then added to the system using POST SessionMachineCatalogs({id})/SessionMachines. |
Type: Boolean |
| AutoProvisioningSettings | Auto-provisioning settings for the session machine catalog. Required if AutoProvision is true. |
|
| Tags |
Type: Array of String |
|
| CustomProperties |
Type: Array of CustomPropertyModel |
Sample
application/json
{
"Name": "catalog 1",
"ShortName": "catalog1",
"Description": "my session machine catalog",
"MachineType": "SingleUserVda",
"AllocationType": "Random",
"LoadBalancingSettings": {
"IncludeCpuMemory": true
},
"AutoProvision": true,
"AutoProvisioningSettings": {
"ResetOnReboot": false,
"PVDiskSizeGB": 10,
"PVDiskLetter": "V",
"NamingConvention": "SRV_####",
"NamingConventionType": "Numerical",
"VCpus": 2,
"MemoryMB": 4096,
"Template": "win8_base_os"
},
"Tags": [
"tag"
],
"CustomProperties": [
{
"Name": "myProperty",
"Value": "myValue"
}
]
}