カタログ管理 CLI プラグイン

IBM Cloud® catalogs management command-line interface (CLI) は、 IBM Cloud catalogs およびお客様のアカウント内のプライベートカタログの製品を操作するための追加機能を提供します。この CLI プラグインを使用して、プライベート・カタログの管理、プライベート・ソフトウェア製品のオンボード、およびパブリック・カタログとプライベート・カタログの間のカタログの可視性の管理を行うことができます。

開始前に

IBM Cloud CLI をインストールします。詳しくは、IBM Cloud CLI の概要を参照してください。 IBM Cloud CLI を使用してコマンドを実行するための接頭部は、ibmcloud です。
レジストリー・コマンドを実行する前に、ibmcloud login コマンドを使用して IBM Cloud にログインし、アクセス・トークンを生成して、セッションを認証します。

カタログ管理プラグインのインストール

カタログ管理プラグインをインストールするには、以下のコマンドを実行します。

ibmcloud plugin install catalogs-management

ibmcloud CLI および catalogs-management CLI プラグインの更新が使用可能になると、コマンド・ラインに通知が表示されます。使用可能なすべてのコマンドおよびフラグを使用できるように、CLI を最新の状態に保つようにしてください。

catalogs-management CLI プラグインの現行バージョンを確認するには、ibmcloud plugin list を実行します。

プライバシーとセキュリティーを維持するため、カタログ名やカタログの説明に個人情報を入力しないでください。

ibmcloud catalog アカウント add-approval-access

以下のコマンドを実行して、カタログ・アカウントへの承認アクセスを追加します。

ibmcloud catalog account add-approval-access [--account-ids IDS] [--object-kind KIND]

コマンド・オプション

--object-kind 価値: オブジェクトの種類を指定します。オプションは、 offering、 vpe、 proxy_source、または preset_configuration です。
--account-ids 価値: アカウントIDのカンマ区切りのリストの先頭に、以下のいずれかを付けてください。通常のアカウントには -acct- を、エンタープライズアカウントには -ent- を、エンタープライズアカウントグループには -entgrp- を指定します。

ibmcloud catalog アカウント delete-approval-access

以下のコマンドを実行して、カタログ・アカウントへの承認アクセスを削除します。

ibmcloud catalog account delete-approval-access [--account-ids IDS] [--object-kind KIND]

コマンド・オプション

--object-kind 価値: オブジェクトの種類を指定します。オプションは、 offering、 vpe、 proxy_source、または preset_configuration です。
--account-ids 価値: アカウントIDのカンマ区切りのリストの先頭に、以下のいずれかを付けてください。通常のアカウントには -acct- を、エンタープライズアカウントには -ent- を、エンタープライズアカウントグループには -entgrp- を指定します。

ibmcloud catalog アカウント get-approval-list

以下のコマンドを実行して、カタログアカウントの承認リストを取得してください。

ibmcloud catalog account get-approval-list [--object-kind KIND]

コマンド・オプション

--object-kind 価値: オブジェクトの種類を指定します。オプションは、 offering、 vpe、 proxy_source、または preset_configuration です。

ibmcloud catalog アカウント get-approval-list-source

以下のコマンドを実行して、ソースを指すすべてのターゲット・アカウントを取得します。

ibmcloud catalog account get-approval-list-source [--approval-state STATE] [--enterprise-id ID] [--object-kind KIND]

コマンド・オプション

--object-kind 価値: オブジェクトの種類を指定します。オプションは、 offering、 vpe、 proxy_source、または preset_configuration です。
--approval-state 価値: 承認状態を指定します。オプションは、 approved、 pending、または rejected です。
--enterprise-id VALUE（オプション）: エンタープライズまたはエンタープライズ・アカウント・グループ ID を指定して、エンタープライズの要求を表示または管理します。 ID の接頭部として、エンタープライズの場合は -ent- 、アカウント・グループの場合は -entgrp を付けます。

ibmcloud catalog アカウント・セット-approval-state-source

以下のコマンドを実行して、ソースを指すターゲット・アカウントの承認状態を設定する。

ibmcloud catalog account set-approval-state-source [--account-ids IDS] [--approval-state STATE] [--enterprise-id ID] [--object-kind KIND]

コマンド・オプション

--object-kind 価値: オブジェクトの種類を指定します。オプションは、 offering、 vpe、 proxy_source、または preset_configuration です。
--approval-state 価値: 承認状態を指定します。オプションは、 approved、 pending、または rejected です。
--account-ids 価値: コンマで区切られたアカウントIDのリストの先頭に、以下のいずれかを付けてください。通常のアカウントの場合は -acct- 、エンタープライズアカウントの場合は -ent- 、エンタープライズアカウントグループの場合は -entgrp-。
--enterprise-id VALUE（オプション）: エンタープライズまたはエンタープライズ・アカウント・グループ ID を指定して、エンタープライズの要求を表示または管理します。 ID の接頭部として、エンタープライズの場合は -ent- 、アカウント・グループの場合は -entgrp を付けます。

ibmcloud catalog create

このコマンドは、自分のアカウントに新規プライベート・カタログを作成するときに使用します。プライベート・カタログを使用して、一連の製品、追加するプライベート製品、または IBM Cloud カタログ内の製品への参照を整理できます。ユーザーに対して製品が表示されて、それらの製品を扱えるようにするには、ユーザーが IAM アクセス・ポリシーによりプライベート・カタログにアクセスでき、またプライベート・カタログを含むリソース・グループにアクセスできる必要があります。

カタログは特定のリソースグループのコンテキストに存在するため、リソースグループをターゲットにしてカタログを作成する。リソース・グループのリストを取得するには、ibmcloud resource groups コマンド、ibmcloud target -g "resource group" コマンドの順に実行できます。

ibmcloud catalog create --name CATALOG [--catalog-description "DESCRIPTION"]

コマンド・オプション

--name CATALOG: カタログ名。
--catalog-description DESCRIPTION (オプション): 新しいカタログの簡略説明。

例

名前が dev-catalog、説明が a catalog for development and testing purpsoses のカタログを作成します。

ibmcloud catalog create --name dev-catalog --catalog-description "a catalog for development and testing purposes"

ibmcloud catalog list

以下のコマンドを実行して、この特定のアカウント内のカタログのリストを取得します。

ibmcloud catalog list [--output FORMAT]

コマンド・オプション

--output FORMAT (オプション): 出力フォーマットを指定します。デフォルトはターミナル互換で、唯一サポートされている代替手段はJSONである。例えば、--output json です。

出力

このコマンドは以下の出力を返します。

Name                                           ID                                     Description                   Last Updated
dev-catalog                                    93f592fb-e09b-4a53-bbd9-92f6ab9e253b   short-description             2019-11-21 21:28:28.347 +0000 UTC
ABDemoTestCatalog                              7a246530-e191-45e2-87cc-07c8c7033d2b   short-description             2019-08-19 17:43:48.59 +0000 UTC

ibmcloud catalog get

以下のコマンドを実行して、対象アカウント内の特定のカタログに関する情報を取得します。

ibmcloud catalog get --catalog CATALOG [--output FORMAT]

コマンド・オプション

--catalog CATALOG: カタログ名またはカタログ ID。
--output FORMAT (オプション): 出力フォーマットを指定します。デフォルトはターミナル互換で、唯一サポートされている代替手段はJSONである。例えば、--output json です。

出力

このコマンドは以下の出力を返します。

Name                                     Current State   Version Locator
dev-catalog
|__dev-offering
|  |__Openshift
|     |__1.0.0                           Draft           480fb4e3-d7ba-4e9b-9d4c-42f0ab811040.fd8f91a3-8027-4919-ad6d-c5189a4a8ee

ibmcloud catalog delete

以下のコマンドを実行して、アカウント内の特定のカタログを削除します。

ibmcloud catalog delete --catalog CATALOG

コマンド・オプション

--catalog CATALOG: カタログ名またはカタログ ID。

ibmcloud catalog search

以下のコマンドを実行して、パブリック・カタログで公開されている製品 (サービスとソフトウェアを含む) を検索します。

ibmcloud catalog search <QUERY> [--catalog CATALOG] [--type TYPE] [-r, --region REGION] [-k, --kind KIND] [--fields FIELDS] [-p, --price PRICE] [-t, --tag TAG] [--sort-by PROPERTY] [--col COLUMNS] [--reverse] [--output TYPE] [--global]

コマンド・オプション

--type TYPE (オプション): オプション。デフォルトはservicesです。有効なオプションは services と software です。
--catalog CATALOG (オプション): アカウントによって公開されたソフトウェアを検索します。検索のキーとして使用するカタログ名またはカタログ ID を指定します。
--output FORMAT (オプション): 出力フォーマットを指定します。デフォルトはターミナル互換で、代替オプションは json と csv のみ。
--kind KIND (オプション): このフラグは検索サービスでのみ有効である。製品タイプのコンマ区切りリストを指定します。
--region REGION (オプション): このフラグは検索サービスでのみ有効である。リージョンのコンマ区切りリストを指定します。 ibmcloud cs regions を実行すると、有効なリストが返されます。
--price PRICE (オプション): このフラグは検索サービスでのみ有効である。価格タイプのコンマ区切りリストを指定します。
--tag TAG (オプション): このフラグは検索サービスでのみ有効である。タグのコンマ区切りリストを指定します。
--global (オプション): このフラグは検索サービスでのみ有効である。グローバル・スコープで操作する場合に使用する。
--sort-by TYPE (オプション): このフラグは検索サービスでのみ有効で、検索結果の順序付けに使用される。使用可能なオプションは、name、displayname、kind、provider、created、updated です。
--reverse (オプション): このフラグは検索サービスでのみ有効である。ソート順を逆順にします。
--fields FIELDS (オプション): このフラグは検索サービスでのみ有効である。テーブルをカスタマイズします。例: --fields name,kind,metadata.service.iam_compatible。

出力

このコマンドは以下の出力を返します。

Name                                       ID                                                    Category
2 Zone VPC                                 f10d9ae9-ac94-4718-b24a-3994241ae2a4-global           Networking
Apache                                     Qml0bmFtaS1hcGFjaGU=-global                           Developer Tools
Apache Airflow                             Qml0bmFtaS1haXJmbG93-global                           Databases
Apache Airflow                             Qml0bmFtaS1haXJmbG93-global                           Developer Tools

ibmcloud catalog filter get

以下のコマンドを実行して、アカウントまたは特定のカタログのフィルターの詳細を取得します。

ibmcloud catalog filter get --catalog CATALOG [--output FORMAT]

出力

このコマンドは以下の出力を返します。

Account: The IBM Cloud catalog is visible to all users in this account.

Filter:
Including IBM Cloud catalog

Type           Include   Tags
Pricing plan   false     Free
Provider       false     Third Party

ibmcloud catalog filter create

以下のコマンドを実行して、新規フィルターを作成します。フィルターが存在する場合、このコマンドは現在のフィルターをオーバーライドします。

ibmcloud catalog filter create [--catalog CATALOG] [--category CATEGORY] [--compliance COMPLIANCE] [--deployment-target TARGET] [--exclude-list LIST] [--include-all ALL] [--include-list LIST] [--offering-format FORMAT] [--pricing-plan PLAN] [--provider PROVIDER] [--release RELEASE] [--type TYPE]

--catalog CATALOG (オプション): カタログ名またはカタログ ID を指定します。指定しない場合、アカウント・レベルでフィルターが作成されます。
--account-group ACCOUNT GROUP: アカウント・グループ名またはアカウント・グループ ID。このオプションは、エンタープライズ・アカウントにのみ適用されます。
--hide-ibm-catalog (オプション): デフォルトでは、カタログはこのアカウントのすべてのユーザーに表示されます。このフラグを指定すると、IBM Cloud カタログの可視性をオフにしてから、対象の製品をプライベート・カタログに追加することで、選択したユーザーのみに製品を表示できます。
--include-all BOOLEAN (オプション): フラグが指定されていない場合のデフォルトはtrue。有効な値は true および false です。 true に設定すると、フィルターにはデフォルトでパブリック・カタログ全体が含まれ、これ以降のフィルターでは除外されます。 false に設定すると、フィルターではパブリック・カタログ全体が除外され、それ以降のフラグでは含まれます。詳しくは、カタログ設定の管理を参照してください。

--offering-format FORMAT (オプション)

--category CATEGORY (オプション): ユーザーが製品を使用する方法に最適なカテゴリーを指定します。カテゴリーは、共通のソリューション、機能、または用途によってカタログ内の製品を分類するために使用されます。選択できるカテゴリーは1つだけ。 ibmcloud catalog offering category-options コマンドを実行すると、すべてのオプションが表示されます。デフォルトはDeveloper toolsです。
--compliance TYPE (オプション): 含めるかまたは除外するコンプライアンス・カテゴリーのコンマ区切りリストを指定します。 ibmcloud catalog filter options コマンドを実行すると、すべてのオプションが表示されます。
--deployment-target TARGET (オプション): 含めるかまたは除外するデプロイメント・ターゲットのコンマ区切りリストを指定します。 ibmcloud catalog filter options コマンドを実行すると、すべてのオプションが表示されます。
--exclude-list LIST (オプション): フィルタリングするパブリック・カタログから除外する必要がある製品 ID または製品名のコンマ区切りリストを指定します。
--include-list LIST (オプション): フィルタリングするパブリック・カタログに含める必要がある製品 ID または製品名のコンマ区切りリストを指定します。; 含めるかまたは除外する製品フォーマットのコンマ区切りリストを指定します。 ibmcloud catalog filter options コマンドを実行すると、すべてのオプションが表示されます。
--pricing-plan PLAN (オプション): 含めるかまたは除外する価格プランのコンマ区切りリストを指定します。 ibmcloud catalog filter options コマンドを実行すると、すべてのオプションが表示されます。
--provider PROVIDER (オプション): 含めるかまたは除外するプロバイダーのコンマ区切りリストを指定します。 ibmcloud catalog filter options コマンドを実行すると、すべてのオプションが表示されます。
--release RELEASE (オプション): 含めるかまたは除外するカテゴリーのコンマ区切りリストを指定します。 ibmcloud catalog filter options コマンドを実行すると、すべてのオプションが表示されます。
--type TYPE (オプション): 含めるかまたは除外するソフトウェア・タイプのコンマ区切りリストを指定します。 ibmcloud catalog filter options コマンドを実行すると、すべてのオプションが表示されます。

ibmcloud catalog filter delete

以下のコマンドを実行して、適用されているフィルターを削除します。このフィルターによって、カタログが指定されている場合を除いて、デフォルトでアカウント・レベルになります。その結果、フィルターはリセットされて、パブリック・カタログ内のすべての製品が含まれるようになります。

ibmcloud catalog filter delete --catalog CATALOG

ibmcloud catalog filter offering

特定の製品および適用可能な価格プランを含めるかまたは除外するようにフィルターを更新します。このフィルターによって、カタログまたはアカウント・グループが指定されている場合を除いて、デフォルトでアカウント・レベルになります。

ibmcloud catalog filter offering --offering PRODUCT-NAME

コマンド・オプション

--catalog CATALOG: カタログ名またはカタログ ID。
--account-group ACCOUNT GROUP: アカウント・グループ名またはアカウント・グループ ID。このオプションは、エンタープライズ・アカウントにのみ適用されます。
--plans-list PLANS LIST: 含めるかまたは除外するプラン ID またはプラン名のコンマ区切りリスト。
--offering OFFERING: 製品名または製品 ID。
--include: フラグが無指定の場合、デフォルト値は true です。有効な値は true および false です。 true に設定すると、指定した製品とプランが、アカウント内のユーザーに表示されます。 false に設定すると、製品とプランは、アカウント内のユーザーに表示されません。

ibmcloud catalog filter hide-ibm-public-catalog

デフォルトでは、IBM Cloud カタログは対象アカウント内のすべてのユーザーに表示されます。 IBM Cloud カタログの可視性をオフにしてから、対象の製品をプライベート・カタログに追加することで、選択したユーザーのみに製品を表示できます。

ibmcloud catalog filter hide-ibm-public-catalog

ibmcloud catalog filter show-ibm-public-catalog

ibmcloud catalog filter show-ibm-public-catalog

ibmcloud catalog filter options

以下のコマンドを実行して、各フィルター・カテゴリーのフィルター・オプションを取得します。

ibmcloud catalog filter options

出力

このコマンドは以下の出力を返します。

Deployment target              ID
IBM Cloud Kubernetes Service   target_iks
IBM Cloud Schematics           target_terraform
Red Hat OpenShift              target_roks
VMware vCenter Server          target_vcenter
Virtual private cloud          target_vpc-x86
Power Systems Virtual Server   target_power-iaas

Provider      ID
Third party   ibm_third_party
Community     ibm_community
IBM           ibm_created

Release      ID
Beta         ibm_beta
Deprecated   ibm_deprecated

Works with             ID
SAP Certified          sap_certified
Quantum Technologies   quantum_tech
Satellite Enabled      satellite_enabled
HPC                    hpc

Support                 ID
Third party supported   support_third_party
Community supported     support_community
IBM supported           support_ibm

Delivery method   ID
Cloud Paks        cloud_pak
Helm charts       helm
Operators         operator
OVA Images        ova
Starter kits      template
Terraform         terraform
Server Images     vsi_image
Blueprint         blueprint
Toolchains        toolchain

Compliance                     ID
EU Supported                   eu_access
Financial Services Validated   fs_ready
HIPAA Enabled                  hipaa
IAM-enabled                    rc_compatible
Service Endpoint Supported     service_endpoint_supported

Category                   ID                   Tags
Compute                    compute              compute,compute_classic,content,openwhisk,runtime,virtualservers,compute_baremetal
Containers                 containers           containers,clusters,registry
Networking                 network              network,network_vpc,network_classic,network_edge,network_interconnectivity
Storage                    storage              storage,storage_vpc,storage_classic,storage_datamovement
Converged infrastructure   converged_infra      converged_infra
Enterprise applications    enterprise_app       enterprise_app
AI / Machine Learning      ai                   watson,ai
Analytics                  analytics            data_analytics,business_analytics,analytics
Blockchain                 blockchain           blockchain
Databases                  databases            data_management,database
Developer tools            devops               dev_ops
Logging and monitoring     logging_monitoring   logging_monitoring
Migration                  migration_tools      migration_tools
Integration                integration          integration,api
Internet of Things         iot                  internet_of_things
Security                   security             security
Mobile                     mobile               mobile,web_and_app

ibmcloud catalog offering create

以下のコマンドを実行して、アカウントのプライベート・カタログに製品を追加します。

ibmcloud catalog offering create [--catalog CATALOG_NAME] [--zipurl URL] [--include-config] [--target-version VERSION] [--token TOKEN] [--vpc-body BODY]

コマンド・オプション

--catalog CATALOG_NAME: カタログ名またはカタログ ID。
--zipurl URL (オプション): 製品の .zip ファイルを指す URL。
--target-version VERSION: 製品のバージョンを指定します。
--include-config (オプション): 指定されている場合はすべての構成値が含まれ、製品を追加するときに使用可能になります。
--token TOKEN (オプション): プライベート・リポジトリーのパーソナル・アクセス・トークンを指定します。
--vpc-body BODY (オプション): VPC の仮想サーバー・イメージをインポートするための情報を指定します。これには、名前、ラベル、インストールの種類、ターゲットの種類、バージョン、SHA、タグ、およびメタデータが含まれます。

VPC の仮想サーバー・イメージの例 #1

VPC の仮想サーバー・イメージをオファリングとして ID 51c9e0db-2911-45a6-adb0-ac5332d27cf2 のカタログにインポートします。

ibmcloud catalog offering create --catalog 51c9e0db-2911-45a6-adb0-ac5332d27cf2 --vpc-body '{
    "name": "virtual-server-image",
    "label": "virtual server image",
    "install_kind": "instance",
    "target_kinds": ["vpc-x86"],
    "version": "0.0.10",
    "sha": "64245e5f3f1e9c4048b18db3abd1450d4b6f9e263ac1b33df6fc1ae96fcbdebb",
    "tags": ["virtualservers"],
    "metadata": {
        "operating_system": {
            "dedicated_host_only": false,
            "vendor": "CentOS",
            "name": "centos-7-amd64",
            "href": "https://us-south-stage01.iaasdev.cloud.ibm.com/v1/operating_systems/centos-7-amd64",
            "display_name": "CentOS 7.x - Minimal Install (amd64)",
            "family": "CentOS",
            "version": "7.x - Minimal Install",
            "architecture": "amd64"
        },
        "minimum_provisioned_size": 100,
        "file": {
            "size": 1
        },
        "images": [{"id": "r134-14903434-faf0-4a66-b861-7b35198de393", "name": "virtual-server-image", "region": "us-south"}]
    }
}'

VPC の仮想サーバー・イメージの例 #2

VPC の仮想サーバー・イメージをオファリングとして ID 2bdc3974-dfcf-4711-b298-cd238f7d3734 のカタログにインポートします。

ibmcloud catalog offering create --catalog 2bdc3974-dfcf-4711-b298-cd238f7d3734 --vpc-body '{
"name": "virtual-server-image-s390x",
"label": "virtual-server-image-s390x",
"install_kind": "instance",
"target_kinds": ["vpc-z"],
"version": "0.0.10",
"sha": "4739f1eaeeebc69ad5d48f9191fcc0d23960cb720bb16c67e915e5556c1da9b2",
"tags": ["virtualservers"],
"metadata": {
    "operating_system": {
        "dedicated_host_only": false,
        "vendor": "SUSE Linux Enterprise Server",
        "name": "sles-15-sp2-s390x-byol",
        "href": "https://us-south-stage01.iaasdev.cloud.ibm.com/v1/operating_systems/sles-15-s390x",
        "display_name": "Suse enterprise server(s390x)",
        "family": "SUSE",
        "version": "15-sp2",
        "architecture": "s390x"
    },
    "minimum_provisioned_size": 100,
    "file": {
        "size": 1
    },
    "images": [{"id": "r134-f20e2e4e-3133-423c-afa2-365afa14c4dc", "name": "virtual-server-image-s390x", "region": "us-south"}]
}

ibmcloud catalog offering list

以下のコマンドを実行して、プライベート・カタログ内の製品に関する詳細を取得します。このコマンドでは、プライベート・カタログ、製品、およびバージョンでフィルタリングできます。

ibmcloud catalog offering list [--catalog CATALOG] [--offering OFFERING_NAME] [--version VERSION] [--output FORMAT]

コマンド・オプション

--catalog CATALOG: カタログ名またはカタログ ID。
--output FORMAT (オプション): 出力フォーマットを指定します。デフォルトはターミナル互換で、唯一サポートされている代替はJSON、例えば --output json。

例

dev-catalog カタログに含まれているすべての製品をリストします。

ibmcloud catalog offering list --catalog dev-catalog

出力

このコマンドは以下の出力を返します。

Name                                   ID                                     Current State   Version Locator
Cloud Pak for Automation               cb90274e-398b-4373-9b28-d6428d3302df
|__OpenShift
   |__19.0.2                                                                  New             7b7e590f-259b-437b-b1f4-39e8615ed837.21d1d712-80ab-4318-9d05-73c6caaaee23
Cloud Pak for Data                     8993c7b1-1794-4447-9275-db83faa08ee4
|__OpenShift
   |__2.1.0.2                                                                 New             7b7e590f-259b-437b-b1f4-39e8615ed837.ab6ba56f-788d-4d6b-b880-a1001fca8451
harbor                                 927adb44-6784-4bec-a771-f639900f07f1
|__Kubernetes
   |__1.9.1                                                                   New             7b7e590f-259b-437b-b1f4-39e8615ed837.e437b06c-273f-49de-8c44-f55e408abf78
IBM Starter Collection for Openshift   fd1857f4-cf17-4e97-9443-b615bc71f6a0
|__OpenShift
   |__0.0.1                                                                   New             7b7e590f-259b-437b-b1f4-39e8615ed837.72e0f636-9dc4-49ae-b3c2-7a5de90487b9
tf_cloudless_sleepy-2.0                c260a67a-1b25-49fc-9896-46e7e6212990
|__
   |__1.0.0                                                                   New             7b7e590f-259b-437b-b1f4-39e8615ed837.965df91d-5760-4872-adf6-4019796c06b0
   |__1.0.1                                                                   New             7b7e590f-259b-437b-b1f4-39e8615ed837.aff4cecb-4c9b-41ba-ae3d-71f4217dc0bc

ibmcloud catalog offering search

ibmcloud catalog offering search [--catalog CATALOG] [--offering OFFERING_NAME] [--version VERSION] [--output FORMAT]

コマンド・オプション

--catalog CATALOG (オプション): カタログ名またはカタログ ID。
--offering OFFERING (オプション): 製品名または製品 ID。
--version VERSION (オプション): バージョン名またはバージョン ID。
--output FORMAT (オプション): 出力フォーマットを指定します。デフォルトはターミナル互換で、唯一サポートされている代替はJSON、例えば --output json。

例

dev-catalog カタログに含まれているすべての製品をリストします。

ibmcloud catalog offering list --catalog dev-catalog

出力

このコマンドは以下の出力を返します。

Name                                     Current State          Version Locator
dev-catalog
|__dev-offering
|  |__Kubernetes
|     |__1.0.0                           Validated              b636d651-8489-4425-bd6a-f30af1603577.17ac792e-a603-4f1a-a1b6-48e90a46940c
|__dev-offering-2.0
|  |__Kubernetes
|     |__1.0.0                           Published to account   b636d651-8489-4425-bd6a-f30af1603577.decdb0e1-46d2-401a-b482-80f9d6855f98

ibmcloud catalog offering get

以下のコマンドを実行して、カタログ内の特定の 1 製品に関する詳細を取得します。

ibmcloud catalog offering get --catalog CATALOG --offering OFFERING_NAME [--output FORMAT]

コマンド・オプション

--catalog CATALOG: カタログ名またはカタログ ID。
--offering OFFERING_NAME: 製品名または製品 ID。
--output FORMAT (オプション): 出力フォーマットを指定します。デフォルトはターミナル互換で、唯一サポートされている代替はJSON、例えば --output json。

出力

このコマンドは以下の出力を返します。

Name           Current State   Version Locator
dev-offering
|__
   |__1.0.0    Draft           480fb4e3-d7ba-4e9b-9d4c-42f0ab811040.a92f5409-ebd9-413c-88ae-7ed311c1b793

ibmcloud catalog offering import-version

以下のコマンドを実行して、プライベート・カタログに製品の新規バージョンをインポートします。

ibmcloud catalog offering import-version --catalog CATALOG --offering OFFERING_NAME [--zipurl URL] [--target-version APP_VERSION] [--include-config] [--vpc-body BODY]

コマンド・オプション

--catalog CATALOG: カタログ名またはカタログ ID。
--offering OFFERING_NAME: : 製品名または製品 ID。
--zipurl URL (オプション): 製品の.zipファイルを指す URL。
--target-version APP_VERSION (オプション): インポートする "tgz" のアプリケーション・バージョン。
--include-config (オプション): 指定されている場合はすべての構成値が含まれ、新しいバージョンをインポートするときに使用可能になります。
--vpc-body BODY (オプション): VPC の仮想サーバー・イメージをインポートするための情報を指定します。これには、名前、ラベル、インストールの種類、ターゲットの種類、バージョン、SHA、タグ、およびメタデータが含まれます。

VPC用仮想サーバーイメージの例

ID 51c9e0db-2911-45a6-adb0-ac5332d27cf2 とオファリングID 97cdaf1b-62b2-48e2-8589-10b31023866d を持つカタログに、VPC用の仮想サーバーイメージを既存のオファリングにインポートします。

ibmcloud catalog offering import-version --catalog 51c9e0db-2911-45a6-adb0-ac5332d27cf2 --offering 97cdaf1b-62b2-48e2-8589-10b31023866d --vpc-body '{
    "name": "virtual-server-image",
    "label": "virtual server image",
    "install_kind": "instance",
    "target_kinds": ["vpc-x86"],
    "version": "0.0.10",
    "sha": "64245e5f3f1e9c4048b18db3abd1450d4b6f9e263ac1b33df6fc1ae96fcbdebb",
    "tags": ["virtualservers"],
    "metadata": {
        "operating_system": {
            "dedicated_host_only": false,
            "vendor": "CentOS",
            "name": "centos-7-amd64",
            "href": "https://us-south-stage01.iaasdev.cloud.ibm.com/v1/operating_systems/centos-7-amd64",
            "display_name": "CentOS 7.x - Minimal Install (amd64)",
            "family": "CentOS",
            "version": "7.x - Minimal Install",
            "architecture": "amd64"
        },
        "minimum_provisioned_size": 100,
        "file": {
            "size": 1
        },
        "images": [{"id": "r134-14903434-faf0-4a66-b861-7b35198de393", "name": "virtual-server-image", "region": "us-south"}]
    }
}''

ibmcloud catalog offering update

プライベートカタログの商品を更新するには、まず商品を入手し、それから更新する必要があります。

offering get コマンドを実行します。詳細については、ibmcloud カタログのオファリングゲットを参照してください。

ibmcloud catalog offering get -c <CATALOGID> -o <OFFERINGID> --output json

offering update コマンドを実行します。

ibmcloud catalog offering update -c <CATALOGID> -o <OFFERINGID> --updated-offering <UPDATED_OFFERING.json>

ibmcloud catalog offering version preinstall

以下のコマンドを実行して、特定の製品に対してプリインストール・スクリプトを実行します。

ibmcloud catalog offering version preinstall --version-locator VERSION_NUMBER --cluster CLUSTER_ID --namespace NAME

コマンド・オプション

--version-locator VERSION_NUMBER: この製品のバージョン・ロケーターを取得するには、ibmcloud catalog offering list コマンドを実行し、使用する指定の製品とバージョンを確認します。
--cluster CLUSTER_ID: 対象製品をインストールするクラスターのクラスター ID を指定します。
--namespace NAME: 使用する名前空間を指定します。新規の名前空間を指定できます。この場合、指定した名前空間はプリインストールの一部として自動的に作成されます。

例

名前空間 b636d651-8489-4425-bd6a-f30af1603577.18aad484-c78b-4269-808b-52027621abd4 内の ID が bn5ebho206o7fg45f2e0 のクラスター内で、バージョン・ロケーター番号 test-namespace の製品に対してプリインストール・スクリプトを実行します。

ibmcloud catalog offering version preinstall --version-locator b636d651-8489-4425-bd6a-f30af1603577.18aad484-c78b-4269-808b-52027621abd4 --cluster bn5ebho206o7fg45f2e0 --namespace test-namespace

ibmcloud catalog offering version preinstall-status

以下のコマンドを実行して、進行中のプリインストールの状況を取得します。

ibmcloud catalog offering version preinstall-status --version-locator VERSION_NUMBER --cluster CLUSTER_ID --namespace NAME [--output FORMAT]

コマンド・オプション

--version-locator VERSION_NUMBER: 対象製品のバージョン・ロケーターを取得するには、ibmcloud catalog offering list コマンドを実行し、使用する指定の製品とバージョンを確認します。
--cluster CLUSTER_ID: プリインストールが実行されたクラスターのクラスター ID を指定します。
--namespace NAME: プリインストールに使用された名前空間を指定します。
--output FORMAT (オプション): 出力フォーマットを指定します。デフォルトはターミナル互換で、唯一サポートされている代替はJSON、例えば --output json。

ibmcloud catalog offering version validate

以下のコマンドを実行して、プライベート・カタログ内の製品の新規バージョンを検証します。他のユーザーがプライベート・カタログからインスタンスを作成できるようにアカウントで製品を公開する前に、製品が予期されているとおりに機能することを確認するため、製品を検証する必要があります。

ibmcloud catalog offering version validate --version-locator VERSION_NUMBER --cluster CLUSTER_ID --namespace NAME [--timeout TIMEOUT] [--wait WAIT] [--override-values VALUES|FILENAME] [--workspace-tf-version VERSION] [--workspace-region REGION] [--workspace-rg-id ID][--schematics-destroy][--schematics-delete]

コマンド・オプション

--version-locator VERSION_NUMBER: 対象製品のバージョン・ロケーターを取得するには、ibmcloud catalog offering list コマンドを実行し、使用する指定の製品とバージョンを確認します。
--cluster CLUSTER_ID: 対象製品をインストールするクラスターのクラスター ID を指定します。
--namespace NAME: 使用する名前空間を指定します。新規の名前空間を指定できます。この場合、指定した名前空間はプリインストールの一部として自動的に作成されます。
--timeout TIMEOUT: Schematics ワークスペースがインストールを待機する時間を秒単位で指定します。デフォルトは180です。
--wait WAIT: 待機、および Schematics ワークスペース・ジョブの進行状況を追跡します。 true の場合、インストールを待機します。 false の場合には、ソフトウェアはすぐにインストールを行います。デフォルトは true です。
--override-values VALUES|FILENAME (オプション): インストールのカスタム構成を指定します。この値は、インラインで指定するか、JSON ファイルまたは TXT ファイルを使用して指定することができます。例えば、 override-values values.json です。 VPC の仮想サーバー・イメージを検証する場合は、以下のフィールドを指定する必要があります。 vsi_instance_name、vsi_id、vpc_profile、subnet_id、vpc_id、subnet_zone、ssh_key_id、vpc_region
--workspace-tf-version VERSION (オプション): ワークスペース Terraform のバージョンを指定します。
--workspace-region REGION (オプション): ワークスペース・リージョンを指定します。
--workspace-rg-id ID (オプション): ワークスペース・リソース・グループ ID を指定します。
--schematics-destroy (オプション): 検証およびインストール後にワークスペース・リソースを削除するには、このフラグを指定します。
--schematics-delete VALUE (オプション): 検証およびインストール後に Schematics ワークスペースを削除するには、このフラグを指定します。

クラスタを使用する製品の検証例

名前空間 b636d651-8489-4425-bd6a-f30af1603577.18aad484-c78b-4269-808b-52027621abd4 の ID が bn5ebho206o7fg45f2e0 のクラスターで、バージョン・ロケーター番号 test-namespace の製品を検証します。このインストールにはカスタム構成があるので、values.json ファイルを使用して値が指定されます。

ibmcloud catalog offering version validate --version-locator b636d651-8489-4425-bd6a-f30af1603577.18aad484-c78b-4269-808b-52027621abd4 --cluster bn5ebho206o7fg45f2e0 --namespace test-namespace --override-values values.json

values.json ファイルからの値のサンプル形式をオーバーライドします。

{
  "username": "provision-test-1",
  "password": "passw0rd"
}

VPC用仮想サーバーイメージの例

ID r134-476cbb67-a6c2-4957-9806-3fcbac3498be を持つ VPC 内のバージョン・ロケーター 51c9e0db-2911-45a6-adb0-ac5332d27cf2.ecebffdc-f1f8-4a85-965f-9cbe31920542 を使用して製品を検証します。

ibmcloud catalog offering version validate --version-locator 51c9e0db-2911-45a6-adb0-ac5332d27cf2.ecebffdc-f1f8-4a85-965f-9cbe31920542 --workspace-region=us-south --workspace-rg-id Default --override-values '{
  "vsi_instance_name": "instance-name-1",
  "vsi_id": "r134-14903434-faf0-4a66-b861-7b35198de393",
  "vpc_profile": "bx2-2x8",
  "subnet_id": "0716-d799c449-466c-4844-902c-a5d3f8948d7d",
  "vpc_id": "r134-476cbb67-a6c2-4957-9806-3fcbac3498be",
  "subnet_zone": "us-south-1",
  "ssh_key_id": "r134-0c53e7f2-771f-4d0e-a19e-39f2e6e6949c",
  "vpc_region": "us-south"
}

ibmcloud catalog offering version validate-status

以下のコマンドを実行して、進行中の検証の状況を取得します。

ibmcloud catalog offering version validate-status --version-locator VERSION_NUMBER [--output FORMAT]

コマンド・オプション

--version-locator VERSION_NUMBER: 対象製品のバージョン・ロケーターを取得するには、ibmcloud catalog offering list コマンドを実行し、使用する指定の製品またはバージョンを確認します。
--output FORMAT (オプション): 出力フォーマットを指定します。デフォルトはターミナル互換で、唯一サポートされている代替はJSON、例えば --output json。

ibmcloud catalog offering category-options

以下のコマンドを実行して、カテゴリー選択項目のリストを取得します。

ibmcloud catalog offering category-options [--output FORMAT]

コマンド・オプション

--output FORMAT (オプション): 出力フォーマットを指定します。デフォルトはターミナル互換で、唯一サポートされている代替はJSON、例えば --output json。

例

ibmcloud catalog offering category-options

出力

このコマンドは以下の出力を返します。

Name                    Tags                                                  Description
VPC Infrastructure      vpc                                                   Fully customizable, software-defined virtual network with superior isolation.
Compute                 compute,content,containers,openwhisk,vmware,runtime   Build your virtual environments
Containers              containers,clusters,registry                          Get started by creating a Kubernetes cluster, or manage your Docker images in the registry.
Networking              network                                               Order network.
Storage                 storage                                               Order storage.

ibmcloud catalog offering add-category

以下のコマンドを実行して、製品にカテゴリー・タグを追加します。カテゴリー名を指定することができます。 ibmcloud catalog offering category-options コマンドを実行することで見つけることができます。製品をカタログに表示するには、製品をカテゴリーに入れる必要があります。デフォルトはDeveloper toolsです。

ibmcloud catalog offering category-options [--output FORMAT]

コマンド・オプション

--catalog CATALOG: カタログ名またはカタログ ID。
--offering OFFERING: 製品名または製品 ID。
--category CATEGORY: ユーザーが製品を使用する方法に最適なカテゴリーを指定します。カテゴリーは、共通のソリューション、機能、または用途によってカタログ内の製品を分類するために使用されます。選択できるカテゴリーは1つだけ。 ibmcloud catalog offering category-options コマンドを実行すると、すべてのオプションが表示されます。デフォルトはDeveloper toolsです。

例

ibmcloud catalog offering add-category --catalog dev-catalog --offering dev-offering --category dev_ops

ibmcloud カタログ・オファリングのカテゴリー

以下のコマンドを実行して、製品バージョンのカテゴリーを取得します。

ibmcloud catalog offering version categories [--catalog CATALOG] [--offering OFFERING] [--output OUTPUT]

コマンド・オプション

--catalog CATALOG: カタログ名またはカタログ ID。
--offering OFFERING: 製品名または製品 ID。
--output FORMAT (オプション): 出力フォーマットを指定します。デフォルトはターミナル互換で、唯一サポートされている代替手段はJSONである。例えば、--output json です。

例

dev-offering という名前で、 dev-catalog に配置されている製品のカテゴリーを取得します。

ibmcloud catalog offering version categories --catalog dev-catalog --offering dev-offering

ibmcloudカタログ提供バージョン get-claims

以下のコマンドを実行して、バージョンが要求したセキュリティー情報とコンプライアンス情報を取得します。

  ibmcloud catalog offering version get-claims [--output OUTPUT] [--version-locator LOCATOR]

コマンド・オプション

--version-locator ロケーター: 対象製品のバージョン・ロケーターを取得するには、ibmcloud catalog offering list コマンドを実行し、使用する指定の製品またはバージョンを確認します。
--output値（オプション）: 出力フォーマットを指定します。デフォルトはターミナル互換で、唯一サポートされている代替はJSON、例えば --output json。

ibmcloudカタログ提供バージョン更新-クレーム

以下のコマンドを実行して、あるバージョンのセキュリティとコンプライアンスに関する主張を更新する。

  ibmcloud catalog offering version update-claims [--claims CLAIMS] [--version-locator LOCATOR]

コマンド・オプション

--claims クレーム: バージョンのクレーム・データを JSON オブジェクトまたはファイルとして指定します。
--version-locator ロケーター: 対象製品のバージョン・ロケーターを取得するには、ibmcloud catalog offering list コマンドを実行し、使用する指定の製品またはバージョンを確認します。

IBMcloudカタログ提供バージョン SCC-apply

以下のコマンドを実行して、 Security and Compliance Center スキャンをご使用のバージョンに追加します。スキャンを追加する前に、バージョンにセキュリティとコンプライアンス情報を追加し、バージョンを検証します。

  ibmcloud catalog offering version scc-apply [--instance-region REGION] [--scan SCAN] [--service-instance INSTANCE] [--target-account-name NAME] [--target-api-key KEY] [--timeout TIMEOUT] [--version-locator LOCATOR] [--wait WAIT]

コマンド・オプション

--instance-region リージョン: インスタンスのリージョン。
--scan スキャン: Security and Compliance Center スキャンの ID。
--service-instance インスタンス: Security and Compliance Center インスタンス ID を指定します。
--target-account-name NAME (オプション): 対象のアカウント名を入力してください。
--target-api-key KEY (オプション): 代替アカウント (ターゲット・アカウント) を使用してソース・アカウントにスキャンを適用する場合は、API キーを指定します。詳しくは、ターゲット・アカウントのセットアップを参照してください。
--timeout TIMEOUT: コマンドが戻る前に、スキャンがバージョンに適用されるのを待機する時間を秒単位で指定します。デフォルト値は 600 (10 分) です。
--version-locator ロケーター: 対象製品のバージョン・ロケーターを取得するには、ibmcloud catalog offering list コマンドを実行し、使用する指定の製品またはバージョンを確認します。
--wait WAIT: スキャン・アプリケーションの進行状況を待機して追跡します。フラグが指定されていない場合のデフォルトはtrue。 true の場合、コマンドはスキャンアプリケーションの進行状況を追跡する。 false の場合、コマンドは即時に戻ります。

ibmcloudカタログ提供バージョン scc-apply-status

以下のコマンドを実行して、ご使用のバージョンに対する Security and Compliance Center スキャン・アプリケーションの状況を確認します。

  ibmcloud catalog offering version scc-apply-status [--scan SCAN] [--version-locator LOCATOR]

コマンド・オプション

--scan スキャン: Security and Compliance Center スキャンの ID。
--version-locator ロケーター: 対象製品のバージョン・ロケーターを取得するには、ibmcloud catalog offering list コマンドを実行し、使用する指定の製品またはバージョンを確認します。

ibmcloudカタログ提供バージョン取得スキャン

以下のコマンドを実行して、ご使用のバージョンに追加された Security and Compliance Center スキャンを取得します。

  ibmcloud catalog offering version get-scans [--instance-region REGION] [--output OUTPUT] [--profiles PROFILES] [--service-instance INSTANCE] [--target-account-name NAME] [--target-api-key KEY]

コマンド・オプション

--instance-region リージョン: インスタンスの地域を指定する。
--output OUTPUT (オプション): 出力フォーマットを指定します。デフォルトはターミナル互換で、唯一サポートされている代替手段はJSONである。例えば、--output json です。
--profiles プロフィール: プロファイル名とバージョンのコンマ区切りリストを指定します (例: "IBM Cloud for Financial Services::1.2.0")。
--service-instance インスタンス: Security and Compliance Center インスタンス ID を指定します。
--target-account-name NAME (オプション): 対象のアカウント名を入力してください。
--target-api-key KEY (オプション): 代替アカウント (ターゲット・アカウント) を使用してソース・アカウントにスキャンを適用する場合は、API キーを指定します。詳しくは、ターゲット・アカウントのセットアップを参照してください。

ibmcloudカタログの提供 get-scan-results

次のコマンドを実行して、ご使用のバージョンのCode Risk Analyzerと Security and Compliance Center のスキャン結果のレポートを生成します。完全なレポートを作成するには、Code Risk Analyzerと Security and Compliance Center のスキャンを実行する必要があります。

ibmcloud catalog offering get-scan-results [--version-locator LOCATOR]

コマンド・オプション

--version-locator ロケーター: 対象製品のバージョン・ロケーターを取得するには、ibmcloud catalog offering list コマンドを実行し、使用する指定の製品またはバージョンを確認します。

ibmcloud catalog offering version create-draft

以下のコマンドを実行して、既存のバージョンのドラフトを作成します。このコマンドは、新規バージョンを導入せずに既存のバージョンの変更内容を公開したい場合に便利です。ソース・ファイルの変更など、一部の変更操作では、製品を再検証する必要が生じます。

ibmcloud catalog offering version create-draft --version-locator VERSION_NUMBER [--output FORMAT]

コマンド・オプション

--version-locator VERSION_NUMBER: 対象製品のバージョン・ロケーターを取得するには、ibmcloud catalog offering list コマンドを実行し、使用する指定の製品またはバージョンを確認します。
--output FORMAT (オプション): 出力フォーマットを指定します。デフォルトはターミナル互換で、唯一サポートされている代替手段はJSONである。例えば、--output json です。

ibmcloud catalog offering version delete-version

以下のコマンドを実行して、製品のバージョンを削除します。

ibmcloud catalog offering version delete-version --version-locator VERSION_NUMBER [--output FORMAT]

コマンド・オプション

--version-locator VERSION_NUMBER: 対象製品のバージョン・ロケーターを取得するには、ibmcloud catalog offering list コマンドを実行し、使用する指定の製品またはバージョンを確認します。
--output FORMAT (オプション): 出力フォーマットを指定します。デフォルトはターミナル互換で、唯一サポートされている代替手段はJSONである。例えば、--output json です。

ibmcloud catalog offering version deprecate-version

以下のコマンドを実行して、以前に公開された製品バージョンを IBM Cloud カタログで非推奨にします。

ibmcloud catalog offering version deprecate-version --version-locator VERSION_NUMBER

コマンド・オプション

--version-locator VERSION_NUMBER: 対象製品のバージョン・ロケーターを取得するには、ibmcloud catalog offering list コマンドを実行し、使用する指定の製品またはバージョンを確認します。

ibmcloud catalog offering version refresh-version

ドラフト版のソースファイルに変更を加えるには、以下のコマンドを実行します。このコマンドは、既存のバージョンを更新する場合に便利です。

ibmcloud catalog offering version refresh-version --version-locator VERSION_NUMBER --zipurl URL [--include-config]

コマンド・オプション

--version-locator VERSION_NUMBER: 対象製品のバージョン・ロケーターを取得するには、ibmcloud catalog offering list コマンドを実行し、使用する指定の製品またはバージョンを確認します。
--zipurl URL: 製品の圧縮ファイルを指す URL。
--include-config (オプション): 指定されている場合はすべての構成値が含まれ、製品を追加するときに使用可能になります。

ibmcloud catalog offering version merge-draft

以下のコマンドを実行して、製品のドラフト・バージョンをマージします。

ibmcloud catalog offering version merge-draft --version-locator VERSION_NUMBER

コマンド・オプション

--version-locator VERSION_NUMBER: 対象製品のバージョン・ロケーターを取得するには、ibmcloud catalog offering list コマンドを実行し、使用する指定の製品またはバージョンを確認します。

以下のコマンドを実行して、製品を共有できるようにします。

ibmcloud catalog offering enable-sharing --catalog CATALOG --offering OFFERING

ibmcloud catalog offering ready

以下のコマンドを実行して、製品に共有または公開の準備完了のマークを付けます。

ibmcloud catalog offering ready --version-locator VERSION_NUMBER

コマンド・オプション

--version-locator VERSION_NUMBER: 対象製品のバージョン・ロケーターを取得するには、ibmcloud catalog offering list コマンドを実行し、使用する指定の製品またはバージョンを確認します。

ibmcloud catalog offering delete

以下のコマンドを実行して、プライベート・カタログから製品を削除します。 IBM Cloud カタログで公開されている製品は削除できません。公開済みの製品を IBM Cloud カタログで非推奨にするには、ibmcloud catalog offering deprecate-offering を参照してください。

ibmcloud catalog offering delete --catalog CATALOG --offering OFFERING

コマンド・オプション

--catalog CATALOG: カタログ名またはカタログ ID。
--offering OFFERING: 製品名または製品 ID。

ibmcloud catalog offering publish account

以下のコマンドを実行して、製品をプライベート・カタログからアカウントに公開します。製品が公開されると、そのアカウントのユーザーはプライベートカタログにアクセスできるようになります。そのリソースグループがインスタンスを作成し、使用を開始することができる。

ibmcloud catalog offering publish account [--catalog CATALOG][--offering OFFERING]

コマンド・オプション

--catalog CATALOG: カタログ名またはカタログ ID。
--offering OFFERING: 製品名または製品 ID。

ibmcloud catalog offering publish allowlist

以下のコマンドを実行して、製品をプライベート・カタログから許可リストに登録されているアカウントのセットに公開します。製品が公開されると、許可リストに登録されたアカウントユーザーはインスタンスを作成し、使用を開始することができます。

ibmcloud catalog offering publish allowlist [--catalog CATALOG][--offering OFFERING][--account-ids ACCOUNT-IDS]

コマンド・オプション

--catalog CATALOG: カタログ名またはカタログ ID。
--offering OFFERING: 製品名または製品 ID。
--account-ids ACCOUNT-IDS: アカウント ID。

ibmcloud catalog offering publish enterprise

以下のコマンドを実行して、製品をエンタープライズに公開します。製品が公開されると、エンタープライズ内のユーザーは製品のインスタンスを作成できます。

ibmcloud catalog offering publish enterprise [--catalog CATALOG][--offering OFFERING]

コマンド・オプション

--catalog CATALOG: カタログ名またはカタログ ID。
--offering OFFERING: 製品名または製品 ID。

ibmcloud catalog offering suspend-offering

以下のコマンドを実行して、カタログで製品を使用停止にします。完全に削除したり非推奨にしたりすることなく、短期間、使用を停止できます。例えば、製品のバグか脆弱性を検出し、以後その製品を顧客がインストールする前に調査しなければならない場合などには、製品の提供を一時停止すると役立ちます。

ibmcloud catalog offering suspend-offering [--catalog CATALOG][--offering OFFERING]

コマンド・オプション

--catalog CATALOG: カタログ名またはカタログ ID。
--offering OFFERING: 製品名または製品 ID。

ibmcloud catalog offering version suspend-version

以下のコマンドを実行して、カタログで製品のバージョンを使用停止にします。バージョンを完全に削除したり非推奨にしたりすることなく、短期間、使用を停止できます。

ibmcloud catalog offering version suspend-version [--version-locator VERSION_NUMBER]

コマンド・オプション

--version-locator VERSION_NUMBER: このオファリングのバージョン・ロケーターを取得するには、ibmcloud catalog offering list を実行し、使用するバージョンを見つけます。

ibmcloud catalog offering workspaces

以下のコマンドを実行して、製品バージョンの Schematics ワークスペースを取得します。

ibmcloud catalog offering workspaces [--version-locator VERSION_NUMBER] [output FORMAT]

コマンド・オプション

--version-locator VERSION_NUMBER: このオファリングのバージョン・ロケーターを取得するには、ibmcloud catalog offering list を実行し、使用する指定のバージョンを見つけます。
--output FORMAT (オプション): 出力フォーマットを指定します。デフォルトはターミナル互換で、唯一サポートされている代替手段はJSONである。例えば、--output json です。

ibmcloud catalog install

以下のコマンドを実行して、IBM Cloud カタログからソフトウェア・バージョンをインストールします。

ibmcloud catalog install [--version-locator VERSION_NUMBER] [--cluster CLUSTER_ID] [--namespace NAME] [--override-values VALUES] [--timeout TIMEOUT] [--wait WAIT] [--workspace-name NAME] [--workspace-tags TAGS] [--workspace-tf-version VERSION] [--workspace-region REGION] [--workspace-rg-id ID] [schematics-delete VALUE]

コマンド・オプション

--version-locator VERSION_NUMBER: このオファリングのバージョン・ロケーターを取得するには、ibmcloud catalog offering list を実行し、使用するバージョンを見つけます。
--cluster CLUSTER_ID: クラスター名またはクラスター ID を指定します。
--namespace NAME: 使用する名前空間を指定します。
--override-values VALUES: インストールのカスタム構成を指定します。この値は、インラインで指定するか、JSON ファイルまたは TXT ファイルを使用して指定することができます。例えば、override-values values.json です。
--timeout TIMEOUT: Schematics ワークスペースがインストールを待機する時間を秒単位で指定します。デフォルトは180です。
--wait WAIT: 待機、および Schematics ワークスペース・ジョブの進行状況を追跡します。 true の場合、インストールを待機します。 false の場合には、ソフトウェアはすぐにインストールを行います。デフォルトは true です。
--workspace-name NAME (オプション): ワークスペース名を指定します。デフォルトはOfferingName-Dateです。
--workspace-tags TAGS (オプション): タグのコンマ区切りリストを指定します。
--workspace-tf-version VERSION (オプション): ワークスペース Terraform のバージョンを指定します。
--workspace-region REGION (オプション): ワークスペース・リージョンを指定します。
--workspace-rg-id ID (オプション): ワークスペース・リソース・グループ ID を指定します。
--schematics-delete VALUE (オプション): 検証およびインストール後に Schematics ワークスペースを削除するには、このフラグを指定します。

例

cluster A、namespace install、override values JSON values.json を使って、ソフトウェアのバージョン 1 をインストールします。

ibmcloud catalog install [--version-locator 1] [--cluster A] [--namespace install] [--override-values values.json]

values.json ファイルからの値のサンプル形式をオーバーライドします。

{
  "username": "install-test-1",
  "password": "passw0rd"
}

ibmcloud catalog の料金設定

以下のコマンドを実行して、カタログ・オファリングの価格設定情報を取得します。

ibmcloud catalog pricing [-r, --region REGION] [-k, --kind KIND] [-p, --price PRICE] [--tag TAG] [--country COUNTRY] [--global] [--iam] [--json] [--csv] [-f, --file FILENAME]

コマンド・オプション

-r --region (オプション): 地理的位置でフィルターに掛けます。
-k, --kind (オプション): リソースの種類を基準にしてフィルター操作します。現在、 service （デフォルト）、 iaas、 runtime、 template、 geography がサポートされている
-p, --price（オプション）: 価格を基準にしてフィルター操作します。現在、 free、 paygo、 subscription がサポートされている
-t, --tag (オプション): タグを基準にしてフィルター操作します。このフラグは反復可能であり、指定されたすべてのタグの論理 OR になります。
--co, --country（オプション）: 国でフィルタリングします。 CSV、またはJSONへの出力は、すべての国の値を取得するために値 ALL。
--json (オプション): JSONレスポンスを出力する。
--csv（オプション）: CSV ファイルを出力する。
-f --file (オプション): csv出力のファイル名を指定する。
--global (オプション): グローバル・スコープで操作します。
--iam（オプション）: Iam 互換オファリングでフィルタリングします。

例

従量課金 (PAYG) アカウントの Virtual Server for VPC の料金情報を取得します。

ibmcloud catalog pricing is.instance [--price paygo]

IBMクラウドカタログ・プライベートエンドポイント・リージョン

以下のコマンドを実行して、指定したサービスのプライベート・エンドポイントをサポートするリージョンのリストを取得する。

ibmcloud catalog private-endpoint regions [--service ID]

コマンド・オプション

--service: プライベート・エンドポイントをサポートするリージョンを表示するには、サービスのIDまたはプログラム名を入力する

IBMクラウドカタログ・プライベートエンドポイントサービス

以下のコマンドを実行して、指定した地域のプライベート・エンドポイントをサポートするサービスのリストを取得する。

ibmcloud catalog private-endpoint services [--region REGION]

コマンド・オプション

--region または -r: REGION を指定すると、その地域でどのサービスがプライベートエンドポイントをサポートしているかを確認できます

ibmcloud catalog ユーティリティー create-product-from-workspace

以下のコマンドを実行して、 Git リポジトリーから直接作成された Schematics ワークスペースからデプロイ可能なアーキテクチャー・タイルを作成します。デプロイ可能なアーキテクチャはプロジェクトを作成し、将来のバージョンでデプロイ可能なアーキテクチャの開発と保守を継続できるようにします。

このコマンドには、カタログ・マニフェストを追加できるように、ソース・リポジトリーで認証するための GIT_TOKEN 環境変数が必要です。このコマンドは、 Schematics ワークスペースにある Git リポジトリー内の新規ブランチにプッシュし、オンボーディングに使用されるリリースを作成します。

ibmcloud catalog utility create-product-from-workspace [--workspace-id ID] [--api-key KEY] [--trusted-profile-id ID] [--catalog-label LABEL] [--offering-label LABEL] [--project-name NAME] [--project-resource-group GROUP] [--target-version VERSION] [--variation-label LABEL]

コマンド・オプション

--api-key または --ak API KEY: カタログとプロジェクトのリンクに使用するAPIキーを指定します。 '--trusted-profile-id' と排他的です。
--catalog-label CATALOG LABEL (オプション): インポート先の既存のカタログのラベル、または作成する新規カタログの名前を指定します。デフォルトは'Migrated DAs'である。
--offering-label オファリングラベル（オプション）: インポート先の既存のオファリングのラベル、または作成する新規オファリングの名前を指定します。デフォルトは「Migrated <workspace_name>」です。ワークスペースがカタログ提供物から作成される場合、ラベルは既存の提供物ラベルを上書きします。
--project-name NAME (オプション): オンボード・カタログにリンクされているプロジェクト名を指定する。プロジェクトが存在しない場合は作成される。デフォルトの名前は'Dev Migration Project'である。
--project-resource-group (オプション): 作成されるプロジェクトのリソースグループを指定する。デフォルトのリソースグループは「Default」である。
--target-version VERSION (オプション): マイグレーションされたオファリングのターゲット・バージョンを指定します。デフォルトは '1.0.0' です。
--trusted-profile-id または --tpi TRUSTED PROFILE ID: カタログとプロジェクトのリンクに使用される、信頼できるプロファイル ID を指定します。 '--api-key'。
--variation-label VARIATION LABEL (オプション): オンボードするバージョンのバリエーション・ラベルを指定します。デフォルトは「標準」。ワークスペースがカタログ・オファリングから作成された場合、ラベルは既存のバージョン・ラベルを上書きします。
--workspace-id ワークスペースID: Schematics ワークスペース ID を指定します。ワークスペース ID を取得するには、 Schematics ワークスペースを作成する必要があります。細については、 ibmcloud schematics workspace newを参照してください。

ibmcloud catalog utility netrc

以下のコマンドを実行して、.netrc ファイルを作成、.netrc ファイル内にマシン名を生成、または .netrc ファイル内の資格情報を更新します。 .netrc ファイルには、IBM Cloud カタログから Terraform モジュールを使用するために必要なログイン情報が保管されます。

このコマンドを実行すると、 iamtoken をユーザー名、IAMトークンをパスワードとして、 cm.globalcatalog.cloud.ibm.com というマシン名の .netrc ファイルが構成される。

.netrc コマンドを実行するには、バージョン 1.2.7 以上のカタログ管理 CLI プラグインが必要です。

ibmcloud catalog utility netrc

ibmcloud catalog utility update-module-references

以下のコマンドを実行して、カタログで更新について作業ディレクトリーの Terraform モジュールを確認し、ソース属性を最新バージョンに更新します。 README.md も更新されました。

ibmcloud catalog utility update-module-references

ibmcloud catalog offering unpublish account

以下のコマンドを実行して、製品をアカウントで非公開にします。製品が非公開になると、アカウント内のユーザーは製品のインスタンスを作成できなくなります。

ibmcloud catalog offering unpublish account [--catalog CATALOG][--offering OFFERING]

コマンド・オプション

--catalog CATALOG: カタログ名またはカタログ ID。
--offering OFFERING: 製品名または製品 ID。

ibmcloud catalog offering unpublish allowlist

以下のコマンドを実行して、製品の許可リストからアカウント ID を削除します。許可リストから削除されたアカウントは、製品のインスタンスを作成できなくなります。

ibmcloud catalog offering unpublish allowlist [--catalog CATALOG][--offering OFFERING][--account-ids ACCOUNT-IDS]

コマンド・オプション

--catalog CATALOG: カタログ名またはカタログ ID。
--offering OFFERING: 製品名または製品 ID。
--account-ids ACCOUNT-IDS: アカウント ID。

ibmcloud catalog offering unpublish enterprise

以下のコマンドを実行して、製品をエンタープライズで非公開にします。製品が非公開になると、エンタープライズは製品のインスタンスを作成できなくなります。

ibmcloud catalog offering unpublish enterprise [--catalog CATALOG][--offering OFFERING]

コマンド・オプション

--catalog CATALOG: カタログ名またはカタログ ID。
--offering OFFERING: 製品名または製品 ID。

ibmcloudカタログの提供 ibmのアンパブリッシュ

IBM から製品をアンパブリッシュするには、以下のコマンドを実行します。製品がアンパブリッシュされた後、 IBM 社員が製品のインスタンスを作成することはできません。

ibmcloud catalog offering unpublish ibm [--catalog CATALOG][--offering OFFERING]

コマンド・オプション

--catalog CATALOG: カタログ名またはカタログ ID。
--offering OFFERING: 製品名または製品 ID。

ibmcloudカタログ提供パブリッシュibm

次のコマンドを実行して、アカウントすでに利用可能なオファーをすべての IBM ユーザーに公開します。パブリケーション・プロセスのこの部分は、ステージング・カタログとプロダクション・カタログにタイルを作成し、 IBM のユーザーだけに見えるようにする。オファリングを IBM ユーザに公開することで、 IBM Cloud カタログの全ユーザに公開する前に、本番環境でオファリングをテストすることができます。

ibmcloud catalog offering publish ibm [--catalog CATALOG][--offering OFFERING]

コマンド・オプション

--catalog CATALOG: カタログ名またはカタログ ID。
--offering OFFERING: 製品名または製品 ID。

ibmcloud catalog offering publish public

以下のコマンドを実行して、すべてのユーザーが表示および使用できるように、プライベート・オファリングを IBM Cloud カタログに公開します。公開プロセスのこのステップに進むには、最初にオファリングを自分のアカウントとすべての IBM 社員に公開して、テスト・プロセスを完了する必要があります。テストが完了したら、このコマンドを実行できます。

このオプションには承認が必要です。承認が完了すると、 IBM Cloud のすべてのお客様にタイルをご利用いただけます。

ibmcloud catalog offering publish public [--catalog CATALOG][--offering OFFERING]

コマンド・オプション

--catalog CATALOG: カタログ名またはカタログ ID。
--offering OFFERING: 製品名または製品 ID。

ibmcloud catalog offering deprecate-offering

以下のコマンドを実行して、IBM Cloud カタログで以前に公開されたオファリング・バージョンを非推奨にします。

ibmcloud catalog offering deprecate-offering [--catalog CATALOG][--offering OFFERING]

コマンド・オプション

--catalog CATALOG: カタログ名またはカタログ ID。
--offering OFFERING: 製品名または製品 ID。

ibmcloud catalog offering restore-offering

以下のコマンドを実行して、以前に非推奨になった製品を IBM Cloud カタログで復元します。製品のバージョンを検証した後、そのバージョンが非推奨になる前の公開状態に復元することができます。

ibmcloud catalog offering restore-offering [--catalog CATALOG][--offering OFFERING]

コマンド・オプション

--catalog CATALOG: カタログ名またはカタログ ID。
--offering OFFERING: 製品名または製品 ID。

ibmcloud catalog offering version restore-version

以下のコマンドを実行して、以前に非推奨になった製品のバージョンを IBM Cloud カタログで復元します。これを復元すると、バージョンはドラフト状態になる。検証後に、元のバージョンを非推奨になる前の公開済み状態に復元できます。

ibmcloud catalog offering version restore-version [--catalog CATALOG][--offering OFFERING] [--include-config]

コマンド・オプション

--catalog CATALOG: カタログ名またはカタログ ID。
--offering OFFERING: 製品名または製品 ID。
--include-config (オプション): 指定されている場合はすべての構成値が含まれ、製品を追加するときに使用可能になります。

ibmcloud catalog オブジェクト create vpe

以下のコマンドを実行して、アカウントプライベート・カタログにオブジェクトを追加する。

ibmcloud catalog object create vpe [--catalog CATALOG] [--crn CRN] [endpoint-type TYPE] [--fqdn FQDN] [--name NAME] [--region REGION]

コマンド・オプション

--catalog CATALOG: カタログ名またはカタログ ID を指定します。
--crn シーアールエヌ: クラウドリソース名（CRN）を入力します。
--endpoint-type タイプ: VPE エンドポイント・タイプを指定します。
--fqdn かんぜんしゅうしょくドメインめい: 完全修飾ドメイン名をカンマ区切りで列挙する。
--name NAME: オブジェクトの名前を指定する。
--region REGION: VPE エンドポイントのリージョンを指定します。

ibmcloud カタログ・オブジェクトの削除

以下のコマンドを実行してオブジェクトを削除する。

ibmcloud catalog object delete [--catalog CATALOG] [--name NAME]

コマンド・オプション

--catalog CATALOG: カタログ名またはカタログ ID を指定します。
--name NAME: オブジェクトの名前を入力します。

ibmcloud catalog オブジェクト更新 vpe

以下のコマンドを実行して、オブジェクトを更新する。

ibmcloud catalog object update vpe [--catalog CATALOG] [--name NAME] [--crn CRN] [--endpoint-type TYPE] [--fqdn FQDN] [--region REGION]

コマンド・オプション

--catalog CATALOG: カタログ名またはカタログ ID を指定します。
--name NAME: オブジェクトの名前を指定する。
--crn CRN（オプション）: クラウドリソース名（CRN）を入力します。
--endpoint-type TYPE (オプション): VPE エンドポイント・タイプを指定します。
--fqdn FQDN (オプション): 完全修飾ドメイン名をカンマ区切りで列挙する。
--region REGION (オプション): VPE エンドポイントのリージョンを指定します。

ibmcloud catalog オブジェクトの取得

以下のコマンドを実行して、特定のオブジェクトの情報を取得します。

ibmcloud catalog object get [--catalog CATALOG] [--name NAME] [--output OUTPUT]

コマンド・オプション

--catalog CATALOG: カタログ名またはカタログ ID を指定します。
--name NAME: オブジェクトの名前を入力します。
--output OUTPUT (オプション): 出力フォーマットを指定します。デフォルトはターミナル互換で、唯一サポートされている代替手段はJSONである。例: --output json

ibmcloud カタログ・オブジェクト・リスト

以下のコマンドを実行して、カタログ内のオブジェクトのリストを取得します。

ibmcloud catalog object list [--catalog CATALOG] [--output OUTPUT]

コマンド・オプション

--catalog CATALOG: カタログ名またはカタログ ID を指定します。
--output OUTPUT (オプション): 出力フォーマットを指定します。デフォルトはターミナル互換で、唯一サポートされている代替手段はJSONである。例: --output json

ibmcloud カタログ・オブジェクト検索

Lucene 照会構文を使用してオブジェクトを検索するには、以下のコマンドを実行します。

ibmcloud catalog object search [--query QUERY] [--output OUTPUT]

コマンド・オプション

--query 問い合わせ: Lucene 照会ストリングを指定します。
--output OUTPUT (オプション): 出力フォーマットを指定します。デフォルトはターミナル互換で、唯一サポートされている代替手段はJSONである。例: --output json

ibmcloud カタログ・オブジェクトの準備ができました

以下のコマンドを実行し、オブジェクトを共有または公開する準備ができているとマークします。

ibmcloud catalog object ready [--catalog CATALOG] [--name NAME]

コマンド・オプション

--catalog CATALOG: カタログ名またはカタログ ID を指定します。
--name NAME: オブジェクトの名前を指定する。

以下のコマンドを実行して、Partner Center 管理対象オブジェクトの共有を有効にします。アカウントまたはアクセスリストにオブジェクトを共有する前に、共有を有効にします。

ibmcloud catalog object enable-sharing [--catalog CATALOG] [--name NAME]

ibmcloud カタログ・オブジェクトの公開

以下のコマンドを実行して、アクセス・リスト、アカウント、 IBM 従業員、またはすべてのユーザーが表示および使用できる IBM Cloud カタログにオブジェクトを公開します。

ibmcloud catalog object publish COMMAND [--catalog CATALOG] [--name NAME]

コマンド・オプション

コマンド: オブジェクトを公開する場所を指定します。有効な値は、 accesslist、 account、 ibm、または public です。
--catalog CATALOG: カタログ名またはカタログ ID を指定します。
--name NAME: オブジェクトの名前を入力します。

例

カタログ dev-catalog にある dev-object というオブジェクトを IBM 従業員に公開します。

ibmcloud catalog object publish ibm --catalog dev-catalog --name dev-object

ibmcloudカタログオブジェクトアクセスリスト追加

以下のコマンドを実行して、オブジェクトのアクセス・リストにアカウント ID を追加します。

ibmcloud catalog object access-list add [--account-id ID] [--catalog CATALOG] [--name NAME]

コマンド・オプション

--account-id 身分証明書: アカウント IDをカンマ区切りで指定します。
--catalog CATALOG: カタログ名またはカタログ ID を指定します。
--name NAME: オブジェクトの名前を指定する。

ibmcloudカタログオブジェクトアクセスリスト取得

以下のコマンドを実行して、オブジェクトの特定のアクセス・リストに関する情報を取得します。

ibmcloud catalog object access-list get [--catalog CATALOG] [--name NAME] [--output OUTPUT]

コマンド・オプション

--catalog CATALOG: カタログ名またはカタログ ID を指定します。
--name NAME: オブジェクトの名前を指定する。
--output OUTPUT (オプション): 出力フォーマットを指定します。デフォルトはターミナル互換で、唯一サポートされている代替手段はJSONである。例: --output json

ibmcloudカタログオブジェクトアクセスリストrm

以下のコマンドを実行して、オブジェクトのアクセス・リストからアカウント IDを削除する。

ibmcloud catalog object access-list rm [--account-id ID] [--catalog CATALOG] [--name NAME]

コマンド・オプション

--account-id 身分証明書: アカウント IDをカンマ区切りで指定します。
--catalog CATALOG: カタログ名またはカタログ ID を指定します。
--name NAME: オブジェクトの名前を指定する。