翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# AWS ParallelCluster CLI コマンド
`pcluster` はプライマリ AWS ParallelCluster CLI コマンドです。`pcluster` を使用して、 で HPC クラスターを起動および管理 AWS クラウド し、カスタム AMI イメージを作成および管理します。
`pcluster3-config-converter` は、バージョン 2 形式のクラスター設定 AWS ParallelCluster を AWS ParallelCluster バージョン 3 形式に変換するために使用されます。
```
pcluster [-h] ( build-image | configure |
create-cluster | dcv-connect |
delete-cluster | delete-cluster-instances | delete-image |
describe-cluster | describe-cluster-instances |
describe-compute-fleet | describe-image |
export-cluster-logs | export-image-logs |
get-cluster-log-events | get-cluster-stack-events |
get-image-log-events | get-image-stack-events |
list-cluster-log-streams | list-clusters |
list-images | list-image-log-streams | list-official-images |
ssh | update-cluster |
update-compute-fleet | version ) ...
pcluster3-config-converter [-h] [-t CLUSTER_TEMPLATE]
[-c CONFIG_FILE]
[--force-convert]
[-o OUTPUT_FILE]
```
**Topics**
+ [`pcluster`](pcluster-v3.md)
+ [`pcluster3-config-converter`](pcluster3-config-converter.md)
# `pcluster`
`pcluster` はプライマリ AWS ParallelCluster CLI コマンドです。`pcluster` は、 AWS クラウド内の HPC クラスターを起動し、管理するために使用します。
`pcluster` は `/home/user/.parallelcluster/` の `pcluster.log.#` ファイルにコマンドのログを書き込みます。詳細については、「[`pcluster` CLI ログ](troubleshooting-v3-pc-cli-logs.md)」を参照してください。
`pcluster` の実行に必要な[アクセス許可](iam-roles-in-parallelcluster-v3.md#iam-roles-in-parallelcluster-v3-example-user-policies)を持つ IAM ロールが必要です。
```
pcluster [-h]
```
## 引数
**`pcluster command`**
可能な選択肢: [`build-image`](pcluster.build-image-v3.md) \$1 [`configure`](pcluster.configure-v3.md) \$1 [`create-cluster`](pcluster.create-cluster-v3.md) \$1 [`dcv-connect`](pcluster.dcv-connect-v3.md) \$1 [`delete-cluster`](pcluster.delete-cluster-v3.md) \$1 [`delete-cluster-instances`](pcluster.delete-cluster-instances-v3.md) \$1 [`delete-image`](pcluster.delete-image-v3.md) \$1 \$1 [`describe-cluster`](pcluster.describe-cluster-v3.md) [`describe-cluster-instances`](pcluster.describe-cluster-instances-v3.md) \$1 [`describe-compute-fleet`](pcluster.describe-compute-fleet-v3.md) \$1 [`describe-image`](pcluster.describe-image-v3.md) \$1 [`export-cluster-logs`](pcluster.export-cluster-logs-v3.md) \$1 [`export-image-logs`](pcluster.export-image-logs-v3.md) [`get-cluster-log-events`](pcluster.get-cluster-log-events-v3.md) \$1 [`get-cluster-stack-events`](pcluster.get-cluster-stack-events-v3.md) \$1 \$1 [`get-image-log-events`](pcluster.get-image-log-events-v3.md) \$1 [`get-image-stack-events`](pcluster.get-image-stack-events-v3.md) \$1 [`list-clusters`](pcluster.list-clusters-v3.md) \$1 \$1 [`list-cluster-log-streams`](pcluster.list-cluster-log-streams-v3.md) \$1 [`list-images`](pcluster.list-images-v3.md) \$1 [`ssh`](pcluster.ssh-v3.md) \$1 \$1 [`list-image-log-streams`](pcluster.list-image-log-streams-v3.md) [`list-official-images`](pcluster.list-official-images-v3.md) \$1 [`update-cluster`](pcluster.update-cluster-v3.md) \$1 [`update-compute-fleet`](pcluster.update-compute-fleet-v3.md) \$1 [`version`](pcluster.version-v3.md)
**サブコマンド:**
**Topics**
+ [引数](#pcluster.arguments-v3)
+ [`pcluster build-image`](pcluster.build-image-v3.md)
+ [`pcluster configure`](pcluster.configure-v3.md)
+ [`pcluster create-cluster`](pcluster.create-cluster-v3.md)
+ [`pcluster dcv-connect`](pcluster.dcv-connect-v3.md)
+ [`pcluster delete-cluster`](pcluster.delete-cluster-v3.md)
+ [`pcluster delete-cluster-instances`](pcluster.delete-cluster-instances-v3.md)
+ [`pcluster delete-image`](pcluster.delete-image-v3.md)
+ [`pcluster describe-cluster`](pcluster.describe-cluster-v3.md)
+ [`pcluster describe-cluster-instances`](pcluster.describe-cluster-instances-v3.md)
+ [`pcluster describe-compute-fleet`](pcluster.describe-compute-fleet-v3.md)
+ [`pcluster describe-image`](pcluster.describe-image-v3.md)
+ [`pcluster export-cluster-logs`](pcluster.export-cluster-logs-v3.md)
+ [`pcluster export-image-logs`](pcluster.export-image-logs-v3.md)
+ [`pcluster get-cluster-log-events`](pcluster.get-cluster-log-events-v3.md)
+ [`pcluster get-cluster-stack-events`](pcluster.get-cluster-stack-events-v3.md)
+ [`pcluster get-image-log-events`](pcluster.get-image-log-events-v3.md)
+ [`pcluster get-image-stack-events`](pcluster.get-image-stack-events-v3.md)
+ [`pcluster list-clusters`](pcluster.list-clusters-v3.md)
+ [`pcluster list-cluster-log-streams`](pcluster.list-cluster-log-streams-v3.md)
+ [`pcluster list-images`](pcluster.list-images-v3.md)
+ [`pcluster list-image-log-streams`](pcluster.list-image-log-streams-v3.md)
+ [`pcluster list-official-images`](pcluster.list-official-images-v3.md)
+ [`pcluster ssh`](pcluster.ssh-v3.md)
+ [`pcluster update-cluster`](pcluster.update-cluster-v3.md)
+ [`pcluster update-compute-fleet`](pcluster.update-compute-fleet-v3.md)
+ [`pcluster version`](pcluster.version-v3.md)
# `pcluster build-image`
指定されたリージョンにカスタム AWS ParallelCluster イメージを作成します。
```
pcluster build-image [-h]
--image-configuration IMAGE_CONFIGURATION
--image-id IMAGE_ID
[--debug]
[--dryrun DRYRUN]
[--query QUERY]
[--region REGION]
[--rollback-on-failure ROLLBACK_ON_FAILURE]
[--suppress-validators SUPPRESS_VALIDATORS [SUPPRESS_VALIDATORS ...]]
[--validation-failure-level {INFO,WARNING,ERROR}]
```
## 名前付き引数
**-h, --help**
`pcluster build-image` のヘルプテキストを表示します。
**--image-configuration, -c *IMAGE\$1CONFIGURATION***
イメージ設定ファイルを YAML ドキュメントで指定します。
**--image-id, -i *IMAGE\$1ID***
構築されるイメージの ID を指定します。
**--debug**
デバッグログを有効にします。
**--dryrun *DRYRUN***
`true` の場合、リソースを作成することなく、検証を行います。イメージの構成を検証するためにこれを使用することができます。(デフォルトは `false` です)
**--query *QUERY***
出力時に実行する JMESPath クエリ。
**--region, -r *REGION***
AWS リージョン 使用する を指定します。イメージ設定ファイルの[リージョン](image-builder-configuration-file-v3.md#yaml-build-image-Region)設定、`AWS_DEFAULT_REGION`環境変数、`~/.aws/config`ファイルの `[default]`セクションの `region`設定、または `--region`パラメータを使用して、 を指定 AWS リージョン する必要があります。
**--rollback-on-failure *ROLLBACK\$1ON\$1FAILURE***
`true` の場合、失敗するとイメージスタックのロールバックが自動的に開始されます。(デフォルトは `false` です)
**--suppress-validators * SUPPRESS\$1VALIDATORS* [*SUPPRESS\$1VALIDATORS ...*]**
抑制する 1 つまたは複数のコンフィグバリデータを指定します。
形式: (`ALL`\$1`type:[A-Za-z0-9]+`)
**--validation-failure-level \$1`INFO`,`WARNING`,`ERROR`\$1**
作成が失敗する最小の検証レベルを指定します。(デフォルトは `ERROR` です)
** AWS ParallelCluster バージョン 3.1.2 の使用例:**
```
$ pcluster build-image --image-configuration image-config.yaml --image-id custom-alinux2-image
{
"image": {
"imageId": "custom-alinux2-image",
"imageBuildStatus": "BUILD_IN_PROGRESS",
"cloudformationStackStatus": "CREATE_IN_PROGRESS",
"cloudformationStackArn": "arn:aws:cloudformation:us-east-1:123456789012:stack/custom-alinux2-image/1234abcd-56ef-78gh-90ij-abcd1234efgh",
"region": "us-east-1",
"version": "3.1.2"
}
}
```
**警告**
`pcluster build-image` はデフォルトの VPC を使用します。デフォルトの VPC が削除された場合は、おそらく AWS Control Tower または AWS Landing Zone を使用して、イメージ設定ファイルでサブネット ID を指定する必要があります。詳細については、「[SubnetId](HeadNode-v3.md#yaml-HeadNode-Networking-SubnetId)」を参照してください。
# `pcluster configure`
AWS ParallelCluster バージョン 3 のインタラクティブ設定ウィザードを開始します。詳細については、「[AWS ParallelCluster コマンドラインインターフェイスを使用してクラスターを設定および作成する](install-v3-configuring.md)」を参照してください。
```
pcluster configure [-h]
--config CONFIG
[--debug]
[--region REGION]
```
## 名前付き引数
**-h, --help**
`pcluster configure` のヘルプテキストを表示します。
**--config *CONFIG***
生成された設定ファイルを出力するパス。
**--debug**
デバッグログを有効にします。
**--region, -r *REGION***
AWS リージョン 使用する を指定します。リージョンは、イメージ設定ファイルの[リージョン](image-builder-configuration-file-v3.md#yaml-build-image-Region)設定、環境変数 `AWS_DEFAULT_REGION`、`~/.aws/config` ファイルの `[default]` セクションにある `region` 設定、または `--region` パラメータを使って指定する必要があります。
# `pcluster create-cluster`
AWS ParallelCluster クラスターを作成します。
```
pcluster create-cluster [-h]
--cluster-configuration CLUSTER_CONFIGURATION
--cluster-name CLUSTER_NAME
[--debug]
[--dryrun DRYRUN]
[--query QUERY]
[--region REGION]
[--rollback-on-failure ROLLBACK_ON_FAILURE]
[--suppress-validators SUPPRESS_VALIDATORS [SUPPRESS_VALIDATORS ...]]
[--validation-failure-level {INFO,WARNING,ERROR}]
```
## 名前付き引数
**-h, --help**
`pcluster create-cluster` のヘルプテキストを表示します。
**--cluster-configuration, -c *CLUSTER\$1CONFIGURATION***
YAML クラスター設定ファイルを指定します。
**--cluster-name, -n *CLUSTER\$1NAME***
作成するクラスターの名前を指定します。
名前の最初は、アルファベットで始まっている必要があります。名前は最大 60 文字です。Slurm アカウンティングが有効になっている場合、名前の最大長は 40 文字です。
有効な文字は、A～Z、a～z、0～9、- (ハイフン) です。
**--debug**
デバッグログの有効化
**--dryrun *DRYRUN***
`true` の場合、コマンドはリソースを作成することなく、検証を行います。クラスターの構成を検証するためにこれを使用することができます。(デフォルトは `false` です)
**--query *QUERY***
出力に対して実行する JMESPath クエリを指定します。
**--region, -r *REGION***
AWS リージョン 使用する を指定します。クラスター設定ファイルの [`Region`](cluster-configuration-file-v3.md#yaml-Region)設定、 `AWS_DEFAULT_REGION`環境変数、 `~/.aws/config` ファイルの `[default]`セクションの `region`設定、または `--region`パラメータを使用して、 を指定 AWS リージョン する必要があります。
**--rollback-on-failure *ROLLBACK\$1ON\$1FAILURE***
`true` の場合、障害発生時に自動的にクラスタースタックのロールバックを開始します。(デフォルトは `true` です)
**--suppress-validators *SUPPRESS\$1VALIDATORS* [*SUPPRESS\$1VALIDATORS* ...]**
抑制する 1 つまたは複数のコンフィグバリデータを指定します。
形式: (`ALL`\$1タイプ: `[A-Za-z0-9]+`)
**--validation-failure-level \$1`INFO`,`WARNING`,`ERROR`\$1**
作成が失敗する最小の検証レベルを指定します。(デフォルトは `ERROR` です)
** AWS ParallelCluster バージョン 3.1.4 の使用例:**
```
$ pcluster create-cluster -c cluster-config.yaml -n cluster-v3
{
"cluster": {
"clusterName": "cluster-v3",
"cloudformationStackStatus": "CREATE_IN_PROGRESS",
"cloudformationStackArn": "arn:aws:cloudformation:us-east-1:123456789012:stack/cluster-v3/1234abcd-56ef-78gh-90ij-abcd1234efgh",
"region": "us-east-1",
"version": "3.1.4",
"clusterStatus": "CREATE_IN_PROGRESS"
}
}
```
# `pcluster dcv-connect`
Amazon DCV を使用してインタラクティブセッションからヘッドノードに接続することを許可します。
```
pcluster dcv-connect [-h]
--cluster-name CLUSTER_NAME
[--debug]
[--key-path KEY_PATH]
[--login-node-ip LOGIN_NODE_IP]
[--region REGION]
[--show-url]
```
## 名前付き引数
**-h, --help**
`pcluster dcv-connect` のヘルプテキストを表示します。
**--cluster-name, -n *CLUSTER\$1NAME***
クラスターの名前を指定します。
**--debug**
デバッグログの有効化
**--key-path *KEY\$1PATH***
接続に使用する SSH キーのパスを指定します。
**--login-node-ip**
クラスター内のログインノードのパブリック IP アドレスまたはプライベート IP アドレスを指定します。この引数を使用すると、DCV が有効になっているクラスター内のログインノードに接続できます。
この引数は AWS ParallelCluster バージョン 3.11.0 で追加されています。
**--region, -r *REGION***
AWS リージョン 使用する を指定します。`AWS_DEFAULT_REGION` 環境変数、 `~/.aws/config` ファイルの `[default]`セクションの `region`設定、または `--region`パラメータを使用して、 を指定 AWS リージョン する必要があります。
**--show-url**
DCV の接続に使用される URL を出力して終了します。
** AWS ParallelCluster バージョン 3.11 の使用例**
```
$ pcluster dcv-connect -n cluster-3Dcv --login-node-ip 198.51.100.44 -r us-east-1 --key-path /home/user/.ssh/key.pem
```
![\[A screenshot of the DCV console.\]](http://docs.aws.amazon.com/ja_jp/parallelcluster/latest/ug/images/Dcv-image.png)
# `pcluster delete-cluster`
クラスターの削除を開始します。
```
pcluster delete-cluster [-h]
--cluster-name CLUSTER_NAME
[--debug]
[--query QUERY]
[--region REGION]
```
## 名前付き引数
**-h, --help**
`pcluster delete-cluster` のヘルプテキストを表示します。
**--cluster-name, -n *CLUSTER\$1NAME***
クラスターの名前を指定します。
**--debug**
デバッグログの有効化
**--query *QUERY***
出力に対して実行する JMESPath クエリを指定します。
**--region, -r *REGION***
AWS リージョン 使用する を指定します。リージョンは、`AWS_DEFAULT_REGION` の環境変数、`~/.aws/config` ファイルの `[default]` セクションにある `region` 設定、または `--region` のパラメータを使って指定する必要があります。
** AWS ParallelCluster バージョン 3.1.4 の使用例:**
```
$ pcluster delete-cluster -n cluster-v3
{
"cluster": {
"clusterName": "cluster-v3",
"cloudformationStackStatus": "DELETE_IN_PROGRESS",
"cloudformationStackArn": "arn:aws:cloudformation:us-east-1:123456789012:stack/cluster-v3/1234abcd-56ef-78gh-90ij-abcd1234efgh",
"region": "us-east-1",
"version": "3.1.4",
"clusterStatus": "DELETE_IN_PROGRESS"
}
}
```
# `pcluster delete-cluster-instances`
すべてのクラスターコンピューティングノードの強制終了を開始します。これは AWS Batch クラスターでは機能しません。
```
pcluster delete-cluster-instances [-h]
--cluster-name CLUSTER_NAME
[--debug]
[--force FORCE]
[--query QUERY]
[--region REGION]
```
## 名前付き引数
**-h, --help**
`pcluster delete-cluster-instances` のヘルプテキストを表示します。
**--cluster-name, -n *CLUSTER\$1NAME***
クラスターの名前を指定します。
**--debug**
デバッグログの有効化
**--force *FORCE***
`true` の場合、検証エラーを無視して強制的に削除します。(デフォルトは `false` です)
**--query *QUERY***
出力に対して実行する JMESPath クエリを指定します。
**--region, -r *REGION***
AWS リージョン 使用する を指定します。`AWS_DEFAULT_REGION` 環境変数、 `~/.aws/config` ファイルの `[default]`セクションの `region`設定、または `--region`パラメータを使用して、 を指定 AWS リージョン する必要があります。
```
$ pcluster delete-cluster-instances -n cluster-v3
```
# `pcluster delete-image`
カスタム AWS ParallelCluster イメージの削除を開始します。
```
pcluster delete-image [-h]
--image-id IMAGE_ID
[--debug]
[--force FORCE]
[--query QUERY]
[--region REGION]
```
## 名前付き引数
**-h, --help**
`pcluster delete-image` のヘルプテキストを表示します。
**--image-id, -i *IMAGE\$1ID***
削除するイメージの ID を指定します。
**--debug**
デバッグログの有効化
**--force *FORCE***
`true` の場合、AMI を使用しているインスタンスがある場合や、AMI が共有されている場合は、強制的に削除されます。(デフォルトは `false` です)
**--query *QUERY***
出力に対して実行する JMESPath クエリを指定します。
**--region, -r *REGION***
AWS リージョン 使用する を指定します。`AWS_DEFAULT_REGION` 環境変数、 `~/.aws/config` ファイルの `[default]`セクションの `region`設定、または `--region`パラメータを使用して、 を指定 AWS リージョン する必要があります。
** AWS ParallelCluster バージョン 3.1.4 の使用例:**
```
$ pcluster delete-image --image-id custom-alinux2-image
{
"image": {
"imageId": "custom-alinux2-image",
"imageBuildStatus": "DELETE_IN_PROGRESS",
"region": "us-east-1",
"version": "3.1.4"
}
}
```
# `pcluster describe-cluster`
クラスターの詳細情報を取得します。
```
pcluster describe-cluster [-h]
--cluster-name CLUSTER_NAME
[--debug]
[--query QUERY]
[--region REGION]
```
## 名前付き引数
**-h, --help**
`pcluster describe-cluster` のヘルプテキストを表示します。
**--cluster-name, -n *CLUSTER\$1NAME***
クラスターの名前を指定します。
**--debug**
デバッグログの有効化
**--query *QUERY***
出力に対して実行する JMESPath クエリを指定します。
**--region, -r *REGION***
AWS リージョン 使用する を指定します。`AWS_DEFAULT_REGION` 環境変数、 `~/.aws/config` ファイルの `[default]`セクションの `region`設定、または `--region`パラメータを使用して、 を指定 AWS リージョン する必要があります。
** AWS ParallelCluster バージョン 3.1.4 を使用した例:**
クラスターの詳細を説明します。
```
$ pcluster describe-cluster -n cluster-v3
{
"creationTime": "2022-07-12T17:19:16.101Z",
"headNode": {
"launchTime": "2022-07-12T17:22:21.000Z",
"instanceId": "i-1234567890abcdef0",
"publicIpAddress": "198.51.100.44",
"instanceType": "t2.micro",
"state": "running",
"privateIpAddress": "192.0.2.0.196"
},
"loginNodes": [
{
"status": "active",
"poolName": "pool1",
"address": "cluster-v3-eMr9BYRKZVDa-e5bb34f40b24f51d.elb.us-east-1.amazonaws.com",
"scheme": "internet-facing",
"healthyNodes": 1,
"unhealthyNodes": 0
},
{
"status": "active",
"poolName": "pool2",
"address": "cluster-v3-PaQ7GgC27sic-aba10c890247b36b.elb.us-east-1.amazonaws.com",
"scheme": "internet-facing",
"healthyNodes": 1,
"unhealthyNodes": 0
}
],
"version": "3.1.4",
"clusterConfiguration": {
"url": "https://parallelcluster-e5ca74255d6c3886-v1-do-not-delete..."
},
"tags": [
{
"value": "3.11",
"key": "parallelcluster:version"
}
],
"cloudFormationStackStatus": "CREATE_COMPLETE",
"clusterName": "cluster-v3",
"computeFleetStatus": "RUNNING",
"cloudformationStackArn": "arn:aws:cloudformation:us-east-1:123456789012:stack/cluster-v3/1234abcd-56ef-78gh-90ij-abcd1234efgh",
"lastUpdatedTime": "2022-07-12T17:19:16.101Z",
"region": "us-east-1",
"clusterStatus": "CREATE_COMPLETE"
}
```
`describe-cluster` を使用してクラスター設定を取得します。
```
$ curl -o - $(pcluster describe-cluster -n cluster-v3 --query clusterConfiguration.url | xargs echo)
Region: us-east-1
Image:
Os: alinux2
HeadNode:
InstanceType: t2.micro
Networking:
SubnetId: subnet-abcdef01234567890
Ssh:
KeyName: adpc
Iam:
S3Access:
- BucketName: cluster-v3-bucket
KeyName: logs
EnableWriteAccess: true
Scheduling:
Scheduler: slurm
SlurmQueues:
- Name: queue1
ComputeResources:
- Name: t2micro
InstanceType: t2.micro
MinCount: 0
MaxCount: 10
Networking:
SubnetIds:
- subnet-021345abcdef6789
```
# `pcluster describe-cluster-instances`
クラスター内のインスタンスについて説明します。
```
pcluster describe-cluster-instances [-h]
--cluster-name CLUSTER_NAME
[--debug]
[--next-token NEXT_TOKEN]
[--node-type {HeadNode,ComputeNode,LoginNode}]
[--query QUERY]
[--queue-name QUEUE_NAME]
[--region REGION]
```
## 名前付き引数
**-h, --help**
`pcluster describe-cluster-instances` のヘルプテキストを表示します。
**--cluster-name, -n *CLUSTER\$1NAME***
クラスターの名前を指定します。
**--debug**
デバッグログの有効化
**--next-token *NEXT\$1TOKEN***
次の結果セットのトークン。
**--node-type \$1`HeadNode`,`ComputeNode`,`LoginNode`\$1**
リストするノードタイプを指定します。サポートされる値は `HeadNode`、`ComputeNode`、`LoginNode` です。このパラメータが指定されていない場合、`HeadNode`、`ComputeNode`、`LoginNode` のインスタンスが記述されます。
**--query *QUERY***
出力に対して実行する JMESPath クエリを指定します。
**--queue-name *QUEUE\$1NAME***
一覧表示するキューの名前を指定します。このパラメータが指定されていない場合、すべてのキューのインスタンスが記述されます。
**--region, -r *REGION***
AWS リージョン 使用する を指定します。`AWS_DEFAULT_REGION` 環境変数、 `~/.aws/config` ファイルの `[default]`セクションの `region`設定、または `--region`パラメータを使用して、 を指定 AWS リージョン する必要があります。
** AWS ParallelCluster バージョン 3.1.4 の使用例:**
```
$ pcluster describe-cluster-instances -n cluster-v3
{
"instances": [
{
"launchTime": "2022-07-12T17:22:21.000Z",
"instanceId": "i-1234567890abcdef0",
"publicIpAddress": "198.51.100.44",
"instanceType": "t2.micro",
"state": "running",
"nodeType": "HeadNode",
"privateIpAddress": "192.0.2.0.196"
},
{
"launchTime": "2022-07-12T17:37:42.000Z",
"instanceId": "i-021345abcdef6789",
"queueName": "queue1",
"publicIpAddress": "198.51.100.44",
"instanceType": "t2.micro",
"state": "pending",
"nodeType": "ComputeNode",
"privateIpAddress": "192.0.2.0.196"
},
{
"launchTime": "2022-07-12T17:37:42.000Z",
"instanceId": "i-021345abcdef6789",
"poolName": "pool1",
"publicIpAddress": "198.51.100.44",
"instanceType": "t2.micro",
"state": "pending",
"nodeType": "loginNode",
"privateIpAddress": "192.0.2.0.196"
}
]
}
```
# `pcluster describe-compute-fleet`
コンピューティングフリートの状況について説明してください。
```
pcluster describe-compute-fleet [-h]
--cluster-name CLUSTER_NAME
[--debug]
[--query QUERY]
[--region REGION]
```
## 名前付き引数
**-h, --help**
`pcluster describe-compute-fleet` のヘルプテキストを表示します。
**--cluster-name, -n *CLUSTER\$1NAME***
クラスターの名前を指定します。
**--debug**
デバッグログの有効化
**--query *QUERY***
出力に対して実行する JMESPath クエリを指定します。
**--region, -r *REGION***
AWS リージョン 使用する を指定します。`AWS_DEFAULT_REGION` 環境変数、 `~/.aws/config` ファイルの `[default]`セクションの `region`設定、または `--region`パラメータを使用して、 を指定 AWS リージョン する必要があります。
** AWS ParallelCluster バージョン 3.1.4 の使用例:**
```
$ pcluster describe-compute-fleet -n pcluster-v3
{
"status": "RUNNING",
"lastStatusUpdatedTime": "2022-07-12T17:24:26.000Z"
}
```
# `pcluster describe-image`
イメージの詳細情報を取得します。
```
pcluster describe-image [-h]
--image-id IMAGE_ID
[--debug]
[--query QUERY]
[--region REGION]
```
## 名前付き引数
**-h, --help**
`pcluster describe-image` のヘルプテキストを表示します。
**--image-id, -i *IMAGE\$1ID***
イメージの ID を指定します。
**--debug**
デバッグログの有効化
**--query *QUERY***
出力に対して実行する JMESPath クエリを指定します。
**--region, -r *REGION***
AWS リージョン 使用する を指定します。`AWS_DEFAULT_REGION` 環境変数、 `~/.aws/config` ファイルの `[default]`セクションの `region`設定、または `--region`パラメータを使用して、 を指定 AWS リージョン する必要があります。
** AWS ParallelCluster バージョン 3.1.2 の使用例:**
```
$ pcluster describe-image --image-id custom-alinux2-image
{
"imageConfiguration: {
"url": "https://parallelcluster-1234abcd5678-v1-do-not-delete.../configs/image-config.yaml"
},
"imageId": "custom-alinux2-image",
"creationTime": "2022-04-05T20:23:07.000Z"
"imageBuildStatus": "BUILD_COMPLETE",
"region": "us-east-1",
"ec2AmiInfo": {
"amiName": "custom-alinux2-image 2022-04-05T19-55-22.518Z",
"amiId": "ami-1234abcd5678efgh",
"description": "AWS ParallelCluster AMI for alinux2, kernel-4.14.268-205.500.amzn2.x86_64, lustre-2.10.8-5.amzn2.x86_64, efa-1.14.2-1.amzn2.x86_64, dcv-2021.3.11591-1.el7.x86_64, slurm-21-08-6-1",
"state": "AVAILABLE",
"tags": [
{
"value": "arn:aws:imagebuilder:us-east-1:123456789012:image/parallelclusterimage-custom-alinux2-image/3.1.2/1",
"key": "Ec2ImageBuilderArn"
},
{
"value": "parallelcluster-1234abcd5678efgh-v1-do-not-delete",
"key": "parallelcluster:amzn-s3-demo-bucket"
},
{
"value": "custom-alinux2-image",
"key": "parallelcluster:image_name"
},
{
"value": "available",
"key": "parallelcluster:build_status"
},
{
"value": "s3://amzn-s3-demo-bucket/parallelcluster/3.1.2/images/custom-alinux2-image-1234abcd5678efgh/configs/image-config.yaml",
"key": "parallelcluster:build_config"
},
{
"value": "Amazon EC2 Image Builder",
"key": "CreatedBy"
},
{
"value": "arn:aws:logs:us-east-1:123456789012:log-group:/aws/imagebuilder/ParallelClusterImage-custom-alinux2-image",
"key": "parallelcluster:build_log"
},
{
"value": "4.14.268-205.500.amzn2.x86_64",
"key": "parallelcluster:kernel_version"
},
{
"value": "arn:aws:imagebuilder:us-east-1:444455556666:image/amazon-linux-2-x86/2022.3.16/1",
"key": "parallelcluster:parent_image"
},
{
"value": "3.1.2",
"key": "parallelcluster:version"
},
{
"value": "0.5.14",
"key": "parallelcluster:munge_version"
},
{
"value": "21-08-6-1",
"key": "parallelcluster:slurm_version"
},
{
"value": "2021.3.11591-1.el7.x86_64",
"key": "parallelcluster:dcv_version"
},
{
"value": "alinux2-image",
"key": "parallelcluster:image_id"
},
{
"value": "3.2.3",
"key": "parallelcluster:pmix_version"
},
{
"value": "parallelcluster/3.15.0/images/alinux2-image-abcd1234efgh56781234",
"key": "parallelcluster:s3_image_dir"
},
{
"value": "1.14.2-1.amzn2.x86_64",
"key": "parallelcluster:efa_version"
},
{
"value": "alinux2",
"key": "parallelcluster:os"
},
{
"value": "aws-parallelcluster-cookbook-3.1.2",
"key": "parallelcluster:bootstrap_file"
},
{
"value": "1.8.23-10.amzn2.1.x86_64",
"key": "parallelcluster:sudo_version"
},
{
"value": "2.10.8-5.amzn2.x86_64",
"key": "parallelcluster:lustre_version"
}
],
"architecture": "x86_64"
},
"version": "3.1.2"
}
```
# `pcluster export-cluster-logs`
クラスターのログを Amazon S3 バケットを経由して、ローカルの `tar.gz` アーカイブにエクスポートします。
```
pcluster export-cluster-logs [-h]
--cluster-name CLUSTER_NAME
[--bucket BUCKET_NAME]
[--bucket-prefix BUCKET_PREFIX]
[--debug]
[--end-time END_TIME]
[--filters FILTER [FILTER ...]]
[--keep-s3-objects KEEP_S3_OBJECTS]
[--output-file OUTPUT_FILE]
[--region REGION]
[--start-time START_TIME]
```
**注記**
`export-cluster-logs` コマンドは CloudWatch Logs がログのエクスポートを完了するのを待つため、出力なしで一定期間が発生することが予想されます。
## 名前付き引数
**-h, --help**
`pcluster export-cluster-logs` のヘルプテキストを表示します。
**--bucket *BUCKET\$1NAME***
クラスターログデータのエクスポート先の Amazon S3 バケットを指定します。クラスターと同じリージョンである必要があります。
+ CloudWatch にアクセスを許可するために、Amazon S3 バケットポリシーに対するアクセス許可を追加する必要があります。詳細については、「CloudWatch Logs [ ユーザーガイド」のAmazon S3バケットに対するアクセス許可](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/S3ExportTasks.html#S3Permissions)の設定」を参照してください。 *CloudWatch *
+ AWS ParallelCluster バージョン **3.12.0** 以降、 `--bucket`オプションは**オプション**です。オプションが指定されていない場合は、リージョンの AWS ParallelCluster デフォルトバケット (`parallelcluster-hash-v1-DO-NOT-DELETE`) が使用されます。または、 が指す Amazon S3 バケット`CustomS3Bucket`がクラスター設定で指定されている場合は、 が使用されます。`--bucket` オプションを指定せず、デフォルトの AWS ParallelCluster バケットを使用する場合は、内部使用のために予約されている保護された`parallelcluster/`フォルダであるため、 フォルダにログをエクスポートすることはできません。
AWS ParallelCluster デフォルトのバケットが使用されている場合、pcluster はバケットポリシーの設定を処理します。バケットポリシーをカスタマイズしてからバージョン **3.12.0** にアップグレード AWS ParallelCluster すると、バケットポリシーは上書きされ、変更を再適用する必要があります。
**--cluster-name, -n *CLUSTER\$1NAME***
クラスターの名前を指定します。
**--bucket-prefix *BUCKET\$1PREFIX***
エクスポートされたログデータが Amazon S3 バケットに格納されるパスを指定します。
デフォルトでは、バケットプレフィックスは次のとおりです。
```
cluster-name-logs-202209061743.tar.gz
```
`202209061743` は `%Y%m%d%H%M`形式の時刻の例です。
AWS ParallelCluster バージョン **3.12.0** 以降、 `--bucket`オプションを指定せず、デフォルトの AWS ParallelCluster バケットを使用する場合は、内部使用用に予約された保護されたフォルダであるため、 `parallelcluster/` フォルダにログをエクスポートすることはできません。
**--debug**
デバッグログの有効化
**--end-time *END\$1TIME***
ログイベントを収集する時間範囲の終わりを指定し、ISO 8601 形式 (`YYYY-MM-DDThh:mm:ssZ`、例えば `2021-01-01T20:00:00Z`) で表します。この時間と同じかそれ以降のタイムスタンプを持つイベントは含まれません。時間要素 (分、秒など) は省略可能です。デフォルト値は現在の時刻です。
**--filters *FILTER* [*FILTER* ...]**
ログのフィルタを指定します。形式: `Name=a,Values=1 Name=b,Values=2,3`。サポートされているフィルタ:
`private-dns-name`
インスタンスのプライベート DNS 名の短縮形を指定します (例: `ip-10-0-0-101`)。
`node-type`
ノードタイプを指定します。このフィルターで受け入れられる値は `HeadNode` のみです。
**--keep-s3-objects *KEEP\$1S3\$1OBJECTS***
`true` の場合は、Amazon S3 にエクスポートされたオブジェクトが保持されます。(デフォルトは `false` です)
**--output-file *OUTPUT\$1FILE***
ログアーカイブを保存するファイルパスを指定します。これが指定された場合、ログはローカルに保存されます。それ以外の場合は、Amazon S3 にアップロードされ、出力に URL が返されます。デフォルトでは、Amazon S3 にアップロードされます。
**--region, -r *REGION***
AWS リージョン 使用する を指定します。`AWS_DEFAULT_REGION` 環境変数、 `~/.aws/config` ファイルの `[default]`セクションの `region`設定、または `--region`パラメータを使用して、 を指定 AWS リージョン する必要があります。
**--start-time *START\$1TIME***
時間範囲の開始時刻を ISO 8601 形式 (`YYYY-MM-DDThh:mm:ssZ`、例えば `2021-01-01T20:00:00Z`) で指定します。タイムスタンプがこの時間に等しいか、この時間よりも遅いログイベントが含まれます。指定されていない場合、デフォルトはクラスターが作成された時刻です。
** AWS ParallelCluster バージョン 3.1.4 の使用例:**
```
$ pcluster export-cluster-logs --bucket cluster-v3-bucket -n cluster-v3
{
"url": "https://cluster-v3-bucket..."
}
```
## ログを取得できませんか?
`export-cluster-logs` コマンドを使用してログを取得できない場合は、次のいずれかを実行します。
+ クラスターの CloudWatch ロググループからログを手動で取得します。
+ ロググループが空の場合は、クラスターノードに SSH 接続し、 にリストされているログを取得します[ノードの初期化に関する問題のトラブルシューティング](troubleshooting-v3-scaling-issues.md#troubleshooting-v3-node-init)。
+ クラスターの作成に失敗したためにクラスターノードにアクセスできない場合は、 オプションを使用してクラスターを再作成`--rollback-on-failure false`し、ノードからログを取得します。
# `pcluster export-image-logs`
Image Builder スタックのログを Amazon S3 バケットを経由して、ローカルの `tar.gz` アーカイブにエクスポートします。
```
pcluster export-image-logs [-h]
--image-id IMAGE_ID
[--bucket BUCKET]
[--bucket-prefix BUCKET_PREFIX]
[--debug]
[--end-time END_TIME]
[--keep-s3-objects KEEP_S3_OBJECTS]
[--output-file OUTPUT_FILE]
[--region REGION]
[--start-time START_TIME]
```
**注記**
`export-image-logs` コマンドは CloudWatch Logs がログのエクスポートを完了するのを待つため、出力なしで一定期間が発生することが予想されます。
## 名前付き引数
**-h, --help**
`pcluster export-image-logs` のヘルプテキストを表示します。
**--bucket *BUCKET\$1NAME***
イメージビルドログのエクスポート先の Amazon S3 バケット名を指定します。イメージと同じリージョンである必要があります。
+ CloudWatch にアクセスを許可するために、Amazon S3 バケットポリシーに対するアクセス許可を追加する必要があります。詳細については、CloudWatch Logs ユーザーガイドの[Amazon S3バケットに対するアクセス許可の設定](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/S3ExportTasks.html#S3Permissions)」を参照してください。 *CloudWatch *
+ AWS ParallelCluster バージョン **3.12.0** 以降、 `--bucket`オプションは**オプション**です。オプションが指定されていない場合は、リージョンの AWS ParallelCluster デフォルトバケット (`parallelcluster-hash-v1-DO-NOT-DELETE`) が使用されます。 `CustomS3Bucket`がイメージ設定で指定されている場合は、 が使用されます。
AWS ParallelCluster デフォルトのバケットが使用されている場合、pcluster はバケットポリシーの設定を処理します。 AWS ParallelCluster バージョン **3.12.0** にアップグレードする前にバケットポリシーをカスタマイズすると、バケットポリシーは上書きされ、変更を再適用する必要があります。
**--image-id, -i *IMAGE\$1ID***
ログがエクスポートされるイメージ ID。
**--bucket-prefix *BUCKET\$1PREFIX***
エクスポートされたログデータが Amazon S3 バケットに格納されるパスを指定します。
デフォルトでは、バケットプレフィックスは次のとおりです。
```
ami-id-logs-202209061743.tar.gz
```
`202209061743` は現在の時刻を `%Y%m%d%H%M` フォーマットで表示します。
AWS ParallelCluster バージョン **3.12.0** 以降では、 `--bucket`オプションを指定せず、デフォルトの AWS ParallelCluster バケットを使用する場合は、内部使用用に予約された保護されたフォルダであるため、 `parallelcluster/` フォルダにログをエクスポートすることはできません。
**--debug**
デバッグログの有効化
**--end-time *END\$1TIME***
ログイベントを収集する時間範囲の終わりを指定し、ISO 8601 形式 (`YYYY-MM-DDThh:mm:ssZ`、例えば `2021-01-01T20:00:00Z`) で表します。この時間と同じかそれ以降のタイムスタンプを持つイベントは含まれません。時間要素 (分、秒など) は省略可能です。デフォルト値は現在の時刻です。
**--keep-s3-objects *KEEP\$1S3\$1OBJECTS***
`true` の場合は、Amazon S3 にエクスポートされたオブジェクトが保持されます。(デフォルトは `false` です)
**--output-file *OUTPUT\$1FILE***
ログアーカイブを保存するファイルパスを指定します。これが指定された場合、ログはローカルに保存されます。それ以外の場合は、Amazon S3 にアップロードされ、出力に URL が返されます。デフォルトでは、Amazon S3 にアップロードされます。
**--region, -r *REGION***
AWS リージョン 使用する を指定します。`AWS_DEFAULT_REGION` 環境変数、 `~/.aws/config` ファイルの `[default]`セクションの `region`設定、または `--region`パラメータを使用して、 を指定 AWS リージョン する必要があります。
**--start-time *START\$1TIME***
時間範囲の開始時刻を ISO 8601 形式 (`YYYY-MM-DDThh:mm:ssZ`、例えば `2021-01-01T20:00:00Z`) で指定します。タイムスタンプがこの時間に等しいか、この時間よりも遅いログイベントが含まれます。指定されていない場合、デフォルトはクラスターが作成された時刻です。
** AWS ParallelCluster バージョン 3.1.4 の使用例:**
```
$ pcluster export-image-logs --bucket image-v3-bucket --image-id ami-1234abcd5678efgh
{
"url": "https://image-v3-bucket..."
}
```
# `pcluster get-cluster-log-events`
ログストリームに関連するイベントを取得します。
```
pcluster get-cluster-log-events [-h]
--cluster-name CLUSTER_NAME
--log-stream-name LOG_STREAM_NAME
[--debug]
[--end-time END_TIME]
[--limit LIMIT]
[--next-token NEXT_TOKEN]
[--query QUERY]
[--region REGION]
[--start-from-head START_FROM_HEAD]
[--start-time START_TIME]
```
## 名前付き引数
**-h, --help**
`pcluster get-cluster-log-events` のヘルプテキストを表示します。
**--cluster-name, -n *CLUSTER\$1NAME***
クラスターの名前を指定します。
**--log-stream-name *LOG\$1STREAM\$1NAME***
ログストリームの名前を指定します。`list-cluster-log-streams` コマンドを使用して、1 つまたは複数のイベントに関連するログストリームを取得できます。
**--debug**
デバッグログの有効化
**--end-time *END\$1TIME***
時間範囲の終了時刻を指定し、ISO 8601 形式 (`YYYY-MM-DDThh:mm:ssZ`、例えば `2021-01-01T20:00:00Z`) で表します。この時間と同じかそれ以降のタイムスタンプを持つイベントは含まれません。
**--limit *LIMIT***
返されるログイベントの最大数数を指定します。値が指定されていない場合、最大値は 1 MB の応答サイズに収まるログイベントの数で、最大 10,000 ログイベントまでとなります。
**--next-token *NEXT\$1TOKEN***
次の結果セットのトークン。
**--query *QUERY***
出力に対して実行する JMESPath クエリを指定します。
**--region, -r *REGION***
AWS リージョン 使用する を指定します。`AWS_DEFAULT_REGION` 環境変数、 `~/.aws/config` ファイルの `[default]`セクションの `region`設定、または `--region`パラメータを使用して、 を指定 AWS リージョン する必要があります。
**--start-from-head *START\$1FROM\$1HEAD***
値が `true` の場合、最も古いログイベントが最初に返されます。値が `false` の場合、最も新しいログイベントが最初に返されます。(デフォルトは `false` です)
**--start-time *START\$1TIME***
時間範囲の開始時刻を ISO 8601 形式 (`YYYY-MM-DDThh:mm:ssZ`、例えば `2021-01-01T20:00:00Z`) で指定します。タイムスタンプがこの時間と同じか、この時間よりも遅いイベントが含まれます。
** AWS ParallelCluster バージョン 3.1.4 の使用例:**
```
$ pcluster get-cluster-log-events \
-c cluster-v3 \
-r us-east-1 \
--log-stream-name ip-198-51-100-44.i-1234567890abcdef0.clustermgtd \
--limit 3
{
"nextToken": "f/36966906399261933213029082268132291405859205452101451780/s",
"prevToken": "b/36966906399239632467830551644990755687586557090595471362/s",
"events": [
{
"message": "2022-07-12 19:16:53,379 - [slurm_plugin.clustermgtd:_maintain_nodes] - INFO - Performing node maintenance actions",
"timestamp": "2022-07-12T19:16:53.379Z"
},
{
"message": "2022-07-12 19:16:53,380 - [slurm_plugin.clustermgtd:_maintain_nodes] - INFO - Following nodes are currently in replacement: (x0) []",
"timestamp": "2022-07-12T19:16:53.380Z"
},
{
"message": "2022-07-12 19:16:53,380 - [slurm_plugin.clustermgtd:_terminate_orphaned_instances] - INFO - Checking for orphaned instance",
"timestamp": "2022-07-12T19:16:53.380Z"
}
]
}
```
# `pcluster get-cluster-stack-events`
指定されたクラスターのスタックに関連するイベントを取得します。
**注記**
バージョン 3.6.0 以降、 はネストされたスタック AWS ParallelCluster を使用して、キューとコンピューティングリソースに関連付けられたリソースを作成します。`GetClusterStackEvents` API と `pcluster get-cluster-stack-events` コマンドはクラスターのメインスタックイベントのみを返します。キューやコンピュートリソースに関連するものを含むクラスタースタックイベントは、CloudFormation コンソールで表示できます。
```
pcluster get-cluster-stack-events [-h]
--cluster-name CLUSTER_NAME
[--debug]
[--next-token NEXT_TOKEN]
[--query QUERY]
[--region REGION]
```
## 名前付き引数
**-h, --help**
`pcluster get-cluster-stack-events` のヘルプテキストを表示します。
**--cluster-name, -n *CLUSTER\$1NAME***
クラスターの名前を指定します。
**--debug**
デバッグログの有効化
**--next-token *NEXT\$1TOKEN***
次の結果セットのトークン。
**--query *QUERY***
出力に対して実行する JMESPath クエリを指定します。
**--region, -r *REGION***
AWS リージョン 使用する を指定します。`AWS_DEFAULT_REGION` 環境変数、 `~/.aws/config` ファイルの `[default]`セクションの `region`設定、または `--region`パラメータを使用して、 を指定 AWS リージョン する必要があります。
** AWS ParallelCluster バージョン 3.1.4 の使用例:**
```
$ pcluster get-cluster-stack-events \
-n cluster-v3 \
-r us-east-1 \
--query "events[0]"
{
"eventId": "1234abcd-56ef-78gh-90ij-abcd1234efgh",
"physicalResourceId": "arn:aws:cloudformation:us-east-1:123456789012:stack/cluster-v3/1234abcd-56ef-78gh-90ij-abcd1234efgh",
"resourceStatus": "CREATE_COMPLETE",
"stackId": "arn:aws:cloudformation:us-east-1:123456789012:stack/cluster-v3/1234abcd-56ef-78gh-90ij-abcd1234efgh",
"stackName": "cluster-v3",
"logicalResourceId": "cluster-v3",
"resourceType": "AWS::CloudFormation::Stack",
"timestamp": "2022-07-12T18:29:12.140Z"
}
```
# `pcluster get-image-log-events`
イメージビルドに関連付けられたログイベントを取得します。
```
pcluster get-image-log-events [-h]
--image-id IMAGE_ID
--log-stream-name LOG_STREAM_NAME
[--debug]
[--end-time END_TIME]
[--limit LIMIT]
[--next-token NEXT_TOKEN]
[--query QUERY]
[--region REGION]
[--start-from-head START_FROM_HEAD]
[--start-time START_TIME]
```
## 名前付き引数
**-h, --help**
`pcluster get-image-log-events` のヘルプテキストを表示します。
**--image-id, -i *IMAGE\$1ID***
イメージの ID を指定します。
**--log-stream-name *LOG\$1STREAM\$1NAME***
ログストリームの名前を指定します。`list-image-log-streams` コマンドを使用して、1 つまたは複数のイベントに関連するログストリームを取得できます。
**--debug**
デバッグログの有効化
**--end-time *END\$1TIME***
時間範囲の終了時刻を指定し、ISO 8601 形式 (`YYYY-MM-DDThh:mm:ssZ`、例えば `2021-01-01T20:00:00Z`) で表します。この時間と同じかそれ以降のタイムスタンプを持つイベントは含まれません。
**--limit *LIMIT***
返されるログイベントの最大数数を指定します。値が指定されていない場合、最大値は 1 MB の応答サイズに収まるログイベントの数で、最大 10,000 ログイベントまでとなります。
**--next-token *NEXT\$1TOKEN***
次の結果セットのトークン。
**--query *QUERY***
出力に対して実行する JMESPath クエリを指定します。
**--region, -r *REGION***
AWS リージョン 使用する を指定します。`AWS_DEFAULT_REGION` 環境変数、 `~/.aws/config` ファイルの `[default]`セクションの `region`設定、または `--region`パラメータを使用して、 を指定 AWS リージョン する必要があります。
**--start-from-head *START\$1FROM\$1HEAD***
値が `true` の場合、最も古いログイベントが最初に返されます。値が `false` の場合、最も新しいログイベントが最初に返されます。(デフォルトは `false` です)
**--start-time *START\$1TIME***
時間範囲の開始時刻を ISO 8601 形式 (`YYYY-MM-DDThh:mm:ssZ`、例えば `2021-01-01T20:00:00Z`) で指定します。この時間と同じかそれ以降のタイムスタンプを持つイベントが含まれます。
** AWS ParallelCluster バージョン 3.1.2 の使用例:**
```
$ pcluster get-image-log-events --image-id custom-alinux2-image --region us-east-1 --log-stream-name 3.1.2/1 --limit 3
{
"nextToken": "f/36778317771100849897800729464621464113270312017760944178/s",
"prevToken": "b/36778317766952911290874033560295820514557716777648586800/s",
"events": [
{
"message": "ExecuteBash: FINISHED EXECUTION",
"timestamp": "2022-04-05T22:13:26.633Z"
},
{
"message": "Document arn:aws:imagebuilder:us-east-1:123456789012:component/parallelclusterimage-test-1234abcd-56ef-78gh-90ij-abcd1234efgh/3.1.2/1",
"timestamp": "2022-04-05T22:13:26.741Z"
},
{
"message": "TOE has completed execution successfully",
"timestamp": "2022-04-05T22:13:26.819Z"
}
]
}
```
# `pcluster get-image-stack-events`
指定されたイメージビルドのスタックに関連するイベントを取得します。
```
pcluster get-image-stack-events [-h]
--image-id IMAGE_ID
[--debug]
[--next-token NEXT_TOKEN]
[--query QUERY]
[--region REGION]
```
## 名前付き引数
**-h, --help**
`pcluster get-image-stack-events` のヘルプテキストを表示します。
**--image-id, -i *IMAGE\$1ID***
イメージの ID を指定します。
**--debug**
デバッグログの有効化
**--next-token *NEXT\$1TOKEN***
次の結果セットのトークン。
**--query *QUERY***
出力に対して実行する JMESPath クエリを指定します。
**--region, -r *REGION***
AWS リージョン 使用する を指定します。`AWS_DEFAULT_REGION` 環境変数、 `~/.aws/config` ファイルの `[default]`セクションの `region`設定、または `--region`パラメータを使用して、 を指定 AWS リージョン する必要があります。
** AWS ParallelCluster バージョン 3.1.2 の使用例:**
```
$ pcluster get-image-stack-events --image-id custom-alinux2-image --region us-east-1 --query "events[0]"
{
"eventId": "ParallelClusterImage-CREATE_IN_PROGRESS-2022-04-05T21:39:24.725Z",
"physicalResourceId": "arn:aws:imagebuilder:us-east-1:123456789012:image/parallelclusterimage-custom-alinux2-image/3.1.2/1",
"resourceStatus": "CREATE_IN_PROGRESS",
"resourceStatusReason": "Resource creation Initiated",
"resourceProperties": "{\"InfrastructureConfigurationArn\":\"arn:aws:imagebuilder:us-east-1:123456789012:infrastructure-configuration/parallelclusterimage-1234abcd-56ef-78gh-90ij-abcd1234efgh\",\"ImageRecipeArn\":\"arn:aws:imagebuilder:us-east-1:123456789012:image-recipe/parallelclusterimage-custom-alinux2-image/3.1.2\",\"DistributionConfigurationArn\":\"arn:aws:imagebuilder:us-east-1:123456789012:distribution-configuration/parallelclusterimage-1234abcd-56ef-78gh-90ij-abcd1234efgh\",\"EnhancedImageMetadataEnabled\":\"false\",\"Tags\":{\"parallelcluster:image_name\":\"custom-alinux2-image\",\"parallelcluster:image_id\":\"custom-alinux2-image\"}}",
"stackId": "arn:aws:cloudformation:us-east-1:123456789012:stack/custom-alinux2-image/1234abcd-56ef-78gh-90ij-abcd1234efgh",
"stackName": "custom-alinux2-image",
"logicalResourceId": "ParallelClusterImage",
"resourceType": "AWS::ImageBuilder::Image",
"timestamp": "2022-04-05T21:39:24.725Z"
}
```
# `pcluster list-clusters`
既存のクラスターのリストを取得します。
```
pcluster list-clusters [-h]
[--cluster-status {CREATE_IN_PROGRESS,CREATE_FAILED,CREATE_COMPLETE,
DELETE_IN_PROGRESS,DELETE_FAILED,UPDATE_IN_PROGRESS,
UPDATE_COMPLETE,UPDATE_FAILED}
[{CREATE_IN_PROGRESS,CREATE_FAILED,CREATE_COMPLETE,
DELETE_IN_PROGRESS,DELETE_FAILED,UPDATE_IN_PROGRESS,
UPDATE_COMPLETE,UPDATE_FAILED} ...]]
[--debug]
[--next-token NEXT_TOKEN]
[--query QUERY]
[--region REGION]
```
## 名前付き引数
**-h, --help**
`pcluster list-clusters` のヘルプテキストを表示します。
**--cluster-status \$1`CREATE_IN_PROGRESS`, `CREATE_FAILED`, `CREATE_COMPLETE`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`, `UPDATE_IN_PROGRESS`, `UPDATE_COMPLETE`, `UPDATE_FAILED`\$1 [\$1`CREATE_IN_PROGRESS`, `CREATE_FAILED`, `CREATE_COMPLETE`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`, `UPDATE_IN_PROGRESS`, `UPDATE_COMPLETE`, `UPDATE_FAILED`\$1 ...]**
フィルタリングの対象となるクラスターステータスのリストを指定します。(デフォルトは `all` です)
**--debug**
デバッグログの有効化
**--next-token *NEXT\$1TOKEN***
次の結果セットのトークン。
**--query *QUERY***
出力に対して実行する JMESPath クエリを指定します。
**--region, -r *REGION***
AWS リージョン 使用する を指定します。`AWS_DEFAULT_REGION` 環境変数、 `~/.aws/config` ファイルの `[default]`セクションの `region`設定、または `--region`パラメータを使用して、 を指定 AWS リージョン する必要があります。
** AWS ParallelCluster バージョン 3.1.4 の使用例:**
```
$ pcluster list-clusters
{
"clusters": [
{
"clusterName": "cluster-v3",
"cloudformationStackStatus": "CREATE_COMPLETE",
"cloudformationStackArn": "arn:aws:cloudformation:us-east-1:123456789012:stack/cluster-v3/1234abcd-56ef-78gh-90ij-abcd1234efgh",
"region": "us-east-1",
"version": "3.1.4",
"clusterStatus": "CREATE_COMPLETE"
}
]
}
```
# `pcluster list-cluster-log-streams`
クラスターに関連付けられているログストリームのリストを取得します。
```
pcluster list-cluster-log-streams [-h]
--cluster-name CLUSTER_NAME
[--filters FILTERS [FILTERS ...]]
[--next-token NEXT_TOKEN] [--debug]
[--query QUERY]
[--region REGION]
```
## 名前付き引数
**-h, --help**
`pcluster list-cluster-log-streams` のヘルプテキストを表示します。
**--cluster-name, -n *CLUSTER\$1NAME***
クラスターの名前を指定します。
**--debug**
デバッグログの有効化
**--filters *FILTERS* [*FILTERS* ...]**
ログストリームのフィルタを指定します。形式: `Name=a,Values=1 Name=b,Values=2,3`。サポートされているフィルタ:
`private-dns-name`
インスタンスのプライベート DNS 名の短縮形を指定します (例: `ip-10-0-0-101`)。
`node-type`
ノードタイプを指定します。このフィルターで受け入れられる値は `HeadNode` のみです。
**--next-token *NEXT\$1TOKEN***
次の結果セットのトークン。
**--query *QUERY***
出力に対して実行する JMESPath クエリを指定します。
**--region, -r *REGION***
AWS リージョン 使用する を指定します。`AWS_DEFAULT_REGION` 環境変数、 `~/.aws/config` ファイルの `[default]`セクションの `region`設定、または `--region`パラメータを使用して、 を指定 AWS リージョン する必要があります。
** AWS ParallelCluster バージョン 3.1.4 の使用例:**
```
$ pcluster list-cluster-log-streams \
-n cluster-v3 \
-r us-east-1 \
--query 'logStreams[*].logStreamName'
[
"ip-172-31-58-205.i-1234567890abcdef0.cfn-init",
"ip-172-31-58-205.i-1234567890abcdef0.chef-client",
"ip-172-31-58-205.i-1234567890abcdef0.cloud-init",
"ip-172-31-58-205.i-1234567890abcdef0.clustermgtd",
"ip-172-31-58-205.i-1234567890abcdef0.slurmctld",
"ip-172-31-58-205.i-1234567890abcdef0.supervisord",
"ip-172-31-58-205.i-1234567890abcdef0.system-messages"
]
```
# `pcluster list-images`
既存のカスタムイメージのリストを取得します。
```
pcluster list-images [-h]
--image-status {AVAILABLE,PENDING,FAILED}
[--debug]
[--next-token NEXT_TOKEN]
[--query QUERY]
[--region REGION]
```
## 名前付き引数
**-h, --help**
`pcluster list-images` のヘルプテキストを表示します。
**--image-status \$1`AVAILABLE`,`PENDING`,`FAILED`\$1**
指定されたステータスでイメージを返します。
**--debug**
デバッグログの有効化
**--next-token *NEXT\$1TOKEN***
次の結果セットのトークン。
**--query *QUERY***
出力に対して実行する JMESPath クエリを指定します。
**--region, -r *REGION***
AWS リージョン 使用する を指定します。`AWS_DEFAULT_REGION` 環境変数、 `~/.aws/config` ファイルの `[default]`セクションの `region`設定、または `--region`パラメータを使用して、 を指定 AWS リージョン する必要があります。
** AWS ParallelCluster バージョン 3.1.2 の使用例:**
```
$ pcluster list-images --image-status AVAILABLE
{
"images": [
{
"imageId": "custom-alinux2-image",
"imageBuildStatus": "BUILD_COMPLETE",
"ec2AmiInfo": {
"amiId": "ami-1234abcd5678efgh"
},
"region": "us-east-1",
"version": "3.1.2"
}
]
}
```
# `pcluster list-image-log-streams`
イメージに関連付けられたログストリームのリストを取得します。
```
pcluster list-image-log-streams [-h]
--image-id IMAGE_ID
[--next-token NEXT_TOKEN] [--debug]
[--query QUERY]
[--region REGION]
```
## 名前付き引数
**-h, --help**
`pcluster list-image-log-streams` のヘルプテキストを表示します。
**--image-id, -i *IMAGE\$1ID***
イメージの ID を指定します。
**--debug**
デバッグログの有効化
**--next-token *NEXT\$1TOKEN***
次の結果セットのトークン。
**--query *QUERY***
出力に対して実行する JMESPath クエリを指定します。
**--region, -r *REGION***
AWS リージョン 使用する を指定します。`AWS_DEFAULT_REGION` 環境変数、 `~/.aws/config` ファイルの `[default]`セクションの `region`設定、または `--region`パラメータを使用して、 を指定 AWS リージョン する必要があります。
** AWS ParallelCluster バージョン 3.1.2 の使用例:**
```
$ pcluster list-image-log-streams --image-id custom-alinux2-image --region us-east-1 --query 'logStreams[*].logStreamName'
[
"3.0.0/1",
"3.1.2/1"
]
```
# `pcluster list-official-images`
AWS ParallelCluster AMIs。
```
pcluster list-official-images [-h]
[--architecture ARCHITECTURE]
[--debug]
[--os OS]
[--query QUERY]
[--region REGION]
```
## 名前付き引数
**-h, --help**
`pcluster list-official-images` のヘルプテキストを表示します。
**--architecture *ARCHITECTURE***
検索結果のフィルタリングに使用するアーキテクチャを指定します。このパラメータが指定されていない場合は、すべてのアーキテクチャが返されます。
**--debug**
デバッグログの有効化
**--os *OS***
結果のフィルタリングに使用するオペレーティングシステムを指定します。このパラメータが指定されていない場合は、すべてのオペレーティングシステムが返されます。
**--query *QUERY***
出力に対して実行する JMESPath クエリを指定します。
**--region, -r *REGION***
AWS リージョン 使用する を指定します。イメージ設定ファイルの[リージョン](image-builder-configuration-file-v3.md#yaml-build-image-Region)設定、`AWS_DEFAULT_REGION`環境変数、`~/.aws/config`ファイルの `[default]`セクションの `region`設定、または `--region`パラメータを使用して、 を指定 AWS リージョン する必要があります。
** AWS ParallelCluster バージョン 3.1.2 の使用例:**
```
$ pcluster list-official-images
{
"images": [
{
"amiId": "ami-015cfeb4e0d6306b2",
"os": "ubuntu2204",
"name": "aws-parallelcluster-3.1.2-ubuntu-2204-lts-hvm-x86_64-202202261505 2022-02-26T15-08-34.759Z",
"version": "3.1.2",
"architecture": "x86_64"
},
{
"amiId": "ami-036f23237ce49d25b",
"os": "ubuntu2204",
"name": "aws-parallelcluster-3.1.2-ubuntu-1804-lts-hvm-x86_64-202202261505 2022-02-26T15-08-17.558Z",
"version": "3.1.2",
"architecture": "x86_64"
},
{
"amiId": "ami-09e5327e694d89ef4",
"os": "ubuntu2204",
"name": "aws-parallelcluster-3.1.2-ubuntu-2204-lts-hvm-arm64-202202261505 2022-02-26T15-08-45.736Z",
"version": "3.1.2",
"architecture": "arm64"
},
{
"amiId": "ami-0b9b0874c35f626ae",
"os": "alinux2",
"name": "aws-parallelcluster-3.1.2-amzn2-hvm-x86_64-202202261505 2022-02-26T15-08-31.311Z",
"version": "3.1.2",
"architecture": "x86_64"
},
{
"amiId": "ami-0d0de4f95f56374bc",
"os": "alinux2",
"name": "aws-parallelcluster-3.1.2-amzn2-hvm-arm64-202202261505 2022-02-26T15-08-46.088Z",
"version": "3.1.2",
"architecture": "arm64"
},
{
"amiId": "ami-0ebf7bc54b8740dc6",
"os": "ubuntu2204",
"name": "aws-parallelcluster-3.1.2-ubuntu-1804-lts-hvm-arm64-202202261505 2022-02-26T15-08-45.293Z",
"version": "3.1.2",
"architecture": "arm64"
}
]
}
```
# `pcluster ssh`
事前に入力されているクラスターのユーザー名と IP アドレスを使用して `ssh` コマンドを実行します。。任意の引数は `ssh` コマンドラインの末尾に付加されます。
```
pcluster ssh [-h]
--cluster-name CLUSTER_NAME
[--debug]
[--dryrun DRYRUN]
[--region REGION]
```
## 名前付き引数
**-h, --help**
`pcluster ssh` のヘルプテキストを表示します。
**--cluster-name, -n *CLUSTER\$1NAME***
接続するクラスターの名前を指定します。
**--debug**
デバッグログの有効化
**--dryrun *DRYRUN***
`true` の場合、実行するコマンドラインを出力して終了します。(デフォルトは `false` です)
**--region, -r *REGION***
AWS リージョン 使用する を指定します。`AWS_DEFAULT_REGION` 環境変数、 `~/.aws/config` ファイルの `[default]`セクションの `region`設定、または `--region`パラメータを使用して、 を指定 AWS リージョン する必要があります。
例:
```
$ pcluster ssh --cluster-name mycluster -i ~/.ssh/id_rsa
```
事前に入力されているクラスターのユーザー名と IP アドレスを使用して `ssh` コマンドを実行します。
```
ssh ec2-user@1.1.1.1 -i ~/.ssh/id_rsa
```
# `pcluster update-cluster`
既存のクラスターを、指定された設定ファイルの設定に合わせて更新します。
**注記**
クラスターの更新は、すべてのクラスターノードが正常に更新を適用した場合にのみ成功します。更新が失敗した場合、トラブルシューティングのガイダンスについては、[`pcluster describe-cluster` コマンドで `clusterStatus` が `UPDATE_FAILED` であることが表示されている](troubleshooting-fc-v3-update-cluster.md#update-cluster-failure-v3)「」セクションを参照してください。
```
pcluster update-cluster [-h]
--cluster-configuration CLUSTER_CONFIGURATION
--cluster-name CLUSTER_NAME
[--debug]
[--dryrun DRYRUN]
[--force-update FORCE_UPDATE]
[--query QUERY]
[--region REGION]
[--suppress-validators SUPPRESS_VALIDATORS [SUPPRESS_VALIDATORS ...]]
[--validation-failure-level {INFO,WARNING,ERROR}]
```
## 名前付き引数
**-h, --help**
`pcluster update-cluster` のヘルプテキストを表示します。
**--cluster-configuration, -c *CLUSTER\$1CONFIGURATION***
YAML クラスター設定ファイルを指定します。
**--cluster-name, -n *CLUSTER\$1NAME***
クラスターの名前を指定します。
**--debug**
デバッグログの有効化
**--dryrun *DRYRUN***
`true` の場合、クラスターを更新やリソースを作成することなく、検証を実行します。イメージの構成や更新の要件を検証するために使用することができます。(デフォルトは `false` です)
**--force-update *FORCE\$1UPDATE***
`true` の場合、更新検証のエラーを無視して、強制的に更新を行います。(デフォルトは `false` です)
**--query *QUERY***
出力に対して実行する JMESPath クエリを指定します。
**--region, -r *REGION***
AWS リージョン 使用する を指定します。クラスター設定ファイルの [`Region`](cluster-configuration-file-v3.md#yaml-Region)設定、 `AWS_DEFAULT_REGION`環境変数、 `~/.aws/config` ファイルの `[default]`セクションの `region`設定、または `--region`パラメータを使用して、 を指定 AWS リージョン する必要があります。
**--suppress-validators * SUPPRESS\$1VALIDATORS* [*SUPPRESS\$1VALIDATORS ...*]**
抑制する 1 つまたは複数のコンフィグバリデータを指定します。
形式: (`ALL`\$1`type:[A-Za-z0-9]+`)
**--validation-failure-level *\$1INFO,WARNING,ERROR\$1***
更新時に報告される検証エラーのレベルを指定します。
** AWS ParallelCluster バージョン 3.1.4 の使用例:**
```
$ pcluster update-cluster -c cluster-config.yaml -n cluster-v3 -r us-east-1
{
"cluster": {
"clusterName": "cluster-v3",
"cloudformationStackStatus": "UPDATE_IN_PROGRESS",
"cloudformationStackArn": "arn:aws:cloudformation:us-east-1:123456789012:stack/cluster-v3/1234abcd-56ef-78gh-90ij-abcd1234efgh",
"region": "us-east-1",
"version": "3.1.4",
"clusterStatus": "UPDATE_IN_PROGRESS"
},
"changeSet": [
{
"parameter": "HeadNode.Iam.S3Access",
"requestedValue": {
"BucketName": "amzn-s3-demo-bucket1",
"KeyName": "output",
"EnableWriteAccess": false
}
},
{
"parameter": "HeadNode.Iam.S3Access",
"currentValue": {
"BucketName": "amzn-s3-demo-bucket2",
"KeyName": "logs",
"EnableWriteAccess": true
}
}
]
}
```
# `pcluster update-compute-fleet`
クラスターコンピューティングフリートの状態を更新します。
```
pcluster update-compute-fleet [-h]
--cluster-name CLUSTER_NAME
--status {START_REQUESTED,STOP_REQUESTED,ENABLED,DISABLED}
[--debug]
[--query QUERY]
[--region REGION]
```
## 名前付き引数
**-h, --help**
`pcluster update-compute-fleet` のヘルプテキストを表示します。
**--cluster-name, -n *CLUSTER\$1NAME***
クラスターの名前を指定します。
**--status \$1START\$1REQUESTED,STOP\$1REQUESTED,ENABLED,DISABLED\$1**
クラスターコンピューティングフリートに適用されるステータスを指定します。ステータス`START_REQUESTED`と `STOP_REQUESTED`はスSlurmケジューラに対応し、ステータス`ENABLED`と はス AWS Batch ケジューラ`DISABLED`に対応します。
**--debug**
デバッグログの有効化
**--query *QUERY***
出力に対して実行する JMESPath クエリを指定します。
**--region, -r *REGION***
AWS リージョン 使用する を指定します。`AWS_DEFAULT_REGION` 環境変数、 `~/.aws/config` ファイルの `[default]`セクションの `region`設定、または `--region`パラメータを使用して、 を指定 AWS リージョン する必要があります。
** AWS ParallelCluster バージョン 3.1.4 の使用例:**
```
$ pcluster update-compute-fleet -n cluster-v3 --status STOP_REQUESTED
{
"status": "STOP_REQUESTED",
"lastStatusUpdatedTime": "2022-07-12T20:19:47.653Z"
}
```
# `pcluster version`
のバージョンを表示します AWS ParallelCluster。
```
pcluster version [-h] [--debug]
```
## 名前付き引数
**-h, --help**
`pcluster version` のヘルプテキストを表示します。
**--debug**
デバッグログの有効化
** AWS ParallelCluster バージョン 3.1.4 の使用例:**
```
$ pcluster version
{
"version": "3.1.4"
}
```
# `pcluster3-config-converter`
AWS ParallelCluster バージョン 2 の設定ファイルを読み取り、 AWS ParallelCluster バージョン 3 の設定ファイルを書き込みます。
```
pcluster3-config-converter [-h]
[-t CLUSTER_TEMPLATE]
[-c CONFIG_FILE]
[--force-convert]
[-o OUTPUT_FILE]
```
## 名前付き引数
**-h, --help**
`pcluster3-config-converter` のヘルプテキストを表示します。
**-t *CLUSTER\$1TEMPLATE*, --cluster-template *CLUSTER\$1TEMPLATE***
変換するコンフィグレーションファイルの [`[cluster]` セクション](https://docs.aws.amazon.com/parallelcluster/v2/ug/cluster-definition.html)を指定します。指定されていない場合、スクリプトは [`[global]` セクション](https://docs.aws.amazon.com/parallelcluster/v2/ug/global.html)の [cluster-template](https://docs.aws.amazon.com/parallelcluster/v2/ug/global.html#cluster-template) パラメータを検索するか、`[cluster default]` を検索します。
**-c *CONFIG\$1FILE*, --config-file *CONFIG\$1FILE***
読み取る AWS ParallelCluster バージョン 2 の設定ファイルを指定します。
**--force-convert**
1 つ以上の設定がサポートされておらず、推奨されていない場合でも、変換を有効にします。
**-o *OUTPUT\$1FILE*, --output-file *OUTPUT\$1FILE***
書き込む AWS ParallelCluster バージョン 3 の設定ファイルを指定します。このパラメータが指定されていない場合、設定内容は標準出力に書き込まれます。
**注記**
`pcluster3-config-converter` コマンドが AWS ParallelCluster バージョン 3.0.1 に追加されました。