型錄管理 CLI 外掛程式
IBM Cloud® 目錄管理命令列介面 (CLI) 提供額外的功能,可讓您處理 IBM Cloud 目錄中的產品以及您帳戶中的私人目錄。 您可以使用此 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 目錄帳戶新增核准存取
執行下列指令,以將核准存取權新增至型錄帳戶。
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 目錄帳戶刪除核准存取
執行下列指令,以刪除型錄帳戶的核准存取權。
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 目錄帳戶 get-approval-list
執行以下命令以取得您的目錄帳戶的核准清單。
ibmcloud catalog account get-approval-list [--object-kind KIND]
指令選項
- --object-kind價值
- 提供物件類型。 選項有
offering、vpe、proxy_source或preset_configuration。
ibmcloud 目錄帳戶 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值(可選)
- 提供企業或企業帳戶群組 ID,以檢視或管理企業的要求。 在 ID 前面加上
-ent-(代表企業) 和-entgrp(代表帳戶群組)。
ibmcloud 目錄帳戶 set-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值(可選)
- 提供企業或企業帳戶群組 ID,以檢視或管理企業的要求。 在 ID 前面加上
-ent-(代表企業) 和-entgrp(代表帳戶群組)。
建立 ibmcloud 目錄
請使用這個指令在您的帳戶中建立新的專用型錄。 專用型錄用來組織 IBM Cloud 型錄中的一組產品、您新增的專用型錄或產品參照。 使用者必須透過 IAM 存取原則及包含專用型錄的資源群組來存取您的專用型錄,才能檢視及使用產品。
以資源組為目標來建立目錄,因為目錄存在於特定資源組的上下文中。 若要取得資源群組清單,您可以執行 ibmcloud resource groups 指令,然後執行 ibmcloud target -g "resource group" 指令。
ibmcloud catalog create --name CATALOG [--catalog-description "DESCRIPTION"]
指令選項
- --name目錄
- 型錄名稱。
- --catalog-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 目錄清單
執行下列指令,以擷取此特定帳戶中的型錄清單。
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 目錄
執行下列指令,以擷取帳戶中特定型錄的資訊。
ibmcloud catalog get --catalog CATALOG [--output FORMAT]
指令選項
- --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 目錄
執行下列指令,以刪除帳戶中的特定型錄。
ibmcloud catalog delete --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 類型(可選)
- 選用。 預設值為
services。 有效的選項為services和software。 - --catalog目錄(可選)
- 搜尋您帳戶發佈的軟體。 請指定要用來搜尋的型錄名稱或 ID。
- --output FORMAT(選用)
- 指定輸出格式。 預設值為終端機相容,且唯一替代選項為
json及csv。 - --kind種類(可選)
- 此標誌僅對搜尋服務有效。 提供產品類型的逗點區隔清單。
- --region 區域(選擇性)
- 此標誌僅對搜尋服務有效。 提供以逗點區隔的區域清單。 執行
ibmcloud cs regions以傳回有效清單。 - --price價格(可選)
- 此標誌僅對搜尋服務有效。 提供以逗號分隔的定價類型清單。
- --tag標籤(可選)
- 此標誌僅對搜尋服務有效。 提供以逗號分隔的標籤清單。
- --global(選修的)
- 此標誌僅對搜尋服務有效。 使用它在全局範圍內操作。
- --sort-by類型(可選)
- 該標誌僅對搜尋服務有效,並用於排序搜尋結果。 可用的選項有
name、displayname、kind、provider、created和updated。 - --reverse(選修的)
- 此標誌僅對搜尋服務有效。 使用它來反轉排序順序。
- --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 目錄過濾器取得
執行下列指令,以擷取帳戶或特定型錄的過濾器詳細資料。
ibmcloud catalog filter get --catalog CATALOG [--output FORMAT]
指令選項
- --catalog目錄
- 目錄名稱或 ID。
- --account-group帳戶組
- 帳戶群組的名稱或 ID。 此欄位僅適用於企業帳戶。
- --output FORMAT(選用)
- 指定輸出格式。 預設值是終端相容的,唯一支援的替代方案是 JSON。 例如,
--output json。
輸出
該指令傳回下列輸出:
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 目錄篩選器
執行下列指令建立新的篩選器。 如果過濾器存在,這個指令會置換現行過濾器。
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目錄(可選)
- 請指定型錄名稱或 ID。 如果未指定,篩選器會在帳戶層級建立。
- --account-group帳戶組
- 帳戶群組的名稱或 ID。 此選項只適用於企業帳戶。
- --hide-ibm-catalog(選修的)
- 依預設,此帳戶中的所有使用者都可看見型錄。 透過提供此旗標,您可以關閉 IBM Cloud 目錄的能見度,並將產品新增至您的私人目錄,使產品僅供您選擇的使用者使用。
- --include-all布林值(可選)
- 如果未提供旗標,預設為 true。 有效值為
true及false。 如果設定為 true,篩選器預設會包含整個公開目錄,且後續的篩選器會排除在外。 如果設定為 false,篩選器會排除整個公開目錄,而後續的標記會包含在內。 如需相關資訊,請參閱 管理型錄設定。
--offering-format格式(可選)
- --category類別(可選)
- 提供最適合使用者使用您產品的種類。 分類用於根據共同的解決方案、功能或用途來組織目錄中的產品。 您只能選擇一個類別。 執行
ibmcloud catalog offering category-options指令,以檢視所有選項。 預設值為Developer tools。 - --compliance類型(可選)
- 提供您要併入或排除的相符性種類清單 (以逗點區隔)。 執行
ibmcloud catalog filter options指令,以檢視所有選項。 - --deployment-target目標(可選)
- 提供您要併入或排除的部署目標清單 (以逗點區隔)。 執行
ibmcloud catalog filter options指令,以檢視所有選項。 - --exclude-list清單(可選)
- 提供必須在已過濾的公用型錄中排除的產品 ID 或名稱清單 (以逗點區隔)。
- --include-list清單(可選)
- 提供必須包含在已過濾公用型錄中的產品 ID 或名稱清單 (以逗點區隔)。
- 提供您要併入或排除的產品格式清單 (以逗點區隔)。 執行
ibmcloud catalog filter options指令,以檢視所有選項。 - --pricing-plan計劃(選項)
- 提供您要併入或排除的定價方案清單 (以逗點區隔)。 執行
ibmcloud catalog filter options指令,以檢視所有選項。 - --provider提供者(可選)
- 提供您要併入或排除的提供者清單 (以逗點區隔)。 執行
ibmcloud catalog filter options指令,以檢視所有選項。 - --release發布(可選)
- 提供您要併入或排除的種類清單 (以逗點區隔)。 執行
ibmcloud catalog filter options指令,以檢視所有選項。 - --type 類型(可選)
- 提供您要併入或排除的軟體類型清單 (以逗點區隔)。 執行
ibmcloud catalog filter options指令,以檢視所有選項。
ibmcloud 目錄過濾器刪除
執行下列指令刪除已套用的篩選條件。 除非指定目錄,否則此過濾器預設為帳戶層級。 因此,會重設過濾器,以併入公用型錄中的所有產品。
ibmcloud catalog filter delete --catalog CATALOG
指令選項
- --catalog目錄
- 目錄名稱或 ID。
- --account-group帳戶組
- 帳戶群組的名稱或 ID。 此選項只適用於企業帳戶。
ibmcloud 目錄篩選產品
更新過濾器,以併入或排除特定產品及任何適用的定價方案。 除非指定型錄或帳戶群組,否則此過濾器預設為帳戶層次。
ibmcloud catalog filter offering --offering PRODUCT-NAME
指令選項
- --catalog目錄
- 目錄名稱或 ID。
- --account-group帳戶組
- 帳戶群組的名稱或 ID。 此選項只適用於企業帳戶。
- --plans-list計劃清單
- 要併入或排除的計劃 ID 或名稱清單 (以逗點區隔)。
- --offering發售
- 產品名稱或 ID。
- --include
- 如果未提供旗標,則預設值為 true。 有效值為
true及false。 如果設為 true,則提供的產品及計劃對帳戶中的使用者可見。 如果設為 false,則使用者在帳戶中看不到產品及計劃。
ibmcloud 目錄過濾器隱藏-ibm-公共目錄
預設情況下,帳戶中的所有使用者都可以看到 IBM Cloud 目錄。 您可以關閉 IBM Cloud 目錄的可視性,並將產品新增至您的私人目錄,使產品只提供給您選擇的使用者。
ibmcloud catalog filter hide-ibm-public-catalog
ibmcloud 目錄篩選器 show-ibm-public-catalog
預設情況下,帳戶中的所有使用者都可以看到 IBM Cloud 目錄。 您可以關閉 IBM Cloud 目錄的可視性,並將產品新增至您的私人目錄,使產品只提供給您選擇的使用者。
ibmcloud catalog filter show-ibm-public-catalog
ibmcloud catalog filter 選項
執行下列指令,以擷取每一個過濾器種類的過濾器選項。
ibmcloud catalog filter options
指令選項
- --all
- 在過濾器清單中包括產業、解決方案類型及定價方案。
- --output FORMAT(選用)
- 指定輸出格式。 預設值是終端相容的,唯一支援的替代方案是 JSON。 例如,
--output json。
輸出
該指令傳回下列輸出:
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 目錄
執行下列指令,以將產品新增至帳戶中的專用型錄。
ibmcloud catalog offering create [--catalog CATALOG_NAME] [--zipurl URL] [--include-config] [--target-version VERSION] [--token TOKEN] [--vpc-body BODY]
指令選項
- --catalogCATALOG_NAME
- 目錄名稱或 ID。
- - --zipurl URL (可選)
- 指向產品 .zip 檔案的 URL。
- --target-version版本
- 指定產品的版本。
- --include-config(選修的)
- 如果提供的話,當您新增產品時,會包含所有配置值並可供使用。
- --token令牌(可選)
- 指定私人儲存庫的個人存取代碼。
- --vpc-body主體(可選)
- 提供資訊以匯入 VPC 的虛擬伺服器映像檔,包括名稱、標籤、安裝類型、目標類型、版本、sha、標籤及 meta 資料。
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 供應項目清單
執行下列指令,以取得專用型錄中產品的詳細資料。 此指令提供依專用型錄、產品及版本的過濾器。
ibmcloud catalog offering list [--catalog CATALOG] [--offering OFFERING_NAME] [--version VERSION] [--output FORMAT]
指令選項
- --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 供應項目搜尋
執行下列指令,以取得專用型錄中產品的詳細資料。 此指令提供依專用型錄、產品及版本的過濾器。
ibmcloud catalog offering search [--catalog CATALOG] [--offering OFFERING_NAME] [--version VERSION] [--output FORMAT]
指令選項
- --catalog目錄(可選)
- 目錄名稱或 ID。
- --offering提供(可選)
- 產品名稱或 ID。
- --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目錄提供獲取
執行下列指令,以取得型錄中特定產品的詳細資料。
ibmcloud catalog offering get --catalog CATALOG --offering OFFERING_NAME [--output FORMAT]
指令選項
- --catalog目錄
- 目錄名稱或 ID。
- --offeringOFFERING_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 目錄提供匯入版本
執行下列指令,以在專用型錄中匯入產品的新版本。
ibmcloud catalog offering import-version --catalog CATALOG --offering OFFERING_NAME [--zipurl URL] [--target-version APP_VERSION] [--include-config] [--vpc-body BODY]
指令選項
- --catalog目錄
- 目錄名稱或 ID。
- --offeringOFFERING_NAME
- : 產品名稱或 ID。
- - --zipurl URL (可選)
- 指向產品 .zip 檔案的 URL。
- --target-versionAPP_VERSION(可選)
- 正在導入的("tgz/")應用程式版本。
- --include-config(選修的)
- 如果提供的話,當您匯入新版本時,會包含所有配置值並可供使用。
- --vpc-body主體(可選)
- 提供資訊以匯入 VPC 的虛擬伺服器映像檔,包括名稱、標籤、安裝類型、目標類型、版本、sha、標籤及 meta 資料。
VPC 虛擬伺服器影像範例
將 VPC 的虛擬伺服器映像匯入到具有 ID 的目錄的現有產品中 51c9e0db-2911-45a6-adb0-ac5332d27cf2 和產品 ID 97cdaf1b-62b2-48e2-8589-10b31023866d。
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 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 目錄提供版本預先安裝
執行下列指令,以執行特定產品的預先安裝 Script。
ibmcloud catalog offering version preinstall --version-locator VERSION_NUMBER --cluster CLUSTER_ID --namespace NAME
指令選項
- --version-locatorVERSION_NUMBER
- 若要取得此產品的版本定位器,請執行
ibmcloud catalog offering list指令,並尋找您要使用的指定產品及版本。 - --cluster叢集ID
- 提供您要在其中安裝產品之叢集的叢集 ID。
- --namespace 名稱
- 提供您要使用的名稱空間。 您可以指定一個新的,它會在預先安裝的過程中自動建立。
範例
在名為 test-namespace 的名稱空間中,執行叢集 (ID 為 bn5ebho206o7fg45f2e0 ) 中版本定位器號碼為 b636d651-8489-4425-bd6a-f30af1603577.18aad484-c78b-4269-808b-52027621abd4 的產品的預先安裝 Script。
ibmcloud catalog offering version preinstall --version-locator b636d651-8489-4425-bd6a-f30af1603577.18aad484-c78b-4269-808b-52027621abd4 --cluster bn5ebho206o7fg45f2e0 --namespace test-namespace
ibmcloud 目錄提供版本預安裝狀態
執行下列指令,以取得進行中前置安裝的狀態。
ibmcloud catalog offering version preinstall-status --version-locator VERSION_NUMBER --cluster CLUSTER_ID --namespace NAME [--output FORMAT]
指令選項
- --version-locatorVERSION_NUMBER
- 若要取得產品的版本定位器,請執行
ibmcloud catalog offering list指令,並尋找您要使用的指定產品及版本。 - --cluster叢集ID
- 提供執行預先安裝之叢集的叢集 ID。
- --namespace 名稱
- 提供用於預先安裝的名稱空間。
- --output FORMAT(選用)
- 指定輸出格式。 預設值是終端機相容,且唯一支援的替代方案是 JSON,例如
--output json。
ibmcloud目錄提供版本驗證
執行下列指令,以驗證專用型錄中產品的新版本。 必須先驗證產品,以確保它們如預期般運作,然後才能發佈至帳戶,以供其他使用者從專用型錄建立實例。
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-locatorVERSION_NUMBER
- 若要取得產品的版本定位器,請執行
ibmcloud catalog offering list指令,並尋找您要使用的指定產品及版本。 - --cluster叢集ID
- 提供您要在其中安裝產品之叢集的叢集 ID。
- --namespace 名稱
- 提供您要使用的名稱空間。 您可以指定一個新的,它會在預先安裝的過程中自動建立。
- --timeout 超時
- 指定 Schematics 工作區等待安裝的時間 (以秒為單位)。 預設值為
180。 - --wait等待
- 等待並追蹤 Schematics 工作區工作的進度。 如果
true,則安裝會等待。 如果是false,軟體會立即安裝。 預設值為true。 - --override-values值|檔名(可選)
- 提供安裝的任何自訂配置。 您可以在行內或使用 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版本(可選)
- 提供工作區 Terraform 版本。
- --workspace-region地區(可選)
- 提供工作區區域。
- --workspace-rg-id身份證(可選)
- 提供工作區資源群組 ID。
- --schematics-destroy(選修的)
- 提供此旗標可在驗證及安裝之後刪除工作區資源。
- --schematics-delete值(可選)
- 提供此旗標,以在驗證及安裝之後刪除 Schematics 工作區。
驗證使用叢集的產品的範例
在名為 test-namespace 的名稱空間內,使用 ID 為 bn5ebho206o7fg45f2e0 之叢集中的版本定位器 b636d651-8489-4425-bd6a-f30af1603577.18aad484-c78b-4269-808b-52027621abd4 來驗證產品。 此安裝具有自訂配置,因此會使用 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 目錄提供版本驗證-狀態
執行下列指令,以取得進行中驗證的狀態。
ibmcloud catalog offering version validate-status --version-locator VERSION_NUMBER [--output FORMAT]
指令選項
- --version-locatorVERSION_NUMBER
- 若要取得產品的版本定位器,請執行
ibmcloud catalog offering list指令,並尋找您要使用的指定產品或版本。 - --output FORMAT(選用)
- 指定輸出格式。 預設值是終端機相容,且唯一支援的替代方案是 JSON,例如
--output json。
ibmcloud 目錄提供類別-選項
執行下列指令,以擷取種類選項清單。
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 目錄提供新增類別
執行下列指令,以將種類標籤新增至產品。 您可以提供種類名稱,透過執行 ibmcloud catalog offering category-options 指令可以找到該種類名稱。 產品必須放在類別中才能在目錄中看到。 預設值為 Developer tools。
ibmcloud catalog offering category-options [--output FORMAT]
指令選項
- --catalog目錄
- 目錄名稱或 ID。
- --offering發售
- 產品名稱或 ID。
- --category 類別
- 提供最適合使用者使用您產品的種類。 分類用於根據共同的解決方案、功能或用途來組織目錄中的產品。 您只能選擇一個類別。 執行
ibmcloud catalog offering category-options指令,以檢視所有選項。 預設值為Developer tools。
範例
ibmcloud catalog offering add-category --catalog dev-catalog --offering dev-offering --category dev_ops
ibmcloud catalog 供應項目種類
執行下列指令,以擷取產品版本的種類。
ibmcloud catalog offering version categories [--catalog CATALOG] [--offering OFFERING] [--output OUTPUT]
指令選項
- --catalog目錄
- 目錄名稱或 ID。
- --offering發售
- 產品名稱或 ID。
- --output FORMAT(選用)
- 指定輸出格式。 預設值是終端相容的,唯一支援的替代方案是 JSON。 例如,
--output json。
範例
擷取稱為 dev-offering 且位於 dev-catalog 中的產品種類。
ibmcloud catalog offering version categories --catalog dev-catalog --offering dev-offering
ibmcloud catalog offering version get-聲明
執行下列指令,以擷取版本所要求的安全及相符性資訊。
ibmcloud catalog offering version get-claims [--output OUTPUT] [--version-locator LOCATOR]
指令選項
- --version-locator定位器
- 若要取得產品的版本定位器,請執行
ibmcloud catalog offering list指令,並尋找您要使用的指定產品或版本。 - --output值(可選)
- 指定輸出格式。 預設值是終端機相容,且唯一支援的替代方案是 JSON,例如
--output json。
ibmcloud catalog offering version update-聲明
執行下列指令,以更新版本的安全及相符性要求。
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姓名(可選)
- 提供目標帳戶的名稱。
- --target-api-key鑰匙(可選)
- 如果您想要使用替代帳戶 (目標帳戶) 將掃描套用至來源帳戶,請提供 API 金鑰。 如需相關資訊,請參閱 設定目標帳戶。
- --timeout 超時
- 指定在指令傳回之前,您要等待掃描套用至版本的時間 (以秒為單位)。 預設值是 600 秒(10 分鐘)。
- --version-locator定位器
- 若要取得產品的版本定位器,請執行
ibmcloud catalog offering list指令,並尋找您要使用的指定產品或版本。 - --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 目錄提供版本 get-scan
執行下列指令,以擷取新增至您版本的 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輸出(可選)
- 指定輸出格式。 預設值是終端相容的,唯一支援的替代方案是 JSON。 例如,
--output json。 - --profiles簡介
- 提供具有版本的設定檔名稱清單 (以逗點區隔),例如
"IBM Cloud for Financial Services::1.2.0"。 - --service-instance實例
- 提供 Security and Compliance Center 實例 ID。
- --target-account-name姓名(可選)
- 提供目標帳戶的名稱。
- --target-api-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 目錄提供版本建立-草稿
執行下列指令,以建立現有版本的草稿。 此指令適用於變更您要發佈而不引進新版本的現有版本。 部分變更 (例如變更原始檔) 需要您重新驗證產品。
ibmcloud catalog offering version create-draft --version-locator VERSION_NUMBER [--output FORMAT]
指令選項
- --version-locatorVERSION_NUMBER
- 若要取得產品的版本定位器,請執行
ibmcloud catalog offering list指令,並尋找您要使用的指定產品或版本。 - --output FORMAT(選用)
- 指定輸出格式。 預設值是終端相容的,唯一支援的替代方案是 JSON。 例如,
--output json。
ibmcloud 目錄提供版本刪除-版本
執行下列指令,以刪除產品版本。
ibmcloud catalog offering version delete-version --version-locator VERSION_NUMBER [--output FORMAT]
指令選項
- --version-locatorVERSION_NUMBER
- 若要取得產品的版本定位器,請執行
ibmcloud catalog offering list指令,並尋找您要使用的指定產品或版本。 - --output FORMAT(選用)
- 指定輸出格式。 預設值是終端相容的,唯一支援的替代方案是 JSON。 例如,
--output json。
ibmcloud 目錄提供版本 deprecate-version
執行下列指令,以從 IBM Cloud 型錄中淘汰先前發佈的產品版本。
ibmcloud catalog offering version deprecate-version --version-locator VERSION_NUMBER
指令選項
- --version-locatorVERSION_NUMBER
- 若要取得產品的版本定位器,請執行
ibmcloud catalog offering list指令,並尋找您要使用的指定產品或版本。
ibmcloud 目錄提供版本刷新-版本
執行以下命令以在草稿版本的來源檔案中建立變更。 此指令對於更新現有版本非常有用。
ibmcloud catalog offering version refresh-version --version-locator VERSION_NUMBER --zipurl URL [--include-config]
指令選項
- --version-locatorVERSION_NUMBER
- 若要取得產品的版本定位器,請執行
ibmcloud catalog offering list指令,並尋找您要使用的指定產品或版本。 - --zipurl URL
- 指向產品壓縮檔案的 URL。
- --include-config(選修的)
- 如果提供的話,當您新增產品時,會包含所有配置值並可供使用。
ibmcloud 目錄提供版本合併草案
執行下列指令,以合併產品的初版。
ibmcloud catalog offering version merge-draft --version-locator VERSION_NUMBER
指令選項
- --version-locatorVERSION_NUMBER
- 若要取得產品的版本定位器,請執行
ibmcloud catalog offering list指令,並尋找您要使用的指定產品或版本。
ibmcloud目錄產品已準備就緒
執行下列指令,將您的產品標示為已備妥可共用或發佈。
ibmcloud catalog offering ready --version-locator VERSION_NUMBER
指令選項
- --version-locatorVERSION_NUMBER
- 若要取得產品的版本定位器,請執行
ibmcloud catalog offering list指令,並尋找您要使用的指定產品或版本。
ibmcloud目錄提供刪除
執行下列指令,以從專用型錄中刪除產品。 您無法刪除在 IBM Cloud 型錄中發佈的產品。 若要從 IBM Cloud 型錄中淘汰已發佈的產品,請參閱 ibmcloud catalog offering deprecate-offering。
ibmcloud catalog offering delete --catalog CATALOG --offering OFFERING
指令選項
- --catalog目錄
- 目錄名稱或 ID。
- --offering發售
- 產品名稱或 ID。
ibmcloud 目錄提供發佈帳戶
執行下列指令,以將產品從專用型錄發佈至帳戶。 產品發布後,帳戶中的使用者有權存取私有目錄。 它包含的資源組可以建立一個實例並開始使用它。
ibmcloud catalog offering publish account [--catalog CATALOG][--offering OFFERING]
指令選項
- --catalog目錄
- 目錄名稱或 ID。
- --offering發售
- 產品名稱或 ID。
ibmcloud目錄提供發佈允許清單
執行下列指令,將產品從專用型錄發佈至一組已列入允許清單的帳戶。 產品發布後,許可帳戶中的使用者可以建立實例並開始使用。
ibmcloud catalog offering publish allowlist [--catalog CATALOG][--offering OFFERING][--account-ids ACCOUNT-IDS]
指令選項
- --catalog目錄
- 目錄名稱或 ID。
- --offering發售
- 產品名稱或 ID。
- --account-ids帳戶IDS
- 帳戶 ID。
ibmcloud目錄提供發佈企業
執行下列指令,以將產品發佈至企業。 發佈產品之後,企業內的使用者可以建立產品實例。
ibmcloud catalog offering publish enterprise [--catalog CATALOG][--offering OFFERING]
指令選項
- --catalog目錄
- 目錄名稱或 ID。
- --offering發售
- 產品名稱或 ID。
ibmcloud目錄暫停提供
執行下列指令,以暫停型錄中的產品。 您可以暫時暫停它,而不永久刪除或淘汰它。 例如,如果您在產品中發現錯誤或漏洞,且在其他客戶安裝它之前必須先調查該漏洞,則暫停產品可能很有用。
ibmcloud catalog offering suspend-offering [--catalog CATALOG][--offering OFFERING]
指令選項
- --catalog目錄
- 目錄名稱或 ID。
- --offering發售
- 產品名稱或 ID。
ibmcloud目錄提供版本暫停-版本
執行下列指令,以從型錄暫停產品版本。 您可以暫時暫停版本,而不永久刪除或淘汰它。
ibmcloud catalog offering version suspend-version [--version-locator VERSION_NUMBER]
指令選項
- --version-locatorVERSION_NUMBER
- 若要取得此供應項目的版本定位器,請執行
ibmcloud catalog offering list並尋找您要使用的版本。
提供工作空間的 ibmcloud 目錄
執行下列指令,以取得產品版本的 Schematics 工作區。
ibmcloud catalog offering workspaces [--version-locator VERSION_NUMBER] [output FORMAT]
指令選項
- --version-locatorVERSION_NUMBER
- 若要取得此供應項目的版本定位器,請執行
ibmcloud catalog offering list並尋找您要使用的指定版本。 - --output FORMAT(選用)
- 指定輸出格式。 預設值是終端相容的,唯一支援的替代方案是 JSON。 例如,
--output json。
安裝 ibmcloud 目錄
執行下列指令,以從 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-locatorVERSION_NUMBER
- 若要取得此供應項目的版本定位器,請執行
ibmcloud catalog offering list並尋找您要使用的版本。 - --cluster叢集ID
- 請指定叢集名稱或 ID。
- --namespace 名稱
- 指定您要使用的名稱空間。
- --override-values價值觀
- 提供安裝的任何自訂配置。 您可以在行內或使用 JSON 或 TXT 檔案來提供此值。 例如,
override-values values.json。 - --timeout 超時
- 指定 Schematics 工作區在安裝之前等待的時間 (以秒為單位)。 預設值為
180。 - --wait等待
- 等待並追蹤 Schematics 工作區工作的進度。 如果
true,則安裝會等待。 如果是false,軟體會立即安裝。 預設值為true。 - --workspace-name姓名(可選)
- 請提供工作區名稱。 預設值為
OfferingName-Date。 - --workspace-tags標籤(可選)
- 提供以逗號分隔的標籤清單。
- --workspace-tf-version版本(可選)
- 提供工作區 Terraform 版本。
- --workspace-region地區(可選)
- 提供工作區區域。
- --workspace-rg-id身份證(可選)
- 提供工作區資源群組 ID。
- --schematics-delete值(可選)
- 提供此旗標,以在驗證及安裝之後刪除 Schematics 工作區。
範例
安裝軟體版本 1 透過使用集群 A,命名空間 install,以及覆蓋值 JSON values.json。
ibmcloud catalog install [--version-locator 1] [--cluster A] [--namespace install] [--override-values values.json]
置換 values.json 檔案中的值範例格式:
{
"username": "install-test-1",
"password": "passw0rd"
}
ibmcloud 目錄定價
執行下列指令,以取得型錄供應項目的計價資訊。
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 相容供應項目過濾。
範例
取得 Virtual Server for VPC for a Pay-As-You-Go 帳戶的計價資訊。
ibmcloud catalog pricing is.instance [--price paygo]
ibmcloud 目錄私人端點區域
執行下列指令以擷取支援指定服務專用端點的區域清單。
ibmcloud catalog private-endpoint regions [--service ID]
指令選項
- --service
- 提供服務的 ID 或程式名稱,以檢視其支援私人端點的區域
ibmcloud 目錄私人端點服務
執行下列指令以擷取指定區域支援私人端點的服務清單。
ibmcloud catalog private-endpoint services [--region REGION]
指令選項
- --region 或 -r
- 提供 REGION 以查看該區域有哪些服務支援私人端點
ibmcloud catalog 公用程式 create-product-from-workspace
執行下列指令,從直接從 Git 儲存庫建立的 Schematics 工作區 建立可部署架構磚。 可部署的架構 創建一個專案 以便您可以繼續開發和維護未來版本的可部署架構。
指令需要 GIT_TOKEN 環境變數來向來源儲存庫進行鑑別,以便可以新增型錄資訊清單。 該指令會推送至 Git 儲存庫中的新分支 (位於 Schematics 工作區中),並建立用於上線的版本。
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金鑰
- 提供用於連結目錄和項目的 API 金鑰。 互斥與'--trusted-profile-id'。
- --catalog-label目錄標籤(可選)
- 提供要匯入至其中的現有型錄標籤,或要建立的新型錄名稱。 預設值為“遷移的 DA”。
- --offering-label產品標籤(可選)
- 提供要匯入至其中的現有供應項目標籤或要建立的新產品與服務名稱。 預設值為“已遷移<工作空間名稱>”。如果工作區是從目錄產品建立的,則該標籤將覆蓋現有產品標籤。
- --project-name姓名(可選)
- 提供連結到載入目錄的項目名稱。 如果專案不存在,則會建立。 預設名稱是“開發遷移專案”。
- --project-resource-group(選修的)
- 為建立的專案提供資源組。 預設資源群組是 'Default'。
- --target-version版本(可選)
- 提供已移轉供應項目的目標版本。 預設為 ' 1.0.0 '。
- --trusted-profile-id或者--tpi受信任的個人資料 ID
- 提供用於連結目錄和專案的可信任設定檔 ID。 與 '--api-key' 互斥。
- --variation-label變化標籤(可選)
- 提供要上線之版本的變異標籤。 預設為“標準”。 如果是從型錄供應項目建立工作區,則標籤會改寫現有版本標籤。
- --workspace-id 工作區 ID
- 提供 Schematics 工作區 ID。 若要取得工作區 ID,您必須建立 Schematics 工作區。 如需相關資訊,請參閱
ibmcloud schematics workspace new。
ibmcloud 目錄公用程式 netrc
執行下列指令,以建立 .netrc 檔案、在 .netrc 檔案中產生機器名稱,或在 .netrc 檔案中更新認證。 .netrc 檔案會儲存使用 IBM Cloud 型錄中 Terraform 模組所需的必要登入資訊。
透過執行此指令,您可以配置機器名稱 cm.globalcatalog.cloud.ibm.com 的 .netrc 檔案,並以 iamtoken 作為使用者名稱,以您的 IAM 記號作為密碼。
您需要 1.2.7 或更高版本的目錄管理 CLI 外掛程式才能執行 .netrc 命令。
ibmcloud catalog utility netrc
ibmcloud 目錄公用程式 update-module-references
執行下列指令,以檢查工作目錄的 Terraform 模組是否有型錄中的更新項目,並將來源屬性更新至最新版本。 README.md 也會更新。
ibmcloud catalog utility update-module-references
ibmcloud catalog 供應項目取消發佈帳戶
執行下列指令,以從您的帳戶取消發佈產品。 取消發佈產品之後,您帳戶中的使用者無法建立產品實例。
ibmcloud catalog offering unpublish account [--catalog CATALOG][--offering OFFERING]
指令選項
- --catalog目錄
- 目錄名稱或 ID。
- --offering發售
- 產品名稱或 ID。
ibmcloud 目錄提供未發佈允許清單
執行下列指令,以從產品的容許清單中移除帳戶 ID。 從允許清單中移除的帳戶無法建立產品實例。
ibmcloud catalog offering unpublish allowlist [--catalog CATALOG][--offering OFFERING][--account-ids ACCOUNT-IDS]
指令選項
- --catalog目錄
- 目錄名稱或 ID。
- --offering發售
- 產品名稱或 ID。
- --account-ids帳戶IDS
- 帳戶 ID。
ibmcloud目錄提供未出版企業版
執行下列指令,以從企業取消發佈產品。 取消發佈產品之後,企業無法建立產品的實例。
ibmcloud catalog offering unpublish enterprise [--catalog CATALOG][--offering OFFERING]
指令選項
- --catalog目錄
- 目錄名稱或 ID。
- --offering發售
- 產品名稱或 ID。
ibmcloud 目錄提供解除發行 ibm
執行下列指令,以從 IBM取消發佈產品。 取消發佈產品之後,IBM 員工無法建立產品實例。
ibmcloud catalog offering unpublish ibm [--catalog CATALOG][--offering OFFERING]
指令選項
- --catalog目錄
- 目錄名稱或 ID。
- --offering發售
- 產品名稱或 ID。
ibmcloud 目錄發佈 ibm
執行下列指令,將您帳戶中已可用的供應項目發佈至所有 IBM程式。 發佈處理程序的這個部分會在暫置及正式作業型錄中建立一個磚,只有 IBM個可見。 透過將供應項目發佈至 IBMers,您可以先在正式作業中測試供應項目,然後再將它提供給 IBM Cloud 型錄中的所有使用者。
ibmcloud catalog offering publish ibm [--catalog CATALOG][--offering OFFERING]
指令選項
- --catalog目錄
- 目錄名稱或 ID。
- --offering發售
- 產品名稱或 ID。
ibmcloud提供的目錄發佈公開
執行下列指令,將您的專用供應項目發佈至 IBM Cloud 型錄,以供所有使用者查看及使用。 若要在發佈程序中進入此步驟,您必須先將供應項目發佈至您的帳戶及所有 IBM 員工,以完成測試程序。 測試完成之後,您可以執行此指令。
此選項需要核准。 當您的審核完成後,您的瓷磚就可以提供給所有 IBM Cloud 客戶。
ibmcloud catalog offering publish public [--catalog CATALOG][--offering OFFERING]
指令選項
- --catalog目錄
- 目錄名稱或 ID。
- --offering發售
- 產品名稱或 ID。
ibmcloud 目錄供貨 廢棄供貨
執行下列指令,以淘汰 IBM Cloud 型錄中先前發佈的供應項目版本。
ibmcloud catalog offering deprecate-offering [--catalog CATALOG][--offering OFFERING]
指令選項
- --catalog目錄
- 目錄名稱或 ID。
- --offering發售
- 產品名稱或 ID。
ibmcloud目錄提供還原-提供
執行下列指令,以還原 IBM Cloud 型錄中先前已淘汰的產品。 驗證產品版本之後,您可以將它還原至淘汰之前的已發佈狀態。
ibmcloud catalog offering restore-offering [--catalog CATALOG][--offering OFFERING]
指令選項
- --catalog目錄
- 目錄名稱或 ID。
- --offering發售
- 產品名稱或 ID。
ibmcloud 目錄提供版本還原-版本
執行下列指令,以在 IBM Cloud 型錄中還原先前已淘汰的產品版本。 恢復它會將版本置於草稿狀態。 驗證之後,您可以將原始版本還原至它在淘汰之前所處的已發佈狀態。
ibmcloud catalog offering version restore-version [--catalog CATALOG][--offering OFFERING] [--include-config]
指令選項
- --catalog目錄
- 目錄名稱或 ID。
- --offering發售
- 產品名稱或 ID。
- --include-config(選修的)
- 如果提供的話,當您新增產品時,會包含所有配置值並可供使用。
ibmcloud 目錄物件建立 vpe
執行下列指令,以將物件新增至帳戶中的專用型錄。
ibmcloud catalog object create vpe [--catalog CATALOG] [--crn CRN] [endpoint-type TYPE] [--fqdn FQDN] [--name NAME] [--region REGION]
指令選項
- --catalog目錄
- 請指定型錄名稱或 ID。
- --crn CRN
- 提供雲端資源名稱 (CRN)。
- --endpoint-type類型
- 指定 VPE 端點類型。
- --fqdn FQDN
- 提供以逗號分隔的完整合格網域名稱清單。
- --name 名稱
- 指定物件的名稱。
- --region 區域
- 指定 VPE 端點的地區。
刪除 ibmcloud 目錄物件
執行下列指令刪除物件。
ibmcloud catalog object delete [--catalog CATALOG] [--name NAME]
指令選項
- --catalog目錄
- 請指定型錄名稱或 ID。
- --name 名稱
- 提供物件的名稱。
ibmcloud 目錄物件更新 vpe
執行下列指令更新物件。
ibmcloud catalog object update vpe [--catalog CATALOG] [--name NAME] [--crn CRN] [--endpoint-type TYPE] [--fqdn FQDN] [--region REGION]
指令選項
- --catalog目錄
- 請指定型錄名稱或 ID。
- --name 名稱
- 指定物件的名稱。
- --crn CRN(可選)
- 提供雲端資源名稱 (CRN)。
- --endpoint-type類型(可選)
- 指定 VPE 端點類型。
- --fqdn FQDN(可選)
- 提供以逗號分隔的完整合格網域名稱清單。
- --region 區域(選擇性)
- 指定 VPE 端點的地區。
取得 ibmcloud 目錄物件
執行下列指令,以擷取特定物件的資訊。
ibmcloud catalog object get [--catalog CATALOG] [--name NAME] [--output OUTPUT]
指令選項
- --catalog目錄
- 請指定型錄名稱或 ID。
- --name 名稱
- 提供物件的名稱。
- --output輸出(可選)
- 指定輸出格式。 預設值是終端相容的,唯一支援的替代方案是 JSON。 例如:
--output json
ibmcloud 目錄物件清單
執行下列指令,以擷取型錄中的物件清單。
ibmcloud catalog object list [--catalog CATALOG] [--output OUTPUT]
指令選項
- --catalog目錄
- 請指定型錄名稱或 ID。
- --output輸出(可選)
- 指定輸出格式。 預設值是終端相容的,唯一支援的替代方案是 JSON。 例如:
--output json
ibmcloud catalog 物件搜尋
執行下列指令,以使用 Lucene 查詢語法來搜尋物件。
ibmcloud catalog object search [--query QUERY] [--output OUTPUT]
指令選項
- --query 查詢
- 提供 Lucene 查詢字串。
- --output輸出(可選)
- 指定輸出格式。 預設值是終端相容的,唯一支援的替代方案是 JSON。 例如:
--output json
ibmcloud 目錄物件就緒
執行下列指令,將您的物件標示為準備好共用或發佈。
ibmcloud catalog object ready [--catalog CATALOG] [--name NAME]
指令選項
- --catalog目錄
- 請指定型錄名稱或 ID。
- --name 名稱
- 指定物件的名稱。
ibmcloud 目錄物件發佈
執行下列指令,將物件發佈至存取清單、您的帳戶、IBM 員工或 IBM Cloud 型錄,以供所有使用者查看及使用。
ibmcloud catalog object publish COMMAND [--catalog CATALOG] [--name NAME]
指令選項
- 指令
- 指定要在何處發佈物件。 有效值為
accesslist、account、ibm或public。 - --catalog目錄
- 請指定型錄名稱或 ID。
- --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
- 提供以逗號分隔的帳戶 ID 清單。
- --catalog目錄
- 請指定型錄名稱或 ID。
- --name 名稱
- 指定物件的名稱。
取得 ibmcloud 目錄物件存取清單
執行下列指令,以擷取物件特定存取清單的資訊。
ibmcloud catalog object access-list get [--catalog CATALOG] [--name NAME] [--output OUTPUT]
指令選項
- --catalog目錄
- 請指定型錄名稱或 ID。
- --name 名稱
- 指定物件的名稱。
- --output輸出(可選)
- 指定輸出格式。 預設值是終端相容的,唯一支援的替代方案是 JSON。 例如:
--output json
ibmcloud 目錄物件存取清單 rm
執行下列指令,以從物件的存取清單中移除帳戶 ID。
ibmcloud catalog object access-list rm [--account-id ID] [--catalog CATALOG] [--name NAME]
指令選項
- --account-id ID
- 提供以逗號分隔的帳戶 ID 清單。
- --catalog目錄
- 請指定型錄名稱或 ID。
- --name 名稱
- 指定物件的名稱。