opc computeコマンドの一般的な構文

2 opc computeコマンドの一般的な構文

次のコマンドを実行すると、opc computeコマンドの一般的な構文を表示できます。

opc -h

opc computeコマンドの一般的な構文は次のとおりです:

opc [global_options...] service_name [service_options...] resource_name command [arguments...] [options...]

オプション	説明	詳細情報
`global_options...`	グローバル・コマンド・ライン・オプション。	グローバル・オプション
`service_name`	`compute`を指定します。
`service_options...`	Compute Classicに固有のコマンドライン・オプション。	サービス・オプション
`resource_name`	`opc compute` CLIを使用して管理するCompute Classicリソース。管理できるCompute Classicリソースのリストを表示するには、次のコマンドを実行します。 opc compute -h
`command`	CLIコマンドを使用してCompute Classicオブジェクトに対して実行できるアクション。	一般的なCLIコマンド・アクション
`[arguments...] [options...]`	引数とオプションは、各コマンドに固有のものです。

グローバル・オプション

次の表では、使用できる一般的なCLIコマンド・オプションについて説明します。これらのオプションに値を指定することは必須ではありません。

オプション説明

オプション	説明
`--format` `value` `-f` `value`	コマンドの出力を、表の枠線、表形式、JSON形式のないプレーンテキスト形式で表示するかどうかを指定します。次の値のいずれか1つを指定できます。 `text`: これはデフォルトのオプションです。表のボーダーがないプレーンテキスト形式で出力を表示します。 `list`コマンドの実行中にテキスト形式を使用すると、nameパラメータの値のみが戻されます。例 opc -f text compute image-list list /oracle/public/ サンプル出力これはサンプル出力です。表示される出力は、環境によって異なります。いくつかの行は、読みやすくするために省略記号(...)で切り捨てられます。 NAME /oracle/public/oel6 /oracle/public/WIN_2008_SE_R2-1.0.0-20160902-040218 ... `json`: 出力をJavaScript Object Notation (JSON)形式で表示し、この出力はフィルタ処理されません。この形式を指定すると、CLIによって`-F`オプションが無視されることに注意してください。例 opc -f json compute image-list get /oracle/public/oel6 サンプル出力これはサンプル出力です。表示される出力は、環境によって異なります。 { "default": 1, "description": "\"\"", "entries": [ { "attributes": {}, "imagelist": null, "machineimages": [ "/oracle/public/oel6" ], "uri": "https://api-z999.compute.us0.oraclecloud.com/imagelist/oracle/public/oel6/entry/1", "version": 1 } ], "name": "/oracle/public/oel6", "uri": "https://api-z999.compute.us0.oraclecloud.com/imagelist/oracle/public/oel6" } `table`: 各フィールドを別の列に表示します。 `-f table`フラグを使用しているときに、`-F`または`-fields`オプションを使用して、特定のリソース属性の出力をフィルタリングすることができます。 `OPC_FORMAT`環境変数をすでに設定している場合、このコマンドライン引数はそれを無効にします。例 opc -f table compute image-list get /oracle/public/oel6 サンプル出力これはサンプル出力です。表示される出力は、環境によって異なります。 +-------------------------+---------------------------------------------------------------+ default \| 1 description \| "" entries/0/imagelist \| entries/0/machineimages \| ["/oracle/public/oel6"] entries/0/uri \| https://api-z999.compute.us0.oraclecloud.com/imagelist/oracle/public/oel6/entry/1 entries/0/version \| 1 name \| /oracle/public/oel6 uri \| https://api-z999.compute.us0.oraclecloud.com/imagelist/oracle/public/oel6 +-------------------------+---------------------------------------------------------------+
`-F` `comma-separated-field-names` `--fields` `comma-separated-field-names`	指定されたリソース属性の値のみをリストします。このオプションを使用して、特に、多数の属性を持つオブジェクトで、必要な属性のみが表示されるように出力をフィルタできます。このオプションを使用するには、`-f table`または`-f text`オプションも指定する必要があります。 `OPC_FIELDS`環境変数をすでに設定している場合、このコマンドライン引数はそれを無効にします。指定できる属性のリストは、リソースによって異なります。たとえば、SSHキーリソースは、属性`name`、`enabled`、および`key`を持ちます。例1: フィルタリングされた出力を罫線付きの表形式で表示使用可能なすべてのシェイプの名前とRAMのみを取得するには: opc -f table -F name,ram compute shape list サンプル出力これはサンプル出力です。表示される出力は、環境によって異なります。いくつかの行は、読みやすくするために省略記号(...)で切り捨てられます。 +------------+--------+ NAME \| RAM +------------+--------+ oc3 \| 7680 oc5 \| 30720 oc4 \| 15360 oc6 \| 61440 ... +------------+--------+ 例2: フィルタリングされた出力を表枠なしのテキスト形式で表示使用可能なすべてのシェイプの名前とRAMのみを取得するには: opc -f text -F name,ram compute shape list サンプル出力これはサンプル出力です。表示される出力は、環境によって異なります。いくつかの行は、読みやすくするために省略記号(...)で切り捨てられます。 NAME RAM oc3 7680 oc5 30720 oc4 15360 oc6 61440 ... ...
`--debug-requests`	コマンドをデバッグ・モードで実行する必要があることを示します。このモードでの出力は非常に詳細です。これには、CLIコマンドに対して起動される内部APIコールのリクエストおよびレスポンスの詳細が含まれています。この出力は問題のデバッグに役立つ場合があります。 `DEBUG`環境変数をすでに設定している場合は、このコマンドライン引数がその値を上書きします。
`--insecure-tls`	SSL証明書の検証を無効にする場合、または署名のない証明書を使用する場合は、このオプションを指定します。
`--insecure-http`	Oracle Cloudサービスへの接続中にHTTPSの代わりにHTTPを使用する場合は、このオプションを指定します。
`--profile` `file_name` `-p` `file_name`	Compute Classicへのアクセスを認証するためのユーザー名とパスワードを含むテキスト・ファイル。また、Compute ClassicサイトのREST APIエンドポイントURLに関する情報も含まれています。プロファイルの作成については、「必要な環境変数とファイルの設定」を参照してください。このファイルは全ユーザーから読取り可能にしない必要があることに注意してください。 `OPC_PROFILE_FILE`環境変数をすでに設定している場合は、このコマンドライン引数がその値を上書きします。環境変数を設定しない場合は必須です: `OPC_COMPUTE_ENDPOINT`、`OPC_COMPUTE_USER`、および`OPC_COMPUTE_PASSWORD_FILE`。このオプションを使用しないで環境変数を設定しない場合、すべてのコマンドを実行するときに、`-e`オプションを使用してREST APIエンドポイントURLを明示的に指定する必要があります。ユーザー名は`-u`オプションを使用し、パスワードを格納するファイルは「サービス・オプション」に示すように`-pf`オプションを使用して指定します。
`--profile-directory` `directory_name` `--pd` `directory_name`	`--profile`または`-p`オプションを使用して指定するファイル名を含むフォルダ。 `OPC_PROFILE_DIRECTORY`環境変数をすでに設定している場合は、このコマンドライン引数がその値を上書きします。
`-h` `--help`	ヘルプ・メッセージを表示して、終了します。例 opc -h
`-v` `--version`	CLIのバージョンを印刷します。例 opc --version サンプル出力 opc version 17.2.4
`--verbose`	詳細な出力を表示します(サポートされている場合)。

--format value

-f value

コマンドの出力を、表の枠線、表形式、JSON形式のないプレーンテキスト形式で表示するかどうかを指定します。

次の値のいずれか1つを指定できます。

text: これはデフォルトのオプションです。表のボーダーがないプレーンテキスト形式で出力を表示します。 listコマンドの実行中にテキスト形式を使用すると、nameパラメータの値のみが戻されます。

例
```
opc -f text compute image-list list /oracle/public/
```
サンプル出力

これはサンプル出力です。表示される出力は、環境によって異なります。いくつかの行は、読みやすくするために省略記号(...)で切り捨てられます。
```
NAME
/oracle/public/oel6
/oracle/public/WIN_2008_SE_R2-1.0.0-20160902-040218
...
```

json: 出力をJavaScript Object Notation (JSON)形式で表示し、この出力はフィルタ処理されません。この形式を指定すると、CLIによって-Fオプションが無視されることに注意してください。

例

opc -f json compute image-list get /oracle/public/oel6

サンプル出力

これはサンプル出力です。表示される出力は、環境によって異なります。

{
 "default": 1,
 "description": "\"\"",
 "entries": [
  {
   "attributes": {},
   "imagelist": null,
   "machineimages": [
    "/oracle/public/oel6"
   ],
   "uri": "https://api-z999.compute.us0.oraclecloud.com/imagelist/oracle/public/oel6/entry/1",
   "version": 1
  }
 ],
 "name": "/oracle/public/oel6",
 "uri": "https://api-z999.compute.us0.oraclecloud.com/imagelist/oracle/public/oel6"
}

table: 各フィールドを別の列に表示します。 -f tableフラグを使用しているときに、-Fまたは-fieldsオプションを使用して、特定のリソース属性の出力をフィルタリングすることができます。

OPC_FORMAT環境変数をすでに設定している場合、このコマンドライン引数はそれを無効にします。

例

opc -f table compute image-list get /oracle/public/oel6

サンプル出力

これはサンプル出力です。表示される出力は、環境によって異なります。

+-------------------------+---------------------------------------------------------------+
  default                 | 1
  description             | ""
  entries/0/imagelist     |
  entries/0/machineimages | ["/oracle/public/oel6"]
  entries/0/uri           | https://api-z999.compute.us0.oraclecloud.com/imagelist/oracle/public/oel6/entry/1
  entries/0/version       | 1
  name                    | /oracle/public/oel6
  uri                     | https://api-z999.compute.us0.oraclecloud.com/imagelist/oracle/public/oel6
+-------------------------+---------------------------------------------------------------+

-F comma-separated-field-names

--fields comma-separated-field-names

指定されたリソース属性の値のみをリストします。このオプションを使用して、特に、多数の属性を持つオブジェクトで、必要な属性のみが表示されるように出力をフィルタできます。

このオプションを使用するには、-f tableまたは-f textオプションも指定する必要があります。

OPC_FIELDS環境変数をすでに設定している場合、このコマンドライン引数はそれを無効にします。

指定できる属性のリストは、リソースによって異なります。たとえば、SSHキーリソースは、属性name、enabled、およびkeyを持ちます。

例1: フィルタリングされた出力を罫線付きの表形式で表示

使用可能なすべてのシェイプの名前とRAMのみを取得するには:

opc -f table -F name,ram compute shape list

サンプル出力

これはサンプル出力です。表示される出力は、環境によって異なります。いくつかの行は、読みやすくするために省略記号(...)で切り捨てられます。

+------------+--------+
     NAME    |  RAM
+------------+--------+
  oc3        |   7680
  oc5        |  30720
  oc4        |  15360
  oc6        |  61440
  ...
+------------+--------+

例2: フィルタリングされた出力を表枠なしのテキスト形式で表示

使用可能なすべてのシェイプの名前とRAMのみを取得するには:

opc -f text -F name,ram compute shape list

サンプル出力

NAME    RAM
oc3     7680
oc5     30720
oc4     15360
oc6     61440
...     ...

--debug-requests

コマンドをデバッグ・モードで実行する必要があることを示します。このモードでの出力は非常に詳細です。これには、CLIコマンドに対して起動される内部APIコールのリクエストおよびレスポンスの詳細が含まれています。この出力は問題のデバッグに役立つ場合があります。

DEBUG環境変数をすでに設定している場合は、このコマンドライン引数がその値を上書きします。

--insecure-tls

SSL証明書の検証を無効にする場合、または署名のない証明書を使用する場合は、このオプションを指定します。

--insecure-http

Oracle Cloudサービスへの接続中にHTTPSの代わりにHTTPを使用する場合は、このオプションを指定します。

--profile file_name

-p file_name

Compute Classicへのアクセスを認証するためのユーザー名とパスワードを含むテキスト・ファイル。また、Compute ClassicサイトのREST APIエンドポイントURLに関する情報も含まれています。

プロファイルの作成については、「必要な環境変数とファイルの設定」を参照してください。

このファイルは全ユーザーから読取り可能にしない必要があることに注意してください。

OPC_PROFILE_FILE環境変数をすでに設定している場合は、このコマンドライン引数がその値を上書きします。

環境変数を設定しない場合は必須です: OPC_COMPUTE_ENDPOINT、OPC_COMPUTE_USER、およびOPC_COMPUTE_PASSWORD_FILE。

このオプションを使用しないで環境変数を設定しない場合、すべてのコマンドを実行するときに、-eオプションを使用してREST APIエンドポイントURLを明示的に指定する必要があります。ユーザー名は-uオプションを使用し、パスワードを格納するファイルは「サービス・オプション」に示すように-pfオプションを使用して指定します。

--profile-directory directory_name

--pd directory_name

--profileまたは-pオプションを使用して指定するファイル名を含むフォルダ。

OPC_PROFILE_DIRECTORY環境変数をすでに設定している場合は、このコマンドライン引数がその値を上書きします。

-h

--help

ヘルプ・メッセージを表示して、終了します。

例

opc -h

-v

--version

CLIのバージョンを印刷します。

例

opc --version

サンプル出力

opc version 17.2.4

--verbose

詳細な出力を表示します(サポートされている場合)。

サービス・オプション

次の表に、Compute Classicに固有のコマンド・オプションを示します。これらのオプションの使用方法については、「環境変数とファイルの設定」を参照してください。

オプション説明

オプション	説明
`-u` `value` `--user` `value`	Compute Classicへのアクセスを認証するためのユーザー名。
`-pf` `file` `--password-file` `file`	`-u`オプションを使用して指定したユーザーのパスワードを含むテキスト・ファイルの完全パスを指定します。このファイルは全ユーザーから読取り可能にしない必要があることに注意してください。
`-e` `url` `--endpoint` `url`	Compute Classicアカウント内のサイトのAPIエンドポイントURL。このガイドの一部の例では、次のAPIエンドポイントURLが使用されています。 `https://api-z999.compute.us0.oraclecloud.com`
`-ac environment variable` `--auth-cookie environment variable`	有効な認証Cookieを提供します。
`-h` `--help`	ヘルプ・メッセージを表示して、終了します。例 opc compute -h

-u value

--user value

Compute Classicへのアクセスを認証するためのユーザー名。

-pf file

--password-file file

-uオプションを使用して指定したユーザーのパスワードを含むテキスト・ファイルの完全パスを指定します。このファイルは全ユーザーから読取り可能にしない必要があることに注意してください。

-e url

--endpoint url

Compute Classicアカウント内のサイトのAPIエンドポイントURL。このガイドの一部の例では、次のAPIエンドポイントURLが使用されています。

https://api-z999.compute.us0.oraclecloud.com

-ac environment variable

--auth-cookie environment variable

有効な認証Cookieを提供します。

-h

--help

ヘルプ・メッセージを表示して、終了します。

例

opc compute -h

一般的なCLIコマンド・アクション

次の表は、CLIコマンドを使用してCompute Classicオブジェクトに対して実行できる一般的な操作を示しています。

特定のオブジェクトでは一部のアクションがサポートされていない場合があること、および、一部のオブジェクトには、独自の追加のアクションがある場合があることに注意してください。

アクション	説明
`add`	オブジェクトを作成します。
`delete`	オブジェクトを削除します。削除操作には、どのレスポンスも返されません。
`discover`	コンテナ内の指定したオブジェクトの名前とサブコンテナの名前を取得します。このコマンドでは、オブジェクトの詳細およびサブコンテナのコンテンツは取得されません。コンテナを指定する必要があり、これにはキー・フィールドの親パスのみを指定できます。たとえば、`/Compute-identity_domain/` `user`です。
`get`	指定したオブジェクトの詳細を取得します。
`list`	指定したコンテナから指定したオブジェクトに関する情報を取得します。このコマンドでは、オブジェクトの名前だけでなく、オブジェクトのその他のすべての詳細も取得します。また、一部のオブジェクトでは、追加の引数を使用して出力をフィルタすることもできます。
`update`	指定されたオブジェクトのすべてのパラメータの値を更新します。このコマンドの実行中にパラメータの値を指定しないと、そのパラメータは`null`に設定されます。 `update`コマンドを実行する前に、`get`コマンドを実行すると、現在割り当てられているすべてのパラメータ値を取得できるため、保持する値と変更したい値を識別できます。

コマンドラインで状況依存ヘルプへのアクセス

コマンドの実行中に、コマンドラインで状況依存ヘルプにアクセスすることができます。次にいくつか例を示します。

```
opc --help
```
CLIを使用する一般的な構文についての情報を提供します。
```
opc compute --help
```
opc compute CLI (コマンド行オプション)を使用する一般的な構文についての情報を提供し、CLIを使用して管理できるすべてのCompute Classicリソースをリストします。

opc compute instances -help

この例では、Compute Classicリソースinstancesについて説明し、このリソースで実行できるアクションを示します。

SUMMARY:
   An Compute Classic instance is a virtual machine running a specific operating system and with CPU and memory resources that you specify

USAGE:
   opc compute instances command [arguments...] [options...]

COMMANDS:
      delete    Delete an Instance
      discover  Retrieve Names of all Instances in a Container
      get       Retrieve Details of an Instance
      list      Retrieve Details of all Instances in a Container

OPTIONS:
   --help, -h  show help

```
opc compute instances get -help
```
指定されたリソースに対して指定されたアクションを実行するための構文を提供します。この例では、getアクションはinstancesリソースに対して実行されます。また、コマンドを実行するための必須および必須の引数をすべてリストし、各引数についても説明します。
```
NAME:
   compute instances get - Retrieve Details of an Instance

USAGE:
   compute instances get name

DESCRIPTION:
   Retrieve Details of an Instance

REQUIRED ARGUMENTS:
   name - Multipart name of the object.
```

アクションまたはリソース名のスペルが間違っている場合は、正しいコマンドを入力するように求められます。例:

opc compute orchestaration 
Can't find "orchestaration", did you mean "orchestration"?

opc compute orchestration updat 
Can't find "updat", did you mean "update"?