Machines

• URL:https://<portaladmin-url>/machines
  
• Operations:Status, Unregister Machine
• Child Resources:Machine
• Required Capability:Default administrator role
• Version Introduced:10.4

Description

The machines resource lists all machines registered with the portal site. The response also returns the information for each machine, such as each machine's admin URL and its OS platform information. Each machine can have its status polled to check whether the machine is ready to accept requests.

Request parameters

Parameter	Details
f	The response format. The default response format is html. Values: html | json | pjson

Example usage

The following is a sample request URL used to access the machines resource:

https://machine.domain.com/webadaptor/portaladmin/machines?f=json

JSON Response syntax

{
  "machines": [
    {
      "machineName": "<machine name>",
      "adminURL": "<admin URL>",
      "role": "<standby|primary>",
      "platform": "<OS platform information>"
    }
  ]
}

JSON Response example

{
  "machines": [
    {
      "machineName": "machine1.domain.com",
      "adminURL": "https://machine1.domain.com:7443/webadaptor",
      "role": "standby",
      "platform": "Linux-amd64-5.4.17-2136.301.1.4.el8uek.x86_64"
    },
    {
      "machineName": "machine2.domain.com",
      "adminURL": "https://machine2.domain.com:7443/webadaptor",
      "role": "primary",
      "platform": "Linux-amd64-5.4.17-2136.301.1.4.el8uek.x86_64"
    }
  ]
}