Kenneth: /* Simple Local */

2023-01-03T16:51:53Z

Simple Local

New page

== Fabric2 ==

See [[Python/Fabric2]]

== Simple Local ==

# local(command, capture=False, shell=None)

<pre>
from fabric.api import local
local('hostname')
</pre>

== Simple Remote ==

<pre>
from fabric.api import env
from fabric.api import run

env.host_string = 'some_node'
env.user = 'some_user'
env.password = 'some_pass'
run('hostname')
</pre>

Kind of ugly:
<pre>
from fabric.api import env
from fabric.api import settings
from fabric.api import run

crash_host = {'host_string': 'some-node',
'user': 'root',
'password': 'password',
'command_timeout': 10,
'connection_attempts': 1,
'abort_on_prompts': True}

with settings(**crash_host):
run('hostname')
</pre>

== Handle a non zero return code ==

Normally Fabric aborts the program on a failure, which is just stupid

For all:
<pre>
env.warn_only = True
</pre>

or per command:
rc = run('aaa', warn_only=True)
if rc.failed:
print("failure with {}".format(rc.return_code))
if rc.succeeded:
print("Happy")
</pre>

== change directory ==

<pre>
from fabric.api import env, run
from fabric.context_managers import cd

env.host_string = 'localhost'

with cd('welcome'):
run("echo 'hi' > hello.txt")
</pre>

ref: [https://stackoverflow.com/questions/10280984/how-to-set-the-working-directory-for-a-fabric-task]

== Sample Put / Get ==

<pre>
#!/usr/bin/python

from fabric.api import env
from fabric.operations import run, put, get

env.host_string = "somenode"
env.user = "user"
env.password = "password"

# put local file on remote node
put('test.zip', '/tmp/test.zip')

# copy remote file on local
get('/tmp/test.zip', 'test2.zip')

# verify md5sum
run('md5sum /tmp/test.zip', timeout=1)
</pre>

<pre>
result = run('pwd')
print(result.return_code)
print(result) # combined output
print(result.stdout)
print(result.stderr)
print(result.failed) # True or False
</pre>

Windows struggles, but this seemed to work:
<pre>
from fabric import api as fab # pylint: disable=import-error
from fabric.exceptions import CommandTimeout # Gets the class for CommandTimeout exception
import sys

fab_test_settings = fab.settings(
host_string='HOSTNAME',
user='USER',
password='PASSWORD',
abort_on_prompts=True,
keepalive=30)

with fab_test_settings:
fab.run('dir', shell=False, pty=False, warn_only=False, timeout=None, quiet=False, stdout=sys.stdout, combine_stderr=True)
</pre>

== API ==

https://docs.fabfile.org/en/1.14/api/core/operations.html

run() also has a timeout in seconds

fabric.operations.run(command, shell=True, pty=True, combine_stderr=None, quiet=False, warn_only=False, stdout=None, stderr=None, timeout=None, shell_escape=None, capture_buffer_size=None)

Other ENV paramters:

https://docs.fabfile.org/en/1.14/usage/env.html

== Paramiko Logging ==

<pre>
import logging
logging.basicConfig(level=logging.DEBUG)
</pre>

Lots of logs, but no logs during the actual copy.

== keywords ==

Python/Fabric - Revision history

Kenneth: /* Simple Local */