MachineDetailModel

Detail about a machine (session machine, delivery controller, or StoreFront server).

Properties

Name	Description	Additional information
Href	See Hypermedia.	Type: String
RelatedActions	See Hypermedia.	Type: Array of RelationModel
Id	ID of the machine.	Type: String
ChangeId	See Optimistic Concurrency.	Type: String
Name	Name.	Type: String
DeleteState	See Deleting Objects.	Type: ObjectDeleteState
Architecture	Machine architecture.	Type: String
CPUs	Number of CPUs.	Type: Number
MemoryMB	Memory in megabytes.	Type: Number
OSName	Operating system name.	Type: String
OSVersion	Operating system version.	Type: String
Capabilities	Machine capabilities. The contents of this string reserve the right to change.	Type: String
MachineType	Type of machine.	Type: MachineDetailType
DeliveryController	If the machine is a delivery controller, this is a link to the delivery controller details.	Type: ReferenceModel
SessionMachine	If the machine is a session machine, this is a link to the session machine details.	Type: ReferenceModel
DeliveryControllerArchitecture	If the machine is a delivery controller, this is the architecture of the delivery controller. If the machine is a session machine, this is the architecture of delivery controllers that are compatible with the session machine.	Type: DeliveryControllerArchitectureType
DeliveryGroup	If the machine is a session machine and is allocated within a delivery group, this is a link to the delivery group.	Type: ReferenceModel
DeliverySite	If the machine is either a session machine or delivery controller, and is a member of a delivery site, this is a link to the delivery site.	Type: ReferenceModel
SID	The machine's SID.	Type: String
Tenant	If the machine is privately allocated to a tenant, this is a link to the tenant.	Type: ReferenceModel
SessionMachineCatalog	If the machine is a session machine, this is a link to the related session machine catalog.	Type: ReferenceModel
DataCenter	The datacenter where the machine resides.	Type: ReferenceModel
HealthSummary	A summary of health notifications related to the machine.	Type: HealthSummaryModel

Sample

application/json

Sample:

{
  "Href": "[api:MachineDetails(bff69e21-c280-488b-ad9e-74b674ffb7c9)]",
  "Id": "bff69e21-c280-488b-ad9e-74b674ffb7c9",
  "ChangeId": "3",
  "Name": "machine1",
  "DeleteState": "NotDeleted",
  "Architecture": "x64",
  "CPUs": 2,
  "MemoryMB": 4096,
  "OSName": "Windows Server 2008 R2",
  "OSVersion": "Service Pack 1",
  "Capabilities": "CAP1,CAP2",
  "MachineType": "SessionMachine",
  "DeliveryController": {
    "Href": "[api:DeliveryControllers(34c04635-50fc-4506-99fc-da1b459fbefa)]",
    "Name": "controller1",
    "Id": "34c04635-50fc-4506-99fc-da1b459fbefa"
  },
  "SessionMachine": {
    "Href": "[api:SessionMachines(77b50020-4252-453c-815b-ce9b9412d543)]",
    "Name": "machine1",
    "Id": "77b50020-4252-453c-815b-ce9b9412d543"
  },
  "DeliveryControllerArchitecture": "FMA",
  "DeliveryGroup": {
    "Href": "[api:DeliveryGroups(c004375e-a96d-4368-96ba-c80702d7e80f)]",
    "Name": "dg1",
    "Id": "c004375e-a96d-4368-96ba-c80702d7e80f"
  },
  "DeliverySite": {
    "Href": "[api:DeliverySites(0ef3e68d-bb8e-4b69-9c30-ae3fac533996)]",
    "Name": "site1",
    "Id": "0ef3e68d-bb8e-4b69-9c30-ae3fac533996"
  },
  "SID": "S-1-5-20-12123131231",
  "Tenant": {
    "Href": "[api:Tenants(91ade655-feb5-47d3-9585-a5827ad50132)]",
    "Name": "Tenant 1",
    "Id": "91ade655-feb5-47d3-9585-a5827ad50132"
  },
  "SessionMachineCatalog": {
    "Href": "[api:SessionMachineCatalogs(628fa898-0c36-4024-8fe4-d7e9a9bfbcfa)]",
    "Name": "catalog 1",
    "Id": "628fa898-0c36-4024-8fe4-d7e9a9bfbcfa"
  },
  "DataCenter": {
    "Href": "[api:DataCenters(af1fc9c4-dee5-4b0d-836c-9e1c5b57a88a)]",
    "Name": "datacenter1",
    "Id": "af1fc9c4-dee5-4b0d-836c-9e1c5b57a88a"
  },
  "HealthSummary": {
    "InfoCount": 1,
    "Messages": [
      {
        "Text": "Attempting to reach desired capacity",
        "IsActive": true,
        "Type": "Allocation"
      }
    ]
  }
}