Que contiennent les modèles gérés ?Prérequis Modèles gérés d’actions à distance et de documents de tâche

Utiliser des modèles AWS gérés pour déployer des opérations à distance courantes

AWS les modèles gérés sont des modèles de tâches fournis par AWS. Ils sont utilisés pour les actions à distance fréquemment effectuées, telles que le redémarrage, le téléchargement d’un fichier ou l’installation d’une application sur vos appareils. Ces modèles comportent un document de travail prédéfini pour chaque action à distance, de sorte que vous n’avez pas à créer votre propre document de travail.

Vous pouvez choisir parmi un ensemble de configurations prédéfinies et créer des tâches à l’aide de ces modèles sans écrire de code supplémentaire. À l’aide de modèles gérés, vous pouvez consulter le document de tâche déployé dans vos flottes. Vous pouvez créer une tâche à l’aide de ces modèles et créer un modèle de tâche personnalisé que vous pouvez réutiliser pour vos opérations à distance.

Que contiennent les modèles gérés ?

Chaque modèle AWS géré contient :

L’environnement dans lequel exécuter les commandes du document de travail.
Document de travail qui indique le nom de l’opération et ses paramètres. Par exemple, si vous utilisez un modèle de fichier de téléchargement, le nom de l’opération est Télécharger le fichier et les paramètres peuvent être les suivants :
- URL du fichier que vous voulez télécharger sur votre appareil. Il peut s’agir d’une ressource Internet ou d’une URL Amazon Simple Storage Service (Amazon S3) publique ou présignée.
- Un chemin de fichier local sur l’appareil pour stocker le fichier téléchargé.
Pour plus d’informations sur la fonction et ses paramètres, veuillez consulter Modèles gérés d’actions à distance et de documents de tâche.

Prérequis

Pour que vos appareils exécutent les actions à distance spécifiées par le modèle de document de travail géré, vous devez :

Installez le logiciel spécifique sur votre appareil

Utilisez le logiciel et les gestionnaires de tâches de votre appareil, ou le client de l' AWS IoT appareil. En fonction de votre analyse de rentabilisation, vous pouvez également les exécuter tous les deux de manière à ce qu’ils remplissent des fonctions différentes.
- Utilisez votre propre appareil, votre propre logiciel et vos propres gestionnaires de tâches
  
  Vous pouvez écrire votre propre code pour les appareils en utilisant Kit SDK des appareils AWS IoT et sa bibliothèque de gestionnaires qui prennent en charge les opérations à distance. Pour déployer et exécuter des tâches, vérifiez que les bibliothèques d’agents d’appareil ont été correctement installées et qu’elles s’exécutent sur les appareils.
  
  Vous pouvez également choisir d’utiliser vos propres gestionnaires qui prennent en charge les opérations à distance. Pour plus d'informations, consultez la section Exemples de gestionnaires de tâches dans le GitHub référentiel AWS IoT Device Client.
- Utiliser le client de AWS IoT l'appareil
  
  Vous pouvez également installer et exécuter le AWS IoT Device Client sur vos appareils, car il prend en charge par défaut l'utilisation de tous les modèles gérés directement depuis la console.
  
  Le Device Client est un logiciel open source écrit en C++ que vous pouvez compiler et installer sur vos appareils IoT intégrés basés sur Linux. Le Device Client possède un client de base et des fonctionnalités distinctes côté client. Le client de base établit la connectivité AWS IoT via le protocole MQTT et peut se connecter aux différentes fonctionnalités côté client.
  
  Pour effectuer des opérations à distance sur vos appareils, utilisez la fonctionnalité Tâches côté client du Device Client. Cette fonctionnalité contient un analyseur pour recevoir le document de tâche et des gestionnaires de tâches qui implémentent les actions à distance spécifiées dans le document de travail. Pour plus d’informations sur Device Client et ses fonctionnalités, veuillez consulter AWS IoT Device Client.
  
  Lorsqu’il est exécuté sur des appareils, le Device Client reçoit le document de tâche et dispose d’une implémentation spécifique à la plate-forme qu’il utilise pour exécuter des commandes dans le document. Pour plus d’informations sur la configuration de Device Client et l’utilisation de la fonctionnalité Tâches, veuillez consulter AWS IoT les didacticiels..
Utiliser l’environnement compatible

Pour chaque modèle géré, vous trouverez des informations sur l’environnement que vous pouvez utiliser pour exécuter les actions à distance. Nous vous recommandons d’utiliser le modèle avec un environnement Linux pris en charge comme indiqué dans le modèle. Utilisez le client de AWS IoT périphérique pour exécuter les actions à distance du modèle géré, car il prend en charge les microprocesseurs courants et les environnements Linux, tels que Debian et Ubuntu.

Modèles gérés d’actions à distance et de documents de tâche

La section suivante répertorie les différents modèles AWS gérés pour les AWS IoT tâches et décrit les actions à distance qui peuvent être effectuées sur les appareils. La section suivante contient des informations sur le document de travail et une description des paramètres du document de tâche pour chaque action à distance. Le logiciel côté appareil utilise le nom du modèle et les paramètres pour effectuer l’action à distance.

AWS les modèles gérés acceptent les paramètres d'entrée pour lesquels vous spécifiez une valeur lors de la création d'une tâche à l'aide du modèle. Tous les modèles gérés ont en commun deux paramètres d’entrée facultatifs : runAsUser et pathToHandler. À l’exception du modèle AWS-Reboot, les modèles nécessitent des paramètres d’entrée supplémentaires pour lesquels vous devez spécifier une valeur lors de la création d’une tâche à l’aide du modèle. Les paramètres d’entrée requis varient en fonction du modèle que vous choisissez. Par exemple, si vous choisissez le modèle AWS-Download-File, vous devez spécifier une liste de packages à installer et une URL à partir de laquelle télécharger les fichiers.

Spécifiez une valeur pour les paramètres d'entrée lorsque vous utilisez la AWS IoT console ou le AWS Command Line Interface (AWS CLI) pour créer une tâche utilisant un modèle géré. Lorsque vous utilisez la CLI, fournissez ces valeurs à l’aide de l’objet document-parameters. Pour plus d’informations, consultez DocumentParameters.

Note

Utilisez document-parameters uniquement lors de la création de tâches à partir de modèles gérés AWS . Ce paramètre ne peut pas être utilisé avec des modèles de tâches personnalisés ou pour créer des tâches à partir de ceux-ci.

Vous trouverez ci-dessous une description des paramètres d’entrée facultatifs courants. Vous verrez une description des autres paramètres d’entrée requis par chaque modèle géré dans la section suivante.

runAsUser: Ce paramètre indique s’il faut exécuter le gestionnaire de tâches en tant qu’autre utilisateur. S’il n’est pas spécifié lors de la création de la tâche, le gestionnaire de tâches est exécuté sous le même nom d’utilisateur que le Device Client. Lorsque vous exécutez le gestionnaire de tâches en tant qu’autre utilisateur, spécifiez une valeur de chaîne ne dépassant pas 256 caractères.

pathToHandler: Le chemin d’accès au gestionnaire de tâches exécuté sur l’appareil. S’il n’est pas spécifié lors de la création de la tâche, le Device Client utilise le répertoire de tâche actuel.

Vous trouverez ci-dessous les différentes actions à distance, leurs documents de tâche et les paramètres qu’elles acceptent. Tous ces modèles prennent en charge l’environnement Linux pour exécuter l’opération à distance sur l’appareil.

Nom du modèle

AWS–Download–File

Description du modèle

Modèle géré fourni par AWS pour le téléchargement d'un fichier.

Paramètres d'entrée

Les paramètres requis de ce modèle sont les suivants. Vous pouvez également spécifier les paramètres facultatifs runAsUser et pathToHandler.

downloadUrl: L’URL à partir de laquelle le fichier doit être téléchargé. Il peut s’agir d’une ressource Internet, d’un objet d’Amazon S3 accessible au public ou d’un objet d’Amazon S3 accessible uniquement par votre appareil à l’aide d’une URL présignée. Pour plus d’informations sur l’utilisation d’URL présignées et l’octroi d’autorisations, veuillez consulter URL présignées.
filePath: Un chemin de fichier local qui indique l’emplacement sur l’appareil où stocker le fichier téléchargé.

Comportement de l’appareil

L’appareil télécharge le fichier depuis l’emplacement indiqué, vérifie que le téléchargement est terminé et le stocke localement.

Document de tâche

Ce qui suit montre le document de travail et sa dernière version. Le modèle indique le chemin d’accès au gestionnaire de tâches et au script shell, download-file.sh, que le gestionnaire de tâches doit exécuter pour télécharger le fichier. Il indique également les paramètres requis downloadUrl etfilePath.


{
  "version": "1.0",
  "steps": [
    {
      "action": {
        "name": "Download-File",
        "type": "runHandler",
        "input": {
          "handler": "download-file.sh",
          "args": [
            "${aws:iot:parameter:downloadUrl}",
            "${aws:iot:parameter:filePath}"
          ],
          "path": "${aws:iot:parameter:pathToHandler}"
        },
        "runAsUser": "${aws:iot:parameter:runAsUser}"
      }
    }
  ]
}

Nom du modèle

AWS–Install–Application

Description du modèle

Modèle géré fourni par AWS pour l'installation d'une ou de plusieurs applications.

Paramètres d'entrée

Ce modèle possède le paramètre obligatoire suivant, packages. Vous pouvez également spécifier les paramètres facultatifs runAsUser et pathToHandler.

packages

Liste d’une ou plusieurs applications à installer, séparées par des espaces.

Comportement de l’appareil

L’appareil installe les applications comme indiqué dans le document de travail.

Document de tâche

Ce qui suit montre le document de travail et sa dernière version. Le modèle indique le chemin d’accès au gestionnaire de tâches et au script shell install-packages.sh, que le gestionnaire de tâches doit exécuter pour télécharger le fichier. Il indique également le paramètre requis packages.


{
  "version": "1.0",
  "steps": [
    {
      "action": {
        "name": "Install-Application",
        "type": "runHandler",
        "input": {
          "handler": "install-packages.sh",
          "args": [
            "${aws:iot:parameter:packages}"
          ],
          "path": "${aws:iot:parameter:pathToHandler}"
        },
        "runAsUser": "${aws:iot:parameter:runAsUser}"
      }
    }
  ]
}

Nom du modèle

AWS–Reboot

Description du modèle

Un modèle géré fourni par AWS pour le redémarrage de votre appareil.

Paramètres d'entrée

Ce modèle n’a aucun paramètre requis. Vous pouvez également spécifier les paramètres facultatifs runAsUser et pathToHandler.

Comportement de l’appareil

L’appareil redémarre correctement.

Document de tâche

Ce qui suit montre le document de travail et sa dernière version. Le modèle indique le chemin d’accès au gestionnaire de tâches et au script shell reboot.sh, que le gestionnaire de tâches doit exécuter pour redémarrer l’appareil.


{
  "version": "1.0",
  "steps": [
    {
      "action": {
        "name": "Reboot",
        "type": "runHandler",
        "input": {
          "handler": "reboot.sh",
          "path": "${aws:iot:parameter:pathToHandler}"
        },
        "runAsUser": "${aws:iot:parameter:runAsUser}"
      }
    }
  ]
}

Nom du modèle

AWS–Remove–Application

Description du modèle

Modèle géré fourni par AWS pour la désinstallation d'une ou de plusieurs applications.

Paramètres d'entrée

Ce modèle possède le paramètre obligatoire suivant, packages. Vous pouvez également spécifier les paramètres facultatifs runAsUser et pathToHandler.

packages

Liste d’une ou plusieurs applications à désinstaller, séparées par des espaces.

Comportement de l’appareil

L’appareil désinstalle les applications comme indiqué dans le document de tâche.

Document de tâche

Ce qui suit montre le document de travail et sa dernière version. Le modèle indique le chemin d’accès au gestionnaire de tâches et au script shell remove-packages.sh, que le gestionnaire de tâches doit exécuter pour télécharger le fichier. Il indique également le paramètre requis packages.


{
  "version": "1.0",
  "steps": [
    {
      "action": {
        "name": "Remove-Application",
        "type": "runHandler",
        "input": {
          "handler": "remove-packages.sh",
          "args": [
            "${aws:iot:parameter:packages}"
          ],
          "path": "${aws:iot:parameter:pathToHandler}"
        },
        "runAsUser": "${aws:iot:parameter:runAsUser}"
      }
    }
  ]
}

Nom du modèle

AWS–Restart–Application

Description du modèle

Modèle géré fourni par AWS pour arrêter et redémarrer un ou plusieurs services.

Paramètres d'entrée

Ce modèle possède le paramètre obligatoire suivant, services. Vous pouvez également spécifier les paramètres facultatifs runAsUser et pathToHandler.

Services

Liste des applications, séparées par des espaces, à redémarrer.

Comportement de l’appareil

Les applications spécifiées sont arrêtées puis redémarrées sur l’appareil.

Document de tâche

Ce qui suit montre le document de travail et sa dernière version. Le modèle indique le chemin d’accès au gestionnaire de tâches et au script shell restart-services.sh, que le gestionnaire de tâches doit exécuter pour redémarrer les services du système. Il indique également le paramètre requis services.


{
  "version": "1.0",
  "steps": [
    {
      "action": {
        "name": "Restart-Application",
        "type": "runHandler",
        "input": {
          "handler": "restart-services.sh",
          "args": [
            "${aws:iot:parameter:services}"
          ],
          "path": "${aws:iot:parameter:pathToHandler}"
        },
        "runAsUser": "${aws:iot:parameter:runAsUser}"
      }
    }
  ]
}

Nom du modèle

AWS-Start-Application

Description du modèle

Modèle géré fourni par AWS pour démarrer un ou plusieurs services.

Paramètres d'entrée

Ce modèle possède le paramètre obligatoire suivant, services. Vous pouvez également spécifier les paramètres facultatifs runAsUser et pathToHandler.

services

Liste, séparées par des espaces, d’une ou plusieurs applications à démarrer.

Comportement de l’appareil

Les applications spécifiées commencent à s’exécuter sur l’appareil.

Document de tâche

Ce qui suit montre le document de travail et sa dernière version. Le modèle indique le chemin d’accès au gestionnaire de tâches et au script shell start-services.sh, que le gestionnaire de tâches doit exécuter pour démarrer les services système. Il indique également le paramètre requis services.


{
  "version": "1.0",
  "steps": [
    {
      "action": {
        "name": "Start-Application",
        "type": "runHandler",
        "input": {
          "handler": "start-services.sh",
          "args": [
            "${aws:iot:parameter:services}"
          ],
          "path": "${aws:iot:parameter:pathToHandler}"
        },
        "runAsUser": "${aws:iot:parameter:runAsUser}"
      }
    }
  ]
}

Nom du modèle

AWS–Stop–Application

Description du modèle

Modèle géré fourni par AWS pour arrêter un ou plusieurs services.

Paramètres d'entrée

Ce modèle possède le paramètre obligatoire suivant, services. Vous pouvez également spécifier les paramètres facultatifs runAsUser et pathToHandler.

services

Liste des applications, séparées par des espaces, à arrêter.

Comportement de l’appareil

Les applications spécifiées cessent de s’exécuter sur l’appareil.

Document de tâche

Ce qui suit montre le document de travail et sa dernière version. Le modèle indique le chemin d’accès au gestionnaire de tâches et au script shell stop-services.sh, que le gestionnaire de tâches doit exécuter pour arrêter les services système. Il indique également le paramètre requis services.


{
  "version": "1.0",
  "steps": [
    {
      "action": {
        "name": "Stop-Application",
        "type": "runHandler",
        "input": {
          "handler": "stop-services.sh",
          "args": [
            "${aws:iot:parameter:services}"
          ],
          "path": "${aws:iot:parameter:pathToHandler}"
        },
        "runAsUser": "${aws:iot:parameter:runAsUser}"
      }
    }
  ]
}

Nom du modèle

AWS–Run–Command

Description du modèle

Modèle géré fourni par AWS pour exécuter une commande shell.

Paramètres d'entrée

Ce modèle possède le paramètre obligatoire suivant, command. Vous pouvez également spécifier le paramètre facultatif runAsUser.

command

Chaîne de commande séparée par des virgules. Toute virgule contenue dans la commande elle-même doit être évitée.

Comportement de l’appareil

Le périphérique exécute la commande shell comme indiqué dans le document de travail.

Document de tâche

Ce qui suit montre le document de travail et sa dernière version. Le modèle indique le chemin d’accès à la commande de tâche et à la commande que vous avez fournie et que l’appareil exécutera.


{
  "version": "1.0",
  "steps": [
    {
      "action": {
        "name": "Run-Command",
        "type": "runCommand",
        "input": {
          "command": "${aws:iot:parameter:command}"
        },
        "runAsUser": "${aws:iot:parameter:runAsUser}"
      }
    }
  ]
}

Rubriques

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

Modèles de tâche

Création d'une tâche à partir de modèles AWS gérés à l'aide de la console