Greengrass CLI - AWS IoT Greengrass
バージョンタイプオペレーティングシステム要件依存関係構成ローカルログファイル変更ログ

Greengrass CLI

Greengrass CLI コンポーネント (aws.greengrass.Cli) は、コアデバイス上でコンポーネントをローカルで開発およびデバッグするために使用できるローカルコマンドラインインターフェイスを提供します。Greengrass CLI を使用すると、たとえば、ローカルデプロイを作成し、コアデバイスでコンポーネントを再起動できます。

このコンポーネントは、AWS IoT Greengrass Core ソフトウェアをインストールするときにインストールできます。詳細については、「チュートリアル: AWS IoT Greengrass V2 の開始方法」を参照してください。

重要

このコンポーネントは、本番環境ではなく、開発環境でのみで使用することをお勧めします。このコンポーネントは、通常、本番環境では必要とされない情報や操作へのアクセスを提供します。このコンポーネントを必要なコアデバイスにのみデプロイして、最小特権の原則に従います。

このコンポーネントをインストールしたら、以下のコマンドを実行してヘルプドキュメントを表示します。このコンポーネントがインストールされると、/greengrass/v2/bin フォルダに greengrass-cli へのシンボリックリンクが追加されます。このパスから Greengrass CLI を実行するか、絶対パスなしで greengrass-cli を実行する PATH 環境変数に追加することができます。

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

次のコマンドを使用すると、たとえば com.example.HelloWorld という名前のコンポーネントが再起動されます。

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"

詳細については、「Greengrass コマンドラインインターフェイス」を参照してください。

バージョン

このコンポーネントには、次のバージョンがあります。

  • 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.1.x

  • 2.0.x

タイプ

このコンポーネントはプラグインコンポーネント (aws.greengrass.plugin) です。Greengrass nucleus は、nucleus と同じ Java バーチャルマシン (JVM) でこのコンポーネントを実行します。コアデバイスでこのコンポーネントのバージョンを変更するとき、nucleus が再起動します。

このコンポーネントは、Greengrass nucleus と同じログファイルを使用します。詳細については、「AWS IoT Greengrass ログのモニタリング」を参照してください。

詳細については、「コンポーネントタイプ」を参照してください。

オペレーティングシステム

このコンポーネントは、次のオペレーティングシステムを実行するコアデバイスにインストールできます。

  • Linux

  • Windows

要件

このコンポーネントには次の要件があります。

  • AWS IoT Greengrass Core ソフトウェアとやり取りするために Greengrass CLI を使用することを認可されている必要があります。Greengrass CLI を使用するには、次のいずれかを実行します。

    • AWS IoT Greengrass Core ソフトウェアを実行するシステムユーザーを使用する。

    • root 権限または管理者権限を持つユーザーを使用する。Linux コアデバイスでは、sudo を使用して root 権限を取得できます。

    • 設定をデプロイする際に、AuthorizedPosixGroups または AuthorizedWindowsGroups 設定パラメータで指定したグループのシステムユーザーを使用する。詳細については、「Greengrass CLI コンポーネント設定」を参照してください。

  • Greengrass CLI コンポーネントは、VPC での実行がサポートされています。

依存関係

コンポーネントをデプロイするとき、AWS IoT Greengrass はそれと互換性のあるバージョンの依存関係もデプロイします。つまり、コンポーネントを正常にデプロイするには、コンポーネントとその依存関係のすべての要件を満たす必要があります。このセクションでは、このコンポーネントのリリースされたバージョンの依存関係と、各依存関係に対するコンポーネントのバージョンを定義するセマンティックバージョン制約をリスト表示しています。コンポーネントの各バージョンの依存関係は、AWS IoT Greengrass コンソールでも確認できます。コンポーネントの詳細ページで [Dependencies] (依存関係) リストを確認します。

2.13.0

次の表に、このコンポーネントのバージョン 2.12.0 から 2.14.0 までの依存関係を示します。

依存関係 互換性のあるバージョン 依存関係タイプ
Greengrass nucleus >=2.12.0 <2.14.0 ソフト
2.12.0 – 2.12.6

次の表に、このコンポーネントのバージョン 2.12.0 から 2.12.6 までの依存関係を示します。

依存関係 互換性のあるバージョン 依存関係タイプ
Greengrass nucleus >=2.12.0 <2.13.0 ソフト
2.11.0 – 2.11.3

次の表に、このコンポーネントのバージョン 2.11.0 から 2.11.3 までの依存関係を示します。

依存関係 互換性のあるバージョン 依存関係タイプ
Greengrass nucleus >=2.11.0 <2.12.0 ソフト
2.10.0 – 2.10.3

次の表に、このコンポーネントのバージョン 2.10.0 から 2.10.3 までの依存関係を示します。

依存関係 互換性のあるバージョン 依存関係タイプ
Greengrass nucleus >=2.5.0 <2.11.0 ソフト
2.9.0 – 2.9.6

次の表に、このコンポーネントのバージョン 2.9.0 から 2.9.6 までの依存関係を示します。

依存関係 互換性のあるバージョン 依存関係タイプ
Greengrass nucleus >=2.5.0 <2.10.0 ソフト
2.8.0 – 2.8.1

次の表に、このコンポーネントのバージョン 2.8.0 および 2.8.1 の依存関係を示します。

依存関係 互換性のあるバージョン 依存関係タイプ
Greengrass nucleus >=2.5.0 <2.9.0 ソフト
2.7.0

次の表に、このコンポーネントのバージョン 2.7.0 の依存関係を示します。

依存関係 互換性のあるバージョン 依存関係タイプ
Greengrass nucleus >=2.5.0 <2.8.0 ソフト
2.6.0

次の表に、このコンポーネントのバージョン 2.6.0 の依存関係を示します。

依存関係 互換性のあるバージョン 依存関係タイプ
Greengrass nucleus >=2.5.0 <2.7.0 ソフト
2.5.0 – 2.5.6

次の表に、このコンポーネントのバージョン 2.5.0 から 2.5.6 までの依存関係を示します。

依存関係 互換性のあるバージョン 依存関係タイプ
Greengrass nucleus >=2.5.0 <2.6.0 ソフト
2.4.0

次の表に、このコンポーネントのバージョン 2.4.0 の依存関係を示します。

依存関係 互換性のあるバージョン 依存関係タイプ
Greengrass nucleus >=2.1.0 <2.5.0 ソフト
2.3.0

次の表に、このコンポーネントのバージョン 2.3.0 の依存関係を示します。

依存関係 互換性のあるバージョン 依存関係タイプ
Greengrass nucleus >=2.1.0 <2.4.0 ソフト
2.2.0

次の表に、このコンポーネントのバージョン 2.2.0 の依存関係を示します。

依存関係 互換性のあるバージョン 依存関係タイプ
Greengrass nucleus >=2.1.0 <2.3.0 ソフト
2.1.0

次の表に、このコンポーネントのバージョン 2.1.0 の依存関係を示します。

依存関係 互換性のあるバージョン 依存関係タイプ
Greengrass nucleus >=2.1.0 <2.2.0 ソフト
2.0.x

次の表に、このコンポーネントのバージョン 2.0.x の依存関係を示します。

依存関係 互換性のあるバージョン 依存関係タイプ
Greengrass nucleus >=2.0.0 <2.1.0 ソフト
注記

Greengrass nucleus の最小互換バージョンは、Greengrass CLI コンポーネントのパッチバージョンに対応しています。

コンポーネントの依存関係の詳細については、「コンポーネント recipe のリファレンス」を参照してください。

構成

このコンポーネントには、コンポーネントのデプロイ時にカスタマイズできる次の設定パラメータが用意されています。

2.5.x - 2.13.x
AuthorizedPosixGroups

(オプション) システムグループのカンマ区切りリストを含む文字列。これらのシステムグループには、Greengrass CLI を使用して AWS IoT Greengrass Core ソフトウェアとやり取りすることを認可します。グループ名またはグループ ID を指定できます。例:group1,1002,group3 は 3 つのシステムグループ (group1、1002 および group3) に Greengrass CLI の使用を認可します。

認可するグループを指定しない場合は、ルートユーザー (sudo) または AWS IoT Greengrass Core ソフトウェアを実行するシステムユーザーとして Greengrass CLI を使用できます。

AuthorizedWindowsGroups

(オプション) システムグループのカンマ区切りリストを含む文字列。これらのシステムグループには、Greengrass CLI を使用して AWS IoT Greengrass Core ソフトウェアとやり取りすることを認可します。グループ名またはグループ ID を指定できます。例:group1,1002,group3 は 3 つのシステムグループ (group1、1002 および group3) に Greengrass CLI の使用を認可します。

認可するグループを指定しない場合は、管理者または AWS IoT Greengrass Core ソフトウェアを実行するシステムユーザーとして Greengrass CLI を使用できます。

例: 設定マージの更新

次の設定例では、3 つの POSIX システムグループ (group1、1002 および group3) と 2 つの Windows ユーザーグループ (Device Operators と QA Engineers) に Greengrass CLI の利用を認可するように指定しています。

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

(オプション) システムグループのカンマ区切りリストを含む文字列。これらのシステムグループには、Greengrass CLI を使用して AWS IoT Greengrass Core ソフトウェアとやり取りすることを認可します。グループ名またはグループ ID を指定できます。例:group1,1002,group3 は 3 つのシステムグループ (group1、1002 および group3) に Greengrass CLI の使用を認可します。

認可するグループを指定しない場合は、ルートユーザー (sudo) または AWS IoT Greengrass Core ソフトウェアを実行するシステムユーザーとして Greengrass CLI を使用できます。

例: 設定マージの更新

次の設定例では、3 つのシステムグループ (group1、1002 および group3) に Greengrass CLI の利用を認可するように指定しています。

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

ローカルログファイル

このコンポーネントは、Greengrass nucleus コンポーネントと同じログファイルを使用します。

Linux
/greengrass/v2/logs/greengrass.log
Windows
C:\greengrass\v2\logs\greengrass.log
このコンポーネントのログを確認するには

  • コアデバイスに次のコマンドを実行して、このコンポーネントのログファイルをリアルタイムに確認します。/greengrass/v2 または C:\greengrass\v2 を AWS IoT Greengrass ルートフォルダへのパスに置き換えてください。

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

変更ログ

次の表は、コンポーネントの各バージョンにおける変更を示します。

バージョン

変更

2.13.0

Greengrass nucleus バージョン 2.13.0 のリリース用にバージョンが更新されました。

2.12.6

Greengrass nucleus バージョン 2.12.6 のリリース用にバージョンが更新されました。

2.12.5

Greengrass nucleus バージョン 2.12.5 のリリース用にバージョンが更新されました。

2.12.4

Greengrass nucleus バージョン 2.12.4 のリリース用にバージョンが更新されました。

2.12.3
警告

このバージョンは現在利用できません。このバージョンの改善は、このコンポーネントのそれ以降のバージョンで利用できます。

Greengrass nucleus バージョン 2.12.3 のリリース用にバージョンが更新されました。

2.12.2

Greengrass nucleus バージョン 2.12.2 のリリース用にバージョンが更新されました。

2.12.1

Greengrass nucleus バージョン 2.12.1 のリリース用にバージョンが更新されました。

2.12.0

Greengrass nucleus バージョン 2.12.0 のリリース用にバージョンが更新されました。

2.11.3

Greengrass nucleus バージョン 2.11.3 のリリース用にバージョンが更新されました。

2.11.2

Greengrass nucleus バージョン 2.11.2 のリリース用にバージョンが更新されました。

2.11.1

Greengrass nucleus バージョン 2.11.1 のリリース用にバージョンが更新されました。

2.11.0
新機能

  • ローカルのデプロイをキャンセルできます。

  • ローカルのデプロイの障害処理ポリシーを設定できます。

  • 詳細なデプロイステータスのレポートを改善しています。

2.10.3

Greengrass nucleus バージョン 2.10.3 のリリース用にバージョンが更新されました。

2.10.2

Greengrass nucleus バージョン 2.10.2 のリリース用にバージョンが更新されました。

2.10.1

Greengrass nucleus バージョン 2.10.1 のリリース用にバージョンが更新されました。

2.10.0

Greengrass nucleus バージョン 2.10.0 のリリース用にバージョンが更新されました。

2.9.6

Greengrass nucleus バージョン 2.9.6 のリリース用にバージョンが更新されました。

2.9.5

Greengrass nucleus バージョン 2.9.5 のリリース用にバージョンが更新されました。

2.9.4

Greengrass nucleus バージョン 2.9.4 のリリース用にバージョンが更新されました。

2.9.3

Greengrass nucleus バージョン 2.9.3 のリリース用にバージョンが更新されました。

2.9.2

Greengrass nucleus バージョン 2.9.2 のリリース用にバージョンが更新されました。

2.9.1

Greengrass nucleus バージョン 2.9.1 のリリース用にバージョンが更新されました。

2.9.0

 Greengrass nucleus バージョン 2.9.0 のリリース用にバージョンが更新されました。

2.8.1

Greengrass nucleus バージョン 2.8.1 のリリース用にバージョンが更新されました。

2.8.0

 Greengrass nucleus バージョン 2.8.0 のリリース用にバージョンが更新されました。

2.7.0

Greengrass nucleus バージョン 2.7.0 のリリース用にバージョンが更新されました。

2.6.0
新機能

  • Greengrass CLI が使用するプロセス間通信 (IPC) のオペレーションを呼び出す、カスタムコンポーネントに関するサポートが追加されました。これらの IPC オペレーションにより、ローカルでのデプロイ管理、コンポーネントの詳細の表示、およびローカルのデバッグコンソールへのサインイン用のパスワード生成を行うことができます。詳細については、「IPC: Manage local deployments and components」(IPC: ローカルのデプロイとコンポーネントを管理する) を参照してください。

バグ修正と機能向上

  • 追加のマイナー修正と機能向上。

2.5.6

Greengrass nucleus バージョン 2.5.6 のリリース用にバージョンが更新されました。

2.5.5

Greengrass nucleus バージョン 2.5.5 のリリース用にバージョンが更新されました。

2.5.4

Greengrass nucleus バージョン 2.5.4 のリリース用にバージョンが更新されました。

2.5.3

Greengrass nucleus バージョン 2.5.3 のリリース用にバージョンが更新されました。

2.5.2

Greengrass nucleus バージョン 2.5.2 のリリース用にバージョンが更新されました。

2.5.1

Greengrass nucleus バージョン 2.5.1 のリリース用にバージョンが更新されました。

2.5.0
新機能

  • Windows を実行するコアデバイスのサポートが追加されました。

  • Windows デバイスで Greengrass CLI を使用するために、システムグループを認可するために指定できる新しい AuthorizedWindowsGroups 設定パラメータを追加しました。

  • ローカルデプロイ用の windowsUser パラメータが追加されました。このパラメータを使用して、Windows コアデバイスでコンポーネントを実行するために使用するユーザーを指定できます。

2.4.0
新機能

2.3.0

Greengrass nucleus バージョン 2.3.0 のリリース用にバージョンが更新されました。

2.2.0

Greengrass nucleus バージョン 2.2.0 のリリース用にバージョンが更新されました。

2.1.0

Greengrass nucleus バージョン 2.1.0 のリリース用にバージョンが更新されました。

2.0.5

 Greengrass nucleus バージョン 2.0.5 のリリース用にバージョンが更新されました。

2.0.4

 Greengrass nucleus バージョン 2.0.4 のリリース用にバージョンが更新されました。

2.0.3

当初のバージョン