GET SessionMachineCatalogs

Get session machine catalogs.

Request Information

Parameters

NameDescriptionAdditional information
name

See Filtering, Arranging, and Paging.

Type: String

filterBy

See Filtering, Arranging, and Paging. The supported filters are:

  • All: All session machine catalogs.
  • NotDeleted: All session machine catalogs which are not currently being deleted. (default)
  • Empty: All session machine catalogs which do not contain any session machines.
  • NotUsed: All session machine catalogs which do not have any delivery groups associated.
  • OldVersion: All session machine catalogs containing 1 or more session machines which have not been updated to the catalog's current version.
  • UpdatePending: All session machine catalogs containing 1 or more session machines which require admin intervention to complete the update process.
  • Overallocated: All sesssion machine catalogs which require additional externally-provisioned session machines to be imported in order to meet desired capacity.

Type: Filter

filterProp

See Filtering, Arranging, and Paging.

Type: String

arrangeBy

See Filtering, Arranging, and Paging. The supported arrangers are:

  • Name: Arrange by name. (default)
  • FreeItems: Arrange by the number of unallocated session machines in the catalog.
  • TotalItems: Arrange by the total number of session machines in the catalog.

Type: String

skip

See Filtering, Arranging, and Paging.

Type: Number

take

See Filtering, Arranging, and Paging.

Type: Number

Response Information

A list of session machine catalogs.

Response type

CollectionResultModel<SessionMachineCatalogModel>

Response body formats

application/json, text/json

Sample:
{
  "Href": "[api:SessionMachineCatalogs]",
  "Count": 1,
  "TotalMatchingFilter": 1,
  "Items": [
    {
      "Href": "[api:SessionMachineCatalogs(628fa898-0c36-4024-8fe4-d7e9a9bfbcfa)]",
      "Id": "628fa898-0c36-4024-8fe4-d7e9a9bfbcfa",
      "ChangeId": "14",
      "Version": 3,
      "Architecture": "x64",
      "CPUs": 2,
      "MemoryMB": 4096,
      "OSName": "Windows Server 2008 R2",
      "OSVersion": "Service Pack 1",
      "Capabilities": "CAP1",
      "HasMetadata": true,
      "HasMetadataAtLatestVersion": true,
      "Name": "catalog 1",
      "ShortName": "catalog1",
      "Description": "my session machine catalog",
      "AutoProvision": true,
      "AllocationType": "Static",
      "DeleteState": "NotDeleted",
      "VersionUpdateState": "VersionUpdateInProgress",
      "TerminateSessionsBy": "2013-12-05T16:12:39.248188-05:00",
      "AutomaticUpdateProcessType": "AlwaysEnabled",
      "UpdateProcessIsAutomatic": true,
      "NumDesiredMachines": 15,
      "NumUnallocatedMachines": 1,
      "NumAllocatedMachines": 10,
      "NumDrainingMachines": 3,
      "NumDeliveryGroupsAwaitingDeliverySites": 2,
      "NumMachinesAwaitingUpdate": 5,
      "HealthSummary": {
        "ActiveCount": 0,
        "ErrorCount": 0,
        "WarningCount": 0,
        "InfoCount": 1,
        "Messages": [
          {
            "Text": "Attempting to reach desired capacity",
            "IsError": false,
            "IsWarning": false,
            "IsInfo": false,
            "IsActive": true,
            "Type": "Allocation"
          }
        ]
      },
      "MachineType": "SingleUserVda",
      "LoadBalancingSettings": {
        "MaxUsers": 250,
        "IncludeCpuMemory": true
      },
      "AutoProvisioningSettings": {
        "RequirePrivateComputeResource": false,
        "ResetOnReboot": false,
        "PVDiskSizeGB": 10,
        "PVDiskLetter": "V",
        "NamingConvention": "SRV_####",
        "NamingConventionType": "Numerical",
        "VCpus": 2,
        "MemoryMB": 4096,
        "Template": "win8_base_os"
      },
      "SecureIcaRequired": true,
      "NetScalerGatewayAccessMode": "Both",
      "AacFiltersRequired": true,
      "AacFilters": [
        "filter1"
      ],
      "Tags": [
        "tag"
      ],
      "CustomProperties": [
        {
          "Name": "myProperty",
          "Value": "myValue"
        }
      ],
      "IsCatalogUpdatable": true,
      "ProductType": "XenDesktop71"
    }
  ]
}