本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# AWS ParallelCluster CLI 命令
AWS ParallelCluster 版本 3 CLI 命令

`pcluster`是主要 AWS ParallelCluster CLI 命令。您可以使用`pcluster`在和中启动和管理 HPC 集群来创建和管理自定义 AMI 映像。 AWS Cloud 

`pcluster3-config-converter`用于将 AWS ParallelCluster 版本 2 格式的集群配置转换为 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 Cloud中启动和管理 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 \$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 \$1 [`delete-image`](pcluster.delete-image-v3.md)\$1 [`describe-cluster`](pcluster.describe-cluster-v3.md)\$1 [`describe-cluster-instances`](pcluster.describe-cluster-instances-v3.md)\$1 \$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)\$1 \$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 \$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 [`list-images`](pcluster.list-images-v3.md)\$1 [`list-image-log-streams`[`list-official-images`](pcluster.list-official-images-v3.md)](pcluster.list-image-log-streams-v3.md)\$1 [`ssh`](pcluster.ssh-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 区域 要使用的。 AWS 区域 必须使用图像配置文件中的 “[区域](image-builder-configuration-file-v3.md#yaml-build-image-Region)” 设置、`AWS_DEFAULT_REGION`环境变量、文件`[default]`部分中的`region``~/.aws/config`设置或`--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`。）

**使用 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 着陆区域），则必须在映像配置文件中指定子网 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 区域 要使用的。必须使用映像配置文件中的 [Region](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`。）

**使用 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 地址。使用该参数可以连接到集群中已启用 DCV 的登录节点。  
此参数已在 3.11.0 AWS ParallelCluster 版本中添加。

**--region, -r *REGION***  
指定 AWS 区域 要使用的。 AWS 区域 必须使用`AWS_DEFAULT_REGION`环境变量、`~/.aws/config`文件`[default]`部分中的`region`设置或`--region`参数来指定。

**--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/zh_cn/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 区域 必须使用`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`参数来指定。

**使用 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 区域 必须使用`AWS_DEFAULT_REGION`环境变量、`~/.aws/config`文件`[default]`部分中的`region`设置或`--region`参数来指定。

**使用 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 区域 必须使用`AWS_DEFAULT_REGION`环境变量、`~/.aws/config`文件`[default]`部分中的`region`设置或`--region`参数来指定。

**使用 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 区域 必须使用`AWS_DEFAULT_REGION`环境变量、`~/.aws/config`文件`[default]`部分中的`region`设置或`--region`参数来指定。

**使用 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 区域 必须使用`AWS_DEFAULT_REGION`环境变量、`~/.aws/config`文件`[default]`部分中的`region`设置或`--region`参数来指定。

**使用 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 存储桶的名称。它必须与集群位于相同的区域。  
+ 您必须向 Amazon S3 存储桶策略添加权限才能授予 CloudWatch 访问权限。有关更多信息，请参阅*CloudWatch 日志用户指南*中的对 [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`格式的示例。  
从 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***  
指定要将日志存档保存到的文件路径。如果提供此参数，则在本地保存日志。否则会通过输出中返回的 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`）表示。包括时间戳等于或晚于该时间的日志事件。如果未指定，则默认为集群的创建时间。

**使用 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`


通过 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 日志用户指南*中的对 [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 将负责配置存储桶策略。如果您在升级到 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***  
指定要将日志存档保存到的文件路径。如果提供此参数，则在本地保存日志。否则会通过输出中返回的 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`）表示。包括时间戳等于或晚于该时间的日志事件。如果未指定，则默认为集群的创建时间。

**使用 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` 命令来检索与一个或多个事件关联的日志流。

**--debug**  
启用调试日志记录。

**--end-time *END\$1TIME***  
指定时间范围的结束时间，以 ISO 8601 格式（`YYYY-MM-DDThh:mm:ssZ`，例如 `2021-01-01T20:00:00Z`）表示。不包括时间戳等于或晚于该时间的事件。

**--limit *LIMIT***  
指定返回的日志事件的最大数量。如果不指定值，则最大值为 1 MB 的响应大小所能容纳的日志事件数量，最多可达 10000 个日志事件。

**--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`）表示。包括时间戳等于或晚于该时间的事件。

**使用 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 区域 必须使用`AWS_DEFAULT_REGION`环境变量、`~/.aws/config`文件`[default]`部分中的`region`设置或`--region`参数来指定。

**使用 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` 命令来检索与一个或多个事件关联的日志流。

**--debug**  
启用调试日志记录。

**--end-time *END\$1TIME***  
指定时间范围的结束时间，以 ISO 8601 格式（`YYYY-MM-DDThh:mm:ssZ`，例如 `2021-01-01T20:00:00Z`）表示。不包括时间戳等于或晚于该时间的事件。

**--limit *LIMIT***  
指定返回的日志事件的最大数量。如果不指定值，则最大值为 1 MB 的响应大小所能容纳的日志事件数量，最多可达 10000 个日志事件。

**--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`）表示。包括时间戳等于或晚于该时间的事件。

**使用 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 区域 必须使用`AWS_DEFAULT_REGION`环境变量、`~/.aws/config`文件`[default]`部分中的`region`设置或`--region`参数来指定。

**使用 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 区域 必须使用`AWS_DEFAULT_REGION`环境变量、`~/.aws/config`文件`[default]`部分中的`region`设置或`--region`参数来指定。

**使用 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 区域 必须使用`AWS_DEFAULT_REGION`环境变量、`~/.aws/config`文件`[default]`部分中的`region`设置或`--region`参数来指定。

**使用 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 区域 必须使用`AWS_DEFAULT_REGION`环境变量、`~/.aws/config`文件`[default]`部分中的`region`设置或`--region`参数来指定。

**使用 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 区域 必须使用`AWS_DEFAULT_REGION`环境变量、`~/.aws/config`文件`[default]`部分中的`region`设置或`--region`参数来指定。

**使用 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 区域 要使用的。 AWS 区域 必须使用图像配置文件中的 “[区域](image-builder-configuration-file-v3.md#yaml-build-image-Region)” 设置、`AWS_DEFAULT_REGION`环境变量、文件`[default]`部分中的`region``~/.aws/config`设置或`--region`参数来指定。

**使用 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 区域 必须使用`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`


更新现有集群以匹配指定配置文件的设置。

**注意**  
 只有当所有群集节点都成功应用更新时，群集更新才会成功。如果更新失败，请参阅故障排除指南[使用 `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 区域 要使用的。 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***  
指定为更新报告的验证失败级别。

**使用 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`和`DISABLED`对应于调度器。 AWS Batch 

**--debug**  
启用调试日志记录。

**--query *QUERY***  
指定要对输出执行的 JMESPath 查询。

**--region, -r *REGION***  
指定 AWS 区域 要使用的。 AWS 区域 必须使用`AWS_DEFAULT_REGION`环境变量、`~/.aws/config`文件`[default]`部分中的`region`设置或`--region`参数来指定。

**使用 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**  
即使不支持或不建议使用一个或多个设置，也启用转换。

**-o *OUTPUT\$1FILE*, --output-file *OUTPUT\$1FILE***  
指定要写入的 AWS ParallelCluster 版本 3 配置文件。如果未指定此参数，则将配置写入 stdout。

**注意**  
该`pcluster3-config-converter`命令是在 3.0.1 AWS ParallelCluster 版本中添加的。