You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

Background

  • Provisioning module objects are created by State.pm::initialize() when a new state object is created.
  • Provisioning module objects are available within state modules
  • Provisioning module objects are not available within other types of modules for safety.

Provisioning Module Subroutines

It is highly recommended that all provisioning modules implement the following subroutines.  There may be many additional subroutines implemented within a provisioning module.  These will not be called by any of the core VCL modules.

capture

  • 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
      • ...

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
      • ...

power_off

  • 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
      • ...

power_on

  • 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
      • ...

get_current_image

  • 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
      • ...

get_image_size 

  • 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
      • ...
  • No labels