Greengrass CLI - AWS IoT Greengrass

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Greengrass CLI

Le CLI composant Greengrass (aws.greengrass.Cli) fournit une interface de ligne de commande locale que vous pouvez utiliser sur les appareils principaux pour développer et déboguer des composants localement. Le Greengrass vous CLI permet de créer des déploiements locaux et de redémarrer des composants sur le périphérique principal, par exemple.

Vous pouvez installer ce composant lors de l'installation du logiciel AWS IoT Greengrass Core. Pour de plus amples informations, veuillez consulter Didacticiel : Commencer avec AWS IoT Greengrass V2.

Important

Nous vous recommandons d'utiliser ce composant uniquement dans les environnements de développement, et non dans les environnements de production. Ce composant permet d'accéder à des informations et à des opérations dont vous n'avez généralement pas besoin dans un environnement de production. Suivez le principe du moindre privilège en déployant ce composant uniquement sur les appareils principaux là où vous en avez besoin.

Après avoir installé ce composant, exécutez la commande suivante pour consulter sa documentation d'aide. Lorsque ce composant est installé, il ajoute un lien symbolique greengrass-cli dans le /greengrass/v2/bin dossier. Vous pouvez exécuter le Greengrass CLI à partir de ce chemin ou l'ajouter à votre variable d'PATHenvironnement pour l'exécuter greengrass-cli sans son chemin absolu.

Linux or Unix
/greengrass/v2/bin/greengrass-cli help
Windows
C:\greengrass\v2\bin\greengrass-cli help

La commande suivante redémarre un composant nommécom.example.HelloWorld, par exemple.

Linux or Unix
sudo /greengrass/v2/bin/greengrass-cli component restart --names "com.example.HelloWorld"
Windows
C:\greengrass\v2\bin\greengrass-cli component restart --names "com.example.HelloWorld"

Pour de plus amples informations, veuillez consulter Interface de ligne de commande Greengrass.

Versions

Les versions de ce composant sont les suivantes :

  • 2,13.x

  • 2,12. x

  • 2,11.x

  • 2.10.x

  • 2,9. x

  • 2,8. x

  • 2.7.x

  • 2,6. x

  • 2,5.x

  • 2.4.x

  • 2.3.x

  • 2.2.x

  • 2,1x

  • 2,0.x

Type

Ce composant est un composant de plugin (aws.greengrass.plugin). Le noyau Greengrass exécute ce composant dans la même machine virtuelle Java (JVM) que le noyau. Le noyau redémarre lorsque vous modifiez la version de ce composant sur le périphérique principal.

Ce composant utilise le même fichier journal que le noyau Greengrass. Pour de plus amples informations, veuillez consulter AWS IoT GreengrassJournaux de surveillance.

Pour de plus amples informations, veuillez consulter Types de composants.

Système d’exploitation

Ce composant peut être installé sur les appareils principaux qui exécutent les systèmes d'exploitation suivants :

  • Linux

  • Windows

Prérequis

Ce composant répond aux exigences suivantes :

  • Vous devez être autorisé à utiliser le Greengrass CLI pour interagir avec le logiciel AWS IoT Greengrass Core. Pour utiliser le CLI Greengrass, effectuez l'une des opérations suivantes :

    • Utilisez l'utilisateur du système qui exécute le logiciel AWS IoT Greengrass Core.

    • Utilisez un utilisateur doté d'autorisations root ou administratives. Sur les appareils principaux de Linux, vous pouvez l'utiliser sudo pour obtenir des autorisations root.

    • Utilisez un utilisateur système appartenant à un groupe que vous spécifiez dans les paramètres de AuthorizedWindowsGroups configuration AuthorizedPosixGroups ou lorsque vous déployez le composant. Pour plus d'informations, consultez la section Configuration des CLIcomposants Greengrass.

  • Le CLI composant Greengrass est compatible pour s'exécuter dans un. VPC

Dépendances

Lorsque vous déployez un composant, il déploie AWS IoT Greengrass également des versions compatibles de ses dépendances. Cela signifie que vous devez satisfaire aux exigences relatives au composant et à toutes ses dépendances pour réussir le déploiement du composant. Cette section répertorie les dépendances des versions publiées de ce composant et les contraintes de version sémantiques qui définissent les versions des composants pour chaque dépendance. Vous pouvez également consulter les dépendances de chaque version du composant dans la AWS IoT Greengrass console. Sur la page de détails du composant, recherchez la liste des dépendances.

2.13.0

Le tableau suivant répertorie les dépendances pour les versions 2.12.0 à 2.14.0 de ce composant.

Dépendance Versions compatibles Type de dépendance
Noyau de Greengrass >=2,12,0 <2,14,0 Flexible
2.12.0 – 2.12.6

Le tableau suivant répertorie les dépendances pour les versions 2.12.0 à 2.12.6 de ce composant.

Dépendance Versions compatibles Type de dépendance
Noyau de Greengrass >=2,12,0 <2,13,0 Flexible
2.11.0 – 2.11.3

Le tableau suivant répertorie les dépendances pour les versions 2.11.0 à 2.11.3 de ce composant.

Dépendance Versions compatibles Type de dépendance
Noyau de Greengrass >=2,11,0 <2,12,0 Flexible
2.10.0 – 2.10.3

Le tableau suivant répertorie les dépendances pour les versions 2.10.0 à 2.10.3 de ce composant.

Dépendance Versions compatibles Type de dépendance
Noyau de Greengrass >=2,5,0 <2,11,0 Flexible
2.9.0 – 2.9.6

Le tableau suivant répertorie les dépendances pour les versions 2.9.0 à 2.9.6 de ce composant.

Dépendance Versions compatibles Type de dépendance
Noyau de Greengrass >=2,5,0 <2,1,0 Flexible
2.8.0 – 2.8.1

Le tableau suivant répertorie les dépendances pour les versions 2.8.0 et 2.8.1 de ce composant.

Dépendance Versions compatibles Type de dépendance
Noyau de Greengrass >=2,5,0 <2,9,0 Flexible
2.7.0

Le tableau suivant répertorie les dépendances pour la version 2.7.0 de ce composant.

Dépendance Versions compatibles Type de dépendance
Noyau de Greengrass >=2,5,0 <2,8,0 Flexible
2.6.0

Le tableau suivant répertorie les dépendances pour la version 2.6.0 de ce composant.

Dépendance Versions compatibles Type de dépendance
Noyau de Greengrass >=2,5,0 <2,7,0 Flexible
2.5.0 – 2.5.6

Le tableau suivant répertorie les dépendances pour les versions 2.5.0 à 2.5.6 de ce composant.

Dépendance Versions compatibles Type de dépendance
Noyau de Greengrass >=2,5,0 <2,6,0 Flexible
2.4.0

Le tableau suivant répertorie les dépendances pour la version 2.4.0 de ce composant.

Dépendance Versions compatibles Type de dépendance
Noyau de Greengrass >=2,10 <2,5,0 Flexible
2.3.0

Le tableau suivant répertorie les dépendances pour la version 2.3.0 de ce composant.

Dépendance Versions compatibles Type de dépendance
Noyau de Greengrass >=2,10 <2,4,0 Flexible
2.2.0

Le tableau suivant répertorie les dépendances pour la version 2.2.0 de ce composant.

Dépendance Versions compatibles Type de dépendance
Noyau de Greengrass >=2,10 <2,3,0 Flexible
2.1.0

Le tableau suivant répertorie les dépendances pour la version 2.1.0 de ce composant.

Dépendance Versions compatibles Type de dépendance
Noyau de Greengrass >=2,10 <2,2,0 Flexible
2.0.x

Le tableau suivant répertorie les dépendances pour la version 2.0.x de ce composant.

Dépendance Versions compatibles Type de dépendance
Noyau de Greengrass >=2,0.0 <2,10 Flexible
Note

La version minimale compatible du noyau Greengrass correspond à la version patch du composant Greengrass. CLI

Pour plus d'informations sur les dépendances des composants, consultez la référence de la recette des composants.

Configuration

Ce composant fournit les paramètres de configuration suivants que vous pouvez personnaliser lorsque vous déployez le composant.

2.5.x - 2.12.x
AuthorizedPosixGroups

(Facultatif) Chaîne contenant une liste de groupes de systèmes séparés par des virgules. Vous autorisez ces groupes de systèmes à utiliser le Greengrass CLI pour interagir avec le logiciel AWS IoT Greengrass Core. Vous pouvez spécifier des noms de groupes ou des groupesIDs. Par exemple, group1,1002,group3 autorise trois groupes de systèmes (group11002, etgroup3) à utiliser le GreengrassCLI.

Si vous ne spécifiez aucun groupe à autoriser, vous pouvez utiliser Greengrass en CLI tant qu'utilisateur root (sudo) ou en tant qu'utilisateur système qui exécute le logiciel AWS IoT Greengrass Core.

AuthorizedWindowsGroups

(Facultatif) Chaîne contenant une liste de groupes de systèmes séparés par des virgules. Vous autorisez ces groupes de systèmes à utiliser le Greengrass CLI pour interagir avec le logiciel AWS IoT Greengrass Core. Vous pouvez spécifier des noms de groupes ou des groupesIDs. Par exemple, group1,1002,group3 autorise trois groupes de systèmes (group11002, etgroup3) à utiliser le GreengrassCLI.

Si vous ne spécifiez aucun groupe à autoriser, vous pouvez utiliser le Greengrass en CLI tant qu'administrateur ou en tant qu'utilisateur du système qui exécute le logiciel AWS IoT Greengrass Core.

Exemple : mise à jour de la fusion de configurations

L'exemple de configuration suivant indique d'autoriser trois groupes de POSIX systèmes (group1,1002, etgroup3) et deux groupes d'utilisateurs Windows (Device OperatorsetQA Engineers) à utiliser le GreengrassCLI.

{ "AuthorizedPosixGroups": "group1,1002,group3", "AuthorizedWindowsGroups": "Device Operators,QA Engineers" }
2.4.x - 2.0.x
AuthorizedPosixGroups

(Facultatif) Chaîne contenant une liste de groupes de systèmes séparés par des virgules. Vous autorisez ces groupes de systèmes à utiliser le Greengrass CLI pour interagir avec le logiciel AWS IoT Greengrass Core. Vous pouvez spécifier des noms de groupes ou des groupesIDs. Par exemple, group1,1002,group3 autorise trois groupes de systèmes (group11002, etgroup3) à utiliser le GreengrassCLI.

Si vous ne spécifiez aucun groupe à autoriser, vous pouvez utiliser Greengrass en CLI tant qu'utilisateur root (sudo) ou en tant qu'utilisateur système qui exécute le logiciel AWS IoT Greengrass Core.

Exemple : mise à jour de la fusion de configurations

L'exemple de configuration suivant indique d'autoriser trois groupes de systèmes (group1,1002, etgroup3) à utiliser le GreengrassCLI.

{ "AuthorizedPosixGroups": "group1,1002,group3" }

Fichier journal local

Ce composant utilise le même fichier journal que le composant Greengrass nucleus.

Linux
/greengrass/v2/logs/greengrass.log
Windows
C:\greengrass\v2\logs\greengrass.log
Pour consulter les journaux de ce composant
  • Exécutez la commande suivante sur le périphérique principal pour afficher le fichier journal de ce composant en temps réel. Remplacer /greengrass/v2 ou C:\greengrass\v2 avec le chemin d'accès au dossier AWS IoT Greengrass racine.

    Linux
    sudo tail -f /greengrass/v2/logs/greengrass.log
    Windows (PowerShell)
    Get-Content C:\greengrass\v2\logs\greengrass.log -Tail 10 -Wait

Journal des modifications

Le tableau suivant décrit les modifications apportées à chaque version du composant.

Version

Modifications

2.13.0

Version mise à jour pour la version 2.13.0 de Greengrass Nucleus.

2.12,6

Version mise à jour pour la version 2.12.6 de Greengrass Nucleus.

2,1,5

Version mise à jour pour la version 2.12.5 de Greengrass Nucleus.

2.12.4

Version mise à jour pour la version 2.12.4 de Greengrass Nucleus.

2.12.3

Avertissement

Cette version n'est plus disponible. Les améliorations apportées à cette version sont disponibles dans les versions ultérieures de ce composant.

Version mise à jour pour la version 2.12.3 de Greengrass Nucleus.

2.12.2

Version mise à jour pour la version 2.12.2 de Greengrass Nucleus.

2.12.1

Version mise à jour pour la version 2.12.1 de Greengrass Nucleus.

2.12.0

Version mise à jour pour la version 2.12.0 de Greengrass Nucleus.

2.11.3

Version mise à jour pour la version 2.11.3 de Greengrass Nucleus.

2.11.2

Version mise à jour pour la version 2.11.2 de Greengrass Nucleus.

2.11.1

Version mise à jour pour la version 2.11.1 de Greengrass Nucleus.

2.11.0

Nouvelles fonctionnalités
  • Vous permet d'annuler un déploiement local.

  • Vous permet de configurer une politique de gestion des défaillances pour un déploiement local.

  • Améliore les rapports détaillés sur l'état du déploiement.

2.10.3

Version mise à jour pour la version 2.10.3 de Greengrass Nucleus.

2.10.2

Version mise à jour pour la version 2.10.2 de Greengrass Nucleus.

2.10.1

Version mise à jour pour la version 2.10.1 de Greengrass Nucleus.

2.10.0

Version mise à jour pour la version 2.10.0 de Greengrass Nucleus.

2,9,6

Version mise à jour pour la version 2.9.6 de Greengrass Nucleus.

2.9.5

Version mise à jour pour la version 2.9.5 de Greengrass Nucleus.

2.9.4

Version mise à jour pour la version 2.9.4 de Greengrass Nucleus.

2.9.3

Version mise à jour pour la version 2.9.3 de Greengrass Nucleus.

2.9.2

Version mise à jour pour la version 2.9.2 de Greengrass Nucleus.

2.9.1

Version mise à jour pour la version 2.9.1 de Greengrass Nucleus.

2.9.0

Version mise à jour pour la version 2.9.0 de Greengrass Nucleus.

2.8.1

Version mise à jour pour la version 2.8.1 de Greengrass Nucleus.

2.8.0

Version mise à jour pour la version 2.8.0 de Greengrass Nucleus.

2.7.0

Version mise à jour pour la version 2.7.0 de Greengrass Nucleus.

2.6.0

Nouvelles fonctionnalités
  • Ajoute la prise en charge de composants personnalisés pour appeler les opérations de communication interprocessus (IPC) utilisées par CLI Greengrass. Vous pouvez utiliser ces IPC opérations pour gérer les déploiements locaux, afficher les détails des composants et générer un mot de passe que vous pouvez utiliser pour vous connecter à la console de débogage locale. Pour plus d'informations, voir IPC: Gérer les déploiements et les composants locaux.

Corrections de bogues et améliorations
  • Corrections et améliorations mineures supplémentaires.

2.5.6

Version mise à jour pour la version 2.5.6 de Greengrass Nucleus.

2.5.5

Version mise à jour pour la version 2.5.5 de Greengrass Nucleus.

2.5.4

Version mise à jour pour la version 2.5.4 de Greengrass Nucleus.

2.5.3

Version mise à jour pour la version 2.5.3 de Greengrass Nucleus.

2.5.2

Version mise à jour pour la version 2.5.2 de Greengrass Nucleus.

2.5.1

Version mise à jour pour la version 2.5.1 de Greengrass Nucleus.

2.5.0

Nouvelles fonctionnalités
  • Ajoute la prise en charge des appareils principaux qui exécutent Windows.

  • Ajoute le nouveau paramètre AuthorizedWindowsGroups de configuration que vous pouvez spécifier pour autoriser les groupes de systèmes à utiliser le Greengrass CLI sur les appareils Windows.

  • Ajoute le windowsUser paramètre pour les déploiements locaux. Vous pouvez utiliser ce paramètre pour spécifier l'utilisateur à utiliser pour exécuter les composants sur un périphérique principal Windows.

2.4.0

Nouvelles fonctionnalités

2.3.0

Version mise à jour pour la version 2.3.0 de Greengrass Nucleus.

2.2.0

Version mise à jour pour la version 2.2.0 de Greengrass Nucleus.

2.1.0

Version mise à jour pour la version 2.1.0 de Greengrass Nucleus.

2.0.5

Version mise à jour pour la version 2.0.5 de Greengrass Nucleus.

2.0.4

Version mise à jour pour la version 2.0.4 de Greengrass Nucleus.

2.0.3

Première version.