xCAT Rest API Resources

• Token Resources
  • [URI:/tokens] - The authentication token resource.
• Node Resources
  • [URI:/nodes] - The node list resource.
  • [URI:/nodes/{noderange}] - The node resource
  • [URI:/nodes/{noderange}/attrs/{attr1,attr2,attr3 …}] - The attributes resource for the node {noderange}
  • [URI:/nodes/{noderange}/host] - The mapping of ip and hostname for the node {noderange}
  • [URI:/nodes/{noderange}/dns] - The dns record resource for the node {noderange}
  • [URI:/nodes/{noderange}/dhcp] - The dhcp record resource for the node {noderange}
  • [URI:/nodes/{noderange}/nodestat}] - The attributes resource for the node {noderange}
  • [URI:/nodes/{noderange}/nodels}] - Lists the nodes, noderange cannot start with /
  • [URI:/nodes/{noderange}/subnodes] - The sub-nodes resources for the node {noderange}
  • [URI:/nodes/{noderange}/power] - The power resource for the node {noderange}
  • [URI:/nodes/{noderange}/energy] - The energy resource for the node {noderange}
  • [URI:/nodes/{noderange}/energy/{cappingmaxmin,cappingstatus,cappingvalue …}] - The specific energy attributes resource for the node {noderange}
  • [URI:/nodes/{noderange}/sp/{community|ip|netmask|…}] - The attribute resource of service processor for the node {noderange}
  • [URI:/nodes/{noderange}/nextboot] - The temporary bootorder resource in next boot for the node {noderange}
  • [URI:/nodes/{noderange}/bootstate] - The boot state resource for node {noderange}.
  • [URI:/nodes/{noderange}/vitals] - The vitals resources for the node {noderange}
  • [URI:/nodes/{noderange}/vitals/{temp|voltage|wattage|fanspeed|power|leds…}] - The specific vital attributes for the node {noderange}
  • [URI:/nodes/{noderange}/inventory] - The inventory attributes for the node {noderange}
  • [URI:/nodes/{noderange}/inventory/{pci|model…}] - The specific inventory attributes for the node {noderange}
  • [URI:/nodes/{noderange}/eventlog] - The eventlog resource for the node {noderange}
  • [URI:/nodes/{noderange}/beacon] - The beacon resource for the node {noderange}
  • [URI:/nodes/{noderange}/updating] - The updating resource for the node {noderange}
  • [URI:/nodes/{noderange}/filesyncing] - The filesyncing resource for the node {noderange}
  • [URI:/nodes/{noderange}/sw] - The software maintenance for the node {noderange}
  • [URI:/nodes/{noderange}/postscript] - The postscript resource for the node {noderange}
  • [URI:/nodes/{noderange}/nodeshell] - The nodeshell resource for the node {noderange}
  • [URI:/nodes/{noderange}/nodecopy] - The nodecopy resource for the node {noderange}
  • [URI:/nodes/{noderange}/vm] - The virtualization node {noderange}.
  • [URI:/nodes/{noderange}/vmclone] - The clone resource for the virtual node {noderange}.
  • [URI:/nodes/{noderange}/vmmigrate] - The virtualization resource for migration.
• Osimage resources
  • [URI:/osimages] - The osimage resource.
  • [URI:/osimages/{imgname}] - The osimage resource
  • [URI:/osimages/{imgname}/attrs/attr1,attr2,attr3 …] - The attributes resource for the osimage {imgname}
  • [URI:/osimages/{imgname}/instance] - The instance for the osimage {imgname}
• Network Resources
  • [URI:/networks] - The network list resource.
  • [URI:/networks/{netname}] - The network resource
  • [URI:/networks/{netname}/attrs/attr1,attr2,…] - The attributes resource for the network {netname}
• Policy Resources
  • [URI:/policy] - The policy resource.
  • [URI:/policy/{policy_priority}] - The policy resource
  • [URI:/policy/{policyname}/attrs/{attr1,attr2,attr3,…}] - The attributes resource for the policy {policy_priority}
• Group Resources
  • [URI:/groups] - The group list resource.
  • [URI:/groups/{groupname}] - The group resource
  • [URI:/groups/{groupname}/attrs/{attr1,attr2,attr3 …}] - The attributes resource for the group {groupname}
• Global Configuration Resources
  • [URI:/globalconf] - The global configuration resource.
  • [URI:/globalconf/attrs/{attr1,attr2 …}] - The specific global configuration resource.
• Service Resources
  • [URI:/services/dns] - The dns service resource.
  • [URI:/services/dhcp] - The dhcp service resource.
  • [URI:/services/host] - The hostname resource.
  • [URI:/services/slpnodes] - The nodes which support SLP in the xCAT cluster
  • [URI:/services/slpnodes/{CEC|FRAME|MM|IVM|RSA|HMC|CMM|IMM2|FSP…}] - The slp nodes with specific service type in the xCAT cluster
• Table Resources
  • [URI:/tables/{tablelist}/nodes/{noderange}] - The node table resource
  • [URI:/tables/{tablelist}/nodes/nodes/{noderange}/{attrlist}] - The node table attributes resource
  • [URI:/tables/{tablelist}/rows] - The non-node table resource
  • [URI:/tables/{tablelist}/rows/{keys}] - The non-node table rows resource
  • [URI:/tables/{tablelist}/rows/{keys}/{attrlist}] - The non-node table attributes resource