bluemixUtility コマンド

IBM® Bluemix® コマンド・ライン・ユーティリティーにより、 オンプレミスの Liberty サーバーが一定の IBM Cloud クラウド・サービスを使用するように構成します。

現在、IBM Bluemix は IBM Cloud となっており、これらの名前を指している場合、https://console.bluemix.net にある同じクラウド・プラットフォームを示します。

ソース

このコマンド・ライン・ユーティリティーで使用できる IBM Cloud サービス (Watson™ サービスや Cloudant® サービスなど) に関する説明を参照してください。

構文

コマンド構文は次のようになります。
bluemixUtility action [options]
以下の action コマンドを使用します。
login
IBM Cloud にログインします。何もオプションを指定しないで login コマンドを実行した場合は、ユーザー名やパスワードなどの詳細情報がツールによって求められます。正常にログインすると、IBM Cloud 資格情報がファイルに保存されます。 これにより、ユーザー名とパスワードを再び指定せずに、他のコマンドを実行できます。
Cloud Foundry (cf) クライアントで IBM Cloud にログインする場合、 bluemixUtility は、cf クライアントで保存された資格情報を使用します。 詳しくは、「アプリケーションを管理するための cf コマンド」を参照してください。
marketplace
コマンド・ライン・ユーティリティーを使用して構成できる IBM Cloud サービスをすべてリストします。
createService
IBM Cloud カタログからサービス・インスタンスを作成します。
listServices
使用可能な IBM Cloud サービス・インスタンスをすべてリストします。
showService
サービス・インスタンスに関する情報を表示します。
import
サービスの構成をインポートします。 インポートされたサービス構成とその依存関係は、次のディレクトリーに入ります。
${wlp.user.dir}/shared/config/services/serviceName
listImports
Liberty サーバーにバインドできるインポート済みサービス構成をすべてリストします。
bind
IBM Cloud サービス構成を Liberty サーバーにバインドします。 サービスの構成は、dataSource エレメントの jndiName など、特定オプションのデフォルト値を提供できます。 場合によっては、そのデフォルト値が、アプリケーションの予期する値と一致しないことがあります。 アプリケーションが予期する値でデフォルト値をオーバーライドするには、--v オプションを使用します。
unbind
Liberty サーバーからサービス構成をアンバインドします。
deleteService
サービス・インスタンスを削除します。
switch
別の IBM Cloud 組織またはスペースに切り替えます。
info
IBM Cloud 接続情報を表示します。
help
各コマンドで help アクションを使用すると、説明、使用法、オプションが表示されます。
logout
IBM Cloud からログアウトします。 logout コマンドによって、 IBM Cloud 資格情報でのログイン時に作成されたファイルは削除されます。

使用法

各アクションの実行可能な使用法の例を示します。

login アクションを実行するには以下のコマンドを使用します。
bluemixUtility login [options]
marketplace アクションを実行するには以下のコマンドを使用します。
bluemixUtility marketplace [serviceType...]
createService アクションを実行するには以下のコマンドを使用します。
bluemixUtility createService [options] serviceType servicePlan serviceName
listServices アクションを実行するには以下のコマンドを使用します。
bluemixUtility listServices
showService アクションを実行するには以下のコマンドを使用します。
bluemixUtility showService [options] serviceName
import アクションを実行するには以下のコマンドを使用します。
bluemixUtility import [options] serviceName
listImports アクションを実行するには以下のコマンドを使用します。
bluemixUtility listImports [serverName]
bind アクションを実行するには以下のコマンドを使用します。
bluemixUtility bind [options] serverName serviceName
unbind アクションを実行するには以下のコマンドを使用します。
bluemixUtility unbind serverName serviceName
deleteService アクションを実行するには以下のコマンドを使用します。
bluemixUtility deleteService [options] serviceName
switch アクションを実行するには以下のコマンドを使用します。
bluemixUtility switch [options]
logout アクションを実行するには以下のコマンドを使用します。
bluemixUtility logout

オプション

各アクションで使用可能なオプションを示します。

bluemixUtility login コマンドで使用可能なオプションは、以下のとおりです。
--api=url
Bluemix API エンドポイント (https://api.ng.bluemix.net など)。API エンドポイントは、Bluemix 地域名として設定することもできます。 例えば、米国南部地域の場合は us-south、英国ロンドン地域の場合は eu-gb、 オーストラリア・シドニー地域の場合は au-syd に設定できます。
--user=username
IBM Cloud アカウントのユーザー名。
--password=password
IBM Cloud アカウントのパスワード。
--org=organizationName
組織名。
--space=spaceName
スペース名。
[16.0.0.3 and later]--sso
IBM Cloud フェデレーテッド ID を使用してログインする必要があるワンタイム・パスコード。このパスコードを生成するには 、コマンドにより指定される IBM Cloud パスコード Web サイトに移動してから、生成されるパスコードをコマンド・ラインで入力します。このオプションは、IBM ID を使用してサインインする必要はありません。
bluemixUtility marketplace コマンドで使用可能なオプションは、以下のとおりです。
[serviceType...]
特定の IBM Cloud サービスに関する詳細情報を表示します。 サービス名が複数ある場合は、スペースで区切って指定してください。
bluemixUtility createService コマンドで使用可能なオプションは、以下のとおりです。
--credentialName=name
サービス資格情報の名前。デフォルトでは、credential-1 が使用されます。
serviceType
作成するサービスの型。
servicePlan
サービス・プランの名前。
serviceName
作成するサービスの名前。

bluemixUtility listServices コマンドで使用可能なオプションはありません。

bluemixUtility showService コマンドで使用可能なオプションは、以下のとおりです。

--showCredentials
サービス資格情報を表示します。
serviceName
IBM Cloud サービスの名前。

bluemixUtility import コマンドで使用可能なオプションは、以下のとおりです。

--acceptLicense
ライセンス条項に同意することを自動的に示します。
--credentialName=name
サービス資格情報の名前。デフォルトでは、最初に見つかった資格情報が使用されます。
--encodeAlgorithm=[xor|aes]
インポートされたサービス構成内の機密情報をエンコードする方法を指定します。サポートされるエンコード値は、xor および aes です。 デフォルトのエンコード・アルゴリズムは xor です。
--encodeKey=key
AES 暗号化でエンコードする際に使用する鍵を指定します。 このオプションを指定しないと、デフォルトの鍵が使用されます。
--p[parameter]=value
サービスの構成の生成とインポートで有用なパラメーターを指定します。
serviceName
IBM Cloud サービスの名前。

bluemixUtility listImports コマンドで使用可能なオプションは、以下のとおりです。

[serverName]
既にこの特定のサーバーにバインドされているサービスをリストします。

bluemixUtility bind コマンドで使用可能なオプションは、以下のとおりです。

--v[variable]=value
インポートされたサービス構成内の変数をオーバーライドします。
--acceptLicense
ライセンス条項に同意することを自動的に示します。
serverName
サービス構成にバインドするサーバーの名前。
serviceName
インポートされたサービス構成の名前。

bluemixUtility unbind コマンドで使用可能なオプションは、以下のとおりです。

serverName
アンバインドするサービス構成がバインドされているサーバーの名前。
serviceName
アンバインドするサービス構成の名前。

bluemixUtility deleteService コマンドで使用可能なオプションは、以下のとおりです。

--force
確認を求めずに削除を強制します。
serviceName
削除するサービスの名前。

bluemixUtility switch コマンドで使用可能なオプションは、以下のとおりです。

--org=organizationName
組織名。
--space=spaceName
スペース名。

bluemixUtility info コマンドで使用可能なオプションはありません。

bluemixUtility logout コマンドで使用可能なオプションはありません。

戻りコード

表 1. 戻りコードと説明
戻りコード 説明
0 コマンドは、要求された操作を正常に完了しました。
20 1 つ以上のコマンド・ライン引数またはオプションが無効です。
21 未知のランタイム例外が発生しました。
22 主として、ファイルをファイル・システムから削除しようとしたときに、入出力エラーが発生しました。
24 ユーザーによる打ち切り。ユーザーがプロンプトへの応答に失敗した場合、または操作を取り消した場合に発生します。
26 不明な例外が発生しました。
27 ログインしようとしたとき、またはログインせずにタスクを実行しようとしたときに、IBM Cloud 認証エラーが発生しました。
28 IBM Cloud との通信時に一般エラーが発生しました。
29 構成サービスとの通信時に一般エラーが発生しました。
30 一般サービス構成エラーが発生しました。
31 一般フィーチャー・インストール・エラーが発生しました。
255 不明なエラーが発生しました。

トピックのタイプを示すアイコン 参照トピック

ファイル名: rwlp_blmx_utility.html