IBM Storage Ceph as a Service CLI

IBM Storage Ceph as a Service プラグインは、 IBM Cloud のコマンドラインインターフェイス (CLI) を拡張し、ボリューム、ホスト、マッピング、オブジェクト認証情報、証明書の管理など、サービスのさまざまな操作を実行するコマンドを実行できるようにします。

前提条件

IBM Storage Ceph as a Service CLI プラグインを使用する前に、まず IBM Cloud CLI をインストールし、CLI にログインしてから software-defined-storage CLI プラグインをインストールする必要があります。 IBM Cloud CLI のインストール方法については、「 IBM Cloud CLI のはじめに」を 参照してください。

このプラグインは、64ビットプロセッサ上で動作する linux64、Windows®、および macOS® の各プラットフォームに対応しています。

plugin install コマンドを使用して、プラグインをインストールします：

ibmcloud plugin install software-defined-storage

プラグインのインストールが完了したら、software-defined-storage プラグインを実行してインストールを確認できます。実行すると、ヘルプが表示されます：

ibmcloud software-defined-storage --help

出力には、USAGE コマンドの説明と、サポートされているコマンドが一覧表示されます。

プラグインの更新

plugin update コマンドを使用して、プラグインを更新してください。

ibmcloud plugin update software-defined-storage

最新のプラグインバージョンがダウンロードされ、現在のプラグインサービスコマンドと置き換わります。 利用可能な新しいアップデートがない場合は、 No updates are available というメッセージが表示されます。

IBM Cloud のCLIおよびプラグインの更新が利用可能になると、コマンドライン上で通知されます。 最新のコマンドを使用できるように、CLI をいつも最新の状態にしておいてください。 ibmcloud plugin list を実行すると、インストールされているすべてのプラグインの現行バージョンを表示できます。

コマンド索引

各操作には、その機能、使用方法、およびオプションまたは必須のパラメータに関する説明が記載されています。 リストされているすべてのパラメーターは、オプションと示されていない限り、必須です。

CLIプラグインは、ソフトウェア定義ストレージで利用可能なすべての機能にはまだ対応していません。

ソフトウェア定義ストレージ

software-defined-storage- IBM Cloud プラットフォーム上の IBM Storage Ceph as a Service CLI 用の OpenAPI 定義。

ibmcloud software-defined-storage [command] [options]

software-defined-storage の別名： sds

ブロック・ストレージ

ibmcloud sds volume-create

このコマンドを使用すると、指定した容量の新しいボリュームを作成できます。

ibmcloud sds volume-create --capacity CAPACITY [--name NAME] [--source-snapshot (SOURCE-SNAPSHOT | @SOURCE-SNAPSHOT-FILE) | --source-snapshot-id SOURCE-SNAPSHOT-ID]

volume-create の別名： volc

例：新しいボリュームの作成

ibmcloud sds volume-create \
    --capacity 10 \
    --name my-volume \
    --url $sds_endpoint

例：スナップショットからボリュームを復元する

ibmcloud sds volume-create \
    --name test-volume-restored \
    --source-snapshot-id r134-eda57df4-41f2-48d8-812d-3d81955b6a1a \
    --capacity 10 \
    --url $sds_endpoint

スナップショットからボリュームを復元する場合、その容量は元のボリュームの容量以上でなければなりません。

$sds_endpoint は環境変数で、 IBM Storage Ceph as a Service の設定時に提供されたエンドポイントを指す。 URL のフォームです。 例えば、https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1 です。 URL を一度設定すれば、コマンドごとに追加する必要がなくなります。 URL の設定方法については 、「設定コマンド」 を参照してください。

指定するパラメーター:

  • ボリュームの容量（ギガバイト単位）。

    • フラグ: --capacity CAPACITY

  • ボリュームの名前。

    • フラグ: --name NAME

    新しいボリュームの名前を指定しない場合、システムはランダムに選択された単語をハイフンでつないだ名前を生成します。

  • URL フォームのAPIエンドポイント。

    • フラグ: --url string

  • このボリュームの作成元スナップショット。

    • フラグ: --source-snapshot

    スナップショットからボリュームを作成する場合は、このオプションを使用します。

  • リソースのユニークなスナップショット識別子。

    • フラグ: --source-snapshot-id

    スナップショットからボリュームを作成する場合は、このオプションを使用します。

ibmcloud sds volume

このコマンドを使用して、1つのボリュームの詳細情報を取得します。

ibmcloud sds volume --volume-id VOLUME-ID --url string

volume の別名： vol

コマンド例:

ibmcloud sds volume \
    --volume-id r134-f24710c4-d5f4-4881-ab78-7bfXX6281f39 \
    --url $sds_endpoint

$sds_endpoint は環境変数で、 IBM Storage Ceph as a Service の設定時に提供されたエンドポイントを指す。 URL のフォームです。 例えば、https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1 です。 URL を一度設定すれば、コマンドごとに追加する必要がなくなります。 URL の設定方法については 、「設定コマンド」 を参照してください。

指定するパラメーター:

  • ボリューム識別子。

    • フラグ: --volume-id VOLUME-ID

  • URL フォームのAPIエンドポイント。

    • フラグ: --url string

ibmcloud sds volume-update

このコマンドを、ボリュームパッチパラメータで指定された新しい情報と組み合わせて使用し、ボリュームの容量またはボリューム名を更新してください。

コマンドでは、一度に変更できるパラメータ値は1つだけです。 同一コマンドの複数回の変更はサポートされていません。

ibmcloud sds volume-update --volume-id VOLUME-ID [--volume-patch VOLUME-PATCH | @VOLUME-PATCH-FILE] --url string

volume-update の別名： volu

コマンド例:

ibmcloud sds volume-update \
    --volume-id r134-f24710c4-d5f4-4881-ab78-7bfXX6281f39 \
    --capacity 38 \
    --name my-volume-updated \
    --url $sds_endpoint

$sds_endpoint は環境変数で、 IBM Storage Ceph as a Service の設定時に提供されたエンドポイントを指す。 URL のフォームです。 例えば、https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1 です。 URL を一度設定すれば、コマンドごとに追加する必要がなくなります。 URL の設定方法については 、「設定コマンド」 を参照してください。

指定するパラメーター:

  • ボリューム識別子。

    • 旗：--volume-id VOLUME-ID

  • ボリュームの容量（ギガバイト単位）。

    • フラグ: --capacity CAPACITY

  • ボリュームの名前。

    • フラグ: --name NAME

  • [オプションの] JSONオブジェクトで、JSONファイルへのパスなどのボリューム情報を含む。

    • フラグ: --volume-patch VOLUME-PATCH

  • URL フォームのAPIエンドポイント。

    • フラグ: --url string

ibmcloud sds volume-delete

このコマンドを使用して、1つのボリュームを削除します。

ibmcloud sds volume-delete --volume-id VOLUME-ID --url string

volume-delete の別名： vold

コマンド例:

ibmcloud sds volume-delete \
    --volume-id r134-f24710c4-d5f4-4881-ab78-7bfXX6281f39 \
    --url $sds_endpoint

$sds_endpoint は環境変数で、 IBM Storage Ceph as a Service の設定時に提供されたエンドポイントを指す。 URL のフォームです。 例えば、https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1 です。 URL を一度設定すれば、コマンドごとに追加する必要がなくなります。 URL の設定方法については 、「設定コマンド」 を参照してください。

指定するパラメーター:

  • ボリューム識別子。

    • 旗：--volume-id VOLUME-ID

  • URL フォームのAPIエンドポイント。

    • フラグ: --url string

ibmcloud sds volumes

このコマンドを使用して、すべてのボリュームをリストします。

ibmcloud sds volumes --help [--limit LIMIT] [--name NAME] --url string

volumes の別名： vols

コマンド例:

ibmcloud sds volumes --help \
    --limit 10 \
    --name my-volume \
    --url $sds_endpoint

$sds_endpoint は環境変数で、 IBM Storage Ceph as a Service の設定時に提供されたエンドポイントを指す。 URL のフォームです。 例えば、https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1 です。 URL を一度設定すれば、コマンドごとに追加する必要がなくなります。 URL の設定方法については 、「設定コマンド」 を参照してください。

指定するパラメーター:

  • 1ページで返すリソースの数。 デフォルト値は 1 です。 上限値は1000です。

    • フラグ: --limit int

  • リソースコレクションから名前でフィルタリングする。 文字列の長さは0文字から200文字まで指定できます。

    • フラグ: --name string

ホスト

ibmcloud sds host-create

このコマンドを使用して、新しいホストを作成します。

ibmcloud sds host-create --name NAME --nqn NQN [--volume-mappings VOLUME-MAPPINGS | @VOLUME-MAPPINGS-FILE] --url string --psk string

host-create の別名： hstc

コマンド例:

ibmcloud sds host-create \
    --name my-host \
    --nqn nqn.2014-06.org:9345 \
    --volume-mappings '[{"volume": {"id": "1a6b7274-678d-4dfb-8981-c71dd9d4daa5"}}]' \
    --url $sds_endpoint

$sds_endpoint は環境変数で、 IBM Storage Ceph as a Service の設定時に提供されたエンドポイントを指す。 URL のフォームです。 例えば、https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1 です。 URL を一度設定すれば、コマンドごとに追加する必要がなくなります。 URL の設定方法については 、「設定コマンド」 を参照してください。

指定するパラメーター:

  • 顧客の環境で構成されたホストの NVMe 修飾名 (NQN)。 サポートされている最大長は223バイトです。

    • フラグ: --nqn NQN

  • 新しいホストの名前。 新しい名前が一意であることを確認してください。

    • フラグ: --name NAME

    新しいホストに名前を指定しない場合、システムはランダムに選択した単語をハイフンでつなげた名前を生成します。

  • 新しいホストのPSK。 トランスポート層セキュリティ（TLS）の事前共有鍵（PSK）暗号スイート（ TLS-PSK）は、事前共有鍵（PSK）に基づいて安全な通信を実現する暗号プロトコルのセットです。

    • フラグ: --psk string

  • このホストにマッピングされるボリュームの固有の識別子。 [{"volume": {"id": "1a6b7274-678d-4dfb-8981-c71dd9d4daa5"}}] の形式でなければなりません。

    • フラグ: --volume-mappings VOLUME-MAPPINGS

  • URL フォームのAPIエンドポイント。

    • フラグ: --url string

ibmcloud sds host

このコマンドを使用して、1つのホストの詳細情報を取得します。

ibmcloud sds host --host-id HOST-ID --url string

コマンド例:

ibmcloud sds host \
    --host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
    --url $sds_endpoint

$sds_endpoint は環境変数で、 IBM Storage Ceph as a Service の設定時に提供されたエンドポイントを指す。 URL のフォームです。 例えば、https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1 です。 URL を一度設定すれば、コマンドごとに追加する必要がなくなります。 URL の設定方法については 、「設定コマンド」 を参照してください。

指定するパラメーター:

  • 詳細を確認したいホストID

    • フラグ: --host-id HOST-ID

  • URL フォームのAPIエンドポイント。

    • フラグ: --url string

ibmcloud sds hosts

このコマンドを使用して、すべてのホストを一覧表示します。

ibmcloud sds hosts [--limit LIMIT] --url string

hosts の別名： hsts

コマンド例:

ibmcloud sds hosts \
    --limit 10 \
    --url $sds_endpoint

$sds_endpoint は環境変数で、 IBM Storage Ceph as a Service の設定時に提供されたエンドポイントを指す。 URL のフォームです。 例えば、https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1 です。 URL を一度設定すれば、コマンドごとに追加する必要がなくなります。 URL の設定方法については 、「設定コマンド」 を参照してください。

指定するパラメーター:

  • 1ページで返すリソースの数。

    • フラグ: --limit LIMIT

  • このオプションを含めると、リソースのコレクションが名前でフィルタリングされます。

    • フラグ: --name NAME

  • URL フォームのAPIエンドポイント。

    • フラグ: --url string

ibmcloud sds host-update

ホストを更新するには、このコマンドを使用してください。

ibmcloud sds host-update --host-id HOST-ID [--host-patch HOST-PATCH | @HOST-PATCH-FILE] --url string

host-update の別名： hstu

コマンド例:

ibmcloud sds host-update \
    --host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
    --name my-host
    --url $sds_endpoint

$sds_endpoint は環境変数で、 IBM Storage Ceph as a Service の設定時に提供されたエンドポイントを指す。 URL のフォームです。 例えば、https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1 です。 URL を一度設定すれば、コマンドごとに追加する必要がなくなります。 URL の設定方法については 、「設定コマンド」 を参照してください。

指定するパラメーター:

  • 詳細を更新したいホストID

    • フラグ: --host-id HOST-ID

  • [オプション] host_update のための JSON マージパッチの内容を指定します。

    • フラグ: --host-patch HOST-PATCH

  • 新しいホストの名前。 新しい名前が一意であることを確認してください。

    • フラグ: --name NAME

    新しいホストに名前を指定しない場合、システムはランダムに選択した単語をハイフンでつなげた名前を生成します。

  • URL フォームのAPIエンドポイント。

    • フラグ: --url string

ibmcloud sds host-mapping-create

このコマンドを使用して、ボリュームをホストにマッピングします。

ibmcloud sds host-mapping-create --host-id HOST-ID [--volume (VOLUME | @VOLUME-FILE) | --volume-id VOLUME-ID]

host-mapping-create の別名： hstmc

コマンド例:

ibmcloud sds host-mapping-create \
    --host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
    --volume '{"id": "r134-f24710c4-d5f4-4881-ab78-7bfXX6281f39"}' \
    --url $sds_endpoint

それとも

ibmcloud sds host-mapping-create \
    --host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
    --volume-id r134-f24710c4-d5f4-4881-ab78-7bfXX6281f39 \
    --url $sds_endpoint

$sds_endpoint は環境変数で、 IBM Storage Ceph as a Service の設定時に提供されたエンドポイントを指す。 URL のフォームです。 例えば、https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1 です。 URL を一度設定すれば、コマンドごとに追加する必要がなくなります。 URL の設定方法については 、「設定コマンド」 を参照してください。

指定するパラメーター:

  • 詳細を表示したいホストIDを指定します

    • フラグ: --host-id HOST-ID

  • 一意のボリューム識別子を指定します。

    • フラグ: --volume-id VOLUME-ID

  • このホストにマッピングされるボリュームの固有の識別子。 [{"volume": {"id": "1a6b7274-678d-4dfb-8981-c71dd9d4daa5"}}] の形式でなければなりません。

    • フラグ: --volume VOLUME-ID

  • URL フォームのAPIエンドポイント。

    • フラグ: --url string

ibmcloud sds host-mappings

このコマンドを使用すると、特定のホストに対するすべてのホストマッピングを表示できます。

ibmcloud sds host-mappings --host-id HOST-ID

host-mappings の別名： hstms

コマンド例:

ibmcloud sds host-mappings \
    --host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
    --url $sds_endpoint

$sds_endpoint は環境変数で、 IBM Storage Ceph as a Service の設定時に提供されたエンドポイントを指す。 URL のフォームです。 例えば、https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1 です。 URL を一度設定すれば、コマンドごとに追加する必要がなくなります。 URL の設定方法については 、「設定コマンド」 を参照してください。

指定するパラメーター:

  • 詳細を確認したいホストID

    • フラグ: --host-id HOST-ID

  • URL フォームのAPIエンドポイント。

    • フラグ: --url string

ibmcloud sds host-mapping

このコマンドを使用すると、特定のホストに対する単一のホストマッピングを表示できます。

ibmcloud sds host-mapping --host-id HOST-ID --volume-mapping-id VOLUME-MAPPING-ID

host-mapping の別名： hstm

コマンド例:

ibmcloud sds host-mapping \
    --host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
    --volume-mapping-id r134-f24710c4-d5f4-4881-ab78-7bfXX6281f39 \
    --url $sds_endpoint

$sds_endpoint は環境変数で、 IBM Storage Ceph as a Service の設定時に提供されたエンドポイントを指す。 URL のフォームです。 例えば、https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1 です。 URL を一度設定すれば、コマンドごとに追加する必要がなくなります。 URL の設定方法については 、「設定コマンド」 を参照してください。

指定するパラメーター:

  • 詳細を確認したいホストID

    • フラグ: --host-id HOST-ID

  • ユニークなボリュームマッピング識別子。 このIDは、この操作を完了したい関連ボリュームまたはホストを表示することで見つけることができる。

    • フラグ: --volume-mapping-id VOLUME-MAPPING_ID

  • URL フォームのAPIエンドポイント。

    • フラグ: --url string

ibmcloud sds host-delete

ホストを削除するには、このコマンドを使用します。

ibmcloud sds host-delete --host-id HOST-ID --url string

host-delete の別名： hstd

コマンド例:

ibmcloud sds host-delete \
    --host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
    --url $sds_endpoint

$sds_endpoint は環境変数で、 IBM Storage Ceph as a Service の設定時に提供されたエンドポイントを指す。 URL のフォームです。 例えば、https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1 です。 URL を一度設定すれば、コマンドごとに追加する必要がなくなります。 URL の設定方法については 、「設定コマンド」 を参照してください。

指定するパラメーター:

  • 詳細を確認したいホストID

    • フラグ: --host-id HOST-ID

  • URL フォームのAPIエンドポイント。

    • フラグ: --url string

ibmcloud sds host-mapping-delete

このコマンドを使用すると、ホストから単一のボリュームマッピングを削除できます。

ibmcloud sds host-mapping-delete --host-id HOST-ID --volume-mapping-id VOLUME-MAPPING-ID

host-mapping-delete の別名： hstmd

コマンド例:

ibmcloud sds host-mapping-delete \
    --host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
    --volume-mapping-id r134-f24710c4-d5f4-4881-ab78-7bfXX6281f39 \
    --url $sds_endpoint

$sds_endpoint は環境変数で、 IBM Storage Ceph as a Service の設定時に提供されたエンドポイントを指す。 URL のフォームです。 例えば、https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1 です。 URL を一度設定すれば、コマンドごとに追加する必要がなくなります。 URL の設定方法については 、「設定コマンド」 を参照してください。

指定するパラメーター:

  • 詳細を確認したいホストID

    • フラグ: --host-id HOST-ID

  • ユニークなボリュームマッピング識別子。 このIDは、この操作を完了したい関連ボリュームまたはホストを表示することで見つけることができる。

    • フラグ: --volume-mapping-id VOLUME-MAPPING_ID

  • URL フォームのAPIエンドポイント。

    • フラグ: --url string

ibmcloud sds host-mapping-delete-all

このコマンドを使用すると、ホストに関連付けられているすべてのボリュームマッピングを削除できます。

ibmcloud sds host-mapping-delete-all --host-id HOST-ID

host-vol-delete-all の別名： hstmda

コマンド例:

ibmcloud sds host-mapping-delete-all \
    --host-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
    --url $sds_endpoint

$sds_endpoint は環境変数で、 IBM Storage Ceph as a Service の設定時に提供されたエンドポイントを指す。 URL のフォームです。 例えば、https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1 です。 URL を一度設定すれば、コマンドごとに追加する必要がなくなります。 URL の設定方法については 、「設定コマンド」 を参照してください。

指定するパラメーター:

  • 詳細を確認したいホストID

    • フラグ: --host-id HOST-ID

  • URL フォームのAPIエンドポイント。

    • フラグ: --url string

オブジェクト・ストレージ

ibmcloud sds cred-create

このコマンドを使用して、 アカウント認証情報を更新するか、存在しない場合は作成します。

ibmcloud sds cred-create --access-key ACCESS-KEY --url string

cred-create の別名： crc

コマンド例:

ibmcloud sds cred-create \
    --access-key mytestkey
    --url $sds_endpoint

$sds_endpoint は環境変数で、 IBM Storage Ceph as a Service の設定時に提供されたエンドポイントを指す。 URL のフォームです。 例えば、https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1 です。 URL を一度設定すれば、コマンドごとに追加する必要がなくなります。 URL の設定方法については 、「設定コマンド」 を参照してください。

指定するパラメーター:

  • サービスインスタンスのアクセスキーを設定します。

    • フラグ: --access-key ACCESS-KEY

  • URL フォームのAPIエンドポイント。

    • フラグ: --url string

ibmcloud sds cred-delete

サービスの認証情報を削除するには、このコマンドを使用します。

ibmcloud sds cred-delete --access-key ACCESS-KEY --url string

cred-delete の別名： crd

コマンド例:

ibmcloud sds cred-delete \
    --access-key mytestkey
    --url $sds_endpoint

$sds_endpoint は環境変数で、 IBM Storage Ceph as a Service の設定時に提供されたエンドポイントを指す。 URL のフォームです。 例えば、https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1 です。 URL を一度設定すれば、コマンドごとに追加する必要がなくなります。 URL の設定方法については 、「設定コマンド」 を参照してください。

指定するパラメーター:

  • サービスインスタンスのアクセスキーを設定します。

    • フラグ: --access-key ACCESS-KEY

  • URL フォームのAPIエンドポイント。

    • フラグ: --url string

ibmcloud sds creds

このコマンドを使用して、特定のアカウントの認証情報を取得します。

ibmcloud sds creds --url string

creds の別名： crl

コマンド例:

ibmcloud sds creds \
    --url $sds_endpoint

$sds_endpoint は環境変数で、 IBM Storage Ceph as a Service の設定時に提供されたエンドポイントを指す。 URL のフォームです。 例えば、https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1 です。 URL を一度設定すれば、コマンドごとに追加する必要がなくなります。 URL の設定方法については 、「設定コマンド」 を参照してください。

指定するパラメーター:

  • URL フォームのAPIエンドポイント。
    • フラグ: --url string

ibmcloud sds cert-types

このコマンドを使用して、設定済みの SSL 証明書タイプのリストを取得します。

ibmcloud sds cert-types --url string

cert-types の別名： crtt

コマンド例:

ibmcloud sds cert-types \
    --url $sds_endpoint

$sds_endpoint は環境変数で、 IBM Storage Ceph as a Service の設定時に提供されたエンドポイントを指す。 URL のフォームです。 例えば、https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1 です。 URL を一度設定すれば、コマンドごとに追加する必要がなくなります。 URL の設定方法については 、「設定コマンド」 を参照してください。

指定するパラメーター:

  • URL フォームのAPIエンドポイント。
    • フラグ: --url string

ibmcloud sds cert-create

SSL の証明書が存在しない場合は、このコマンドを使用して新しい証明書を作成してください。

ibmcloud sds cert-create --cert CERT --body BODY --url string

cert-create の別名： crtc

コマンド例:

ibmcloud sds cert-create \
    --cert s3 \
    --body tempdir/test-file.txt \
    --url $sds_endpoint

$sds_endpoint は環境変数で、 IBM Storage Ceph as a Service の設定時に提供されたエンドポイントを指す。 URL のフォームです。 例えば、https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1 です。 URL を一度設定すれば、コマンドごとに追加する必要がなくなります。 URL の設定方法については 、「設定コマンド」 を参照してください。

指定するパラメーター:

  • TLS の証明書を含むリクエスト本文。 CLIは、 .pem 形式の証明書ファイルを受け入れます。

    • フラグ: --body BODY

  • リクエストで使用する証明書のタイプ。 有効な値には、 s3 などがあります。

    • フラグ: --cert CERT

  • URL フォームのAPIエンドポイント。

    • フラグ: --url string

ibmcloud sds cert-update

このコマンドを使用して、既存の SSL 証明書を更新します。

ibmcloud sds cert-update --cert CERT --body BODY --url string

cert-update の別名： crtu

コマンド例:

ibmcloud sds cert-update \
    --cert s3 \
    --body tempdir/test-file.pem \
    --url $sds_endpoint

$sds_endpoint は環境変数で、 IBM Storage Ceph as a Service の設定時に提供されたエンドポイントを指す。 URL のフォームです。 例えば、https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1 です。 URL を一度設定すれば、コマンドごとに追加する必要がなくなります。 URL の設定方法については 、「設定コマンド」 を参照してください。

指定するパラメーター:

  • TLS の証明書を含むリクエスト本文。 CLIは、 .pem 形式の証明書ファイルを受け入れます。

    • フラグ: --body BODY

  • リクエストで使用する証明書のタイプ。 有効な値には、 s3 などがあります。

    • フラグ: --cert CERT

  • URL フォームのAPIエンドポイント。

    • フラグ: --url string

ibmcloud sds cert

このコマンドを使用して、 SSL の証明書の有効期限とステータスを確認します。

ibmcloud sds cert --cert CERT --url string

コマンド例:

ibmcloud sds cert \
    --cert s3
    --url $sds_endpoint

$sds_endpoint は環境変数で、 IBM Storage Ceph as a Service の設定時に提供されたエンドポイントを指す。 URL のフォームです。 例えば、https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1 です。 URL を一度設定すれば、コマンドごとに追加する必要がなくなります。 URL の設定方法については 、「設定コマンド」 を参照してください。

指定するパラメーター:

  • リクエストで使用する証明書のタイプ。 有効な値には、 s3 などがあります。

    • フラグ: --cert CERT

  • URL フォームのAPIエンドポイント。

    • フラグ: --url string

ibmcloud sds cert-delete

SSL の証明書を削除するには、このコマンドを使用します。

ibmcloud sds cert-delete --cert CERT --url string

cert-delete の別名： crtd

コマンド例:

ibmcloud sds cert-delete \
    --cert s3
    --url $sds_endpoint

$sds_endpoint は環境変数で、 IBM Storage Ceph as a Service の設定時に提供されたエンドポイントを指す。 URL のフォームです。 例えば、https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1 です。 URL を一度設定すれば、コマンドごとに追加する必要がなくなります。 URL の設定方法については 、「設定コマンド」 を参照してください。

指定するパラメーター:

  • リクエストで使用する証明書のタイプ。 有効な値には、 s3 などがあります。

    • フラグ: --cert CERT

  • URL フォームのAPIエンドポイント。

    • フラグ: --url string

スナップショット・コマンド

ibmcloud sds volume-snapshot-create

このコマンドを使用して、ボリュームのスナップショットを作成します。

ibmcloud sds volume-snapshot-create [--source-volume (SOURCE-VOLUME | @SOURCE-VOLUME-FILE) | --source-volume-id SOURCE-VOLUME-ID] [--name NAME]

volume-snapshot-create の別名： vsnapc

コマンド例:

ic sds volume-snapshot-create --source-volume-id r134-87a59338-a801-4090-a657-72867fc9ba44

$sds_endpoint は環境変数で、 IBM Storage Ceph as a Service の設定時に提供されたエンドポイントを指す。 URL のフォームです。 例えば、https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1 です。 URL を一度設定すれば、コマンドごとに追加する必要がなくなります。 URL の設定方法については 、「設定コマンド」 を参照してください。

指定するパラメーター:

  • 新しいスナップショットを作成する必要があるブロックボリュームID。

    • フラグ: --source-volume-id

  • スナップショットの固有の名前。 オプションのパラメーター。

    • フラグ: --name

ibmcloud sds volume-snapshot

このコマンドを使用して、1つのスナップショットの詳細情報を取得します。

ibmcloud sds volume-snapshot --snap-id SNAP-ID

volume-snapshot の別名： vsnap

コマンド例:

ibmcloud sds volume-snapshot \
    --snap-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
    --url $sds_endpoint

$sds_endpoint は環境変数で、 IBM Storage Ceph as a Service の設定時に提供されたエンドポイントを指す。 URL のフォームです。 例えば、https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1 です。 URL を一度設定すれば、コマンドごとに追加する必要がなくなります。 URL の設定方法については 、「設定コマンド」 を参照してください。

指定するパラメーター:

  • 詳細を取得したいスナップショットの識別子。
    • フラグ: --snap-id

ibmcloud sds volume-snapshots

このコマンドを使用して、すべてのスナップショットを一覧表示します。

ibmcloud sds volume-snapshots [--start START] [--limit LIMIT] [--name NAME] [--source-volume-id SOURCE-VOLUME-ID]

volume-snapshots の別名： vsnaps

コマンド例:

ibmcloud sds volume-snapshots \
    --start r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
    --limit 20 \
    --name my-host \
    --source-volume-id exampleString \
    --url $sds_endpoint

$sds_endpoint は環境変数で、 IBM Storage Ceph as a Service の設定時に提供されたエンドポイントを指す。 URL のフォームです。 例えば、https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1 です。 URL を一度設定すれば、コマンドごとに追加する必要がなくなります。 URL の設定方法については 、「設定コマンド」 を参照してください。

指定するパラメーター:

オプション・パラメーターは、以下のおとりです。

  • 結果のページを開始するリソースIDを指定します。 大規模なコレクションのページ分割に便利。

    • フラグ: --start

  • ページごとに返すリソース（スナップショット）の最大数を設定します。

    • フラグ: --limit

  • 指定した文字列と一致する名前のスナップショットのみを含むように結果をフィルタリングします。

    • フラグ: --name

  • 指定されたソース・ボリュームIDに属するスナップショットのみを含むように結果をフィルタリングします。

    • フラグ: source-volume-id

  • ボリューム・スナップショットを一覧表示する場合、このオプションは自動的に複数の要求を行い、結果の全ページを取得して表示するため、手動で結果をページングすることなく、コレクション全体を見ることができます。

    • フラグ: all-pages

ibmcloud sds volume-snapshot-update

スナップショットを更新するには、このコマンドを使用してください。

ibmcloud sds volume-snapshot-update --snap-id SNAP-ID [--snapshot-patch SNAPSHOT-PATCH | @SNAPSHOT-PATCH-FILE]

volume-snapshot-update の別名： vsnapu

コマンド例:

ibmcloud sds volume-snapshot-update \
    --snap-id r134-69d5c3e2-8229-45f1-89c8-e4dXXb2e126e \
    --name snap-2-updated \
    --url $sds_endpoint

$sds_endpoint は環境変数で、 IBM Storage Ceph as a Service の設定時に提供されたエンドポイントを指す。 URL のフォームです。 例えば、https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1 です。 URL を一度設定すれば、コマンドごとに追加する必要がなくなります。 URL の設定方法については 、「設定コマンド」 を参照してください。

指定するパラメーター:

  • (必須) 更新したいスナップショットの一意の識別子。

    • フラグ: --snap-id

  • 更新が必要なスナップショット名を指定します。

    • フラグ: --name

  • スナップショットを更新するための JSON Merge-Patch コンテンツを提供します。 これは、コマンドに直接JSON文字列を指定するか、パッチデータを含むJSONファイルへのパスを指定する。 これにより、スナップショットの特定のフィールドを更新することができます。

    • フラグ: --snapshot-patch

ibmcloud sds volume-snapshot-delete

このコマンドを使用して、1つのスナップショットを削除します。

ibmcloud sds volume-snapshot-delete --snap-id SNAP-ID

volume-snapshot-delete の別名： vsnapd

コマンド例:

ibmcloud sds volume-snapshot-delete \
    --snap-id r134-76a4e08c-aa22-4fd3-9eb5-5cae0e78a285 \
    --url $sds_endpoint
Are you sure you want to delete? [y/n]> y
...
OK

$sds_endpoint は環境変数で、 IBM Storage Ceph as a Service の設定時に提供されたエンドポイントを指す。 URL のフォームです。 例えば、https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1 です。 URL を一度設定すれば、コマンドごとに追加する必要がなくなります。 URL の設定方法については 、「設定コマンド」 を参照してください。

指定するパラメーター:

  • コマンドを強制的に実行するには

    • フラッグ： -f、 --force

  • 削除したいスナップショットの固有識別子。

    • フラグ: --snap-id

ibmcloud sds volume-snapshots-delete

このコマンドを使用すると、ボリュームのすべてのスナップショットを削除できます。

ibmcloud sds volume-snapshots-delete [--source-volume-id SOURCE-VOLUME-ID]

volume-snapshots-delete の別名： vsnapsd

コマンド例:

ibmcloud sds volume-snapshots-delete \
    --source-volume-id r134-76a4e08c-aa22-4fd3-9eb5-5cae0e78a285 \
    --url $sds_endpoint
Are you sure you want to delete? [y/n]> y
...
OK

$sds_endpoint は環境変数で、 IBM Storage Ceph as a Service の設定時に提供されたエンドポイントを指す。 URL のフォームです。 例えば、https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}/v1 です。 URL を一度設定すれば、コマンドごとに追加する必要がなくなります。 URL の設定方法については 、「設定コマンド」 を参照してください。

指定するパラメーター:

  • コマンドを強制的に実行するには

    • フラッグ： -f、 --force

  • 指定 し た識別子に一致す る source_volume-id プ ロ パテ ィ を持つ リ ソ ース （ス ナ ッ プ シ ョ ッ ト な ど） にのみ影響を与え る よ う、 操作を フ ィ ル タ し ます。 特定のボリュームのすべてのスナップショットを対象とする場合に使用します。

    • フラグ: --source-volume-id

構成のコマンド

Config コマンドは、グローバルオプションの永続的な設定の制御や表示に使用できます。

永続的なコンフィギュレーションを制御または表示するには、 ibmcloud sds config コマンドをグローバル・オプションとともに実行し、コンフィギュレーション値の一覧表示、設定、解除を行う。

url 変数を設定すると、 sds コマンドで使用する際に --url フラグを使用する必要がなくなります。

ibmcloud sds config

URLオプションの設定例。

pc@mac ~ % ibmcloud sds config set url http://sds-endpoint.satellite.cloud.ibm.com:33189/v1
OK

config set を使用せずにコマンドを使用する方法を示す例。

pc@mac ~ % ibmcloud sds volumes --url $endpoint

url を設定した状態でコマンドを使用する方法を例で示します。

pc@mac ~ % ibmcloud sds volumes

構成コマンドオプション

  • get- 現在設定されているオプションの構成値を取得します。

  • list- 現在設定されているすべての構成値を取得します。

  • set- オプションの設定値を設定します。

  • unset- オプションの設定値を解除します。

ibmcloud sds config get

このコマンドを使用すると、特定のオプションについて現在設定されている値を取得できます。

Get オプションと url オプションを同時に使用すると、現在設定されている「url」オプションの値が取得されます。

ibmcloud sds config get url

出力例をご覧ください。

pc@mac ~ % ibmcloud sds config get url
http://sds-endpoint.satellite.cloud.ibm.com:33189/v1

ibmcloud sds config list

このコマンドを使用すると、現在設定されているすべての設定値を取得して表示できます。

ibmcloud sds config list

出力例をご覧ください。

pc@mac ~ % ibmcloud sds config list
url
http://sds-endpoint.satellite.cloud.ibm.com:33189/v1

ibmcloud sds config set

このコマンドを使用して、特定のオプションの新しい値を設定します。

ibmcloud sds config set [url]

set オプションと url オプションを同時に使用する場合、「url」オプションの値が設定されます。

url オプションの例を参照してください。

pc@mac ~ % ibmcloud sds config set url http://sds-endpoint.satellite.cloud.ibm.com:33189/v1

ibmcloud sds config unset

このコマンドを使用すると、特定のオプションについて、現在設定されている値をリセットできます。

ibmcloud sds config unset [url]

unset オプションと url オプションを同時に使用すると、「url」オプションの現在設定されている値がリセットされます。

次のステップ

実行可能なコマンドの詳細については、 ibmcloud sds --help を実行してください。