第14章 データ処理サービスコマンドラインクライアント


sahara クライアントは、Data Processing サービス API とその拡張機能のコマンドラインインターフェイス(CLI)です。この章では、shara バージョン 0.11.1 について説明します。
特定の sahara コマンドのヘルプを表示するには、次のコマンドを実行します。
$ sahara help COMMAND

14.1. Sahara の使用法

usage: sahara [--version] [--debug] [--os-cache] [--region-name <region-name>] [--service-type <service-type>] [--endpoint-type <endpoint-type>] [--sahara-api-version <sahara-api-ver>] [--bypass-url <bypass-url>] [--os-tenant-name OS_TENANT_NAME] [--os-tenant-id OS_TENANT_ID] [--os-auth-system OS_AUTH_SYSTEM] [--os-auth-token OS_AUTH_TOKEN] [--insecure] [--os-cacert <ca-certificate>] [--os-cert <certificate>] [--os-key <key>] [--timeout <seconds>] [--os-auth-url OS_AUTH_URL] [--os-domain-id OS_DOMAIN_ID] [--os-domain-name OS_DOMAIN_NAME] [--os-project-id OS_PROJECT_ID] [--os-project-name OS_PROJECT_NAME] [--os-project-domain-id OS_PROJECT_DOMAIN_ID] [--os-project-domain-name OS_PROJECT_DOMAIN_NAME] [--os-trust-id OS_TRUST_ID] [--os-user-id OS_USER_ID] [--os-user-name OS_USERNAME] [--os-user-domain-id OS_USER_DOMAIN_ID] [--os-user-domain-name OS_USER_DOMAIN_NAME] [--os-password OS_PASSWORD] <subcommand> ...

サブコマンド

cluster-create
クラスターを作成します。
cluster-delete
クラスターを削除します。
cluster-list
利用可能なクラスターの一覧を出力します。
cluster-scale
クラスターを スケーリング します。
cluster-show
クラスターの詳細を表示します。
cluster-template-create
クラスターテンプレートを作成します。
cluster-template-delete
クラスターテンプレートを削除します。
cluster-template-list
利用可能なクラスターテンプレートの一覧を出力します。
cluster-template-show
クラスターテンプレートの詳細を表示します。
cluster-template-update
クラスターテンプレートを更新します。
data-source-create
ジョブ入力を提供するデータソースを作成し、ジョブ出力を受け取ります。
data-source-delete
データソースを削除します。
data-source-list
利用可能なデータソースの一覧を出力します。
data-source-show
データソースの詳細を表示します。
data-source-update
データソースを更新します。
image-add-tag
イメージにタグを追加します。
image-list
利用可能なイメージの一覧を出力します。
image-register
イメージインデックス からイメージを登録します。
image-remove-tag
イメージからタグを削除します。
image-show
イメージの詳細を表示します。
image-unregister
イメージの登録を解除します。
job-binary-create
ジョブバイナリーを記録します。
job-binary-data-create
内部 DB にデータを保存します。このコマンドの代わりに swift upload を使用します。このコマンドは、Swift が利用できない場合にのみ使用してください。
job-binary-data-delete
内部に保存されたジョブのバイナリーデータを削除します。
job-binary-data-list
内部に保存されたジョブのバイナリーデータのリストを出力します。
job-binary-delete
ジョブのバイナリーを削除します。
job-binary-list
ジョブバイナリーの一覧を出力します。
job-binary-show
ジョブバイナリーの詳細を表示します。
job-binary-update
ジョブのバイナリーを更新します。
job-create
ジョブを作成します。
job-delete
ジョブを削除します。
job-list
ジョブの一覧を出力します。
job-show
ジョブの詳細を表示します。
job-template-create
ジョブテンプレートを作成します。
job-template-delete
ジョブテンプレートを削除します。
job-template-list
ジョブテンプレートの一覧を出力します。
job-template-show
ジョブテンプレートの詳細を表示します。
job-type-list
サポートされているジョブタイプを表示します。
node-group-template-create
ノードグループテンプレートを作成します。
node-group-template-delete
ノードグループテンプレートを削除します。
node-group-template-list
利用可能なノードグループテンプレートの一覧を出力します。
node-group-template-show
ノードグループテンプレートの詳細を表示します。
node-group-template-update
ノードグループテンプレートを更新します。
プラグインリスト
利用可能なプラグインの一覧を出力します。
plugin-show
プラグインの詳細を表示します。
bash-completion
bash-completion の引数を出力します。sahara.bash_completion スクリプトでハードコードをハードコーディングする必要がないように、すべてのコマンドおよびオプションを stdout に出力します。
help
このプログラムまたはそのサブコマンドのヘルプを表示します。

14.2. Sahara オプションの引数

--version
プログラムのバージョン番号を表示して終了します。
--debug
デバッグの出力を出力します。
--os-cache
認証トークンキャッシュを使用します。env[OS_CACHE] が設定されていない場合は、デフォルトで False に設定されます。
--region-name <region-name>
デフォルトは env[OS_REGION_NAME] です。
--service-type <service-type>
デフォルトは、すべてのアクションのデータ処理です。
--endpoint-type <endpoint-type>
デフォルトは env[SAHARA_ENDPOINT_TYPE] または env[OS_ENDPOINT_TYPE] または publicURL です。
--sahara-api-version <sahara-api-ver>
api を受け入れます。デフォルトは env[SAHARA_API_VERSION] です。
--bypass-url <bypass-url>
サービスカタログの代わりにこの API エンドポイントを使用します。
--os-tenant-name OS_TENANT_NAME
デフォルトは env[OS_TENANT_NAME] です。
--os-tenant-id OS_TENANT_ID
デフォルトは env[OS_TENANT_ID] です。
--os-auth-system OS_AUTH_SYSTEM
デフォルトは env[OS_AUTH_SYSTEM] です。
--os-auth-token OS_AUTH_TOKEN
デフォルトは env[OS_AUTH_TOKEN] です。
--insecure
クライアントがセキュアでない TLS (https)要求を実行することを明示的に許可します。サーバーの証明書は認証局に対して検証されません。このオプションは注意して使用する必要があります。
--os-cacert <ca-certificate>
TLS (https)サーバー証明書の検証に使用する CA バンドルファイルを指定します。デフォルトは env[OS_CACERT] です。
--os-cert <certificate>
デフォルトは env[OS_CERT] です。
--os-key <key>
デフォルトは env[OS_KEY] です。
--timeout <seconds>
リクエストのタイムアウトを秒単位で設定します(秒単位)。
--os-auth-url OS_AUTH_URL
認証 URL
--os-domain-id OS_DOMAIN_ID
スコープするドメイン ID
--os-domain-name OS_DOMAIN_NAME
スコープするドメイン名
--os-project-id OS_PROJECT_ID
スコープするプロジェクト ID
--os-project-name OS_PROJECT_NAME
スコープするプロジェクト名
--os-project-domain-id OS_PROJECT_DOMAIN_ID
プロジェクトを含むドメイン ID
--os-project-domain-name OS_PROJECT_DOMAIN_NAME
プロジェクトを含むドメイン名
--os-trust-id OS_TRUST_ID
Trust ID
--os-user-id OS_USER_ID
User ID
--os-user-name OS_USERNAME、--os-username OS_USERNAME
Username
--os-user-domain-id OS_USER_DOMAIN_ID
ユーザーのドメイン ID
--os-user-domain-name OS_USER_DOMAIN_NAME
ユーザーのドメイン名
--os-password OS_PASSWORD
ユーザーのパスワード

14.3. Sahara cluster-create

usage: sahara cluster-create [--json JSON] [--count COUNT]
クラスターを作成します。

オプションの引数

--json JSON
クラスターの JSON 表現。
--count COUNT
作成するクラスターの数。

14.4. Sahara cluster-delete

usage: sahara cluster-delete [--name NAME] [--id <cluster_id>]
クラスターを削除します。

オプションの引数

--name NAME
クラスターの名前。
--id <cluster_id>
削除するクラスターの ID。

14.5. Sahara cluster-list

usage: sahara cluster-list
利用可能なクラスターの一覧を出力します。

14.6. Sahara クラスタースケール

usage: sahara cluster-scale [--name NAME] [--id <cluster_id>] [--json JSON]
クラスターを スケーリング します。

オプションの引数

--name NAME
クラスターの名前。
--id <cluster_id>
クラスターの ID。
--json JSON
クラスタースケールの JSON 表現。

14.7. Sahara cluster-show

usage: sahara cluster-show [--name NAME] [--id <cluster_id>] [--show-progress SHOW_PROGRESS] [--json]
クラスターの詳細を表示します。

オプションの引数

--name NAME
クラスターの名前。
--id <cluster_id>
表示するクラスターの ID。
--show-progress SHOW_PROGRESS
クラスターのプロビジョニング進捗イベントを表示します。
--json
クラスターの JSON 表現を出力します。

14.8. Sahara cluster-template-create

usage: sahara cluster-template-create [--json JSON]
クラスターテンプレートを作成します。

オプションの引数

--json JSON
クラスターテンプレートの JSON 表現。

14.9. sahara cluster-template-delete

usage: sahara cluster-template-delete [--name NAME] [--id <template_id>]
クラスターテンプレートを削除します。

オプションの引数

--name NAME
クラスターテンプレートの名前。
--id <template_id>
削除するクラスターテンプレートの ID。

14.10. Sahara cluster-template-list

usage: sahara cluster-template-list
利用可能なクラスターテンプレートの一覧を出力します。

14.11. Sahara cluster-template-show

usage: sahara cluster-template-show [--name NAME] [--id <template_id>] [--json]
クラスターテンプレートの詳細を表示します。

オプションの引数

--name NAME
クラスターテンプレートの名前。
--id <template_id>
表示するクラスターテンプレートの ID。
--json
クラスターテンプレートの JSON 表現を出力します。

14.12. Sahara cluster-template-update

usage: sahara cluster-template-update [--name NAME] [--id <template_id>] [--json JSON]
クラスターテンプレートを更新します。

オプションの引数

--name NAME
更新するクラスターテンプレートの名前。
--id <template_id>
更新するクラスターテンプレートの ID。
--json JSON
クラスターテンプレートの更新 の JSON 表現。

14.13. Sahara data-source-create

usage: sahara data-source-create --name NAME --type TYPE --url URL [--description DESCRIPTION] [--user USER] [--password PASSWORD]
ジョブ入力を提供するデータソースを作成し、ジョブ出力を受け取ります。

オプションの引数

--name NAME
データソースの名前
--type TYPE
データソースのタイプ。
--url URL
データソースの URL。
--description DESCRIPTION
データソースの説明。
--user USER
データソース URL にアクセスするためのユーザー名
--password PASSWORD
データソース URL にアクセスするためのパスワード

14.14. Sahara data-source-delete

usage: sahara data-source-delete [--name NAME] [--id ID]
データソースを削除します。

オプションの引数

--name NAME
データソースの名前
--id ID
削除するデータソースの ID。

14.15. Sahara data-source-list

usage: sahara data-source-list
利用可能なデータソースの一覧を出力します。

14.16. Sahara data-source-show

usage: sahara data-source-show [--name NAME] [--id ID]
データソースの詳細を表示します。

オプションの引数

--name NAME
データソースの名前
--id ID
データソースの ID。

14.17. Sahara data-source-update

usage: sahara data-source-update [--name NAME] [--id ID] [--json JSON]
データソースを更新します。

オプションの引数

--name NAME
更新するデータソースの名前。
--id ID
更新するデータソースの ID。
--json JSON
更新するデータソースフィールドが含まれる JSON。

14.18. Sahara image-add-tag

usage: sahara image-add-tag [--name NAME] [--id <image_id>] --tag <tag>
イメージにタグを追加します。

オプションの引数

--name NAME
イメージの名前。
--id <image_id>
タグ付けするイメージの ID。
--tag <tag>
追加するタグ。

14.19. Sahara image-list

usage: sahara image-list
利用可能なイメージの一覧を出力します。

14.20. Sahara image-register

usage: sahara image-register --id <image_id> [--username <name>] [--description <desc>]
イメージインデックス からイメージを登録します。

オプションの引数

--id <image_id>
イメージの ID。glance image-list を実行して、すべての ID を表示します。
--username <name>
イメージ内の特権ユーザーのユーザー名。
--description <desc>
イメージの説明。

14.21. Sahara image-remove-tag

usage: sahara image-remove-tag [--name NAME] [--id <image_id>] --tag <tag>
イメージからタグを削除します。

オプションの引数

--name NAME
イメージの名前。
--id <image_id>
Image to tag。
--tag <tag>
削除するタグ。

14.22. Sahara image-show

usage: sahara image-show [--name NAME] [--id <image_id>]
イメージの詳細を表示します。

オプションの引数

--name NAME
イメージの名前。
--id <image_id>
イメージの ID。

14.23. Sahara image-unregister

usage: sahara image-unregister [--name NAME] [--id <image_id>]
イメージの登録を解除します。

オプションの引数

--name NAME
イメージの名前。
--id <image_id>
登録解除するイメージの ID。

14.24. Sahara job-binary-create

usage: sahara job-binary-create --name NAME --url URL [--description DESCRIPTION] [--user USER] [--password PASSWORD]
ジョブバイナリーを記録します。

オプションの引数

--name NAME
ジョブバイナリーの名前。
--url URL
ジョブバイナリーの URL。
--description DESCRIPTION
ジョブバイナリーの説明。
--user USER
ジョブのバイナリー URL にアクセスするためのユーザー名
--password PASSWORD
ジョブのバイナリー URL にアクセスするためのパスワード

14.25. Sahara job-binary-data-create

usage: sahara job-binary-data-create [--file FILE] [--name NAME]
内部 DB にデータを保存します。このコマンドの代わりに swift upload を使用します。このコマンドは、Swift が利用できない場合にのみ使用してください。

オプションの引数

--file FILE
保存するデータ。
--name NAME
ジョブバイナリー内部の名前。

14.26. Sahara job-binary-data-delete

usage: sahara job-binary-data-delete --id ID
内部に保存されたジョブのバイナリーデータを削除します。

オプションの引数

--id ID
内部に保存されているジョブのバイナリーデータの ID。

14.27. Sahara job-binary-data-list

usage: sahara job-binary-data-list
内部に保存されたジョブのバイナリーデータのリストを出力します。

14.28. Sahara job-binary-delete

usage: sahara job-binary-delete [--name NAME] [--id ID]
ジョブのバイナリーを削除します。

オプションの引数

--name NAME
ジョブバイナリーの名前。
--id ID
削除するジョブバイナリーの ID。

14.29. Sahara job-binary-list

usage: sahara job-binary-list
ジョブバイナリーの一覧を出力します。

14.30. Sahara job-binary-show

usage: sahara job-binary-show [--name NAME] [--id ID]
ジョブバイナリーの詳細を表示します。

オプションの引数

--name NAME
ジョブバイナリーの名前。
--id ID
ジョブバイナリーの ID。

14.31. Sahara job-binary-update

usage: sahara job-binary-update [--name NAME] [--id <job_binary_id>] [--json JSON]
ジョブのバイナリーを更新します。

オプションの引数

--name NAME
更新するジョブバイナリーの名前。
--id <job_binary_id>
更新するジョブバイナリーの ID。
--json JSON
ジョブバイナリー更新の JSON 表現。

14.32. Sahara job-create

usage: sahara job-create --job-template JOB_TEMPLATE [--cluster CLUSTER] [--input-data INPUT_DATA] [--output-data OUTPUT_DATA] [--param name=value] [--arg ARG] [--config name=value] [--json JSON]
ジョブを作成します。

オプションの引数

--job-template JOB_TEMPLATE
実行するジョブテンプレートの ID。
--cluster CLUSTER
ジョブを実行するクラスターの ID。
--input-data INPUT_DATA
入力データソースの ID。
--output-data OUTPUT_DATA
出力データソースの ID。
--param
ジョブに追加する name=value パラメーター。繰り返し可能。
--ARG ARG
ジョブに追加する引数。繰り返し可能。
--config
ジョブに追加する name=value Config パラメーター。繰り返し可能。
--json JSON
ジョブの JSON 表現。

14.33. Sahara job-delete

usage: sahara job-delete --id ID
ジョブを削除します。

オプションの引数

--id ID
ジョブの ID。

14.34. Sahara job-list

usage: sahara job-list
ジョブの一覧を出力します。

14.35. Sahara job-show

usage: sahara job-show --id ID
ジョブの詳細を表示します。

オプションの引数

--id ID
ジョブの ID。

14.36. Sahara job-template-create

usage: sahara job-template-create [--name NAME] [--type TYPE] [--main MAIN] [--lib LIB] [--description DESCRIPTION] [--json JSON]
ジョブテンプレートを作成します。

オプションの引数

--name NAME
ジョブテンプレートの名前。
--type TYPE
ジョブテンプレートのタイプ。
--main MAIN
ジョブのメインジョブバイナリーの ID。
--lib LIB
ジョブの lib job-binary、繰り返し可能なジョブの ID。
--description DESCRIPTION
ジョブテンプレートの説明。
--json JSON
ジョブテンプレートの JSON 表現。

14.37. Sahara job-template-delete

usage: sahara job-template-delete [--name NAME] [--id ID]
ジョブテンプレートを削除します。

オプションの引数

--name NAME
ジョブテンプレートの名前。
--id ID
ジョブテンプレートの ID。

14.38. Sahara job-template-list

usage: sahara job-template-list
ジョブテンプレートの一覧を出力します。

14.39. Sahara job-template-show

usage: sahara job-template-show [--name NAME] [--id ID]
ジョブテンプレートの詳細を表示します。

オプションの引数

--name NAME
ジョブテンプレートの名前。
--id ID
ジョブテンプレートの ID。

14.40. Sahara job-type-list

usage: sahara job-type-list [--type <job_type>] [--plugin <plugin>] [--plugin-version <plugin_version>]
サポートされているジョブタイプを表示します。

オプションの引数

--type <job_type>
このジョブタイプにのみ報告します。
--plugin <plugin>
このプラグインでサポートされているジョブタイプのみを報告します。
--plugin-version <plugin_version>
指定されたプラグインのこのバージョンでサポートされているジョブタイプにのみ報告します。--plugin と併用する場合のみ有効です。

14.41. Sahara node-group-template-create

usage: sahara node-group-template-create [--json JSON]
ノードグループテンプレートを作成します。

オプションの引数

--json JSON
ノードグループテンプレートの JSON 表現。

14.42. Sahara node-group-template-delete

usage: sahara node-group-template-delete [--name NAME] [--id <template_id>]
ノードグループテンプレートを削除します。

オプションの引数

--name NAME
ノードグループテンプレートの名前。
--id <template_id>
削除するノードグループテンプレートの ID。

14.43. Sahara node-group-template-list

usage: sahara node-group-template-list
利用可能なノードグループテンプレートの一覧を出力します。

14.44. Sahara node-group-template-show

usage: sahara node-group-template-show [--name NAME] [--id <template_id>] [--json]
ノードグループテンプレートの詳細を表示します。

オプションの引数

--name NAME
ノードグループテンプレートの名前。
--id <template_id>
表示するノードグループテンプレートの ID。
--json
ノードグループテンプレートの JSON 表現を出力します。

14.45. Sahara node-group-template-update

usage: sahara node-group-template-update [--name NAME] [--id <template_id>] [--json JSON]
ノードグループテンプレートを更新します。

オプションの引数

--name NAME
更新するノードグループテンプレートの名前。
--id <template_id>
更新するノードグループテンプレートの ID。
--json JSON
ノードグループテンプレートの更新の JSON 表現。

14.46. Sahara plugin-list

usage: sahara plugin-list
利用可能なプラグインの一覧を出力します。

14.47. Sahara plugin-show

usage: sahara plugin-show --name <plugin>
プラグインの詳細を表示します。

オプションの引数

--name <plugin>
プラグインの名前。
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

Red Hat ドキュメントについて

Legal Notice

Theme

© 2026 Red Hat
トップに戻る