Versions Compared

Key

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

...

capture
Anchor
capture
capture

  • Description
    • A provisioning module's capture() subroutine saves the current state of the resource.  
    • For the provisioning of computers, this means saving an image of the contents of the hard drive.  Although current VCL implementations focus on provisioning computers, the capture() subroutine does not necessarily need to save an image of a hard drive.  A provisioning module may be developed to save the configuration of a network service or some other type of resource.
    • The capture() subroutine is responsible for calling the OS module's pre_capture subroutine.  This is not called by the image.pm state module because there may be cases where an OS isn't applicable.
    • The capture() subroutine is responsible for waiting for the entire capture process to complete.
  • Expected Beginning State
    • An administrator has configured the resource and initiated the capture using the VCL website.
    • The resource is on and accessible.
    • The information contained in the data object describes the image which does not yet exist and will be captured.
  • Expected Ending State
    • The entire capture process is complete or else an error occurred.
    • The capture() subroutine has waited for an image to be captured...
  • Called By
    • ...image.pm::process()
  • Arguments & Calling Environment
    • Must Should only be called as an object method of a provisioning object ($provisioner->pre_captureimage.pm state object ($self->capture()) 
    • No Arguments
  • Return Values
    • 1
      • Resource was successfully captured.
      • image.pm may proceed to update the database tables making the image available to be provisioned.
    • 0
      • Resource was not successfully captured...
      Undefined
      • An administrator needs to investigate the problem
      • ...

load
Anchor
load
load

  • Description
    • ...
  • Expected Beginning State
    • ...
  • Expected Ending State
    • ...
  • Called By
    • ...
  • Arguments & Calling Environment
    • Must only be called as an object method of a provisioning object ($provisioner->pre_capture()) 
    • No Arguments
  • Return Values
    • 1
      • ...
    • 0
      • ...
    • Undefined
      • ...

...