Aller au contenu

Script distant

Propre à OrkyvoToutes les offres1 entrée · 1 sortie

Exécute un script versionné avec ses paramètres, via SSH ou l'agent selon le serveur.

Éléments reçusScript distantÉléments produits

Fonctionnement

Scripts gérés dans Serveurs › Scripts : chaque modification crée une version immuable (contenu et empreinte). Les paramètres déclarés obligatoires doivent être fournis.

Paramètres

ParamètreTypeDétail
Serveur ou groupeobligatoireserveur ou groupeServeurs de l'environnement de l'exécution uniquement. Un groupe est résolu au démarrage de l'étape.
Script versionnéobligatoirescript versionnéLa version exécutée est enregistrée avec chaque tâche. « Dernière version » est résolue au démarrage de l'étape.
Paramètresclé-valeurTransmis au script comme variables d'environnement (échappées).
Répertoire de travailtexteFacultatif. Transmis littéralement (échappé).
Délai maximal (secondes)nombre3600 s au plus. Au-delà, le processus distant est arrêté et l'arrêt vérifié.
Codes de sortie réussistexteEx. 0 ; 0,1 ; 0-2.
Taille maximale des sorties (Ko)nombrePar flux (stdout, stderr), 1024 Ko au plus ; au-delà la sortie est tronquée et signalée.
Exécuter avec sudo (non interactif)oui / nonRefusé si le serveur n'autorise pas les opérations privilégiées.
En cas d'échec sur un serveurchoixValeurs : Échouer le bloc (après tous les serveurs), Continuer : le statut figure dans le résultat.
Serveurs traités en parallèle (groupe)nombre50 au plus.

Données reçues et renvoyées

  • EntréeListe d'éléments ; le premier élément alimente les paramètres.
  • SortieUn élément par serveur : { serverId, serverName, environmentId, status, exitCode, stdout, stderr, startedAt, finishedAt, durationMs, timedOut, cancelled, cancelConfirmed, outputTruncated, error, taskId }. status : SUCCEEDED, FAILED, TIMED_OUT, CANCELLED, INDETERMINATE (connexion perdue : la commande a pu s'exécuter), REFUSED, EXPIRED. Le résultat indique aussi scriptVersion.

Erreurs

Script ou version introuvable, paramètre obligatoire manquant, et les erreurs des commandes.

À savoir. Une commande dont le résultat est inconnu (connexion perdue, worker interrompu) n'est jamais relancée automatiquement : elle est marquée « indéterminée ».

À savoir. Annulation : interruption du processus distant puis vérification ; cancelConfirmed indique si l'arrêt a été constaté.

Exemple

Paramètres d'un bloc prêt à l'emploi. Dans l'éditeur, l'onglet Aide du bloc applique cet exemple en un clic.

Paramètres de l'exemple (JSON)Ouvrir l'éditeur
{
  "params": [
    {
      "id": "p1",
      "key": "VERSION",
      "value": "{{ $json.version }}"
    }
  ],
  "timeoutSeconds": "600"
}

Voir aussi