class Unit(object):
- def add_storage(self):
+ def add_storage(self, name, constraints=None):
"""Add unit storage dynamically.
+ :param str name: Storage name, as specified by the charm
+ :param str constraints: Comma-separated list of constraints in the
+ form 'POOL,COUNT,SIZE'
+
"""
pass
pass
remove = destroy
- def get_resources(self):
+ def get_resources(self, details=False):
"""Return resources for this unit.
+ :param bool details: Include detailed info about resources used by each
+ unit
+
+ """
+ pass
+
+ def resolved(self, retry=False):
+ """Mark unit errors resolved.
+
+ :param bool retry: Re-execute failed hooks
+
"""
pass
- def run(self):
+ def run(self, command, timeout=None):
"""Run command on this unit.
+ :param str command: The command to run
+ :param int timeout: Time to wait before command is considered failed
+
"""
pass
- def run_action(self):
+ def run_action(self, action_name, **params):
"""Run action on this unit.
+ :param str action_name: Name of action to run
+ :param \*\*params: Action parameters
+
"""
pass
- def scp(self):
+ def scp(
+ self, source_path, user=None, destination_path=None, proxy=False,
+ scp_opts=None):
"""Transfer files to this unit.
+ :param str source_path: Path of file(s) to transfer
+ :param str user: Remote username
+ :param str destination_path: Destination of transferred files on
+ remote machine
+ :param bool proxy: Proxy through the Juju API server
+ :param str scp_opts: Additional options to the `scp` command
+
"""
pass
"""
pass
- def ssh(self):
+ def ssh(
+ self, command, user=None, proxy=False, ssh_opts=None):
"""Execute a command over SSH on this unit.
+ :param str command: Command to execute
+ :param str user: Remote username
+ :param bool proxy: Proxy through the Juju API server
+ :param str ssh_opts: Additional options to the `ssh` command
+
"""
pass
- def status_history(self):
+ def status_history(self, num=20, utc=False):
"""Get status history for this unit.
+ :param int num: Size of history backlog
+ :param bool utc: Display time as UTC in RFC3339 format
+
"""
pass