本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
# `pcluster`
`pcluster` 是主要 AWS ParallelCluster CLI 命令。您可以使用 `pcluster` 在 中啟動和管理 HPC 叢集 AWS 雲端。
`pcluster` 會將命令的日誌寫入 中的`pcluster.log.#`檔案`/home/user/.parallelcluster/`。如需詳細資訊，請參閱[`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) [`delete-image`](pcluster.delete-image-v3.md) \$1 \$1 [`describe-cluster`](pcluster.describe-cluster-v3.md) \$1 [`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) [`export-cluster-logs`](pcluster.export-cluster-logs-v3.md) \$1 [`export-image-logs`](pcluster.export-image-logs-v3.md) \$1 [`get-cluster-log-events`](pcluster.get-cluster-log-events-v3.md) \$1 [`get-cluster-stack-events`](pcluster.get-cluster-stack-events-v3.md) \$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 [`list-cluster-log-streams`](pcluster.list-cluster-log-streams-v3.md) \$1 \$1 [`list-images`](pcluster.list-images-v3.md) \$1 [`list-image-log-streams`](pcluster.list-image-log-streams-v3.md) \$1 [`list-official-images`](pcluster.list-official-images-v3.md) \$1 \$1 [`ssh`](pcluster.ssh-v3.md) \$1 [`update-cluster`](pcluster.update-cluster-v3.md) \$1 [`update-compute-fleet`](pcluster.update-compute-fleet-v3.md) [`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 區域 要使用的 。 AWS 區域 必須使用映像組態檔案中[的區域](image-builder-configuration-file-v3.md#yaml-build-image-Region)設定、`AWS_DEFAULT_REGION`環境變數、 `~/.aws/config` 檔案 `[default]`區段中的`region`設定或 `--region` 參數來指定 。
**--rollback-on-failure *ROLLBACK\$1ON\$1FAILURE***
當 時`true`， 會在失敗時自動啟動映像堆疊轉返。（預設為 `false`。)
**--suppress-validators * SUPPRESS\$1VALIDATORS* [*SUPPRESS\$1VALIDATORS ...*]**
識別要隱藏的一或多個組態驗證器。
格式：(`ALL`\$1`type:[A-Za-z0-9]+`)
**--validation-failure-level \$1`INFO`,`WARNING`,`ERROR`\$1**
指定會導致建立失敗的最低驗證層級。（預設為 `ERROR`。)
**使用 3.1.2 AWS ParallelCluster 版的範例：**
```
$ 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 登陸區域，則必須在映像組態檔案中指定子網路 ID。如需詳細資訊，請參閱 [SubnetId](HeadNode-v3.md#yaml-HeadNode-Networking-SubnetId)。
# `pcluster configure`
開始第 3 AWS ParallelCluster 版的互動式組態精靈。如需詳細資訊，請參閱[使用 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 區域 要使用的 。 AWS 區域 必須使用叢集組態檔案中[`Region`](cluster-configuration-file-v3.md#yaml-Region)的設定、`AWS_DEFAULT_REGION`環境變數、 `~/.aws/config` 檔案 `[default]`區段中的`region`設定或 `--region` 參數來指定 。
**--rollback-on-failure *ROLLBACK\$1ON\$1FAILURE***
當 時`true`， 會在失敗時自動啟動叢集堆疊轉返。（預設為 `true`。)
**--suppress-validators *SUPPRESS\$1VALIDATORS* [*SUPPRESS\$1VALIDATORS* ...]**
識別要隱藏的一或多個組態驗證器。
格式：(`ALL`\$1type：`[A-Za-z0-9]+`)
**--validation-failure-level \$1`INFO`,`WARNING`,`ERROR`\$1**
指定會導致建立失敗的最低驗證層級。（預設為 `ERROR`。)
**使用 3.1.4 AWS ParallelCluster 版的範例：**
```
$ 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 地址。使用此引數可讓 連線至叢集中已啟用 DCV 的登入節點。
此引數已新增至 3.11.0 AWS ParallelCluster 版。
**--region, -r *REGION***
指定 AWS 區域 要使用的 。 AWS 區域 必須使用 `AWS_DEFAULT_REGION`環境變數、 `~/.aws/config` 檔案 `[default]`區段中的 `region`設定或 `--region` 參數來指定 。
**--show-url**
列印將用於 DCV 連線的 URL 並結束。
**使用 3.11 AWS ParallelCluster 版的範例**
```
$ 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/zh_tw/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` 參數來指定 區域。
**使用 3.1.4 AWS ParallelCluster 版的範例：**
```
$ 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 區域 必須使用 `AWS_DEFAULT_REGION`環境變數、 `~/.aws/config` 檔案 `[default]`區段中的 `region`設定或 `--region` 參數來指定 。
```
$ 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 區域 必須使用 `AWS_DEFAULT_REGION`環境變數、 `~/.aws/config` 檔案 `[default]`區段中的 `region`設定或 `--region` 參數來指定 。
**使用 3.1.4 AWS ParallelCluster 版的範例：**
```
$ 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 區域 必須使用 `AWS_DEFAULT_REGION`環境變數、 `~/.aws/config` 檔案 `[default]`區段中的 `region`設定或 `--region` 參數來指定 。
**使用 3.1.4 AWS ParallelCluster 版的範例：**
描述叢集詳細資訊：
```
$ 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 區域 必須使用 `AWS_DEFAULT_REGION`環境變數、 `~/.aws/config` 檔案 `[default]`區段中的 `region`設定或 `--region` 參數來指定 。
**使用 3.1.4 AWS ParallelCluster 版的範例：**
```
$ 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 區域 必須使用 `AWS_DEFAULT_REGION`環境變數、 `~/.aws/config` 檔案 `[default]`區段中的 `region`設定或 `--region` 參數來指定 。
**使用 3.1.4 AWS ParallelCluster 版的範例：**
```
$ 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 區域 必須使用 `AWS_DEFAULT_REGION`環境變數、 `~/.aws/config` 檔案 `[default]`區段中的 `region`設定或 `--region` 參數來指定 。
**使用 3.1.2 AWS ParallelCluster 版的範例：**
```
$ 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 儲存貯體名稱。它必須與叢集位於相同的區域。
+ 您必須將許可新增至 Amazon S3 儲存貯體政策，才能授予 CloudWatch 存取。如需詳細資訊，請參閱《*CloudWatch Logs 使用者指南*》中的[設定 Amazon S3 儲存貯體的許可](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/S3ExportTasks.html#S3Permissions)。
+ 從 **3.12.0** AWS ParallelCluster 版開始， `--bucket`選項為**選用**。如果未指定 選項，則會使用區域預設儲存 AWS ParallelCluster 貯體 (`parallelcluster-hash-v1-DO-NOT-DELETE`)，或者如果`CustomS3Bucket`叢集組態中指定了指向 的 Amazon S3 儲存貯體，則會使用該儲存貯體。如果您未指定 `--bucket`選項並使用預設儲存 AWS ParallelCluster 貯體，則無法將日誌匯出至 `parallelcluster/` 資料夾，因為它是保留供內部使用的受保護資料夾。
如果使用 AWS ParallelCluster 預設儲存貯體，則 pcluster 會負責設定儲存貯體政策。如果您自訂儲存貯體政策，然後升級至 AWS ParallelCluster **3.12.0** 版，則會覆寫儲存貯體政策，而且您需要重新套用變更。
**--cluster-name, -n *CLUSTER\$1NAME***
指定叢集的名稱。
**--bucket-prefix *BUCKET\$1PREFIX***
指定 Amazon S3 儲存貯體中要存放匯出日誌資料的路徑。
根據預設，儲存貯體字首為：
```
cluster-name-logs-202209061743.tar.gz
```
`202209061743` 是 `%Y%m%d%H%M` 格式的時間範例。
從 **3.12.0** AWS ParallelCluster 版開始，如果您未指定 `--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***
指定要儲存日誌封存的檔案路徑。如果提供此功能，則日誌會儲存在本機。否則，它們會以輸出中傳回的 URL 上傳至 Amazon S3。預設為上傳至 Amazon S3。
**--region, -r *REGION***
指定 AWS 區域 要使用的 。 AWS 區域 必須使用 `AWS_DEFAULT_REGION`環境變數、 `~/.aws/config` 檔案 `[default]`區段中的 `region`設定或 `--region` 參數來指定 。
**--start-time *START\$1TIME***
指定時間範圍的開始，以 ISO 8601 格式表示 (`YYYY-MM-DDThh:mm:ssZ`例如 `2021-01-01T20:00:00Z`)。包含時間戳記等於或晚於此時間的日誌事件。如果未指定，則預設為建立叢集的時間。
**使用 3.1.4 AWS ParallelCluster 版的範例：**
```
$ 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`
透過傳遞 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 儲存貯體名稱。它必須與影像位於相同的區域。
+ 您必須將許可新增至 Amazon S3 儲存貯體政策，才能授予 CloudWatch 存取。如需詳細資訊，請參閱《*CloudWatch Logs 使用者指南*》中的[設定 Amazon S3 儲存貯體的許可](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/S3ExportTasks.html#S3Permissions)。
+ 從 **3.12.0** AWS ParallelCluster 版開始， `--bucket`選項為**選用**。如果未指定 選項，則會使用區域預設儲存 AWS ParallelCluster 貯體 (`parallelcluster-hash-v1-DO-NOT-DELETE`)，或如果`CustomS3Bucket`已在映像組態中指定 ，則會使用。
如果使用 AWS ParallelCluster 預設儲存貯體，則 pcluster 會負責設定儲存貯體政策。如果您在升級至 **3.12.0** AWS ParallelCluster 版之前自訂儲存貯體政策，將會覆寫儲存貯體政策，而且您將需要重新套用變更。
**--image-id, -i *IMAGE\$1ID***
將匯出其日誌的影像 ID。
**--bucket-prefix *BUCKET\$1PREFIX***
指定 Amazon S3 儲存貯體中要存放匯出日誌資料的路徑。
根據預設，儲存貯體字首為：
```
ami-id-logs-202209061743.tar.gz
```
`202209061743` 是目前時間的`%Y%m%d%H%M`格式。
從 **3.12.0** AWS ParallelCluster 版開始，如果您未指定 `--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***
指定要儲存日誌封存的檔案路徑。如果提供此功能，則日誌會儲存在本機。否則，它們會以輸出中傳回的 URL 上傳至 Amazon S3。預設為上傳至 Amazon S3。
**--region, -r *REGION***
指定 AWS 區域 要使用的 。 AWS 區域 必須使用 `AWS_DEFAULT_REGION`環境變數、 `~/.aws/config` 檔案 `[default]`區段中的 `region`設定或 `--region` 參數來指定 。
**--start-time *START\$1TIME***
指定時間範圍的開始，以 ISO 8601 格式表示 (`YYYY-MM-DDThh:mm:ssZ`例如 `2021-01-01T20:00:00Z`)。包含時間戳記等於或晚於此時間的日誌事件。如果未指定，則預設為建立叢集的時間。
**使用 3.1.4 AWS ParallelCluster 版的範例：**
```
$ 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`命令來擷取與事件相關聯的日誌串流。
**--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 區域 必須使用 `AWS_DEFAULT_REGION`環境變數、 `~/.aws/config` 檔案 `[default]`區段中的 `region`設定或 `--region` 參數來指定 。
**--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`)。包含時間戳記等於此時間或晚於此時間的事件。
**使用 3.1.4 AWS ParallelCluster 版的範例：**
```
$ 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 區域 必須使用 `AWS_DEFAULT_REGION`環境變數、 `~/.aws/config` 檔案 `[default]`區段中的 `region`設定或 `--region` 參數來指定 。
**使用 3.1.4 AWS ParallelCluster 版的範例：**
```
$ 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`命令來擷取與事件相關聯的日誌串流。
**--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 區域 必須使用 `AWS_DEFAULT_REGION`環境變數、 `~/.aws/config` 檔案 `[default]`區段中的 `region`設定或 `--region` 參數來指定 。
**--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`)。包含時間戳記等於或晚於此時間的事件。
**使用 3.1.2 AWS ParallelCluster 版的範例：**
```
$ 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 區域 必須使用 `AWS_DEFAULT_REGION`環境變數、 `~/.aws/config` 檔案 `[default]`區段中的 `region`設定或 `--region` 參數來指定 。
**使用 3.1.2 AWS ParallelCluster 版的範例：**
```
$ 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 區域 必須使用 `AWS_DEFAULT_REGION`環境變數、 `~/.aws/config` 檔案 `[default]`區段中的 `region`設定或 `--region` 參數來指定 。
**使用 3.1.4 AWS ParallelCluster 版的範例：**
```
$ 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 區域 必須使用 `AWS_DEFAULT_REGION`環境變數、 `~/.aws/config` 檔案 `[default]`區段中的 `region`設定或 `--region` 參數來指定 。
**使用 3.1.4 AWS ParallelCluster 版的範例：**
```
$ 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 區域 必須使用 `AWS_DEFAULT_REGION`環境變數、 `~/.aws/config` 檔案 `[default]`區段中的 `region`設定或 `--region` 參數來指定 。
**使用 3.1.2 AWS ParallelCluster 版的範例：**
```
$ 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 區域 必須使用 `AWS_DEFAULT_REGION`環境變數、 `~/.aws/config` 檔案 `[default]`區段中的 `region`設定或 `--region` 參數來指定 。
**使用 3.1.2 AWS ParallelCluster 版的範例：**
```
$ 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 區域 要使用的 。 AWS 區域 必須使用映像組態檔案中[的區域](image-builder-configuration-file-v3.md#yaml-build-image-Region)設定、`AWS_DEFAULT_REGION`環境變數、 `~/.aws/config` 檔案 `[default]`區段中的`region`設定或 `--region` 參數來指定 。
**使用 3.1.2 AWS ParallelCluster 版的範例：**
```
$ 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 區域 必須使用 `AWS_DEFAULT_REGION`環境變數、 `~/.aws/config` 檔案 `[default]`區段中的 `region`設定或 `--region` 參數來指定 。
範例：
```
$ 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`
更新現有叢集以符合指定組態檔案的設定。
**注意**
只有當所有叢集節點都已成功套用更新時，叢集更新才會成功。如果更新失敗，請參閱[使用 `clusterStatus` `UPDATE_FAILED``pcluster describe-cluster`命令查看](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 區域 要使用的 。 AWS 區域 必須使用叢集組態檔案中[`Region`](cluster-configuration-file-v3.md#yaml-Region)的設定、`AWS_DEFAULT_REGION`環境變數、 `~/.aws/config` 檔案 `[default]`區段中的`region`設定或 `--region` 參數來指定 。
**--suppress-validators * SUPPRESS\$1VALIDATORS* [*SUPPRESS\$1VALIDATORS ...*]**
識別要隱藏的一或多個組態驗證器。
格式：(`ALL`\$1`type:[A-Za-z0-9]+`)
**--validation-failure-level *\$1INFO,WARNING,ERROR\$1***
指定回報進行更新的驗證失敗層級。
**使用 3.1.4 AWS ParallelCluster 版的範例：**
```
$ 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`和`DISABLED`對應至 AWS Batch 排程器。
**--debug**
啟用偵錯記錄。
**--query *QUERY***
指定要在輸出上執行的 JMESPath 查詢。
**--region, -r *REGION***
指定 AWS 區域 要使用的 。 AWS 區域 必須使用 `AWS_DEFAULT_REGION`環境變數、 `~/.aws/config` 檔案 `[default]`區段中的 `region`設定或 `--region` 參數來指定 。
**使用 3.1.4 AWS ParallelCluster 版的範例：**
```
$ 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**
啟用偵錯記錄。
**使用 3.1.4 AWS ParallelCluster 版的範例：**
```
$ pcluster version
{
"version": "3.1.4"
}
```