Cosmic Admin API Reference

listHAWorkers

Lists all HA workers

Request parameters

Parameter NameDescriptionRequired
domainidlist only resources belonging to the domain specifiedfalse
idthe ID of the HA workerfalse
isrecursivedefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is falsefalse
pagefalse
pagesizefalse

Response Tags

Response NameDescription
idID of the HA worker
createdDate when the HA worker was created
domainidID of the domain this HA worker belongs too
domainnameName of the domain this HA worker belongs too
hypervisorHypervisor this HA worker belongs too
managementservernameName of the management server this HA worker belongs too
statePrevious state of the virtual machine this HA worker belongs too
stepCurrent step the HA worker is at
takenDate of the last step this HA worker has taken
typeType of the HA worker
virtualmachineidID of the virtual machine this HA worker belongs too
virtualmachinenameName of the virtual machine this HA worker belongs too
virtualmachinestateState of the virtual machine this HA worker belongs too