Catalogs 管理 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 目录帐户 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 VALUE
- 提供以逗号分隔的账户 ID 列表,前缀为以下之一。
-acct-
表示普通账户,-ent-
表示企业账户,-entgrp-
表示企业账户组。
ibmcloud 目录帐户 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 VALUE
- 提供以逗号分隔的账户 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 catalog account 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 值(可选)
- 提供企业或企业帐户组标识以查看或管理企业的请求。 将标识作为
-ent-
(针对企业) 和-entgrp
(针对帐户组) 的前缀。
ibmcloud 目录 account 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 VALUE
- Provide a comma-separated list of account IDs prefixed with one of the following.
-acct-
for regular accounts,-ent-
for enterprise accounts, and-entgrp-
for enterprise account groups. - --enterprise-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 描述(可选)
- 新目录的简短描述。
示例
使用描述 a catalog for development and testing purpsoses
创建名为 dev-catalog
的目录。
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 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 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 CATALOG(可选)
- 搜索由您的帐户发布的软件。 指定要搜索的目录名称或标识。
- --output FORMAT(可选)
- 指定输出格式。 缺省值为与终端兼容,唯一的备用选项为
json
和csv
。 - --kind KIND(可选)
- 该标记仅对搜索服务有效。 提供以逗号分隔的产品类型列表。
- - --region (可选)
- 该标记仅对搜索服务有效。 提供以逗号分隔的区域列表。 运行
ibmcloud cs regions
以返回有效列表。 - --price 价格(可选)
- 该标记仅对搜索服务有效。 请提供逗号分隔的定价类型列表。
- --tag TAG(可选)
- 该标记仅对搜索服务有效。 请提供逗号分隔的标签列表。
- --global (可选)
- 该标记仅对搜索服务有效。 用它在全球范围内开展业务。
- --sort-by 类型(可选)
- 该标记仅用于搜索服务,并用于对搜索结果进行排序。 可用选项包括
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 目录过滤器获取
运行以下命令以检索帐户或特定目录的过滤器详细信息。
ibmcloud catalog filter get --catalog CATALOG [--output FORMAT]
命令选项
- --catalog 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 CATALOG(可选)
- 指定目录名称或标识。 如果没有特别说明,则过滤器将在账户级别创建。
- --account-group 帐户组
- 账户组名称或ID。 此选项仅适用于企业账户。
- --hide-ibm-catalog (可选)
- 缺省情况下,该目录对此帐户中的所有用户可见。 通过设置此标记,您可以关闭 IBM Cloud可见性,并将产品添加到您的私人目录中,从而仅向您选择的用户提供产品。
- --include-all BOOLEAN(可选)
- 如果未提供标志,则默认为true。 有效值为
true
和false
。 如果设置为true,则默认情况下,过滤器将包含整个公共目录,而后续过滤器将被排除在外。 如果设置为false,则过滤器将排除整个公开目录,并包含后续标记。 有关更多信息,请参阅 管理目录设置。
--offering-format FORMAT(可选)
- --category 类别(可选)
- 提供最适合用户使用产品方式的类别。 目录中的产品根据通用解决方案、功能或用途进行分类。 您只能选择一个类别。 运行
ibmcloud catalog offering category-options
命令以查看所有选项。 缺省值为Developer tools
。 - --compliance 类型(可选)
- 提供要包含或排除的合规性类别的逗号分隔列表。 运行
ibmcloud catalog filter options
命令以查看所有选项。 - --deployment-target 目标(可选)
- 提供要包含或排除的部署目标的逗号分隔列表。 运行
ibmcloud catalog filter options
命令以查看所有选项。 - --exclude-list 列表(可选)
- 提供必须在已过滤的公共目录中排除的产品标识或名称的逗号分隔列表。
- --include-list 列表(可选)
- 提供必须包含在已过滤公共目录中的产品标识或名称的逗号分隔列表。
- 提供要包含或排除的产品格式的逗号分隔列表。 运行
ibmcloud catalog filter options
命令以查看所有选项。 - --pricing-plan 计划(选项)
- 提供要包含或排除的定价计划的逗号分隔列表。 运行
ibmcloud catalog filter options
命令以查看所有选项。 - --provider 提供者(可选)
- 提供要包含或排除的提供程序的逗号分隔列表。 运行
ibmcloud catalog filter options
命令以查看所有选项。 - --release RELEASE(可选)
- 提供要包含或排除的类别的逗号分隔列表。 运行
ibmcloud catalog filter options
命令以查看所有选项。 - - --type (可选)
- 提供要包含或排除的软件类型的逗号分隔列表。 运行
ibmcloud catalog filter options
命令以查看所有选项。
ibmcloud 目录过滤器删除
运行以下命令可删除已应用的滤镜。 除非指定目录,否则此过滤器默认为账户级别。 因此,过滤器将重置为包含公共目录中的所有产品。
ibmcloud catalog filter delete --catalog CATALOG
命令选项
- --catalog CATALOG
- 目录名称或ID。
- --account-group 帐户组
- 账户组名称或ID。 此选项仅适用于企业账户。
ibmcloud 目录过滤器产品
更新过滤器以包含或排除特定产品和任何适用的定价计划。 除非指定了目录或帐户组,否则此过滤器缺省为帐户级别。
ibmcloud catalog filter offering --offering PRODUCT-NAME
命令选项
- --catalog CATALOG
- 目录名称或ID。
- --account-group 帐户组
- 账户组名称或ID。 此选项仅适用于企业账户。
- --plans-list 计划列表
- 要包含或排除的计划标识或名称的逗号分隔列表。
- --offering 供品
- 产品名称或ID。
- --include
- 如果未提供标志,那么缺省值为 true。 有效值为
true
和false
。 如果设置为 true,那么提供的产品和计划对帐户中的用户可见。 如果设置为 false,那么产品和计划对帐户中的用户不可见。
ibmcloud 目录过滤器隐藏-ibm-public-catalog
默认情况下,账户中的所有用户都可以看到 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 目录过滤器选项
运行以下命令以检索每个过滤器类别的过滤器选项。
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]
命令选项
- --catalog CATALOG_NAME
- 目录名称或ID。
- --zipurl URL (可选)
- 指向产品压缩包URL。
- --target-version 版本
- 请指明产品版本。
- --include-config (可选)
- 如果提供了配置值,那么在添加产品时,将包含所有配置值并提供这些值。
- --token TOKEN(可选)
- 指定私人存储库的个人访问令牌。
- --vpc-body BODY(可选)
- 提供用于导入 VPC 的虚拟服务器映像的信息,包括名称,标签,安装种类,目标种类,版本,sha,标记和元数据。
VPC 的虚拟服务器映像示例 #1
将 VPC 的虚拟服务器映像作为产品导入到标识为 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 的虚拟服务器映像作为产品导入到标识为 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 目录产品列表
运行以下命令以获取有关专用目录中产品的详细信息。 此命令按专用目录,产品和版本提供过滤器。
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 目录产品搜索
运行以下命令以获取有关专用目录中产品的详细信息。 此命令按专用目录,产品和版本提供过滤器。
ibmcloud catalog offering search [--catalog CATALOG] [--offering OFFERING_NAME] [--version VERSION] [--output FORMAT]
命令选项
- --catalog 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 catalog offering get
运行以下命令以获取有关目录中特定产品的详细信息。
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的虚拟服务器镜像示例
将用于 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 目录产品更新
要更新私人目录中的产品,首先需要获取产品,然后才能更新。
运行 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 目录产品版本预安装
运行以下命令以运行特定产品的预安装脚本。
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
- 提供要在其中安装产品的集群的集群标识。
- - --namespace
- 提供要使用的名称空间。 您可以指定新的内容,并且会在预安装过程中自动创建该内容。
示例
对名称空间 test-namespace
中标识为 bn5ebho206o7fg45f2e0
的集群中版本定位器号为 b636d651-8489-4425-bd6a-f30af1603577.18aad484-c78b-4269-808b-52027621abd4
的产品运行预安装脚本。
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
- 提供运行预安装的集群的集群标识。
- - --namespace
- 提供用于预安装的名称空间。
- --output FORMAT(可选)
- 指定输出格式。 缺省值为与终端兼容,唯一受支持的替代方法是 JSON,例如,
--output json
。
ibmcloud catalog 产品版本验证
运行以下命令以验证专用目录中产品的新版本。 必须验证产品以确保它们按预期工作,然后才能将它们发布到帐户以供其他用户从专用目录创建实例。
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
- 提供要在其中安装产品的集群的集群标识。
- - --namespace
- 提供要使用的名称空间。 您可以指定新的内容,并且会在预安装过程中自动创建该内容。
- - --timeout
- 指定 Schematics 工作空间等待其安装的时间长度 (以秒计)。 缺省值为
180
。 - --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 版本(可选)
- 提供工作空间 Terraform 版本。
- --workspace-region REGION(可选)
- 提供工作空间区域。
- --workspace-rg-id ID(可选)
- 提供工作空间资源组标识。
- --schematics-destroy (可选)
- 提供此标志以在验证和安装后删除工作空间资源。
- --schematics-delete 值(可选)
- 提供此标志以在验证和安装后删除 Schematics 工作空间。
验证使用集群的产品示例
在名为 test-namespace
的名称空间内,使用标识为 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的虚拟服务器镜像示例
使用标识为 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 目录产品类别-选项
运行以下命令以检索类别选项列表。
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 供品
- 产品名称或ID。
- - --category
- 提供最适合用户使用产品方式的类别。 目录中的产品根据通用解决方案、功能或用途进行分类。 您只能选择一个类别。 运行
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 供品
- 产品名称或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 目录产品版本更新-声明
运行以下命令以更新版本的安全性和合规性声明。
ibmcloud catalog offering version update-claims [--claims CLAIMS] [--version-locator LOCATOR]
命令选项
- --claims 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 REGION
- 实例所在的区域。
- - --scan
- Security and Compliance Center 扫描的标识。
- --service-instance INSTANCE
- 提供 Security and Compliance Center 实例标识。
- --target-account-name 名称(可选)
- 请提供目标账户的名称。
- --target-api-key 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 扫描的标识。
- --version-locator 定位器
- 要获取产品的版本定位器,请运行
ibmcloud catalog offering list
命令并找到要使用的指定产品或版本。
ibmcloud catalog offering version get-扫描
运行以下命令以检索添加到您的版本的 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 REGION
- 提供实例的区域。
- --output 输出(可选)
- 指定输出格式。 默认为终端兼容,唯一支持的替代方案是 JSON。 例如,
--output json
。 - --profiles PROFILES
- 提供具有版本的概要文件名称的逗号分隔列表,例如
"IBM Cloud for Financial Services::1.2.0"
。 - --service-instance INSTANCE
- 提供 Security and Compliance Center 实例标识。
- --target-account-name 名称(可选)
- 请提供目标账户的名称。
- --target-api-key KEY(可选)
- 如果要使用备用帐户 (目标帐户) 对源帐户应用扫描,请提供 API 密钥。 有关更多信息,请参阅 设置目标帐户。
ibmcloud catalog offering get-scan-results
运行以下命令,生成您版本代码风险分析和Security and Compliance Center扫描结果的报告。 要生成完整报告,您必须运行代码风险分析仪和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-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 目录产品版本不推荐-版本
运行以下命令以从 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 目录产品版本合并-草稿
运行以下命令以合并产品的草稿版本。
ibmcloud catalog offering version merge-draft --version-locator VERSION_NUMBER
命令选项
- --version-locator VERSION_NUMBER
- 要获取产品的版本定位器,请运行
ibmcloud catalog offering list
命令并找到要使用的指定产品或版本。
ibmcloud 目录产品就绪
运行以下命令以将产品标记为可共享或发布。
ibmcloud catalog offering ready --version-locator VERSION_NUMBER
命令选项
- --version-locator VERSION_NUMBER
- 要获取产品的版本定位器,请运行
ibmcloud catalog offering list
命令并找到要使用的指定产品或版本。
ibmcloud 目录产品删除
运行以下命令以从专用目录中删除产品。 无法删除在 IBM Cloud 目录中发布的产品。 要废弃 IBM Cloud 目录中的已发布产品,请参阅 ibmcloud catalog offering deprecate-offering
。
ibmcloud catalog offering delete --catalog CATALOG --offering OFFERING
命令选项
- --catalog CATALOG
- 目录名称或ID。
- --offering 供品
- 产品名称或ID。
ibmcloud catalog 产品发布帐户
运行以下命令以将产品从专用目录发布到帐户。 产品发布后,账户中的用户可以访问专用目录。 其包含的资源组可以创建一个实例并开始使用。
ibmcloud catalog offering publish account [--catalog CATALOG][--offering OFFERING]
命令选项
- --catalog CATALOG
- 目录名称或ID。
- --offering 供品
- 产品名称或ID。
ibmcloud catalog offering publish allowlist
运行以下命令以将产品从专用目录发布到一组允许使用的帐户。 产品发布后,允许列表账户中的用户可以创建实例并开始使用。
ibmcloud catalog offering publish allowlist [--catalog CATALOG][--offering OFFERING][--account-ids ACCOUNT-IDS]
命令选项
- --catalog CATALOG
- 目录名称或ID。
- --offering 供品
- 产品名称或ID。
- --account-ids ACCOUNT-IDS
- 帐户标识。
ibmcloud 目录产品发布企业
运行以下命令以将产品发布到企业。 发布产品后,企业内的用户可以创建产品实例。
ibmcloud catalog offering publish enterprise [--catalog CATALOG][--offering OFFERING]
命令选项
- --catalog CATALOG
- 目录名称或ID。
- --offering 供品
- 产品名称或ID。
ibmcloud catalog offering suspend-offering
运行以下命令以从目录暂挂产品。 您可以在短时间内将其暂挂,而不永久删除或弃用该文件。 例如,如果您发现产品中存在必须在更多客户安装产品之前进行调查的错误或漏洞,那么暂挂产品可能会很有用。
ibmcloud catalog offering suspend-offering [--catalog CATALOG][--offering OFFERING]
命令选项
- --catalog CATALOG
- 目录名称或ID。
- --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 产品工作空间
运行以下命令以获取产品版本的 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 目录安装
运行以下命令以从 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
- 指定集群名称或标识。
- - --namespace
- 指定要使用的名称空间。
- --override-values 值
- 为安装提供任何定制配置。 您可以直接插入或使用 JSON 或 TXT 文件来提供此值。 例如,
override-values values.json
。 - - --timeout
- 指定 Schematics 工作空间在安装之前等待的时间长度 (以秒计)。 缺省值为
180
。 - --wait 等待
- 等待并跟踪 Schematics 工作空间作业的进度。 如果为
true
,那么安装将等待。 如果false
,那么软件将立即安装。 默认邮箱为true
。 - --workspace-name NAME(可选)
- 提供工作空间名称。 缺省值为
OfferingName-Date
。 - --workspace-tags 标签(可选)
- 请提供逗号分隔的标签列表。
- --workspace-tf-version 版本(可选)
- 提供工作空间 Terraform 版本。
- --workspace-region REGION(可选)
- 提供工作空间区域。
- --workspace-rg-id ID(可选)
- 提供工作空间资源组标识。
- --schematics-delete 值(可选)
- 提供此标志以在验证和安装后删除 Schematics 工作空间。
示例
使用群集 A
、命名空间 install
和覆盖值 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 目录定价
运行以下命令以获取目录产品的定价信息。
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 (可选)
- 按标记过滤。 此标志可重复,会生成所有指定标志的“逻辑或”结果。
- --co, --country (可选)
- 按国家或地区过滤。 输出为CSV或JSON时,可以使用
ALL
获取所有国家的数据。 - --json(可选)
- 输出 JSON 响应。
- --csv (可选)
- 输出 CSV 文件。
- - -f, --file )
- 为csv输出指定文件名。
- --global (可选)
- 在全局范围内运行。
- --iam (可选)
- 按 Iam 兼容产品进行过滤。
示例
获取现收现付帐户的 Virtual Server for VPC 的定价信息。
ibmcloud catalog pricing is.instance [--price paygo]
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 目录标签(可选)
- 提供要导入到的现有目录的标签或要创建的新目录的名称。 默认为“已迁移的 DA”。
- --offering-label 供品标签(可选)
- 提供要导入到其中的现有产品的标签或要创建的新产品的名称。 默认为 "Migrated <workspace_name>"。如果工作区是从目录产品中创建的,则标签会覆盖现有产品标签。
- --project-name 名称(可选)
- 提供一个与入库目录相关联的项目名称。 如果项目不存在,那就创建一个。 默认名称为“开发迁移项目”。
- --project-resource-group (可选)
- 为创建的项目提供一个资源组。 默认资源组为“默认”。
- --target-version 版本(可选)
- 提供已迁移产品的目标版本。 默认为"1.0.0"。
- --trusted-profile-id 或 --tpi 可信档案 ID
- 提供用于连接目录和项目的可信配置文件 ID。 '--api-key'”互斥。
- --variation-label 变量标签(可选)
- 为要加载的版本提供变体标签。 默认为“标准”。 如果工作空间是从目录产品创建的,那么该标签将覆盖现有版本标签。
- - --workspace-id
- 提供 Schematics 工作空间标识。 要获取工作空间标识,必须创建 Schematics 工作空间。 有关更多信息,请参阅
ibmcloud schematics workspace new
。
ibmcloud catalog 实用程序 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 catalog 实用程序 update-module-references
运行以下命令以检查工作目录的 Terraform 模块是否有来自目录的更新,并将源属性更新到最新版本。 还会更新 README.md。
ibmcloud catalog utility update-module-references
ibmcloud catalog offering unpublish 帐户
运行以下命令以从帐户取消发布产品。 取消发布产品后,帐户中的用户无法创建产品实例。
ibmcloud catalog offering unpublish account [--catalog CATALOG][--offering OFFERING]
命令选项
- --catalog CATALOG
- 目录名称或ID。
- --offering 供品
- 产品名称或ID。
ibmcloud 目录产品取消发布允许列表
运行以下命令以从产品的允许列表中除去帐户标识。 从允许列表中除去的帐户无法创建产品的实例。
ibmcloud catalog offering unpublish allowlist [--catalog CATALOG][--offering OFFERING][--account-ids ACCOUNT-IDS]
命令选项
- --catalog CATALOG
- 目录名称或ID。
- --offering 供品
- 产品名称或ID。
- --account-ids ACCOUNT-IDS
- 帐户标识。
ibmcloud 目录产品取消发布企业
运行以下命令以从企业取消发布产品。 取消发布产品后,企业无法创建产品的实例。
ibmcloud catalog offering unpublish enterprise [--catalog CATALOG][--offering OFFERING]
命令选项
- --catalog CATALOG
- 目录名称或ID。
- --offering 供品
- 产品名称或ID。
ibmcloud 目录产品取消发布 ibm
运行以下命令以从 IBM取消发布产品。 取消发布产品后,IBM 员工无法创建产品的实例。
ibmcloud catalog offering unpublish ibm [--catalog CATALOG][--offering OFFERING]
命令选项
- --catalog CATALOG
- 目录名称或ID。
- --offering 供品
- 产品名称或ID。
ibmcloud 目录产品发布 ibm
运行以下命令以将帐户中已可用的产品发布到所有 IBM人员。 发布过程的此部分在登台目录和生产目录中创建仅对 IBM人员可见的磁贴。 通过将产品发布到 IBM程序,您可以先在生产环境中测试该产品,然后再使其可供 IBM Cloud 目录中的所有用户使用。
ibmcloud catalog offering publish ibm [--catalog CATALOG][--offering OFFERING]
命令选项
- --catalog CATALOG
- 目录名称或ID。
- --offering 供品
- 产品名称或ID。
ibmcloud 目录产品发布公共
运行以下命令以将专用产品发布到 IBM Cloud 目录,供所有用户查看和使用。 要在发布过程中执行此步骤,必须首先将产品发布到您的帐户以及所有 IBM 员工,以完成测试过程。 测试完成后,可以运行此命令。
此选项需要核准。 审批完成后,所有 IBM Cloud 客户都可以使用您的磁贴。
ibmcloud catalog offering publish public [--catalog CATALOG][--offering OFFERING]
命令选项
- --catalog CATALOG
- 目录名称或ID。
- --offering 供品
- 产品名称或ID。
ibmcloud catalog offering 不推荐-offering
运行以下命令以废弃 IBM Cloud 目录中先前发布的产品版本。
ibmcloud catalog offering deprecate-offering [--catalog CATALOG][--offering OFFERING]
命令选项
- --catalog CATALOG
- 目录名称或ID。
- --offering 供品
- 产品名称或ID。
ibmcloud catalog offering restore-offering
运行以下命令以在 IBM Cloud 目录中复原先前不推荐使用的产品。 在验证产品版本之后,可以将其复原到不推荐使用之前处于已发布状态的状态。
ibmcloud catalog offering restore-offering [--catalog CATALOG][--offering OFFERING]
命令选项
- --catalog CATALOG
- 目录名称或ID。
- --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 供品
- 产品名称或ID。
- --include-config (可选)
- 如果提供了配置值,那么在添加产品时,将包含所有配置值并提供这些值。
ibmcloud catalog object create vpe
运行以下命令以将对象添加到帐户中的专用目录。
ibmcloud catalog object create vpe [--catalog CATALOG] [--crn CRN] [endpoint-type TYPE] [--fqdn FQDN] [--name NAME] [--region REGION]
命令选项
- --catalog CATALOG
- 指定目录名称或标识。
- --crn CRN
- 请提供云资源名称(CRN)。
- --endpoint-type 类型
- 指定 VPE 端点类型。
- - --fqdn
- 请提供以逗号分隔的完整域名列表。
- - --name
- 请指定对象名称。
- - --region
- 指定 VPE 端点的区域。
ibmcloud 目录对象删除
运行以下命令删除对象。
ibmcloud catalog object delete [--catalog CATALOG] [--name NAME]
命令选项
- --catalog CATALOG
- 指定目录名称或标识。
- - --name
- 请提供物品名称。
ibmcloud 目录对象更新 vpe
运行以下命令更新对象。
ibmcloud catalog object update vpe [--catalog CATALOG] [--name NAME] [--crn CRN] [--endpoint-type TYPE] [--fqdn FQDN] [--region REGION]
命令选项
- --catalog CATALOG
- 指定目录名称或标识。
- - --name
- 请指定对象名称。
- --crn CRN(可选)
- 请提供云资源名称(CRN)。
- --endpoint-type 类型(可选)
- 指定 VPE 端点类型。
- --fqdn FQDN(可选)
- 请提供以逗号分隔的完整域名列表。
- - --region (可选)
- 指定 VPE 端点的区域。
ibmcloud catalog 对象获取
运行以下命令以检索特定对象的信息。
ibmcloud catalog object get [--catalog CATALOG] [--name NAME] [--output OUTPUT]
命令选项
- --catalog CATALOG
- 指定目录名称或标识。
- - --name
- 请提供物品名称。
- --output 输出(可选)
- 指定输出格式。 默认为终端兼容,唯一支持的替代方案是 JSON。 例如,
--output json
ibmcloud 目录对象列表
运行以下命令以检索目录中的对象列表。
ibmcloud catalog object list [--catalog CATALOG] [--output OUTPUT]
命令选项
- --catalog CATALOG
- 指定目录名称或标识。
- --output 输出(可选)
- 指定输出格式。 默认为终端兼容,唯一支持的替代方案是 JSON。 例如,
--output json
ibmcloud 目录对象搜索
运行以下命令以使用 Lucene 查询语法来搜索对象。
ibmcloud catalog object search [--query QUERY] [--output OUTPUT]
命令选项
- --query
: 提供 Lucene 查询字符串。
- --output 输出(可选)
- 指定输出格式。 默认为终端兼容,唯一支持的替代方案是 JSON。 例如,
--output json
ibmcloud catalog 对象就绪
运行以下命令以将对象标记为已准备好共享或发布。
ibmcloud catalog object ready [--catalog CATALOG] [--name NAME]
命令选项
- --catalog CATALOG
- 指定目录名称或标识。
- - --name
- 请指定对象名称。
ibmcloud 目录对象发布
运行以下命令以将对象发布到访问列表,帐户 IBM 员工或 IBM Cloud 目录以供所有用户查看和使用。
ibmcloud catalog object publish COMMAND [--catalog CATALOG] [--name NAME]
命令选项
- 命令
- 指定您要发布对象的位置。 有效值为
accesslist
,account
,ibm
或public
。 - --catalog CATALOG
- 指定目录名称或标识。
- - --name
- 请提供物品名称。
示例
将目录 dev-catalog
中名为 dev-object
的对象发布到 IBM 员工。
ibmcloud catalog object publish ibm --catalog dev-catalog --name dev-object
ibmcloud catalog object access-list add
运行以下命令以将帐户标识添加到对象的访问列表。
ibmcloud catalog object access-list add [--account-id ID] [--catalog CATALOG] [--name NAME]
命令选项
- --account-id ID
- 请提供以逗号分隔的账户ID列表。
- --catalog CATALOG
- 指定目录名称或标识。
- - --name
- 请指定对象名称。
ibmcloud 目录对象访问-list get
运行以下命令以检索对象的特定访问列表的信息。
ibmcloud catalog object access-list get [--catalog CATALOG] [--name NAME] [--output OUTPUT]
命令选项
- --catalog CATALOG
- 指定目录名称或标识。
- - --name
- 请指定对象名称。
- --output 输出(可选)
- 指定输出格式。 默认为终端兼容,唯一支持的替代方案是 JSON。 例如,
--output json
ibmcloud catalog object access-list rm
运行以下命令以从对象的访问列表中除去帐户标识。
ibmcloud catalog object access-list rm [--account-id ID] [--catalog CATALOG] [--name NAME]
命令选项
- --account-id ID
- 请提供以逗号分隔的账户ID列表。
- --catalog CATALOG
- 指定目录名称或标识。
- - --name
- 请指定对象名称。