Fork of https://github.com/arunoda/nodemiral
Changes:
- Update ssh2 and other dependencies
- Fix testing on windows
npm install @zodern/nodemiral- Support connecting to any unix remote server
- Authenticate with password(using
sshpass) or with apemfile - Can work with multiple servers at once
- Supports,
copy,executeandexecuteScriptat core methods - Familiar NodeJS API
var nodemiral = require('@zodern/nodemiral');
var session = nodemiral.session('hostname', {username: 'root', password: 'password'});
session.execute('uname -a', function(err, code, logs) {
console.log(logs.stdout);
});Create a session to a remote server. You can invoke following methods after created a session
@param hostname - hostname or ip addess
@param auth - object containing following fields: `username` and (`password` or `pem`)
@param options - object of options described below
nodemiral.session(hostname, auth, options);
options:
ejs- ejs options withejsfieldsssh- object whose key and value will be passed as-o key:valueto any ssh session. For example{ 'StrictHostKeyChecking': 'no', 'UserKnownHostsFile': '/dev/null' }
execute given shell command on the remote server
@param shellCommand - shellCommand
@param options - {onStdout, onStderr}
@param callback - callback containing following parameters
err - err if exists
code - status code of the ssh process
logs - {stdout: 'stdout logs', stderr: 'stderr logs'}
session.execute(shellCommand, callback);
execute a local shell script in the remote server. You can template shell script with EJS.
@param localScriptFile - localScriptFile
@param options.vars - variables to the template if uses ejs in the script
@param callback - callback containing following parameters
err - err if exists
code - status code of the ssh process
logs - {stdout: 'stdout logs', stderr: 'stderr logs'}
session.executeScript(localScriptFile, options, callback);
copy a file from local machine to the remote machine. Supports binary files too. Support EJS templating with non-binary files
@param localFile - localFile
@param remoteFileLocation - remoteFileLocation
@param options.vars - templateVars
@param optiosn.progressBar - show progress bar
@param callback - callback containing following parameters
err - err if exists
code - status code of the ssh process
logs - {stdout: 'stdout logs', stderr: 'stderr logs'}
session.copy(localFile, remoteFileLocation, options, callback)