リソースと属性の説明

用途

describeコマンドは、Exascaleリソースとその属性に関する情報を表示します。

構文

describe { --all | resource-spec } [ --detail ]

コマンド・オプション

describeコマンドのオプションは、次のとおりです:

--all: すべてのExascaleリソースに関する情報を表示するようにコマンドに指示します。このオプションでは、大量の情報が表示されますが、Exascaleリソースとその属性に慣れていない場合はよい開始点となります。
resource-spec: 次のように、特定のExascaleリソースとその属性に関する情報を表示するようにコマンドに指示します:
- resource-spec値は、大/小文字が区別されません。
  
  したがって、次のコマンドは機能的に同等です:
```
@> describe vaults
```
```
@> describe VAULTS
```
```
@> describe vAUltS
```
- リソース名は、単数形または複数形で指定できます。
  
  したがって、次のコマンドは機能的に同等です:
```
@> describe vault
```
```
@> describe vaults
```
- 完全なリソース名(単数形または複数形)を指定した場合、出力には指定されたリソースのすべての属性が含まれます。
- ワイルドカード(*)を使用してリソース名を指定した場合、出力にはパターンと一致するすべてのリソースが含まれます。
  
  たとえば、次のコマンドでは、文字'v'で始まるリソース(vaults、volumesなど)がすべて表示されます:
```
@> describe v*
```
- 属性名を(<resource>.<attribute>という表記を使用して)指定した場合、出力には指定した属性が表示されます。
  
  たとえば、次のコマンドでは、ボールト名を含む属性の情報を表示します。
```
@> describe vaults.name
```
- ワイルドカード(*)を使用して属性名を指定した場合、出力にはパターンと一致するすべての属性が含まれます。
  
  たとえば、次のコマンドでは、'v'で始まるすべてのリソースの'n'で始まるすべての属性が表示されます:
```
@> describe v*.n*
```
- resource-specが'mk'で始まる場合、出力には、リソース作成時に初期化可能な属性(initializable != No)のみが含まれます。
  
  たとえば、次のコマンドでは、ファイル作成時に初期化可能なすべての属性が表示されます:
```
@> describe mkfiles
```
  次のオプションを使用して、出力をさらに絞り込むことができます:
  - --mandatory: リソース作成時に初期化する必要がある必須属性(initializable = Mandatory)のみを表示します。
    
    次に例を示します:
```
@> describe mkfiles --mandatory
```
  - --optional: リソース作成時に初期化できるオプション属性(initializable = Optional)のみを表示します。
    
    次に例を示します:
```
@> describe mkfiles --optional
```
- resource-specが'ch'で始まる場合、出力には、既存のリソースの変更可能な属性(modifiable = true)のみが含まれます。
  
  たとえば、次のコマンドでは、既存のファイルの変更できる属性が表示されます:
```
@> describe chfiles
```
--detail: オプションで、デフォルトの表形式出力を使用するかわりに、値が別々の行に表示されるようにコマンド出力を書式設定します。

使用上のノート

リソースごとに、リソース名と関連する属性のリストが出力されます。属性ごとに、次の情報が表示されます:

name: 属性名。
type: 属性値のデータ型(String、Integer、Date、Booleanなど)。
description: 有効な値とデフォルト設定(該当する場合)を含む、属性の簡単な説明。
initializable: リソースの作成時に属性値を設定できるかどうか、または設定する必要があるかどうかを示します。使用可能な値は、次のとおりです:
- No: リソースの作成時に属性値を設定できません。値は、システムによって自動的に設定されるか、デフォルト値が継承されます。
- Mandatory: リソースの作成時に属性値を指定する必要があります。
- Optional: リソースの作成時に属性値を指定できます。指定しない場合、通常、属性にはデフォルト値が割り当てられます。
modifiable: リソースの作成後に属性値を変更できるかどうかを示します(trueまたはfalse)。

6.2.2 リソースと属性の説明