Update readme
[osm/N2VC.git] / juju / machine.py
1 class Machine(object):
2 def run(self, command, timeout=None):
3 """Run command on this machine.
4
5 :param str command: The command to run
6 :param int timeout: Time to wait before command is considered failed
7
8 """
9 pass
10
11 def scp(
12 self, source_path, user=None, destination_path=None, proxy=False,
13 scp_opts=None):
14 """Transfer files to this machine.
15
16 :param str source_path: Path of file(s) to transfer
17 :param str user: Remote username
18 :param str destination_path: Destination of transferred files on
19 remote machine
20 :param bool proxy: Proxy through the Juju API server
21 :param str scp_opts: Additional options to the `scp` command
22
23 """
24 pass
25
26 def ssh(
27 self, command, user=None, proxy=False, ssh_opts=None):
28 """Execute a command over SSH on this machine.
29
30 :param str command: Command to execute
31 :param str user: Remote username
32 :param bool proxy: Proxy through the Juju API server
33 :param str ssh_opts: Additional options to the `ssh` command
34
35 """
36 pass
37
38 def status_history(self, num=20, utc=False):
39 """Get status history for this machine.
40
41 :param int num: Size of history backlog
42 :param bool utc: Display time as UTC in RFC3339 format
43
44 """
45 pass