Versions Compared

Old Version 4

changes.mady.by.user John McKeever

Saved on

compared with

New Version Current

changes.mady.by.user John McKeever

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Page Properties
hiddentrue
idmettleci-cli

Namespace

remote

Command

execute

Plugin Name

remote

Plugin File

dm-bamboo-sftp-plugin.jar

Credentials

OS

Windows Client

-

Purpose

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
themeFadeToGrey
titleDataStage Deploy - command line options
$> mettleci remote execute help
Usage: remote execute [options]
  Options:\
  * -host        URL of the server
my-engine.my-org.com \
   -passphraseusername        SSH key pass phrase
myusername \
   -password mypassword  \
    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

-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
$>

See Also

Filter by label (Content by label)
showLabelsfalse
showSpacefalse
cqllabel = "remote_namespace"