Help Page Home

# SessionMachineCatalogModel

A session machine catalog.

### Properties

Name | Description | Additional information
--- | --- | ---
Href | See Hypermedia. | Type: String
RelatedActions | See Hypermedia. | Type: Array of RelationModel
Id | ID of the session machine catalog. | Type: String
ChangeId | See Optimistic Concurrency. | Type: String
Version | Version of the session machine catalog. This starts at 1 and increments whenever POST SessionMachineCatalogs({id})/IncrementVersion is called. | Type: Number
Architecture | Architecture of the session machines in the session machine catalog. | Type: String
CPUs | Number of CPUs for all session machines in the session machine catalog. | Type: Number
MemoryMB | Amount of memory (in megabytes) for all session machines in the session machine catalog. | Type: Number
OSName | Operating system name for all session machines in the session machine catalog. | Type: String
OSVersion | Operating system version for all session machines in the session machine catalog. | Type: String
Capabilities | Capabilities of all session machines in the session machine catalog. The contents of this string reserve the right to change. | Type: String
HasMetadata | If true, the session machine catalog has completed gathering information about the installed applications, hotfixes, operating system, service packs, file types, etc. for session machines in the catalog. Once the session machine catalog has metadata, offerings may be created that are associated with it. | Type: Boolean
HasMetadataAtLatestVersion | If true, the session machine catalog has metadata for the latest version. Once the session machine catalog has metadata for the latest version, all further session machines imported to the catalog at that version are required to match the metadata. | Type: Boolean
Name | Name. | Type: String
ShortName | See Short Names. | Type: String
Description | Description. | Type: String
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
AllocationType | Allocation type for session machines in the session machine catalog. | Type: AllocationType
DeleteState | See Deleting Objects. | Type: ObjectDeleteState
VersionUpdateState | Version update state. | Type: SessionMachineCatalogVersionUpdateState
TerminateSessionsBy | If set, the date and time when sessions will be terminated and the upgrade process begun, for session machines that are not upgraded to the latest version of the session machine catalog. This date and time represents the local time for delivery controllers in the delivery site where the session machines are located. For example, if this indicates midnight, then it will happen at the local midnight within each affected delivery site, as determined by the delivery controllers in that delivery site. If not set, user sessions will not be terminated. The system will wait as long as necessary for users to log out on their own. | Type: String (ISO 8601 standard date)
AutomaticUpdateProcessType | Indicates the availability of automatic update for the session machines in the catalog. | Type: AutomaticUpdateProcessType
UpdateProcessIsAutomatic | If true, the update process will complete automatically, without administrator intervention. If false, the update process will stop once the users have drained off of the session machine, and the administrator must use the POST SessionMachines({id})/CompleteUpdate API to complete the update process for each machine. | Type: Boolean
NumDesiredMachines | Total number of session machines desired by all delivery groups associated with the session machine catalog. | Type: Number
NumUnallocatedMachines | Number of unallocated machines in the session machine catalog. | Type: Number
NumAllocatedMachines | Number of unallocated machines in the session machine catalog. | Type: Number
NumDrainingMachines | Number of machines draining user sessions in the session machine catalog. | Type: Number
NumDeliveryGroupsAwaitingDeliverySites | Number of delivery groups associated with the session machine catalog, for which there are no compatible delivery sites available. | Type: Number
NumMachinesAwaitingUpdate | Number of machines in the session machine catalog which are awaiting admin intervention to complete the update process. | Type: Number
HealthSummary | Summary of health notification messages associated with the session machine catalog. | Type: HealthSummaryModel
MachineType | Type of session machines contained in the session machine catalog. | Type: MachineType
LoadBalancingSettings | Load balancing settings for the session machine catalog. Note: if the MachineType is SingleUserVda, this will be unset. | Type: GetLoadBalancingSettings
AutoProvisioningSettings | Auto-provisioning settings for the session machine catalog. Note: if AutoProvision is not true, this will be unset. | Type: GetAutoProvisioningSettings
SecureIcaRequired | If true, Secure ICA is required for HDX connections to all of the session machines in the session machine catalog. Note that Secure ICA should not be relied upon as the only security mechanism for HDX traffic. Consult Citrix's best practices for securing HDX traffic. | Type: Boolean
NetScalerGatewayAccessMode | NetScaler Gateway access mode. | Type: NetScalerGatewayAccessModeType
AacFiltersRequired | If true, Advanced Access Control filters must be matched when users connect through NetScaler Gateway, in order for icons to be shown for the offerings that the user has subscribed to within the session machine catalog. | Type: Boolean
AacFilters | List of Advanced Access Control filters that must be matched when users connect through NetScaler Gateway, in order for icons to be shown for the offerings that the user has subscribed to within the session machine catalog. Note: this is required when AacFiltersRequired is true, and it is ignored otherwise. | Type: Array of String
Tags | See Tags and Custom Properties. | Type: Array of String
CustomProperties | See Tags and Custom Properties. | Type: Array of CustomPropertyModel
IsCatalogUpdatable | If true, the session machine catalog is in a state where it can be updated to a new version. | Type: Boolean
ProductType | Citrix brokering product type required in order to route user connections to session machines in the session machine catalog. | Type: ProductType

### Sample

#### application/json

Sample:

    {
      "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:13:30.4953339-05:00",
      "AutomaticUpdateProcessType": "AlwaysEnabled",
      "UpdateProcessIsAutomatic": true,
      "NumDesiredMachines": 15,
      "NumUnallocatedMachines": 1,
      "NumAllocatedMachines": 10,
      "NumDrainingMachines": 3,
      "NumDeliveryGroupsAwaitingDeliverySites": 2,
      "NumMachinesAwaitingUpdate": 5,
      "HealthSummary": {
        "InfoCount": 1,
        "Messages": [
          {
            "Text": "Attempting to reach desired capacity",
            "IsActive": true,
            "Type": "Allocation"
          }
        ]
      },
      "MachineType": "SingleUserVda",
      "LoadBalancingSettings": {
        "MaxUsers": 250,
        "IncludeCpuMemory": true
      },
      "AutoProvisioningSettings": {
        "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"
    }