Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Execute a specified script on a target host.

Note

Note that the -privateKey parameter is the name of a private key file accessible your mettleci remote execute command. If used as part of a CI/CD pipeline then the build agent process running the command will need access to the specified private key file.

Syntax

See the examples below.

...

...

Include Page
remote execute command syntax
remote execute command syntax

...

Examples

Code Block
languagebash
# Options
$> mettleci remote execute help
Usage: remote execute [options]
  Options:
  * -host
       URL of the server
    -passphrase
       SSH key pass phrase
    -password
       Password when connecting to remote server, required when -privateKey is
       not used
    -port
       SSH Port
       Default: 22
    -privateKey
       Private SSH key, required when -password is not used
  * -script
       Local script to execute on remote server
  * -username
       Username when connecting to remote server

Command failed.

# Example
$> mettleci remote execute \
   -host my-engine.my-org.com \
   -username myusername \
   -password mypassword \
   -script "config/deploy.sh"
MettleCI Command Line (build 128)
(C) 2018-2022 Data Migrators Pty Ltd
Connecting to my-engine.my-org.com on port 22

Status code = 0 
exit code = 0
$>

...