Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagebash
titleSample Response
PCODE=UH_OH
PMESSAGE="Records indicate this agents is already upgrading, but has since asked for permission! Please mark the provided task complete before requesting additonal work."
PVERSION=LATEST
ENABLED=false
BUSY=false
TASK=6

 


NO_CHILD

Panel

This means the client agent should not make any changes, and continue to take jobs on the current version. 


Tip

Set the system state to STABLE in the admin configuration to return this response.

 


WAIT_FOR_SIBLINGS

Panel

This is returned when updates are allowed, but too many other clients are already marked in progress.

Info

Adjust the "Max. Count" value in the admin configuration to define the threshold for this response.

 

...



YES_CHILD

Panel

This is returned when updates are allowed, the client agent should now monitor the BUSY status returned by this and the agent status api to make sure any running jobs completed.

Note

Agents MUST mark the TASK returned from this code and subsequently call the /finish/<taskId> endpoint once they are ready to resume. Failure to do this will prevent future updates. (see UH_OH code below)

 


UH_OH

 
Panel


This is an error. Client agents should print PCODE and PMESSAGE for details.

Tip

Most times this will be failure to mark a previous task for this agent complete. Call the /finish/taskId endpoint to mark it complete.