Page History

...

• Description
  • Performs a complete graceful reboot of the OS.
  • May forcibly log off users if necessary.
  • Waits for the reboot to complete.
  • Returns after the reboot is complete.
• Expected Beginning State
  • Computer is up and accessible.
  • Users may be logged on to the computer.
• Expected Ending State
  • Computer has been rebooted.
  • Computer is accessible.
• Called By
  • May be called by any module which has access to the OS object
• Arguments & Calling Environment
  • Must only be called as an object method of an OS object ($os->reboot())
  • Argument:
    • Name: reboot_ timeout
    • Description:
      • Instructs reboot() to wait a maximum number of minutes for the reboot to complete
      • If timeout has been reached and computer has not finished rebooting, 0 should be returned
    • Required: No
    • Default Value: 5 minutes
    • Data Type: integer
    • Possible Values:
      •  Any Any positive integer
• Return Values
  • 1
    • Reboot completed successfully
    • Computer is accessible
  • 0
    • Reboot was initiated but computer never came back online
    • Timeout was reached
  • Undefined
    • Reboot could not be initiated

shutdown

• Description
  • Performs a graceful shutdown of the OS.
  • May forcibly log off users if necessary.
  • Waits for the shutdown to complete.
  • Returns after the shutdown is complete and the computer is off.
• Expected Beginning State
  • Computer is up and accessible.
  • Users may be logged on to the computer.
• Expected Ending State
  • Computer is off.
  Expected Ending State
• Called By
  • May be called by any module which has access to the OS object
• Arguments & Calling Environment
  • Must only be called as an object method of an OS object ($os->reboot())
  • Argument:
    • Name: timeout
    • Description:
      • Instructs shutdown() to wait a maximum number of minutes for the shutdown to complete
      • If timeout has been reached and computer has not finished shutting down, 0 should be returned
    • Required: No
    • Default Value: 5 minutes
    • Data Type: integer
    • Possible Values:
      • Any positive integer
• Return Values
  • 1
    • Shudown completed successfully
  • 0
    • Shutdown was initiated but computer never shut down
    • Timeout was reached
  • Undefined
    • Shutdown could not be initiated

get_current_image

• Description
• Expected Beginning State
• Expected Ending State
• Called By
• Arguments & Calling Environment
• Return Values