juju/unit.py

   1 class Unit(object):
   2     def add_storage(self, name, constraints=None):
   3         """Add unit storage dynamically.
   4
   5         :param str name: Storage name, as specified by the charm
   6         :param str constraints: Comma-separated list of constraints in the
   7             form 'POOL,COUNT,SIZE'
   8
   9         """
  10         pass
  11
  12     def collect_metrics(self):
  13         """Collect metrics on this unit.
  14
  15         """
  16         pass
  17
  18     def destroy(self):
  19         """Destroy this unit.
  20
  21         """
  22         pass
  23     remove = destroy
  24
  25     def get_resources(self, details=False):
  26         """Return resources for this unit.
  27
  28         :param bool details: Include detailed info about resources used by each
  29             unit
  30
  31         """
  32         pass
  33
  34     def resolved(self, retry=False):
  35         """Mark unit errors resolved.
  36
  37         :param bool retry: Re-execute failed hooks
  38
  39         """
  40         pass
  41
  42     def run(self):
  43         """Run command on this unit.
  44
  45         """
  46         pass
  47
  48     def run_action(self):
  49         """Run action on this unit.
  50
  51         """
  52         pass
  53
  54     def scp(self):
  55         """Transfer files to this unit.
  56
  57         """
  58         pass
  59
  60     def set_meter_status(self):
  61         """Set the meter status on this unit.
  62
  63         """
  64         pass
  65
  66     def ssh(self):
  67         """Execute a command over SSH on this unit.
  68
  69         """
  70         pass
  71
  72     def status_history(self):
  73         """Get status history for this unit.
  74
  75         """
  76         pass