翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# OpsWorks スタックエージェント CLI
**重要**
この AWS OpsWorks Stacks サービスは 2024 年 5 月 26 日にサポート終了となり、新規および既存のお客様の両方で無効になっています。できるだけ早くワークロードを他のソリューションに移行することを強くお勧めします。移行についてご質問がある場合は、[AWS re:Post](https://repost.aws/) または[AWS プレミアムサポート](https://aws.amazon.com/support)を通じて AWS サポート チームにお問い合わせください。
**注記**
この機能は、Linux インスタンスでのみご利用いただけます。
OpsWorks スタックがすべてのインスタンスにインストールするエージェントは、コマンドラインインターフェイス (CLI) を公開します。[SSH を使用してインスタンスにログイン](workinginstances-ssh.md)すると、CLI を使用して次の操作を実行できます。
+ Chef 実行のログファイルにアクセスする。
+ OpsWorks スタックコマンドにアクセスします。
+ Chef レシピを手動で実行する。
+ インスタンスレポートを表示する。
+ エージェントレポートを表示する。
+ スタック設定およびデプロイ属性の制限されたセットを表示する。
**重要**
エージェント CLI コマンドは、root として実行するか、`sudo` を使用して実行します。
基本的なコマンド構文は次のとおりです。
```
sudo opsworks-agent-cli [--help] [command [activity] [date]]
```
4 つの引数は次のとおりです。
**help**
(オプション) 単独で使用した場合は、使用可能なコマンドの簡単な概要が表示されます。コマンドと共に `help` を使用した場合は、そのコマンドの説明が表示されます。
**コマンド**
(オプション) エージェント CLI コマンド。次のいずれかに設定する必要があります。
+ [agent\$1report](agent-report.md)
+ [get\$1json](agent-json.md)
+ [instance\$1report](agent-instance.md)
+ [list\$1commands](agent-list.md)
+ [run\$1command](agent-run.md)
+ [show\$1log](agent-show.md)
+ [stack\$1state](agent-stack.md)
**activity**
(オプション) 一部のコマンドで引数として使用して、 OpsWorks スタックの特定のアクティビティ (`setup`、`configure`、`deploy`、`undeploy`、`start`、`stop`、`restart` のいずれか) を指定します。
**date**
(オプション) 一部のコマンドで引数として使用して、特定の OpsWorks スタックコマンドの実行を指定します。コマンドの実行を指定するには、**date** をコマンドが実行されたタイムスタンプに設定します。時刻には、*yyyy-mm-ddThh:mm:ss* の形式 (一重引用符を含む) を使用します。たとえば、2013 年 2 月 5 日火曜日 10 時 31 分 55 秒の場合、`'2013-02-05T10:31:55'` を使用します。特定の OpsWorks Stacks コマンドがいつ実行されたかを確認するには、 を実行します[list\$1commands](agent-list.md)。
**注記**
エージェントが同じ OpsWorks スタックアクティビティを複数回実行した場合は、アクティビティと実行時刻の両方を指定して、特定の実行を選択できます。アクティビティを指定し、時刻を省略すると、エージェント CLI コマンドはそのアクティビティの最新の実行に適用されます。両方の引数を省略すると、エージェント CLI コマンドは最新のアクティビティに適用されます。
以下のセクションでは、各コマンドと関連する引数について説明します。簡潔に示すために、構文セクションでは、どのコマンドでも使用できる省略可能な `--help` オプションを省略しています。
**Topics**
+ [agent\$1report](agent-report.md)
+ [get\$1json](agent-json.md)
+ [instance\$1report](agent-instance.md)
+ [list\$1commands](agent-list.md)
+ [run\$1command](agent-run.md)
+ [show\$1log](agent-show.md)
+ [stack\$1state](agent-stack.md)
# agent\$1report
**重要**
この AWS OpsWorks Stacks サービスは 2024 年 5 月 26 日にサポート終了となり、新規および既存のお客様の両方で無効になっています。できるだけ早くワークロードを他のソリューションに移行することを強くお勧めします。移行についてご質問がある場合は、[AWS re:Post](https://repost.aws/) または[AWS プレミアムサポート](https://aws.amazon.com/support)を通じて AWS サポート チームにお問い合わせください。
エージェントレポートを返します。
```
sudo opsworks-agent-cli agent_report
```
configure アクティビティを直近に実行したインスタンスの出力例を次に示します。
```
$ sudo opsworks-agent-cli agent_report
AWS OpsWorks Instance Agent State Report:
Last activity was a "configure" on 2015-12-01 18:19:23 UTC
Agent Status: The AWS OpsWorks agent is running as PID 30998
Agent Version: 4004-20151201152533, up to date
```
# get\$1json
**重要**
この AWS OpsWorks Stacks サービスは 2024 年 5 月 26 日にサポート終了となり、新規および既存のお客様の両方で無効になっています。できるだけ早くワークロードを他のソリューションに移行することを強くお勧めします。移行についてご質問がある場合は、[AWS re:Post](https://repost.aws/) または[AWS プレミアムサポート](https://aws.amazon.com/support)を通じて AWS サポート チームにお問い合わせください。
Chef の実行に関する情報を JSON オブジェクトとして返します。
```
sudo opsworks-agent-cli get_json [activity] [date] [-i | --internal | --no-i | --no-internal]
```
デフォルトでは、`get_json` は最後に実行された Chef の実行について、ユーザーが提供した情報を表示します。特定の情報セットを指定するには、次のオプションを使用します。
**activity**
最後に指定されたアクティビティに関連付けられた Chef の実行に関する情報を表示します。有効なアクティビティのリストを取得するには、[list\$1commands](agent-list.md) を実行します。
**date**
指定されたタイムスタンプに対して実行されたアクティビティに関連付けられている Chef の実行についての情報を表示します。有効なタイムスタンプのリストを取得するには、[list\$1commands](agent-list.md) を実行します。
**-i, --internal**
Chef の実行に OpsWorks スタックが内部的に使用する情報を表示します。
**--no-i, --no-internal**
Chef を実行するためにユーザーが提供した情報を明示的に表示します。これは、それ以外の方法で指定されない場合のデフォルトです。
**注記**
Chef 12 Linux インスタンスの場合、このコマンドを実行すると、インスタンスのスタック設定やデプロイ属性など、有効な情報が返されます。ただし、詳細な情報を取得するには、 OpsWorks スタックがインスタンスで作成する Chef データバッグを参照してください。詳細については、「[OpsWorks スタックデータバッグリファレンス](data-bags.md)」を参照してください。
次の出力例は、最新の configure アクティビティに対して最後に実行された Chef の実行についてユーザーが提供した情報を示しています。
```
$ sudo opsworks-agent-cli get_json configure
{
"run_list": [
"recipe[opsworks_cookbook_demo::configure]"
]
}
```
次の出力例は、指定されたタイムスタンプに対して実行される Chef 実行に OpsWorks スタックが内部的に使用する情報を示しています。
```
$ sudo opsworks-agent-cli get_json 2015-12-01T18:20:24 -i
{
"aws_opsworks_agent": {
"version": "4004-20151201152533",
"valid_client_activities": [
"reboot",
"stop",
"deploy",
"grant_remote_access",
"revoke_remote_access",
"update_agent",
"setup",
"configure",
"update_dependencies",
"install_dependencies",
"update_custom_cookbooks",
"execute_recipes",
"sync_remote_users"
],
"command": {
"type": "configure",
"args": {
"app_ids": [
]
},
"sent_at": "2015-12-01T18:19:23+00:00",
"command_id": "5c2113f3-c6d5-40eb-bcfa-77da2885eeEX",
"iam_user_arn": null,
"instance_id": "cfdaa716-42fe-4e3b-9762-fef184ddd8EX"
},
"resources": {
"apps": [
],
"layers": [
{
"layer_id": "93f50d83-1e73-45c4-840a-0d4f07cda1EX",
"name": "MyCookbooksDemoLayer",
"packages": [
],
"shortname": "cookbooks-demo",
"type": "custom",
"volume_configurations": [
]
}
],
"instances": [
{
"ami_id": "ami-d93622EX",
"architecture": "x86_64",
"auto_scaling_type": null,
"availability_zone": "us-west-2a",
"created_at": "2015-11-18T00:21:05+00:00",
"ebs_optimized": false,
"ec2_instance_id": "i-a480e960",
"elastic_ip": null,
"hostname": "cookbooks-demo1",
"instance_id": "cfdaa716-42fe-4e3b-9762-fef184ddd8EX",
"instance_type": "c3.large",
"layer_ids": [
"93f50d83-1e73-45c4-840a-0d4f07cda1EX"
],
"os": "Amazon Linux 2015.09",
"private_dns": "ip-192-0-2-0.us-west-2.compute.internal",
"private_ip": "10.122.69.33",
"public_dns": "ec2-203-0-113-0.us-west-2.compute.amazonaws.com",
"public_ip": "192.0.2.0",
"root_device_type": "ebs",
"root_device_volume_id": "vol-f6f7e8EX",
"ssh_host_dsa_key_fingerprint": "f2:...:15",
"ssh_host_dsa_key_public": "ssh-dss AAAAB3Nz...a8vMbqA=",
"ssh_host_rsa_key_fingerprint": "0a:...:96",
"ssh_host_rsa_key_public": "ssh-rsa AAAAB3Nz...yhPanvo7",
"status": "online",
"subnet_id": null,
"virtualization_type": "paravirtual",
"infrastructure_class": "ec2",
"ssh_host_dsa_key_private": "-----BEGIN DSA PRIVATE KEY-----\nMIIDVwIB...g5OtgQ==\n-----END DSA PRIVATE KEY-----\n",
"ssh_host_rsa_key_private": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIB...78kprtIw\n-----END RSA PRIVATE KEY-----\n"
}
],
"users": [
],
"elastic_load_balancers": [
],
"rds_db_instances": [
],
"stack": {
"arn": "arn:aws:opsworks:us-west-2:80398EXAMPLE:stack/040c3def-b2b4-4489-bb1b-e08425886fEX/",
"custom_cookbooks_source": {
"type": "s3",
"url": "https://s3.amazonaws.com/amzn-s3-demo-bucket/opsworks-cookbook-demo.tar.gz",
"username": "AKIAJUQN...WG644EXA",
"password": "O5v+4Zz+...rcKbFTJu",
"ssh_key": null,
"revision": null
},
"name": "MyCookbooksDemoStack",
"region": "us-west-2",
"stack_id": "040c3def-b2b4-4489-bb1b-e08425886fEX",
"use_custom_cookbooks": true,
"vpc_id": null
},
"ecs_clusters": [
],
"volumes": [
]
},
"chef": {
"customer_recipes": [
"opsworks_cookbook_demo::configure"
],
"customer_json": "e30=\n",
"customer_data_bags": "e30=\n"
}
}
}
```
# instance\$1report
**重要**
この AWS OpsWorks Stacks サービスは 2024 年 5 月 26 日にサポート終了となり、新規および既存のお客様の両方で無効になっています。できるだけ早くワークロードを他のソリューションに移行することを強くお勧めします。移行についてご質問がある場合は、[AWS re:Post](https://repost.aws/) または[AWS プレミアムサポート](https://aws.amazon.com/support)を通じて AWS サポート チームにお問い合わせください。
拡張インスタンスレポートを返します。
```
sudo opsworks-agent-cli instance_report
```
インスタンスの出力例を次に示します。
```
$ sudo opsworks-agent-cli instance_report
AWS OpsWorks Instance Agent State Report:
Last activity was a "configure" on 2015-12-01 18:19:23 UTC
Agent Status: The AWS OpsWorks agent is running as PID 30998
Agent Version: 4004-20151201152533, up to date
OpsWorks Stack: MyCookbooksDemoStack
OpsWorks Layers: MyCookbooksDemoLayer
OpsWorks Instance: cookbooks-demo1
EC2 Instance ID: i-a480e9EX
EC2 Instance Type: c3.large
Architecture: x86_64
Total Memory: 3.84 Gb
CPU: 2x Intel(R) Xeon(R) CPU E5-2680 v2 @ 2.80GHz
Location:
EC2 Region: us-west-2
EC2 Availability Zone: us-west-2a
Networking:
Public IP: 192.0.2.0
Private IP: 198.51.100.0
```
# list\$1commands
**重要**
この AWS OpsWorks Stacks サービスは 2024 年 5 月 26 日にサポート終了となり、新規および既存のお客様の両方で無効になっています。できるだけ早くワークロードを他のソリューションに移行することを強くお勧めします。移行についてご質問がある場合は、[AWS re:Post](https://repost.aws/) または[AWS プレミアムサポート](https://aws.amazon.com/support)を通じて AWS サポート チームにお問い合わせください。
このインスタンスで実行された各アクティビティの時刻を表示します。これらの時刻を使用して、他のエージェント CLI コマンドで特定の実行を指定できます。
```
sudo opsworks-agent-cli list_commands [activity] [date]
```
設定、セットアップ、およびカスタムクックブックの更新の各アクティビティを実行したインスタンスの出力例を次に示します。
```
$ sudo opsworks-agent-cli list_commands
2015-11-24T21:00:28 update_custom_cookbooks
2015-12-01T18:19:09 setup
2015-12-01T18:20:24 configure
```
# run\$1command
**重要**
この AWS OpsWorks Stacks サービスは 2024 年 5 月 26 日にサポート終了となり、新規および既存のお客様の両方で無効になっています。できるだけ早くワークロードを他のソリューションに移行することを強くお勧めします。移行についてご質問がある場合は、[AWS re:Post](https://repost.aws/) または[AWS プレミアムサポート](https://aws.amazon.com/support)を通じて AWS サポート チームにお問い合わせください。
OpsWorks Stacks コマンドを実行します。これは、Stacks アクティビティ (セットアップ、設定、デプロイなど) の実行に必要な情報を含む Chef OpsWorks 実行リストを含む JSON ファイルです。`run_command` コマンドにより、ログエントリが生成されます。ログエントリを表示するには、[show\$1log](agent-show.md) を実行します。このオプションは開発のみを目的としているため、 OpsWorks スタックは変更を追跡しません。
```
sudo opsworks-agent-cli run_command [activity] [date] [/path/to/valid/json.file]
```
デフォルトでは、 は最新の OpsWorks スタックコマンド`run_command`を実行します。特定のコマンドを指定するには、次のオプションを使用します。
**activity**
指定された OpsWorks Stacks コマンドを実行します: `setup`、`configure`、`deploy`、`undeploy`、`start`、`stop`、または `restart`。
**date**
指定されたタイムスタンプに実行された AWS OpsWorks コマンドを実行します。有効なタイムスタンプのリストを取得するには、[list\$1commands](agent-list.md) を実行します。
**file**
指定されたコマンド JSON ファイルを実行します。コマンドのファイルパスを取得するには、[get\$1json](agent-json.md) を実行します。
次のインスタンスの出力例では configure コマンドを実行しています。
```
$ sudo opsworks-agent-cli run_command configure
[2015-12-02 16:52:53] INFO [opsworks-agent(21970)]: About to re-run 'configure' from 2015-12-01T18:20:24
...
[2015-12-02 16:53:02] INFO [opsworks-agent(21970)]: Finished Chef run with exitcode 0
```
# show\$1log
**重要**
この AWS OpsWorks Stacks サービスは 2024 年 5 月 26 日にサポート終了となり、新規および既存のお客様の両方で無効になっています。できるだけ早くワークロードを他のソリューションに移行することを強くお勧めします。移行についてご質問がある場合は、[AWS re:Post](https://repost.aws/) または[AWS プレミアムサポート](https://aws.amazon.com/support)を通じて AWS サポート チームにお問い合わせください。
コマンドのログファイルを返します。
```
sudo opsworks-agent-cli show_log [activity] [date]
```
デフォルトでは、`show_log` は最新のログファイルの末尾を表示します。特定のコマンドを指定するには、次のオプションを使用します。
**activity**
指定されたアクティビティのログファイルを表示します。
**date**
指定されたタイムスタンプに実行されたアクティビティのログファイルを表示します。有効なタイムスタンプのリストを取得するには、[list\$1commands](agent-list.md) を実行します。
次の出力例は、最新のログを示しています。
```
$ sudo opsworks-agent-cli show_log
[2015-12-02T16:52:59+00:00] INFO: Storing updated cookbooks/opsworks_cookbook_demo/opsworks-cookbook-demo.tar.gz in the cache.
...
[2015-12-02T16:52:59+00:00] INFO: Report handlers complete
```
# stack\$1state
**重要**
この AWS OpsWorks Stacks サービスは 2024 年 5 月 26 日にサポート終了となり、新規および既存のお客様の両方で無効になっています。できるだけ早くワークロードを他のソリューションに移行することを強くお勧めします。移行についてご質問がある場合は、[AWS re:Post](https://repost.aws/) または[AWS プレミアムサポート](https://aws.amazon.com/support)を通じて AWS サポート チームにお問い合わせください。
スタックが最新の Chef OpsWorks 実行のために内部的に使用する情報を表示します。
```
opsworks-agent-cli stack_state
```
**注記**
Chef 12 Linux インスタンスの場合、このコマンドを実行すると、インスタンスのスタック設定やデプロイ属性など、有効な情報が返されます。ただし、詳細な情報を取得するには、 OpsWorks スタックがインスタンスで作成する Chef データバッグを参照してください。詳細については、「[OpsWorks スタックデータバッグリファレンス](data-bags.md)」を参照してください。
インスタンスの出力例を次に示します。
```
$ sudo opsworks-agent-cli stack_state
{
"last_command": {
"sent_at": "2015-12-01T18:19:23+00:00",
"activity": "configure"
},
"instance": {
"ami_id": "ami-d93622EX",
"architecture": "x86_64",
"auto_scaling_type": null,
"availability_zone": "us-west-2a",
"created_at": "2015-11-18T00:21:05+00:00",
"ebs_optimized": false,
"ec2_instance_id": "i-a480e9EX",
"elastic_ip": null,
"hostname": "cookbooks-demo1",
"instance_id": "cfdaa716-42fe-4e3b-9762-fef184ddd8EX",
"instance_type": "c3.large",
"layer_ids": [
"93f50d83-1e73-45c4-840a-0d4f07cda1EX"
],
"os": "Amazon Linux 2015.09",
"private_dns": "ip-192-0-2-0.us-west-2.compute.internal",
"private_ip": "10.122.69.33",
"public_dns": "ec2-203-0-113-0.us-west-2.compute.amazonaws.com",
"public_ip": "192.0.2.0",
"root_device_type": "ebs",
"root_device_volume_id": "vol-f6f7e8EX",
"ssh_host_dsa_key_fingerprint": "f2:...:15",
"ssh_host_dsa_key_public": "ssh-dss AAAAB3Nz...a8vMbqA=",
"ssh_host_rsa_key_fingerprint": "0a:...:96",
"ssh_host_rsa_key_public": "ssh-rsa AAAAB3Nz...yhPanvo7",
"status": "online",
"subnet_id": null,
"virtualization_type": "paravirtual",
"infrastructure_class": "ec2",
"ssh_host_dsa_key_private": "-----BEGIN DSA PRIVATE KEY-----\nMIIDVwIB...g5OtgQ==\n-----END DSA PRIVATE KEY-----\n",
"ssh_host_rsa_key_private": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIB...78kprtIw\n-----END RSA PRIVATE KEY-----\n"
},
"layers": [
{
"layer_id": "93f50d83-1e73-45c4-840a-0d4f07cda1EX",
"name": "MyCookbooksDemoLayer",
"packages": [
],
"shortname": "cookbooks-demo",
"type": "custom",
"volume_configurations": [
]
}
],
"applications": null,
"stack": {
"arn": "arn:aws:opsworks:us-west-2:80398EXAMPLE:stack/040c3def-b2b4-4489-bb1b-e08425886fEX/",
"custom_cookbooks_source": {
"type": "s3",
"url": "https://s3.amazonaws.com/amzn-s3-demo-bucket/opsworks-cookbook-demo.tar.gz",
"username": "AKIAJUQN...WG644EXA",
"password": "O5v+4Zz+...rcKbFTJu",
"ssh_key": null,
"revision": null
},
"name": "MyCookbooksDemoStack",
"region": "us-west-2",
"stack_id": "040c3def-b2b4-4489-bb1b-e08425886fEX",
"use_custom_cookbooks": true,
"vpc_id": null
},
"agent": {
"valid_activities": [
"reboot",
"stop",
"deploy",
"grant_remote_access",
"revoke_remote_access",
"update_agent",
"setup",
"configure",
"update_dependencies",
"install_dependencies",
"update_custom_cookbooks",
"execute_recipes",
"sync_remote_users"
]
}
}
```