Was enthalten verwaltete Vorlagen?Voraussetzungen Verwaltete Vorlagen für Remote-Aktionen und Auftragsdokumente

Verwenden Sie AWS verwaltete Vorlagen, um allgemeine Fernoperationen bereitzustellen

AWS Verwaltete Vorlagen sind Auftragsvorlagen, die von bereitgestellt werden AWS. Sie werden für häufig ausgeführte Remote-Aktionen wie den Neustart, das Herunterladen einer Datei oder die Installation einer Anwendung auf Ihren Geräten verwendet. Diese Vorlagen verfügen über ein vordefiniertes Auftragsdokument für jede Remote-Aktion, sodass Sie kein eigenes Auftragsdokument erstellen müssen.

Sie können aus einer Reihe vordefinierter Konfigurationen auswählen und Aufträge mit diesen Vorlagen erstellen, ohne zusätzlichen Code schreiben zu müssen. Mithilfe verwalteter Vorlagen können Sie das Auftragsdokument einsehen, das für Ihre Flotten bereitgestellt wurde. Sie können mithilfe dieser Vorlagen einen Auftrag erstellen und eine benutzerdefinierte Auftragsvorlage erstellen, die Sie für Ihre Remoteoperationen wiederverwenden können.

Was enthalten verwaltete Vorlagen?

Jede AWS verwaltete Vorlage enthält:

Die Umgebung, in der die Befehle im Auftragsdokument ausgeführt werden.
Ein Auftragsdokument, das den Namen und die Parameter der Operation angibt. Wenn Sie beispielsweise eine Vorlage für Download Datei verwenden, lautet der Name der Operation Datei herunterladen und die Parameter können wie folgt lauten:
- Die URL Datei, die Sie auf Ihr Gerät herunterladen möchten. Dies kann eine Internetressource oder ein öffentlicher oder vorab signierter Amazon Simple Storage Service (Amazon S3) URL sein.
- Ein lokaler Dateipfad auf dem Gerät zum Speichern der heruntergeladenen Datei.
Weitere Information zum Auftragsdokument und den Parametern finden Sie unter Verwaltete Vorlagen für Remote-Aktionen und Auftragsdokumente.

Voraussetzungen

Damit Ihre Geräte die Remote-Aktionen ausführen können, die im verwalteten Auftragsvorlagendokument festgelegt sind, müssen Sie Folgendes tun:

Installieren Sie die bestimmte Software auf Ihrem Gerät.

Verwenden Sie Ihre eigene Gerätesoftware und Job-Handler oder den AWS IoT Device Client. Abhängig von Ihrem Geschäftsfall können Sie beide auch so ausführen, dass sie unterschiedliche Funktionen durchführen.
- Verwenden Sie Ihre eigene Gerätesoftware und Auftragshandler
  
  Sie können Ihren eigenen Code für Geräte schreiben, indem Sie AWS IoT Device SDK und die zugehörigen Handler-Bibliotheken verwenden, mit denen die Remoteoperationen unterstützt werden. Stellen Sie sicher, dass zum Bereitstellen und Ausführen von Aufträgen die Geräteagent-Bibliotheken korrekt installiert wurden und auf den Geräten ausgeführt werden.
  
  Sie können auch Ihre eigenen Handler verwenden, mit denen die Remoteoperationen unterstützt werden. Weitere Informationen finden Sie unter Beispiele für Job-Handler im AWS IoT Device GitHub Client-Repository.
- Verwenden Sie den AWS IoT Geräteclient
  
  Sie können den AWS IoT Geräteclient auch auf Ihren Geräten installieren und ausführen, da er standardmäßig die Verwendung aller verwalteten Vorlagen direkt von der Konsole aus unterstützt.
  
  Der Device Client ist eine in C++ geschriebene Open-Source-Software, die Sie kompilieren und auf Ihren eingebetteten Linux-basierten IoT-Geräten installieren können. Der Device Client verfügt über einen Basisclient und separate clientseitige Funktionen. Der Basisclient stellt die Konnektivität AWS IoT über MQTT das Protokoll her und kann eine Verbindung zu den verschiedenen clientseitigen Funktionen herstellen.
  
  Verwenden Sie die clientseitige Auftragsfunktion des Geräteclients, um Remoteoperationen auf Ihren Geräten durchzuführen. Diese Funktion enthält einen Parser zum Empfangen des Auftragsdokuments und Auftragshandler, mit denen die im Auftragsdokument angegebenen Remote-Aktionen implementiert sind. Weitere Informationen zum Device Client und dessen zugehörige Funktionen finden unter AWS IoT Device Client.
  
  Bei der Ausführung auf Geräten empfängt der Device Client das Auftragsdokument und verfügt über eine plattformspezifische Implementierung, mit der er Befehle im Dokument ausführt. Weitere Informationen zum Einrichten des Device Client und zur Verwendung der Funktion Aufträge finden Sie unter AWS IoT -Tutorials.
Verwenden Sie eine unterstützte Umgebung

Für jede verwaltete Vorlage finden Sie Informationen über die Umgebung, in der Sie die Remote-Aktionen ausführen können. Wir empfehlen, dass Sie die Vorlage in einer unterstützten Linux-Umgebung verwenden, so wie das in der Vorlage angegeben ist. Verwenden Sie den AWS IoT Geräteclient, um die verwalteten Template-Remote-Aktionen auszuführen, da er gängige Mikroprozessoren und Linux-Umgebungen wie Debian und Ubuntu unterstützt.

Verwaltete Vorlagen für Remote-Aktionen und Auftragsdokumente

Der folgende Abschnitt listet die verschiedenen AWS verwalteten Vorlagen für AWS IoT Jobs auf und beschreibt die Remote-Aktionen, die auf den Geräten ausgeführt werden können. Der folgende Abschnitt enthält Informationen zum Auftragsdokument und eine Beschreibung der Parameter für das Auftragsdokument für jede Remote-Aktion. Ihre geräteseitige Software verwendet zum Durchführen der Remote-Aktion den Vorlagennamen und die Parameter.

AWS Verwaltete Vorlagen akzeptieren Eingabeparameter, für die Sie einen Wert angeben, wenn Sie mithilfe der Vorlage einen Job erstellen. Allen verwalteten Vorlagen haben zwei gemeinsame optionale Eingabeparameter: runAsUser und pathToHandler. Mit Ausnahme der AWS-Reboot-Vorlage benötigen die Vorlagen zusätzliche Eingabeparameter, für die Sie einen Wert angeben müssen, wenn Sie einen Auftrag mithilfe der Vorlage erstellen. Die erforderlichen Eingabeparameter variieren je nach der von Ihnen ausgewählten Vorlage. Wenn Sie beispielsweise die AWS-Download-File Vorlage auswählen, müssen Sie eine Liste von Paketen angeben, die installiert werden sollen, und eine, aus der Dateien heruntergeladen werden URL sollen.

Geben Sie einen Wert für die Eingabeparameter an, wenn Sie die AWS IoT Konsole verwenden, oder die AWS Command Line Interface (AWS CLI), um einen Job zu erstellen, der eine verwaltete Vorlage verwendet. Wenn Sie den verwendenCLI, geben Sie diese Werte mithilfe des document-parameters Objekts an. Weitere Informationen finden Sie unter documentParameters.

Anmerkung

Verwenden Sie document-parameters nur beim Erstellen von Aufträgen AWS -verwaltete Vorlagen. Dieser Parameter kann nicht mit benutzerdefinierten Auftragsvorlagen oder zum Erstellen von Aufträgen aus diesen Auftragsvorlagen verwendet werden.

Im Folgenden finden Sie eine Beschreibung der gängigen optionalen Eingabeparameter. Im nächsten Abschnitt finden Sie eine Beschreibung der anderen Eingabeparameter, die für jede verwaltete Vorlage erforderlich sind.

runAsUser: Dieser Parameter gibt an, ob der Auftragshandler unter einem anderen Benutzer ausgeführt werden soll. Wird er bei der Auftragserstellung nicht angegeben, wird der Auftragshandler unter demselben Benutzer wie der Device Client ausgeführt. Wenn Sie den Auftragshandler unter einem anderen Benutzer ausführen, geben Sie einen Zeichenkettenwert an, der nicht länger als 256 Zeichen ist.

pathToHandler: Der Pfad zum Auftragshandler, der auf dem Gerät ausgeführt wird. Wenn der Pfad bei der Auftragserstellung nicht angegeben wurde, verwendet der Device Client das aktuelle Arbeitsverzeichnis.

Im Folgenden werden die verschiedenen Remote-Aktionen, ihre Auftragsdokumente und die von ihnen akzeptierten Parameter dargestellt. Alle diese Vorlagen unterstützen die Linux-Umgebung für die Ausführung des Remote-Operation auf dem Gerät.

Name der Vorlage

AWS–Download–File

Vorlagenbeschreibung

Eine verwaltete Vorlage, die von AWS zum Herunterladen einer Datei bereitgestellt wird.

Eingabeparameter

Diese Vorlage verfügt über die folgenden erforderlichen Parameter. Sie können auch die optionalen Parameter runAsUser und pathToHandler angeben.

downloadUrl: DieURL, von der die Datei heruntergeladen werden soll. Dies kann eine Internetressource sein, ein Objekt in Amazon S3, auf das öffentlich zugegriffen werden kann, oder ein Objekt in Amazon S3, auf das Ihr Gerät nur mit einem vorsignierten URL Objekt zugreifen kann. Weitere Informationen zur Verwendung vorsignierter Berechtigungen URLs und zur Erteilung von Berechtigungen finden Sie unter. Vorsigniert URLs
filePath: Ein lokaler Dateipfad, der den Speicherort auf dem Gerät anzeigt, an dem die heruntergeladene Datei gespeichert wird.

Geräteverhalten

Das Gerät lädt die Datei vom angegebenen Speicherort herunter, überprüft, ob der Download abgeschlossen ist und speichert sie lokal.

Auftragsdokument

Im Folgenden werden das Auftragsdokument und die zugehörige neueste Version angezeigt. Die Vorlage zeigt den Pfad zum Auftragshandler und zum Shell-Skript download-file.sh, die der Auftragshandler ausführen muss, um die Datei herunterzuladen. Es zeigt auch die erforderlichen Parameter downloadUrl und filePath an.


{
  "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}"
      }
    }
  ]
}

Name der Vorlage

AWS–Install–Application

Vorlagenbeschreibung

Eine verwaltete Vorlage, die von AWS für die Installation einer oder mehrerer Anwendungen bereitgestellt wird.

Eingabeparameter

Diese Vorlage hat den folgenden erforderlichen Parameter, packages. Sie können auch die optionalen Parameter runAsUser und pathToHandler angeben.

packages

Eine durch Leerzeichen getrennte Liste mit einer oder mehreren Anwendungen, die installiert werden sollen.

Geräteverhalten

Das Gerät installiert die Anwendungen, wie im Auftragsdokument angegeben.

Auftragsdokument

Im Folgenden werden das Auftragsdokument und die zugehörige neueste Version angezeigt. Die Vorlage zeigt den Pfad zum Auftragshandler und zum Shell-Skript install-packages.sh, die der Auftragshandler ausführen muss, um die Datei herunterzuladen. Es zeigt auch den erforderlichen Parameter packages an.


{
  "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}"
      }
    }
  ]
}

Name der Vorlage

AWS–Reboot

Vorlagenbeschreibung

Eine verwaltete Vorlage, die von AWS für den Neustart Ihres Geräts bereitgestellt wird.

Eingabeparameter

Dieser Befehl hat keine erforderlichen Parameter. Sie können die optionalen Parameter runAsUser und pathToHandler angeben.

Geräteverhalten

Das Gerät wird erfolgreich neu gestartet.

Auftragsdokument

Im Folgenden werden das Auftragsdokument und die zugehörige neueste Version angezeigt. Die Vorlage zeigt den Pfad zum Auftragshandler und zum Shell-Skript reboot.sh, die der Auftragshandler ausführen muss, um das Gerät neu zu starten.


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

Name der Vorlage

AWS–Remove–Application

Vorlagenbeschreibung

Eine verwaltete Vorlage, die von AWS für die Deinstallation einer oder mehrerer Anwendungen bereitgestellt wird.

Eingabeparameter

Diese Vorlage hat den folgenden erforderlichen Parameter, packages. Sie können auch die optionalen Parameter runAsUser und pathToHandler angeben.

packages

Eine durch Leerzeichen getrennte Liste mit einer oder mehreren Anwendungen, die deinstalliert werden sollen.

Geräteverhalten

Das Gerät deinstalliert die Anwendungen, wie im Jobdokument angegeben.

Auftragsdokument

Im Folgenden werden das Auftragsdokument und die zugehörige neueste Version angezeigt. Die Vorlage zeigt den Pfad zum Auftragshandler und zum Shell-Skript remove-packages.sh, die der Auftragshandler ausführen muss, um die Datei herunterzuladen. Es zeigt auch den erforderlichen Parameter packages an.


{
  "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}"
      }
    }
  ]
}

Name der Vorlage

AWS–Restart–Application

Vorlagenbeschreibung

Eine verwaltete Vorlage, die von AWS zum Beenden und Neustarten eines oder mehrerer Dienste bereitgestellt wird.

Eingabeparameter

Diese Vorlage hat den folgenden erforderlichen Parameter, services. Sie können auch die optionalen Parameter runAsUser und pathToHandler angeben.

Services

Eine durch Leerzeichen getrennte Liste mit einer oder mehreren Anwendungen, die neu gestartet werden sollen.

Geräteverhalten

Die angegebenen Anwendungen werden gestoppt und dann auf dem Gerät neu gestartet.

Auftragsdokument

Im Folgenden werden das Auftragsdokument und die zugehörige neueste Version angezeigt. Die Vorlage zeigt den Pfad zum Auftragshandler und zum Shell-Skript restart-services.sh, die der Auftragshandler ausführen muss, um die Systemdienste neu zu starten. Es zeigt auch den erforderlichen Parameter services an.


{
  "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}"
      }
    }
  ]
}

Name der Vorlage

AWS-Start-Application

Vorlagenbeschreibung

Eine verwaltete Vorlage, die von AWS zum Starten eines oder mehrerer Dienste bereitgestellt wird.

Eingabeparameter

Diese Vorlage hat den folgenden erforderlichen Parameter, services. Sie können auch die optionalen Parameter runAsUser und pathToHandler angeben.

services

Eine durch Leerzeichen getrennte Liste mit einer oder mehreren Anwendungen, die gestartet werden sollen.

Geräteverhalten

Die angegebenen Anwendungen werden auf dem Gerät ausgeführt.

Auftragsdokument

Im Folgenden werden das Auftragsdokument und die zugehörige neueste Version angezeigt. Die Vorlage zeigt den Pfad zum Auftragshandler und zum Shell-Skript start-services.sh, die der Auftragshandler ausführen muss, um die Systemdienste zu starten. Es zeigt auch den erforderlichen Parameter services an.


{
  "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}"
      }
    }
  ]
}

Name der Vorlage

AWS–Stop–Application

Vorlagenbeschreibung

Eine verwaltete Vorlage, die von AWS zum Beenden eines oder mehrerer Dienste bereitgestellt wird.

Eingabeparameter

Diese Vorlage hat den folgenden erforderlichen Parameter, services. Sie können auch die optionalen Parameter runAsUser und pathToHandler angeben.

services

Eine durch Leerzeichen getrennte Liste mit einer oder mehreren Anwendungen, die beendet werden sollen.

Geräteverhalten

Die angegebenen Anwendungen werden auf dem Gerät nicht mehr ausgeführt.

Auftragsdokument

Im Folgenden werden das Auftragsdokument und die zugehörige neueste Version angezeigt. Die Vorlage zeigt den Pfad zum Auftragshandler und zum Shell-Skript stop-services.sh, die der Auftragshandler ausführen muss, um die Systemservices zu beenden. Es zeigt auch den erforderlichen Parameter services an.


{
  "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}"
      }
    }
  ]
}

Name der Vorlage

AWS–Run–Command

Vorlagenbeschreibung

Eine verwaltete Vorlage, die von AWS zur Ausführung eines Shell-Befehls bereitgestellt wird.

Eingabeparameter

Diese Vorlage hat den folgenden erforderlichen Parameter, command. Sie können auch den anderen optionalen Parameter runAsUser angeben.

command

Eine durch Kommas getrennte Befehlsfolge. Jedes Komma, das im Befehl selbst enthalten ist, muss maskiert werden.

Geräteverhalten

Das Gerät führt den Shell-Befehl wie im Auftragsdokument angegeben aus.

Auftragsdokument

Im Folgenden werden das Auftragsdokument und die zugehörige neueste Version angezeigt. Die Vorlage zeigt den Pfad zum Auftragsbefehl und den von Ihnen angegebenen Befehl, der auf dem Gerät ausgeführt werden soll.


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

Themen

Warnung JavaScript ist in Ihrem Browser nicht verfügbar oder deaktiviert.

Zur Nutzung der AWS-Dokumentation muss JavaScript aktiviert sein. Weitere Informationen finden auf den Hilfe-Seiten Ihres Browsers.

Dokumentkonventionen

Auftragsvorlagen

Erstellen Sie mithilfe der Konsole einen Job aus AWS verwalteten Vorlagen