Compartir vía


SSH@0: tarea SSH v0

Use esta tarea para ejecutar comandos de shell o un script en un equipo remoto mediante SSH. Esta tarea le permite conectarse a una máquina remota mediante SSH y ejecutar comandos o un script.

Syntax

# SSH v0
# Run shell commands or a script on a remote machine using SSH.
- task: SSH@0
  inputs:
    sshEndpoint: # string. Required. SSH service connection. 
    runOptions: 'commands' # 'commands' | 'script' | 'inline'. Required. Run. Default: commands.
    commands: # string. Required when runOptions = commands. Commands. 
    #scriptPath: # string. Required when runOptions = script. Shell script path. 
    #inline: # string. Required when runOptions = inline. Inline Script. 
    #interpreterCommand: '/bin/bash' # string. Optional. Use when runOptions = inline. Interpreter command. Default: /bin/bash.
    #args: # string. Optional. Use when runOptions = script. Arguments. 
  # Advanced
    #failOnStdErr: true # boolean. Fail on STDERR. Default: true.
    #interactiveSession: false # boolean. Enable interactive session. Default: false.
    readyTimeout: '20000' # string. Required. SSH handshake timeout. Default: 20000.
    #interactiveKeyboardAuthentication: false # boolean. Use interactive-keyboard authentication. Default: false.
# SSH v0
# Run shell commands or a script on a remote machine using SSH.
- task: SSH@0
  inputs:
    sshEndpoint: # string. Required. SSH service connection. 
    runOptions: 'commands' # 'commands' | 'script' | 'inline'. Required. Run. Default: commands.
    commands: # string. Required when runOptions = commands. Commands. 
    #scriptPath: # string. Required when runOptions = script. Shell script path. 
    #inline: # string. Required when runOptions = inline. Inline Script. 
    #interpreterCommand: '/bin/bash' # string. Optional. Use when runOptions = inline. Interpreter command. Default: /bin/bash.
    #args: # string. Optional. Use when runOptions = script. Arguments. 
  # Advanced
    #failOnStdErr: true # boolean. Fail on STDERR. Default: true.
    #interactiveSession: false # boolean. Enable interactive session. Default: false.
    readyTimeout: '20000' # string. Required. SSH handshake timeout. Default: 20000.
# SSH v0
# Run shell commands or a script on a remote machine using SSH.
- task: SSH@0
  inputs:
    sshEndpoint: # string. Required. SSH service connection. 
    runOptions: 'commands' # 'commands' | 'script' | 'inline'. Required. Run. Default: commands.
    commands: # string. Required when runOptions = commands. Commands. 
    #scriptPath: # string. Required when runOptions = script. Shell script path. 
    #inline: # string. Required when runOptions = inline. Inline Script. 
    #args: # string. Optional. Use when runOptions = script. Arguments. 
  # Advanced
    #failOnStdErr: true # boolean. Fail on STDERR. Default: true.
    readyTimeout: '20000' # string. Required. SSH handshake timeout. Default: 20000.
# SSH v0
# Run shell commands or a script on a remote machine using SSH.
- task: SSH@0
  inputs:
    sshEndpoint: # string. Required. SSH service connection. 
    runOptions: 'commands' # 'commands' | 'script' | 'inline'. Required. Run. Default: commands.
    commands: # string. Required when runOptions = commands. Commands. 
    #scriptPath: # string. Required when runOptions = script. Shell script path. 
    #inline: # string. Required when runOptions = inline. Inline Script. 
    #args: # string. Optional. Use when runOptions = script. Arguments. 
  # Advanced
    #failOnStdErr: true # boolean. Fail on STDERR. Default: true.

Entradas

sshEndpoint - Conexión de servicio SSH
string. Obligatorio.

Especifica el nombre de una conexión de servicio SSH que contiene los detalles de conexión de la máquina remota. - El nombre de host o la dirección IP de la máquina remota, el número de puerto y el nombre de usuario son necesarios para crear una conexión de servicio SSH.

  • La clave privada y la frase de contraseña deben especificarse para la autenticación.
  • Se puede usar una contraseña para autenticarse en máquinas Linux remotas, pero esto no es compatible con sistemas macOS o Windows.

runOptions - Ejecutar
string. Obligatorio. Valores permitidos: commands, script (Archivo de script), inline (Script en línea). Valor predeterminado: commands.

Ejecuta comandos de shell o un script de shell en la máquina remota.


commands - Comandos
string. Necesario cuando runOptions = commands.

Especifica los comandos de shell que se van a ejecutar en la máquina remota. Este parámetro solo está disponible cuando se selecciona Comandos para la opción Ejecutar. Escriba cada comando junto con sus argumentos en una nueva línea del cuadro de texto de varias líneas. Para ejecutar varios comandos juntos, escríbalos en la misma línea separados por punto y coma. Ejemplo: cd /home/user/myFolder;build.

Nota:

Cada comando se ejecuta en un proceso independiente. Si desea ejecutar una serie de comandos que son interdependientes (por ejemplo, cambiar la carpeta actual antes de ejecutar un comando), use la opción Script en línea en su lugar.


scriptPath - Ruta de acceso del script de Shell
string. Necesario cuando runOptions = script.

Especifica la ruta de acceso al archivo de script de shell que se va a ejecutar en el equipo remoto. Este parámetro solo está disponible cuando se selecciona Script de shell para la opción Ejecutar.


inline - Script insertado
string. Necesario cuando runOptions = inline.

Escribe el script de shell para ejecutarse en la máquina remota.


interpreterCommand - Comando de intérprete
string. Opcional. Use cuando runOptions = inline. Valor predeterminado: /bin/bash.

Especifica la ruta de acceso al intérprete de comandos que se usa para ejecutar el script. Agrega una línea shebang al principio del script. Solo es pertinente para sistemas operativos similares a UNIX. Use una cadena vacía para hosts remotos basados en Windows. Obtenga más información sobre shebang (#!).


args - Argumentos
string. Opcional. Use cuando runOptions = script.

Especifica los argumentos que se van a pasar al script de shell. Este parámetro solo está disponible cuando se selecciona Script de shell para la opción Ejecutar.


failOnStdErr - Error en STDERR
boolean. Valor predeterminado: true.

Si el valor es true, se produce un error en la compilación cuando los comandos remotos o el script escriben en STDERR.


interactiveSession - Habilitación de la sesión interactiva
boolean. Valor predeterminado: false.

Inicia una sesión interactiva. Las solicitudes de contraseña se rellenan mediante la contraseña del usuario. Las sesiones interactivas pueden ser útiles para ejecutar comandos, como sudo.


readyTimeout - Tiempo de espera del protocolo de enlace SSH
string. Obligatorio. Valor predeterminado: 20000.

Especifica cuánto tiempo (en milisegundos) la tarea espera a que se complete el protocolo de enlace SSH.


interactiveKeyboardAuthentication - Uso de la autenticación de teclado interactivo
boolean. Valor predeterminado: false.

Habilita la autenticación de teclado interactivo. true Establézcalo en si el servidor SSH de destino requiere autenticación de teclado interactiva (PasswordAuthentication está deshabilitado en el equipo de destino o establecido en No en sshd_config).


Opciones de control de tareas

Todas las tareas tienen opciones de control además de las entradas de tareas. Para obtener más información, vea Opciones de control y propiedades de tareas comunes.

Variables de salida

Ninguno.

Comentarios

Use esta tarea para ejecutar comandos de shell o un script en un equipo remoto mediante SSH. Esta tarea le permite conectarse a una máquina remota mediante SSH y ejecutar comandos o un script.

Requisitos previos

  • La tarea admite el uso de un par de claves SSH para conectarse a las máquinas remotas.
  • La clave pública debe preinstalarse o copiarse en las máquinas remotas.

Algoritmos admitidos

Algoritmos de par de claves

  • RSA
  • DSA

Algoritmos de cifrado

  • aes256-cbc
  • aes192-cbc
  • aes128-cbc
  • blowfish-cbc
  • 3des-cbc
  • arcfour256
  • arcfour128
  • cast128-cbc
  • arcfour

Para OpenSSL v1.0.1 y versiones posteriores (en el agente):

  • aes256-ctr
  • aes192-ctr
  • aes128-ctr

Para OpenSSL v1.0.1 y versiones posteriores, NodeJS v0.11.12 y versiones posteriores (en el agente):

  • aes128-gcm
  • aes128-gcm@openssh.com
  • aes256-gcm
  • aes256-gcm@openssh.com

Requisitos

Requisito Descripción
Tipos de canalización YAML, compilación clásica, versión clásica
Se ejecuta en Agente, DeploymentGroup
Peticiones None
Capabilities Esta tarea no satisface ninguna demanda de tareas posteriores en el trabajo.
Restricciones de comandos Any
Variables que se pueden establecer Any
Versión del agente 2.206.1 o superior
Categoría de la tarea: Implementar
Requisito Descripción
Tipos de canalización YAML, compilación clásica, versión clásica
Se ejecuta en Agente, DeploymentGroup
Peticiones None
Capabilities Esta tarea no satisface ninguna demanda de tareas posteriores en el trabajo.
Restricciones de comandos Any
Variables que se pueden establecer Any
Versión del agente 2.144.0 o superior
Categoría de la tarea: Implementar
Requisito Descripción
Tipos de canalización YAML, compilación clásica, versión clásica
Se ejecuta en Agente, DeploymentGroup
Peticiones None
Capabilities Esta tarea no satisface ninguna demanda de tareas posteriores en el trabajo.
Restricciones de comandos Any
Variables que se pueden establecer Any
Versión del agente 2.102.0 o superior
Categoría de la tarea: Implementar

Vea también