Filling in params, docstrings (wip)
[osm/N2VC.git] / 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 run(self):
35 """Run command on this unit.
36
37 """
38 pass
39
40 def run_action(self):
41 """Run action on this unit.
42
43 """
44 pass
45
46 def scp(self):
47 """Transfer files to this unit.
48
49 """
50 pass
51
52 def set_meter_status(self):
53 """Set the meter status on this unit.
54
55 """
56 pass
57
58 def ssh(self):
59 """Execute a command over SSH on this unit.
60
61 """
62 pass
63
64 def status_history(self):
65 """Get status history for this unit.
66
67 """
68 pass