Satellite 命令的 CLI 参考
要自动创建和管理 Satellite 位置时,请参阅这些命令。
ibmcloud sat 命令
下表列出了 ibmcloud sat
命令组。 要获取在 CLI 中构造的所有 ibmcloud sat
命令的完整列表,请参阅 CLI 映射。
ibmcloud sat acl create
创建 ACL。
ibmcloud sat acl create --name NAME --subnet SUBNET [--subnet SUBNET ...] [--endpoint ENDPOINT ...] [-q] (--connector-id ID | --location LOCATION)
命令选项
--connector-id ID
- Satellite 连接器的 ID。 要查找连接器标识,请运行
ibmcloud sat connector ls
。 --endpoint ENDPOINT
- 要为该 ACL 启用的端点的名称或 ID。
--location LOCATION
- Satellite 位置的名称或标识。 要查找位置 ID 或名称,请运行
ibmcloud sat location ls
。 --name NAME
- ACL 的名称。
-q
- 不显示每日消息或更新提示。
--subnet SUBNET
- 此 ACL 允许的 IP 或 CIDR 块。 值必须完全包含在以下 CIDR 中:10.0.0.0/8, 161.26.0.0/16, 166.8.0.0/14, 172.16.0.0/12.
ibmcloud sat acl endpoint add
将一个或多个启用的端点添加到 ACL。
ibmcloud sat acl endpoint add --acl-id ID --endpoint ENDPOINT [--endpoint ENDPOINT ...] [-q] (--connector-id ID | --location LOCATION)
命令选项
--acl-id ID
- 指定 ACL 的 ID。 要列出所有 ACL,请运行
ibmcloud sat acl ls
。 --connector-id ID
- Satellite 连接器的 ID。 要查找连接器标识,请运行
ibmcloud sat connector ls
。 --endpoint ENDPOINT
- 要为该 ACL 启用的端点的名称或 ID。
--location LOCATION
- Satellite 位置的名称或标识。 要查找位置 ID 或名称,请运行
ibmcloud sat location ls
。 -q
- 不显示每日消息或更新提示。
ibmcloud sat acl endpoint ls
列出 ACL 的所有启用端点。
ibmcloud sat acl endpoint ls --acl-id ID [--output OUTPUT] [-q] (--connector-id ID | --location LOCATION)
命令选项
--acl-id ID
- 指定 ACL 的 ID。 要列出所有 ACL,请运行
ibmcloud sat acl ls
。 --connector-id ID
- Satellite 连接器的 ID。 要查找连接器标识,请运行
ibmcloud sat connector ls
。 --location LOCATION
- Satellite 位置的名称或标识。 要查找位置 ID 或名称,请运行
ibmcloud sat location ls
。 --output OUTPUT
- 以提供的格式打印命令输出。 接受的值:
json
-q
- 不显示每日消息或更新提示。
ibmcloud sat acl endpoint rm
从 ACL 中删除一个或多个启用的端点。
ibmcloud sat acl endpoint rm --acl-id ID --endpoint ENDPOINT [--endpoint ENDPOINT ...] [-q] (--connector-id ID | --location LOCATION)
命令选项
--acl-id ID
- 指定 ACL 的 ID。 要列出所有 ACL,请运行
ibmcloud sat acl ls
。 --connector-id ID
- Satellite 连接器的 ID。 要查找连接器标识,请运行
ibmcloud sat connector ls
。 --endpoint ENDPOINT
- 要禁用此 ACL 的端点名称或 ID。
--location LOCATION
- Satellite 位置的名称或标识。 要查找位置 ID 或名称,请运行
ibmcloud sat location ls
。 -q
- 不显示每日消息或更新提示。
ibmcloud sat acl get
查看 ACL 的详细信息。
ibmcloud sat acl get --acl-id ID [--output OUTPUT] [-q] (--connector-id ID | --location LOCATION)
命令选项
--acl-id ID
- 指定 ACL 的 ID。 要列出所有 ACL,请运行
ibmcloud sat acl ls
。 --connector-id ID
- Satellite 连接器的 ID。 要查找连接器标识,请运行
ibmcloud sat connector ls
。 --location LOCATION
- Satellite 位置的名称或标识。 要查找位置 ID 或名称,请运行
ibmcloud sat location ls
。 --output OUTPUT
- 以提供的格式打印命令输出。 接受的值:
json
-q
- 不显示每日消息或更新提示。
ibmcloud sat acl ls
列出 Satellite 连接器或位置的所有 ACL。
ibmcloud sat acl ls [--output OUTPUT] [-q] (--connector-id ID | --location LOCATION)
命令选项
--connector-id ID
- Satellite 连接器的 ID。 要查找连接器标识,请运行
ibmcloud sat connector ls
。 --location LOCATION
- Satellite 位置的名称或标识。 要查找位置 ID 或名称,请运行
ibmcloud sat location ls
。 --output OUTPUT
- 以提供的格式打印命令输出。 接受的值:
json
-q
- 不显示每日消息或更新提示。
ibmcloud sat acl rm
删除 ACL。
ibmcloud sat acl rm --acl-id ID [-q] (--connector-id ID | --location LOCATION)
命令选项
--acl-id ID
- 指定 ACL 的 ID。 要列出所有 ACL,请运行
ibmcloud sat acl ls
。 --connector-id ID
- Satellite 连接器的 ID。 要查找连接器标识,请运行
ibmcloud sat connector ls
。 --location LOCATION
- Satellite 位置的名称或标识。 要查找位置 ID 或名称,请运行
ibmcloud sat location ls
。 -q
- 不显示每日消息或更新提示。
ibmcloud sat acl subnet add
在 ACL 中添加一个或多个子网。
ibmcloud sat acl subnet add --acl-id ID --subnet SUBNET [--subnet SUBNET ...] [-q] (--connector-id ID | --location LOCATION)
命令选项
--acl-id ID
- 指定 ACL 的 ID。 要列出所有 ACL,请运行
ibmcloud sat acl ls
。 --connector-id ID
- Satellite 连接器的 ID。 要查找连接器标识,请运行
ibmcloud sat connector ls
。 --location LOCATION
- Satellite 位置的名称或标识。 要查找位置 ID 或名称,请运行
ibmcloud sat location ls
。 -q
- 不显示每日消息或更新提示。
--subnet SUBNET
- 此 ACL 允许的 IP 或 CIDR 块。 值必须完全包含在以下 CIDR 中:10.0.0.0/8, 161.26.0.0/16, 166.8.0.0/14, 172.16.0.0/12.
ibmcloud sat acl subnet rm
从 ACL 中删除一个或多个子网。
ibmcloud sat acl subnet rm --acl-id ID --subnet SUBNET [--subnet SUBNET ...] [-q] (--connector-id ID | --location LOCATION)
命令选项
--acl-id ID
- 指定 ACL 的 ID。 要列出所有 ACL,请运行
ibmcloud sat acl ls
。 --connector-id ID
- Satellite 连接器的 ID。 要查找连接器标识,请运行
ibmcloud sat connector ls
。 --location LOCATION
- Satellite 位置的名称或标识。 要查找位置 ID 或名称,请运行
ibmcloud sat location ls
。 -q
- 不显示每日消息或更新提示。
--subnet SUBNET
- 此 ACL 允许的 IP 或 CIDR 块。 值必须完全包含在以下 CIDR 中:10.0.0.0/8, 161.26.0.0/16, 166.8.0.0/14, 172.16.0.0/12.
ibmcloud sat acl update
更新 ACL 名称。
ibmcloud sat acl update --acl-id ID --name NAME [-q] (--connector-id ID | --location LOCATION)
命令选项
--acl-id ID
- 指定 ACL 的 ID。 要列出所有 ACL,请运行
ibmcloud sat acl ls
。 --connector-id ID
- Satellite 连接器的 ID。 要查找连接器标识,请运行
ibmcloud sat connector ls
。 --location LOCATION
- Satellite 位置的名称或标识。 要查找位置 ID 或名称,请运行
ibmcloud sat location ls
。 --name NAME
- ACL 的新名称。
-q
- 不显示每日消息或更新提示。
ibmcloud sat agent attach
获取特定平台的 Satellite 连接器代理。 下载适用于 Windows 的 Agent .zip
或获取适用于 Docker 环境的文档链接。
ibmcloud sat agent attach --platform PLATFORM [-q]
命令选项
--platform PLATFORM
- Satellite连接器代理的平台。 有关 Docker 的更多信息,请参阅 https://ibm.biz/satconagent 文档 可用选项:WINDOWS、Docker
-q
- 不显示每日消息或更新提示。
ibmcloud sat agent ls
列出Satellite连接器的所有代理。
ibmcloud sat agent ls --connector-id ID [--output OUTPUT] [-q]
命令选项
--connector-id ID
- Satellite 连接器的标识。
--output OUTPUT
- 以提供的格式打印命令输出。 接受的值:
json
-q
- 不显示每日消息或更新提示。
ibmcloud sat cluster get
获取已注册集群的详细信息。
ibmcloud sat cluster get --cluster CLUSTER [--output OUTPUT] [-q]
命令选项
--cluster CLUSTER
,-c CLUSTER
- 指定集群名称或标识。 要列出已注册的群集,请运行
ibmcloud sat cluster ls
。 --output OUTPUT
- 以提供的格式打印命令输出。 接受的值:
json
-q
- 不显示每日消息或更新提示。
ibmcloud sat cluster ls
列出 IBM Cloud 帐户中的所有已注册集群。
ibmcloud sat cluster ls [--filter FILTER] [--limit LIMIT] [--output OUTPUT] [-q]
命令选项
--filter FILTER
- 按集群标识过滤已注册的集群。
--limit LIMIT
- 限制返回的集群数量。
--output OUTPUT
- 以提供的格式打印命令输出。 接受的值:
json
-q
- 不显示每日消息或更新提示。
ibmcloud sat cluster register
获取 kubectl
命令,在 Satellite 配置中注册集群。 登录到集群并运行此命令以安装 Satellite 配置代理程序。 在 Satellite 位置中运行的集群会自动安装此代理程序。
ibmcloud sat cluster register --name NAME [-q] [--silent]
命令选项
--name NAME
- 指定要注册的集群的名称
-q
- 不显示每日消息或更新提示。
--silent
- 静默。 仅在输出中返回注册命令。
ibmcloud sat cluster unregister
除去集群注册。 集群不再预订 Satellite 配置,但集群及其现有资源仍在运行。
ibmcloud sat cluster unregister --cluster CLUSTER [-f] [-q]
命令选项
--cluster CLUSTER
,-c CLUSTER
- 指定集群名称或标识。 要列出已注册的群集,请运行
ibmcloud sat cluster ls
。 -f
- 强制此命令运行,而不显示用户提示。
-q
- 不显示每日消息或更新提示。
ibmcloud sat config create
创建配置以指定要部署到 Satellite 工作负载中的集群的 Kubernetes 资源。
ibmcloud sat config create --name NAME [-q] (--data-location LOCATION | --provider PROVIDER)
命令选项
--data-location LOCATION
- 指定用于存储 Satellite 配置数据的 IBM 区域。 策略:直接上载。
--name NAME
- 提供 Satellite 配置的名称。
--provider PROVIDER
- 指示 Satellite 配置的远程 GitOps 提供程序。 此提供程序将存储 Kubernetes 资源定义。 策略:GitOps。 允许的值 :github 和 gitlab
-q
- 不显示每日消息或更新提示。
ibmcloud sat config get
获取 Satellite 配置的详细信息,例如与该配置关联的版本或预订。
ibmcloud sat config get --config CONFIG [--output OUTPUT] [-q]
命令选项
--config CONFIG
- 指定 Satellite 配置的名称或标识。 要列出可用配置,请运行
ibmcloud sat config ls
。 --output OUTPUT
- 以提供的格式打印命令输出。 接受的值:
json
-q
- 不显示每日消息或更新提示。
ibmcloud sat config ls
列出 IBM Cloud 帐户中的所有 Satellite 配置。
ibmcloud sat config ls [--output OUTPUT] [-q]
命令选项
--output OUTPUT
- 以提供的格式打印命令输出。 接受的值:
json
-q
- 不显示每日消息或更新提示。
ibmcloud sat config rename
重命名 Satellite 配置。
ibmcloud sat config rename --config CONFIG --name NAME [-q]
命令选项
--config CONFIG
- 指定 Satellite 配置的名称或标识。 要列出可用配置,请运行
ibmcloud sat config ls
。 --name NAME
- 为 Satellite 配置提供新名称。
-q
- 不显示每日消息或更新提示。
ibmcloud sat config rm
移除 Satellite 配置。 必须首先除去所有关联的预订。 将删除所有版本。 备份要保留的任何资源定义。
ibmcloud sat config rm --config CONFIG [-f] [-q]
命令选项
--config CONFIG
- 指定 Satellite 配置的名称或标识。 要列出可用配置,请运行
ibmcloud sat config ls
。 -f
- 强制此命令运行,而不显示用户提示。
-q
- 不显示每日消息或更新提示。
ibmcloud sat config version create
创建配置版本,以根据 Satellite 工作负载更新现有 Kubernetes 资源。
ibmcloud sat config version create --config CONFIG --file-format FORMAT --name NAME --read-config CONFIG [--description DESCRIPTION] [-q]
命令选项
--config CONFIG
- 指定 Satellite 配置的名称或标识。 要列出可用配置,请运行
ibmcloud sat config ls
。 --description DESCRIPTION
- 添加 Satellite 配置版本的描述。
--file-format FORMAT
- 指示配置版本的文件格式。 可用选项 :yaml
--name NAME
- 提供 Satellite 配置版本的名称。
-q
- 不显示每日消息或更新提示。
--read-config CONFIG
- 指定配置版本文件的文件路径。
ibmcloud sat config version get
获取 Satellite 配置版本的详细信息。
ibmcloud sat config version get --config CONFIG --version VERSION [--output OUTPUT] [-q] [--save-config]
命令选项
--config CONFIG
- 指定 Satellite 配置的名称或标识。 要列出可用配置,请运行
ibmcloud sat config ls
。 --output OUTPUT
- 以提供的格式打印命令输出。 接受的值:
json
-q
- 不显示每日消息或更新提示。
--save-config
- 下载配置版本并将其保存到临时文件。
--version VERSION
- 指定 Satellite 配置版本的名称或标识。 要列出配置中的版本,请运行
ibmcloud sat config get --config <configuration_name_or_ID>
。
ibmcloud sat config version rm
移除 Satellite 配置版本。
ibmcloud sat config version rm --config CONFIG --version VERSION [-f] [-q]
命令选项
--config CONFIG
- 指定 Satellite 配置的名称或标识。 要列出可用配置,请运行
ibmcloud sat config ls
。 -f
- 强制此命令运行,而不显示用户提示。
-q
- 不显示每日消息或更新提示。
--version VERSION
- 指示 Satellite 配置版本的名称或标识。 要列出版本,请运行
ibmcloud sat config get --config <configuration_name_or_ID>
。
ibmcloud sat connector create
创建 Satellite 连接器。
ibmcloud sat connector create --name NAME --region REGION [-q]
命令选项
--name NAME
- Satellite 连接器的名称。
-q
- 不显示每日消息或更新提示。
--region REGION
- 用于管理 Satellite 连接器的 IBM Cloud 区域。
ibmcloud sat connector get
查看 Satellite 连接器的详细信息。
ibmcloud sat connector get --connector-id ID [--output OUTPUT] [-q]
命令选项
--connector-id ID
- Satellite 连接器的标识。
--output OUTPUT
- 以提供的格式打印命令输出。 接受的值:
json
-q
- 不显示每日消息或更新提示。
ibmcloud sat connector ls
在 IBM Cloud 账户中查看 Satellite 连接器。
ibmcloud sat connector ls [--after AFTER] [--first FIRST] [--output OUTPUT] [-q]
命令选项
--after AFTER
- 显示指定光标后的Satellite连接器。
--first FIRST
- 查看下一个Satellite连接器,直至第一个连接器的数量。
--output OUTPUT
- 以提供的格式打印命令输出。 接受的值:
json
-q
- 不显示每日消息或更新提示。
ibmcloud sat connector rm
删除 Satellite 连接器。
ibmcloud sat connector rm --connector-id ID [-f] [-q]
命令选项
--connector-id ID
- Satellite 连接器的标识。
-f
- 强制此命令运行,而不显示用户提示。
-q
- 不显示每日消息或更新提示。
ibmcloud sat endpoint authn get
获取端点的身份验证设置。
ibmcloud sat endpoint authn get --endpoint ENDPOINT [--output OUTPUT] [-q] (--connector-id ID | --location LOCATION)
命令选项
--connector-id ID
- Satellite 连接器的 ID。 要查找连接器标识,请运行
ibmcloud sat connector ls
。 --endpoint ENDPOINT
- 指定端点的名称或标识。 要列出所有端点,请运行
ibmcloud sat endpoint ls
。 --location LOCATION
- Satellite 位置的名称或标识。 要查找位置 ID 或名称,请运行
ibmcloud sat location ls
。 --output OUTPUT
- 以提供的格式打印命令输出。 接受的值:
json
-q
- 不显示每日消息或更新提示。
ibmcloud sat endpoint authn rotate
用新证书替换现有的验证证书。 请求流中有两个 TLS 连接。 source
选项指的是源和连接器服务之间的 TLS 握手。 destination
选项指的是 Connector 服务与目的地或目标服务器之间的 TLS 握手。 您可以为其中一个或两个连接提供证书。 只有您指定的证书才会被替换。
ibmcloud sat endpoint authn rotate --endpoint ENDPOINT [--dest-ca-cert-file FILE] [--dest-cert-file FILE] [--dest-key-file FILE] [-q] [--source-ca-cert-file FILE] [--source-cert-file FILE] [--source-key-file FILE] (--connector-id ID | --location LOCATION)
命令选项
--connector-id ID
- Satellite 连接器的 ID。 要查找连接器标识,请运行
ibmcloud sat connector ls
。 --dest-ca-cert-file FILE
- 用于验证目标服务器证书的可信 CA 证书或链。 例如,
myCA.pem
。 --dest-cert-file FILE
- 用于与目标服务器进行身份验证的客户端证书。 例如,
myCert.pem
。 --dest-key-file FILE
- 用于加密客户机证书的客户机专用密钥。 例如,
myKey.pem
。 --endpoint ENDPOINT
- 指定端点的名称或标识。 要列出所有端点,请运行
ibmcloud sat endpoint ls
。 --location LOCATION
- Satellite 位置的名称或标识。 要查找位置 ID 或名称,请运行
ibmcloud sat location ls
。 -q
- 不显示每日消息或更新提示。
--source-ca-cert-file FILE
- 当 source-tls-mode 是相互的时,用于验证源客户机证书的可信 CA 证书或链。 例如,
myCA.pem
。 --source-cert-file FILE
- 要向源客户机提供的服务器证书。 例如,
myCert.pem
。 --source-key-file FILE
- 用于加密服务器证书的服务器专用密钥。 例如,
myKey.pem
。
ibmcloud sat endpoint authn set
为端点设置身份验证设置。 请求流中有两个 TLS 连接。 source
选项指的是源和连接器服务之间的 TLS 握手。 destination
选项指的是 Connector 服务与目的地或目标服务器之间的 TLS 握手。 您可以为其中一个或两个连接提供证书。 未指定的设置将设置为其缺省值。
ibmcloud sat endpoint authn set --endpoint ENDPOINT [--dest-ca-cert-file FILE] [--dest-cert-file FILE] [--dest-key-file FILE] [--dest-tls-mode MODE] [-q] [--source-ca-cert-file FILE] [--source-cert-file FILE] [--source-key-file FILE] [--source-tls-mode MODE] (--connector-id ID | --location LOCATION)
命令选项
--connector-id ID
- Satellite 连接器的 ID。 要查找连接器标识,请运行
ibmcloud sat connector ls
。 --dest-ca-cert-file FILE
- 用于验证目标服务器证书的可信 CA 证书或链。 例如,
myCA.pem
。 --dest-cert-file FILE
- 用于与目标服务器进行身份验证的客户端证书。 例如,
myCert.pem
。 --dest-key-file FILE
- 用于加密客户机证书的客户机专用密钥。 例如,
myKey.pem
。 --dest-tls-mode MODE
- 目标 TLS 方式。 接受值:
simple
,mutual
,none
--endpoint ENDPOINT
- 指定端点的名称或标识。 要列出所有端点,请运行
ibmcloud sat endpoint ls
。 --location LOCATION
- Satellite 位置的名称或标识。 要查找位置 ID 或名称,请运行
ibmcloud sat location ls
。 -q
- 不显示每日消息或更新提示。
--source-ca-cert-file FILE
- 当 source-tls-mode 是相互的时,用于验证源客户机证书的可信 CA 证书或链。 例如,
myCA.pem
。 --source-cert-file FILE
- 要向源客户机提供的服务器证书。 例如,
myCert.pem
。 --source-key-file FILE
- 用于加密服务器证书的服务器专用密钥。 例如,
myKey.pem
。 --source-tls-mode MODE
- 源 TLS 方式。 接受的值:
simple
,mutual
ibmcloud sat endpoint create
创建端点。
ibmcloud sat endpoint create --dest-hostname HOSTNAME --dest-port PORT --dest-type TYPE --name NAME --source-protocol PROTOCOL [--dest-protocol PROTOCOL] [--idle-timeout-seconds SECONDS] [--output OUTPUT] [-q] [--sni SNI] (--connector-id ID | --location LOCATION)
命令选项
--connector-id ID
- Satellite 连接器的 ID。 要查找连接器标识,请运行
ibmcloud sat connector ls
。 --dest-hostname HOSTNAME
- 指示要连接到的目标的标准域名 (FQDN) 或外部可访问的 IP 地址。 对于
cloud
端点,该值必须解析为公共 IP 地址或可在 IBM Cloud (如私有云服务端点)内访问的私有 IP 地址。 对于location
端点,该值必须从 Satellite 位置的控制平面主机或 Satellite Connector 的代理运行所在位置解析,并且可以从控制平面主机到达。 --dest-port PORT
- 提供目标资源侦听入局请求的端口。 确保端口与目标协议匹配。
--dest-protocol PROTOCOL
- 指定目标的协议。 如果未指定此选项,那么将从源协议继承目标协议。 接受的值:
TCP
,TLS
--dest-type TYPE
- 指定目标资源的运行位置,可以是 IBM Cloud (
cloud
) 或您的 Satellite 位置 (location
)。可用选项:位置、云 --idle-timeout-seconds SECONDS
- 指定与目标的活动连接的超时时间间隔 (以秒计)。 确保超时与目标服务和协议
keep-alive
设置兼容。 --location LOCATION
- Satellite 位置的名称或标识。 要查找位置 ID 或名称,请运行
ibmcloud sat location ls
。 --name NAME
- 提供端点的名称。
--output OUTPUT
- 以提供的格式打印命令输出。 接受的值:
json
-q
- 不显示每日消息或更新提示。
--sni SNI
- 如果指定了
tls
或https
源协议,并希望在 TLS 握手时添加单独的主机名,请指定服务器名称指示符。 --source-protocol PROTOCOL
- 提供源用于连接目标资源的协议。 请参阅 http://ibm.biz/endpoint-protocols。 可用选项:TCP、TLS、HTTP、HTTPS、HTTP-隧道
ibmcloud sat endpoint disable
禁用端点。
ibmcloud sat endpoint disable --endpoint ENDPOINT [-f] [-q] (--connector-id ID | --location LOCATION)
命令选项
--connector-id ID
- Satellite 连接器的 ID。 要查找连接器标识,请运行
ibmcloud sat connector ls
。 --endpoint ENDPOINT
- 指定端点的名称或标识。 要列出所有端点,请运行
ibmcloud sat endpoint ls (--connector-id ID | --location LOCATION)
。 -f
- 强制此命令运行,而不显示用户提示。
--location LOCATION
- Satellite 位置的名称或标识。 要查找位置 ID 或名称,请运行
ibmcloud sat location ls
。 -q
- 不显示每日消息或更新提示。
ibmcloud sat endpoint enable
启用端点。
ibmcloud sat endpoint enable --endpoint ENDPOINT [-f] [-q] (--connector-id ID | --location LOCATION)
命令选项
--connector-id ID
- Satellite 连接器的 ID。 要查找连接器标识,请运行
ibmcloud sat connector ls
。 --endpoint ENDPOINT
- 指定端点的名称或标识。 要列出所有端点,请运行
ibmcloud sat endpoint ls (--connector-id ID | --location LOCATION)
。 -f
- 强制此命令运行,而不显示用户提示。
--location LOCATION
- Satellite 位置的名称或标识。 要查找位置 ID 或名称,请运行
ibmcloud sat location ls
。 -q
- 不显示每日消息或更新提示。
ibmcloud sat endpoint get
查看端点的详细信息。
ibmcloud sat endpoint get --endpoint ENDPOINT [--output OUTPUT] [-q] (--connector-id ID | --location LOCATION)
命令选项
--connector-id ID
- Satellite 连接器的 ID。 要查找连接器标识,请运行
ibmcloud sat connector ls
。 --endpoint ENDPOINT
- 指定端点的名称或标识。 要列出所有端点,请运行
ibmcloud sat endpoint ls (--connector-id ID | --location LOCATION)
。 --location LOCATION
- Satellite 位置的名称或标识。 要查找位置 ID 或名称,请运行
ibmcloud sat location ls
。 --output OUTPUT
- 以提供的格式打印命令输出。 接受的值:
json
-q
- 不显示每日消息或更新提示。
ibmcloud sat endpoint ls
列出 Satellite 位置中的所有端点。
ibmcloud sat endpoint ls [--output OUTPUT] [-q] (--connector-id ID | --location LOCATION)
命令选项
--connector-id ID
- Satellite 连接器的 ID。 要查找连接器标识,请运行
ibmcloud sat connector ls
。 --location LOCATION
- Satellite 位置的名称或标识。 要查找位置 ID 或名称,请运行
ibmcloud sat location ls
。 --output OUTPUT
- 以提供的格式打印命令输出。 接受的值:
json
-q
- 不显示每日消息或更新提示。
ibmcloud sat endpoint rm
删除端点。
ibmcloud sat endpoint rm --endpoint ENDPOINT [-q] (--connector-id ID | --location LOCATION)
命令选项
--connector-id ID
- Satellite 连接器的 ID。 要查找连接器标识,请运行
ibmcloud sat connector ls
。 --endpoint ENDPOINT
- 指定端点的名称或标识。 要列出所有端点,请运行
ibmcloud sat endpoint ls (--connector-id ID | --location LOCATION)
。 --location LOCATION
- Satellite 位置的名称或标识。 要查找位置 ID 或名称,请运行
ibmcloud sat location ls
。 -q
- 不显示每日消息或更新提示。
ibmcloud sat endpoint update
更新端点。 仅更新指定的选项。
ibmcloud sat endpoint update --endpoint ENDPOINT [--dest-hostname HOSTNAME] [--dest-port PORT] [--dest-protocol PROTOCOL] [--idle-timeout-seconds SECONDS] [--name NAME] [-q] [--sni SNI] [--source-protocol PROTOCOL] (--connector-id ID | --location LOCATION)
命令选项
--connector-id ID
- Satellite 连接器的 ID。 要查找连接器标识,请运行
ibmcloud sat connector ls
。 --dest-hostname HOSTNAME
- 指示要连接到的目标的标准域名 (FQDN) 或外部可访问的 IP 地址。 对于
cloud
端点,该值必须解析为公共 IP 地址或可在 IBM Cloud (如私有云服务端点)内访问的私有 IP 地址。 对于location
端点,该值必须从 Satellite 位置的控制平面主机或 Satellite Connector 的代理运行所在位置解析,并且可以从控制平面主机到达。 --dest-port PORT
- 提供目标资源侦听入局请求的端口。 确保端口与目标协议匹配。
--dest-protocol PROTOCOL
- 指定目标的协议。 如果未指定此选项,那么将从源协议继承目标协议。 接受的值:
TCP
,TLS
--endpoint ENDPOINT
- 指定端点的名称或标识。 要列出所有端点,请运行
ibmcloud sat endpoint ls (--connector-id ID | --location LOCATION)
。 --idle-timeout-seconds SECONDS
- 指定与目标的活动连接的超时时间间隔 (以秒计)。 确保超时与目标服务和协议
keep-alive
设置兼容。 --location LOCATION
- Satellite 位置的名称或标识。 要查找位置 ID 或名称,请运行
ibmcloud sat location ls
。 --name NAME
- 为端点提供新名称。
-q
- 不显示每日消息或更新提示。
--sni SNI
- 如果指定了
tls
或https
源协议,并希望在 TLS 握手时添加单独的主机名,请指定服务器名称指示符。 --source-protocol PROTOCOL
- 提供源用于连接目标资源的协议。 请参阅 http://ibm.biz/endpoint-protocols。 接受的值:
TCP
,TLS
,HTTP
,HTTPS
和HTTP-tunnel
ibmcloud sat experimental acl create
[已于 2024-10-01 关闭! 使用 ibmcloud sat acl create
代替] 创建 ACL。
ibmcloud sat experimental acl create --name NAME --subnet SUBNET [--subnet SUBNET ...] [--endpoint ENDPOINT ...] [-q] (--connector-id ID | --location LOCATION)
命令选项
--connector-id ID
- Satellite 连接器的 ID。 要查找连接器标识,请运行
ibmcloud sat connector ls
。 --endpoint ENDPOINT
- 要为该 ACL 启用的端点的名称或 ID。
--location LOCATION
- Satellite 位置的名称或标识。 要查找位置 ID 或名称,请运行
ibmcloud sat location ls
。 --name NAME
- ACL 的名称。
-q
- 不显示每日消息或更新提示。
--subnet SUBNET
- 此 ACL 允许的 IP 或 CIDR 块。 值必须完全包含在以下 CIDR 中:10.0.0.0/8, 161.26.0.0/16, 166.8.0.0/14, 172.16.0.0/12.
ibmcloud sat experimental acl endpoint add
[已于 2024-10-01 关闭! 使用 ibmcloud sat acl endpoint add
代替] 在 ACL 中添加一个或多个启用的端点。
ibmcloud sat experimental acl endpoint add --acl-id ID --endpoint ENDPOINT [--endpoint ENDPOINT ...] [-q] (--connector-id ID | --location LOCATION)
命令选项
--acl-id ID
- 指定 ACL 的 ID。 要列出所有 ACL,请运行
ibmcloud sat acl ls
。 --connector-id ID
- Satellite 连接器的 ID。 要查找连接器标识,请运行
ibmcloud sat connector ls
。 --endpoint ENDPOINT
- 要为该 ACL 启用的端点的名称或 ID。
--location LOCATION
- Satellite 位置的名称或标识。 要查找位置 ID 或名称,请运行
ibmcloud sat location ls
。 -q
- 不显示每日消息或更新提示。
ibmcloud sat experimental acl endpoint ls
[已于 2024-10-01 关闭! 使用 ibmcloud sat acl endpoint ls
代替] 列出 ACL 的所有启用端点。
ibmcloud sat experimental acl endpoint ls --acl-id ID [--output OUTPUT] [-q] (--connector-id ID | --location LOCATION)
命令选项
--acl-id ID
- 指定 ACL 的 ID。 要列出所有 ACL,请运行
ibmcloud sat acl ls
。 --connector-id ID
- Satellite 连接器的 ID。 要查找连接器标识,请运行
ibmcloud sat connector ls
。 --location LOCATION
- Satellite 位置的名称或标识。 要查找位置 ID 或名称,请运行
ibmcloud sat location ls
。 --output OUTPUT
- 以提供的格式打印命令输出。 接受的值:
json
-q
- 不显示每日消息或更新提示。
ibmcloud sat experimental acl endpoint rm
[已于 2024-10-01 关闭! 使用 ibmcloud sat acl endpoint rm
代替] 从 ACL 中移除一个或多个启用的端点。
ibmcloud sat experimental acl endpoint rm --acl-id ID --endpoint ENDPOINT [--endpoint ENDPOINT ...] [-q] (--connector-id ID | --location LOCATION)
命令选项
--acl-id ID
- 指定 ACL 的 ID。 要列出所有 ACL,请运行
ibmcloud sat acl ls
。 --connector-id ID
- Satellite 连接器的 ID。 要查找连接器标识,请运行
ibmcloud sat connector ls
。 --endpoint ENDPOINT
- 要禁用此 ACL 的端点名称或 ID。
--location LOCATION
- Satellite 位置的名称或标识。 要查找位置 ID 或名称,请运行
ibmcloud sat location ls
。 -q
- 不显示每日消息或更新提示。
ibmcloud sat experimental acl get
[已于 2024-10-01 关闭! 使用 ibmcloud sat acl get
代替] 查看 ACL 的详细信息。
ibmcloud sat experimental acl get --acl-id ID [--output OUTPUT] [-q] (--connector-id ID | --location LOCATION)
命令选项
--acl-id ID
- 指定 ACL 的 ID。 要列出所有 ACL,请运行
ibmcloud sat acl ls
。 --connector-id ID
- Satellite 连接器的 ID。 要查找连接器标识,请运行
ibmcloud sat connector ls
。 --location LOCATION
- Satellite 位置的名称或标识。 要查找位置 ID 或名称,请运行
ibmcloud sat location ls
。 --output OUTPUT
- 以提供的格式打印命令输出。 接受的值:
json
-q
- 不显示每日消息或更新提示。
ibmcloud sat experimental acl ls
[已于 2024-10-01 关闭! 使用 ibmcloud sat acl ls
代替] 列出 Satellite 连接器或位置的所有 ACL。
ibmcloud sat experimental acl ls [--output OUTPUT] [-q] (--connector-id ID | --location LOCATION)
命令选项
--connector-id ID
- Satellite 连接器的 ID。 要查找连接器标识,请运行
ibmcloud sat connector ls
。 --location LOCATION
- Satellite 位置的名称或标识。 要查找位置 ID 或名称,请运行
ibmcloud sat location ls
。 --output OUTPUT
- 以提供的格式打印命令输出。 接受的值:
json
-q
- 不显示每日消息或更新提示。
ibmcloud sat experimental acl rm
[已于 2024-10-01 关闭! 使用 ibmcloud sat acl rm
代替] 删除 ACL。
ibmcloud sat experimental acl rm --acl-id ID [-q] (--connector-id ID | --location LOCATION)
命令选项
--acl-id ID
- 指定 ACL 的 ID。 要列出所有 ACL,请运行
ibmcloud sat acl ls
。 --connector-id ID
- Satellite 连接器的 ID。 要查找连接器标识,请运行
ibmcloud sat connector ls
。 --location LOCATION
- Satellite 位置的名称或标识。 要查找位置 ID 或名称,请运行
ibmcloud sat location ls
。 -q
- 不显示每日消息或更新提示。
ibmcloud sat experimental acl subnet add
[已于 2024-10-01 关闭! 使用 ibmcloud sat acl subnet add
代替] 为 ACL 添加一个或多个子网。
ibmcloud sat experimental acl subnet add --acl-id ID --subnet SUBNET [--subnet SUBNET ...] [-q] (--connector-id ID | --location LOCATION)
命令选项
--acl-id ID
- 指定 ACL 的 ID。 要列出所有 ACL,请运行
ibmcloud sat acl ls
。 --connector-id ID
- Satellite 连接器的 ID。 要查找连接器标识,请运行
ibmcloud sat connector ls
。 --location LOCATION
- Satellite 位置的名称或标识。 要查找位置 ID 或名称,请运行
ibmcloud sat location ls
。 -q
- 不显示每日消息或更新提示。
--subnet SUBNET
- 此 ACL 允许的 IP 或 CIDR 块。 值必须完全包含在以下 CIDR 中:10.0.0.0/8, 161.26.0.0/16, 166.8.0.0/14, 172.16.0.0/12.
ibmcloud sat experimental acl subnet rm
[已于 2024-10-01 关闭! 使用 ibmcloud sat acl subnet rm
代替] 从 ACL 中移除一个或多个子网。
ibmcloud sat experimental acl subnet rm --acl-id ID --subnet SUBNET [--subnet SUBNET ...] [-q] (--connector-id ID | --location LOCATION)
命令选项
--acl-id ID
- 指定 ACL 的 ID。 要列出所有 ACL,请运行
ibmcloud sat acl ls
。 --connector-id ID
- Satellite 连接器的 ID。 要查找连接器标识,请运行
ibmcloud sat connector ls
。 --location LOCATION
- Satellite 位置的名称或标识。 要查找位置 ID 或名称,请运行
ibmcloud sat location ls
。 -q
- 不显示每日消息或更新提示。
--subnet SUBNET
- 此 ACL 允许的 IP 或 CIDR 块。 值必须完全包含在以下 CIDR 中:10.0.0.0/8, 161.26.0.0/16, 166.8.0.0/14, 172.16.0.0/12.
ibmcloud sat experimental acl update
[已于 2024-10-01 关闭! 使用 ibmcloud sat acl update
代替] 更新 ACL 名称。
ibmcloud sat experimental acl update --acl-id ID --name NAME [-q] (--connector-id ID | --location LOCATION)
命令选项
--acl-id ID
- 指定 ACL 的 ID。 要列出所有 ACL,请运行
ibmcloud sat acl ls
。 --connector-id ID
- Satellite 连接器的 ID。 要查找连接器标识,请运行
ibmcloud sat connector ls
。 --location LOCATION
- Satellite 位置的名称或标识。 要查找位置 ID 或名称,请运行
ibmcloud sat location ls
。 --name NAME
- ACL 的新名称。
-q
- 不显示每日消息或更新提示。
ibmcloud sat experimental agent attach
[2024-09-01停用! 使用 ibmcloud sat agent attach
代替] 获取特定平台的 Satellite 连接器代理。 下载适用于 Windows 的 Agent .zip
或获取适用于 Docker 环境的文档链接。
ibmcloud sat experimental agent attach --platform PLATFORM [-q]
命令选项
--platform PLATFORM
- Satellite连接器代理的平台。 有关 Docker 的更多信息,请参阅 https://ibm.biz/satconagent 文档 可用选项:WINDOWS、Docker
-q
- 不显示每日消息或更新提示。
ibmcloud sat experimental agent ls
[2024-09-01停用! 使用 ibmcloud sat agent ls
代替] 列出Satellite连接器的所有代理。
ibmcloud sat experimental agent ls --connector-id ID [--output OUTPUT] [-q]
命令选项
--connector-id ID
- Satellite 连接器的标识。
--output OUTPUT
- 以提供的格式打印命令输出。 接受的值:
json
-q
- 不显示每日消息或更新提示。
ibmcloud sat experimental connector create
[于 2024-11-18 停用! 使用 ibmcloud sat connector create
代替] 创建一个 Satellite 连接器。
ibmcloud sat experimental connector create --name NAME --region REGION [-q]
命令选项
--name NAME
- Satellite 连接器的名称。
-q
- 不显示每日消息或更新提示。
--region REGION
- 用于管理 Satellite 连接器的 IBM Cloud 区域。
ibmcloud sat experimental connector get
[于 2024-11-18 停用! 使用 ibmcloud sat connector get
代替] 查看Satellite连接器的详细信息。
ibmcloud sat experimental connector get --connector-id ID [--output OUTPUT] [-q]
命令选项
--connector-id ID
- Satellite 连接器的标识。
--output OUTPUT
- 以提供的格式打印命令输出。 接受的值:
json
-q
- 不显示每日消息或更新提示。
ibmcloud sat experimental connector ls
[于 2024-11-18 停用! 使用 ibmcloud sat connector ls
代替] 查看 Satellite 连接器中的 IBM Cloud 帐户。
ibmcloud sat experimental connector ls [--after AFTER] [--first FIRST] [--output OUTPUT] [-q]
命令选项
--after AFTER
- 显示指定光标后的Satellite连接器。
--first FIRST
- 查看下一个Satellite连接器,直至第一个连接器的数量。
--output OUTPUT
- 以提供的格式打印命令输出。 接受的值:
json
-q
- 不显示每日消息或更新提示。
ibmcloud sat experimental connector rm
[于 2024-11-18 停用! 使用 ibmcloud sat connector rm
代替] 删除 Satellite 连接器。
ibmcloud sat experimental connector rm --connector-id ID [-f] [-q]
命令选项
--connector-id ID
- Satellite 连接器的标识。
-f
- 强制此命令运行,而不显示用户提示。
-q
- 不显示每日消息或更新提示。
ibmcloud sat experimental endpoint authn get
[已于 2024-10-01 关闭! 使用 ibmcloud sat endpoint authn get
]* 获取端点的身份验证设置。
ibmcloud sat experimental endpoint authn get --endpoint ENDPOINT [--output OUTPUT] [-q] (--connector-id ID | --location LOCATION)
命令选项
--connector-id ID
- Satellite 连接器的 ID。 要查找连接器标识,请运行
ibmcloud sat connector ls
。 --endpoint ENDPOINT
- 指定端点的名称或标识。 要列出所有端点,请运行
ibmcloud sat endpoint ls
。 --location LOCATION
- Satellite 位置的名称或标识。 要查找位置 ID 或名称,请运行
ibmcloud sat location ls
。 --output OUTPUT
- 以提供的格式打印命令输出。 接受的值:
json
-q
- 不显示每日消息或更新提示。
ibmcloud sat experimental endpoint authn rotate
[已于 2024-10-01 关闭! 使用 ibmcloud sat endpoint authn rotate
代替] 用新证书替换现有的验证证书。 请求流中有两个 TLS 连接。 source
选项指的是源和连接器服务之间的 TLS 握手。 destination
选项指的是 Connector 服务与目的地或目标服务器之间的 TLS 握手。 您可以为其中一个或两个连接提供证书。 只有您指定的证书才会被替换。
ibmcloud sat experimental endpoint authn rotate --endpoint ENDPOINT [--dest-ca-cert-file FILE] [--dest-cert-file FILE] [--dest-key-file FILE] [-q] [--source-ca-cert-file FILE] [--source-cert-file FILE] [--source-key-file FILE] (--connector-id ID | --location LOCATION)
命令选项
--connector-id ID
- Satellite 连接器的 ID。 要查找连接器标识,请运行
ibmcloud sat connector ls
。 --dest-ca-cert-file FILE
- 用于验证目标服务器证书的可信 CA 证书或链。 例如,
myCA.pem
。 --dest-cert-file FILE
- 用于与目标服务器进行身份验证的客户端证书。 例如,
myCert.pem
。 --dest-key-file FILE
- 用于加密客户机证书的客户机专用密钥。 例如,
myKey.pem
。 --endpoint ENDPOINT
- 指定端点的名称或标识。 要列出所有端点,请运行
ibmcloud sat endpoint ls
。 --location LOCATION
- Satellite 位置的名称或标识。 要查找位置 ID 或名称,请运行
ibmcloud sat location ls
。 -q
- 不显示每日消息或更新提示。
--source-ca-cert-file FILE
- 当 source-tls-mode 是相互的时,用于验证源客户机证书的可信 CA 证书或链。 例如,
myCA.pem
。 --source-cert-file FILE
- 要向源客户机提供的服务器证书。 例如,
myCert.pem
。 --source-key-file FILE
- 用于加密服务器证书的服务器专用密钥。 例如,
myKey.pem
。
ibmcloud sat experimental endpoint authn set
[已于 2024-10-01 关闭! 使用 ibmcloud sat endpoint authn set
代替] 为端点设置身份验证设置。 请求流中有两个 TLS 连接。 source
选项指的是源和连接器服务之间的 TLS 握手。 destination
选项指的是 Connector 服务与目的地或目标服务器之间的 TLS 握手。 您可以为其中一个或两个连接提供证书。 未指定的设置将设置为其缺省值。
ibmcloud sat experimental endpoint authn set --endpoint ENDPOINT [--dest-ca-cert-file FILE] [--dest-cert-file FILE] [--dest-key-file FILE] [--dest-tls-mode MODE] [-q] [--source-ca-cert-file FILE] [--source-cert-file FILE] [--source-key-file FILE] [--source-tls-mode MODE] (--connector-id ID | --location LOCATION)
命令选项
--connector-id ID
- Satellite 连接器的 ID。 要查找连接器标识,请运行
ibmcloud sat connector ls
。 --dest-ca-cert-file FILE
- 用于验证目标服务器证书的可信 CA 证书或链。 例如,
myCA.pem
。 --dest-cert-file FILE
- 用于与目标服务器进行身份验证的客户端证书。 例如,
myCert.pem
。 --dest-key-file FILE
- 用于加密客户机证书的客户机专用密钥。 例如,
myKey.pem
。 --dest-tls-mode MODE
- 目标 TLS 方式。 接受值:
simple
,mutual
,none
--endpoint ENDPOINT
- 指定端点的名称或标识。 要列出所有端点,请运行
ibmcloud sat endpoint ls
。 --location LOCATION
- Satellite 位置的名称或标识。 要查找位置 ID 或名称,请运行
ibmcloud sat location ls
。 -q
- 不显示每日消息或更新提示。
--source-ca-cert-file FILE
- 当 source-tls-mode 是相互的时,用于验证源客户机证书的可信 CA 证书或链。 例如,
myCA.pem
。 --source-cert-file FILE
- 要向源客户机提供的服务器证书。 例如,
myCert.pem
。 --source-key-file FILE
- 用于加密服务器证书的服务器专用密钥。 例如,
myKey.pem
。 --source-tls-mode MODE
- 源 TLS 方式。 接受的值:
simple
,mutual
ibmcloud sat experimental location update
[已于 2024-11-25 停用! 使用 "ibmcloud sat location update
代替]更新Satellite位置的名称或描述。
ibmcloud sat experimental location update --location-id ID [--description DESCRIPTION] [--name NAME] [-q]
命令选项
--description DESCRIPTION
- 为 Satellite 位置输入新的描述。 说明的长度限制为 400 字节。
--location-id ID
- Satellite 位置的 ID。 要查找位置 ID,请运行
ibmcloud sat location ls
。 --name NAME
- 为 Satellite 位置指定一个新名称。 地点名称必须以字母开头,可包含字母、数字、句点 (.) 和连字符 (-),且必须少于 36 个字符。 不要重复使用名称,包括已删除位置的名称。
-q
- 不显示每日消息或更新提示。
ibmcloud sat group attach
将集群添加到集群组。 集群可以在 Satellite 位置或 IBM Cloud 中运行。 要添加在 IBM Cloud 中运行的集群,必须首先向 Satellite Config 注册该集群。
ibmcloud sat group attach --cluster CLUSTER [--cluster CLUSTER ...] --group GROUP [-q]
命令选项
--cluster CLUSTER
,-c CLUSTER
- 指定集群名称或标识。 要列出已注册的群集,请运行
ibmcloud sat cluster ls
。 --group GROUP
,-g GROUP
- 指定 Satellite 集群组的名称或标识。 要列出可用的群集组,请运行
ibmcloud sat group ls
。 -q
- 不显示每日消息或更新提示。
ibmcloud sat group create
创建集群组。 然后,可以将集群组预订为 Satellite 配置。
ibmcloud sat group create --name NAME [--cluster CLUSTER ...] [-q]
命令选项
--cluster CLUSTER
,-c CLUSTER
- 指定要添加到集群组的集群名称或标识。 要列出已注册的群集,请运行
ibmcloud sat cluster ls
。 --name NAME
- 提供 Satellite 集群组的名称。
-q
- 不显示每日消息或更新提示。
ibmcloud sat group detach
移除 Satellite 集群组中的一个或多个集群,并删除组预订所管理的 Kubernetes 资源。
ibmcloud sat group detach --cluster CLUSTER [--cluster CLUSTER ...] --group GROUP [-f] [-q]
命令选项
--cluster CLUSTER
,-c CLUSTER
- 指定集群名称或标识。 要列出群集组中的群集,请运行
ibmcloud sat group get --group <cluster_group_name_or_ID>
。 -f
- 强制此命令运行,而不显示用户提示。
--group GROUP
,-g GROUP
- 指定 Satellite 集群组的名称或标识。 要列出可用的群集组,请运行
ibmcloud sat group ls
。 -q
- 不显示每日消息或更新提示。
ibmcloud sat group get
获取 Satellite 集群组的详细信息。
ibmcloud sat group get --group GROUP [--output OUTPUT] [-q]
命令选项
--group GROUP
,-g GROUP
- 指定 Satellite 集群组的名称或标识。 要列出已注册的群集,请运行
ibmcloud sat cluster ls
。 --output OUTPUT
- 以提供的格式打印命令输出。 接受的值:
json
-q
- 不显示每日消息或更新提示。
ibmcloud sat group ls
列出 IBM Cloud 帐户中的所有 Satellite 集群组。
ibmcloud sat group ls [--output OUTPUT] [-q]
命令选项
--output OUTPUT
- 以提供的格式打印命令输出。 接受的值:
json
-q
- 不显示每日消息或更新提示。
ibmcloud sat group rm
如果 Satellite 集群组取消预订集群并且删除组预订所管理的 Kubernetes 资源,将该集群组删除。
ibmcloud sat group rm --group GROUP [-f] [-q]
命令选项
-f
- 强制此命令运行,而不显示用户提示。
--group GROUP
,-g GROUP
- 指定 Satellite 集群组的名称或标识。 要列出可用的群集组,请运行
ibmcloud sat group ls
。 -q
- 不显示每日消息或更新提示。
ibmcloud sat host assign
将主机分配给 Satellite 位置控制平面或集群。
ibmcloud sat host assign --location LOCATION [--cluster CLUSTER] [--host HOST] [--host-label LABEL ...] [-q] [--worker-pool POOL] [--zone ZONE]
命令选项
--cluster CLUSTER
- 要将主机分配到的集群的名称或标识。 要列出可用的群集,请运行
ibmcloud sat cluster ls
。 如果未提供任何集群,那么会自动将主机分配给 Satellite 控制面板。 --host HOST
- 要分配的主机的名称或标识。 要根据标签自动分配主机,请不要包含此选项。 要检索主机 ID,请运行
ibmcloud sat host ls --location <location_ID_or_name>
。 --host-label LABEL
,--hl LABEL
- 输入任何标签作为键值对,以标识要分配给 Satellite 控制平面或 Red Hat OpenShift 集群的主机。 具有此标签且未分配的第一个主机将自动分配给控制平面或集群。 要查找可用的主机标签,请运行
ibmcloud sat host get --host <host_name_or_ID> --location <location_name_or_ID>
。 --location LOCATION
- Satellite 位置的名称或标识。 要查找位置 ID 或名称,请运行
ibmcloud sat location ls
。 -q
- 不显示每日消息或更新提示。
--worker-pool POOL
,-p POOL
- 要分配主机的集群中工作程序池的名称或标识。 如果未指定工作程序池,那么会将主机分配给缺省工作程序池。
--zone ZONE
- 要分配主机的区域的名称或标识。 要查找可用区,请运行
ibmcloud sat location get --location <location_name_or_ID>
并查找Host Zones
字段。
ibmcloud sat host attach
创建并下载可以在主机上运行的脚本,以将它们连接到您的位置。 对于支持 RHCOS 的位置,脚本是一个启动文件。
ibmcloud sat host attach --location LOCATION [--host-label LABEL ...] [--host-link-agent-endpoint ENDPOINT] [--operating-system SYSTEM] [-q] [--reset-key]
命令选项
--host-label LABEL
,--hl LABEL
- 输入任何标签作为键值对,以标识要分配给 Satellite 控制平面或 Red Hat OpenShift 集群的主机。 具有此标签且未分配的第一个主机将自动分配给控制平面或集群。 要查找可用的主机标签,请运行
ibmcloud sat host get --host <host_name_or_ID> --location <location_name_or_ID>
。 --host-link-agent-endpoint ENDPOINT
- 链路代理程序用于连接到链路隧道服务器的端点。
--location LOCATION
- Satellite 位置的名称或标识。 要查找位置 ID 或名称,请运行
ibmcloud sat location ls
。 --operating-system SYSTEM
- 您要连接到您的位置的主机的操作系统。 要连接 RHCOS 主机,您的位置必须启用 RHCOS。 接受的值:
RHEL
,RHCOS
-q
- 不显示每日消息或更新提示。
--reset-key
- 重置控制平面用于连接和分配位置中的主机的密钥。 请参阅 https://ibm.biz/reset-key。
ibmcloud sat host get
查看 Satellite 主机的详细信息。
ibmcloud sat host get --host HOST --location LOCATION [--output OUTPUT] [-q]
命令选项
--host HOST
- Satellite 主机标识。 要查找主机 ID,请运行
ibmcloud sat host ls <location_ID_or_name>
。 --location LOCATION
- Satellite 位置的名称或标识。 要查找位置 ID 或名称,请运行
ibmcloud sat location ls
。 --output OUTPUT
- 以提供的格式打印命令输出。 接受的值:
json
-q
- 不显示每日消息或更新提示。
ibmcloud sat host ls
列出附加到 Satellite 位置的所有主机,包括分配给集群或控制面板的主机。
ibmcloud sat host ls --location LOCATION [--output OUTPUT] [-q]
命令选项
--location LOCATION
- Satellite 位置的名称或标识。 要查找位置 ID 或名称,请运行
ibmcloud sat location ls
。 --output OUTPUT
- 以提供的格式打印命令输出。 接受的值:
json
-q
- 不显示每日消息或更新提示。
ibmcloud sat host rm
从 Satellite 位置中移除主机。
ibmcloud sat host rm --host HOST --location LOCATION [-f] [-q]
命令选项
-f
- 强制此命令运行,而不显示用户提示。
--host HOST
- 要移除的主机的名称或标识。
--location LOCATION
- Satellite 位置的名称或标识。 要查找位置 ID 或名称,请运行
ibmcloud sat location ls
。 -q
- 不显示每日消息或更新提示。
ibmcloud sat host update
更新主机信息,例如区域和标签。
ibmcloud sat host update --host HOST --location LOCATION [--host-label LABEL ...] [-q] [--zone ZONE]
命令选项
--host HOST
- 要分配的主机的名称或标识。 要根据标签自动分配主机,请不要包含此选项。
--host-label LABEL
,--hl LABEL
- 输入任何标签作为键值对,以标识要分配给 Satellite 控制平面或 Red Hat OpenShift 集群的主机。 具有此标签且未分配的第一个主机将自动分配给控制平面或集群。 要查找可用的主机标签,请运行
ibmcloud sat host get --host <host_name_or_ID> --location <location_name_or_ID>
。 --location LOCATION
- Satellite 位置的名称或标识。 要查找位置 ID 或名称,请运行
ibmcloud sat location ls
。 -q
- 不显示每日消息或更新提示。
--zone ZONE
- 要与主机关联的区域的名称或标识。 不能更改分配给资源(例如集群)的主机的区域。 必须先取消分配这些。 要列出可用区段,请运行
ibmcloud sat location get --location <ID>
。
ibmcloud sat key ls
列出 IBM Cloud 帐户中的所有 Satellite Config 密钥。
ibmcloud sat key ls [--output OUTPUT] [-q]
命令选项
--output OUTPUT
- 以提供的格式打印命令输出。 接受的值:
json
-q
- 不显示每日消息或更新提示。
ibmcloud sat key rm
移除 Satellite Config 密钥。 仍使用此密钥的任何集群都无法连接到 Satellite 配置。
ibmcloud sat key rm --key KEY [-f] [-q]
命令选项
-f
- 强制此命令运行,而不显示用户提示。
--key KEY
- Satellite 配置密钥的名称或标识。
-q
- 不显示每日消息或更新提示。
ibmcloud sat key rotate
生成新的密钥,以供受管集群用于连接到 Satellite Config。
ibmcloud sat key rotate --name NAME [-f] [-q]
命令选项
-f
- 强制此命令运行,而不显示用户提示。
--name NAME
- 新 Satellite Config 密钥的名称。
-q
- 不显示每日消息或更新提示。
ibmcloud sat location create
创建 Satellite 位置。 Satellite 位置是基础结构提供程序中环境的表示。 创建位置后,使用 ibmcloud sat host attach
命令从备份基础架构环境的不同区域附加主机。
ibmcloud sat location create --managed-from REGION --name NAME [--capability CAPABILITY ...] [--coreos-enabled] [--cos-bucket BUCKET] [--description DESCRIPTION] [--ha-zone ZONE ...] [--physical-address ADDRESS] [--pod-network-interface-selection SELECTION] [--pod-subnet SUBNET] [--provider PROVIDER] [--provider-credential CREDENTIAL] [--provider-region REGION] [-q] [--service-subnet SUBNET]
命令选项
--capability CAPABILITY
- Satellite位置的能力。
--coreos-enabled
- 对 Satellite 位置启用 Red Hat CoreOS 功能部件。 无法撤销此操作。 请参阅 https://ibm.biz/infra-os。
--cos-bucket BUCKET
- 指定用于存储 Satellite 位置控制平面数据的 IBM Cloud Object Storage 存储区的名称。 否则,将为您创建新的存储区。
--description DESCRIPTION
- 输入 Satellite 位置的描述。
--ha-zone ZONE
- 指定位置的区域。 要实现高可用性,请为您的位置指定 3 个区域,如
--ha-zone ZONE1_NAME --ha-zone ZONE2_NAME --ha-zone ZONE3_NAME
。 这些区域的名称必须与您计划在其中创建主机的基础结构提供程序中相应区域的名称完全匹配。 --managed-from REGION
- 选择要从中管理 Satellite 位置的 IBM Cloud 区域。 为了获得更佳的性能,请选择您的本地数据中心附近的区域。 请参阅 https://ibm.biz/sat-region。
--name NAME
- 指定 Satellite 位置的名称。 地点名称必须以字母开头,可包含字母、数字、句点 (.) 和连字符 (-),且必须少于 36 个字符。 请勿复用名称,即使删除了其他位置也是如此。
--physical-address ADDRESS
- Satellite位置的物理地址。
--pod-network-interface-selection SELECTION
- 用于选择内部 pod 网络的节点网络接口的方法。 只有同时使用
--coreos-enabled
选项启用 Red Hat CoreOS 时,才能使用该选项。 要提供直接 URL 或 IP 地址,请指定can-reach=<url>
或can-reach=<ip_address>
。 要选择网络接口,请指定interface=<network_interface>
。 --pod-subnet SUBNET
- 指定定制子网 CIDR 以便为 Pod 提供专用 IP 地址。 该选项只有在使用
--coreos-enabled
选项启用 Red Hat CoreOS 时才会使用。 子网必须是/23
或更大。 请参阅 https://ibm.biz/sat-location-create。 缺省值:“172.16.0.0/16” --provider PROVIDER
- 指示要用于 Satellite 位置的基础结构提供程序。 如果包含该选项,还必须包含
--provider-credential
选项。 接受的值:aws
,azure
,gcp
和vmware
--provider-credential CREDENTIAL
- 指定本地机器上具有 Satellite 位置的基础架构提供程序凭证的 JSON 文件的路径。 凭证格式是特定于提供者的。 请参阅 http://ibm.biz/sat-infra-creds。
--provider-region REGION
- 指定基础结构提供程序中您计划在其中为 Satellite 位置创建主机的区域。 如果包含该选项,还必须包含
--provider
选项。 -q
- 不显示每日消息或更新提示。
--service-subnet SUBNET
- 指定定制子网 CIDR 以便为服务提供专用 IP 地址。 该选项只有在使用
--coreos-enabled
选项启用 Red Hat CoreOS 时才会使用。 子网必须是/24
或更大。 请参阅 https://ibm.biz/sat-location-create。 缺省值:172.20.0.0/16
ibmcloud sat location dns get
查看 Satellite 位置中已注册子域的详细信息。
ibmcloud sat location dns get --location LOCATION --subdomain SUBDOMAIN [--output OUTPUT] [-q]
命令选项
--location LOCATION
- Satellite 位置的名称或标识。 要查找位置 ID 或名称,请运行
ibmcloud sat location ls
。 --output OUTPUT
- 以提供的格式打印命令输出。 接受的值:
json
-q
- 不显示每日消息或更新提示。
--subdomain SUBDOMAIN
- 指定子域名。 要列出现有子域,请运行
ibmcloud sat location dns ls --location <ID>
。
ibmcloud sat location dns ls
列出 Satellite 位置中已注册的子域。
ibmcloud sat location dns ls --location LOCATION [--output OUTPUT] [-q]
命令选项
--location LOCATION
- Satellite 位置的名称或标识。 要查找位置 ID 或名称,请运行
ibmcloud sat location ls
。 --output OUTPUT
- 以提供的格式打印命令输出。 接受的值:
json
-q
- 不显示每日消息或更新提示。
ibmcloud sat location dns register
在 Satellite 位置中设置分配给控制平面的主机的子域。
ibmcloud sat location dns register --ip IP [--ip IP ...] --location LOCATION [--output OUTPUT] [-q]
命令选项
--ip IP
- 为每个控制平面主机指定 IP 地址,格式为
--ip x.x.x.1 --ip x.x.x.2 --ip x.x.x.3
. 对于多区域集群,每个区域都使用一个 IP 地址。 要查找 IP 地址,请运行ibmcloud sat host ls --location <location_ID_or_name>
,在标有infrastructure
的主机中查找Worker IP
。 --location LOCATION
- Satellite 位置的名称或标识。 要查找位置 ID 或名称,请运行
ibmcloud sat location ls
。 --output OUTPUT
- 以提供的格式打印命令输出。 接受的值:
json
-q
- 不显示每日消息或更新提示。
ibmcloud sat location get
查看 Satellite 位置的详细信息。
ibmcloud sat location get --location LOCATION [--output OUTPUT] [-q]
命令选项
--location LOCATION
- Satellite 位置的名称或标识。 要查找位置 ID 或名称,请运行
ibmcloud sat location ls
。 --output OUTPUT
- 以提供的格式打印命令输出。 接受的值:
json
-q
- 不显示每日消息或更新提示。
ibmcloud sat location ls
列出 IBM Cloud 帐户中的所有 Satellite 位置。
ibmcloud sat location ls [--output OUTPUT] [-q]
命令选项
--output OUTPUT
- 以提供的格式打印命令输出。 接受的值:
json
-q
- 不显示每日消息或更新提示。
ibmcloud sat location rm
删除位置。 在运行此命令之前,请备份配置并除去在该位置中运行的任何主机和集群。 删除位置时,不会自动删除底层主机基础结构。 无法撤销此操作。
ibmcloud sat location rm --location LOCATION [-f] [-q]
命令选项
-f
- 强制此命令运行,而不显示用户提示。
--location LOCATION
- Satellite 位置的名称或标识。 要查找位置 ID 或名称,请运行
ibmcloud sat location ls
。 -q
- 不显示每日消息或更新提示。
ibmcloud sat location update
更新Satellite位置的名称或描述。
ibmcloud sat location update --location-id ID [--description DESCRIPTION] [--name NAME] [-q]
命令选项
--description DESCRIPTION
- 为 Satellite 位置输入新的描述。 说明的长度限制为 400 字节。
--location-id ID
- Satellite 位置的 ID。 要查找位置 ID,请运行
ibmcloud sat location ls
。 --name NAME
- 为 Satellite 位置指定一个新名称。 地点名称必须以字母开头,可包含字母、数字、句点 (.) 和连字符 (-),且必须少于 36 个字符。 不要重复使用名称,包括已删除位置的名称。
-q
- 不显示每日消息或更新提示。
ibmcloud sat messages
查看当前用户消息。
ibmcloud sat messages [-q]
命令选项
-q
- 不显示每日消息或更新提示。
ibmcloud sat resource get
查看由 Satellite 配置管理的 Kubernetes 资源的详细信息。
ibmcloud sat resource get --resource RESOURCE [--history HISTORY] [--output OUTPUT] [-q] [--save-data]
命令选项
--history HISTORY
- 资源的历史记录标识。
--output OUTPUT
- 以提供的格式打印命令输出。 接受的值:
json
-q
- 不显示每日消息或更新提示。
--resource RESOURCE
- 指定 Kubernetes 资源标识。 要查找 Kubernetes 资源,请运行
ibmcloud sat resource ls
。 --save-data
- 下载 Kubernetes 资源定义并将其保存到临时文件。
ibmcloud sat resource history get
获取 Kubernetes 资源的历史记录。
ibmcloud sat resource history get --resource RESOURCE [--limit LIMIT] [--output OUTPUT] [-q]
命令选项
--limit LIMIT
- 指定要返回的最大历史记录条目数。
--output OUTPUT
- 以提供的格式打印命令输出。 接受的值:
json
-q
- 不显示每日消息或更新提示。
--resource RESOURCE
- Kubernetes 资源标识。
ibmcloud sat resource ls
搜索由 Satellite 管理的 Kubernetes 资源。
ibmcloud sat resource ls [--limit LIMIT] [--output OUTPUT] [-q] [--search SEARCH] (--cluster CLUSTER | --subscription SUBSCRIPTION)
命令选项
--cluster CLUSTER
,-c CLUSTER
- 指定在其中运行 Kubernetes 资源的已注册集群的名称或标识。 要查找已注册的群集,请运行
ibmcloud sat cluster ls
。 --limit LIMIT
- 指定要返回的搜索的最大资源条目数。
--output OUTPUT
- 以提供的格式打印命令输出。 接受的值:
json
-q
- 不显示每日消息或更新提示。
--search SEARCH
- 指示用于过滤 Kubernetes 资源(例如 pod 或名称空间名称)的搜索结果的字符串。
--subscription SUBSCRIPTION
- 指定 Satellite 预订标识或名称。 要查找订阅,请运行
ibmcloud sat cluster ls
。
ibmcloud sat service ls
列出您所在位置中的所有 Satellite 服务集群以查看详细信息,例如所请求的主机资源。
ibmcloud sat service ls --location LOCATION [--output OUTPUT] [-q]
命令选项
--location LOCATION
- Satellite 位置的名称或标识。 要查找位置 ID 或名称,请运行
ibmcloud sat location ls
。 --output OUTPUT
- 以提供的格式打印命令输出。 接受的值:
json
-q
- 不显示每日消息或更新提示。
ibmcloud sat storage assignment autopatch disable
storage assignment autopatch disable
命令是 Beta 功能。
禁用 Satellite 存储器分配的自动补丁。
ibmcloud sat storage assignment autopatch disable --config CONFIG [-q] (--all | --assignment ASSIGNMENT)
命令选项
--all
- 禁用存储器配置的所有 Satellite 存储器分配的自动补丁。
--assignment ASSIGNMENT
- Satellite 存储器分配的标识。 要列出配置的可用存储器分配,请运行
ibmcloud sat storage assignment ls --config CONFIG
。 --config CONFIG
- Satellite 存储器配置的名称或标识。 要列出可用的存储配置,请运行
ibmcloud sat storage config ls
。 -q
- 不显示每日消息或更新提示。
ibmcloud sat storage assignment autopatch enable
storage assignment autopatch enable
命令是 Beta 功能。
为 Satellite 存储器分配启用自动补丁。
ibmcloud sat storage assignment autopatch enable --config CONFIG [-q] (--all | --assignment ASSIGNMENT)
命令选项
--all
- 对存储器配置的所有 Satellite 存储器分配启用自动补丁。
--assignment ASSIGNMENT
- Satellite 存储器分配的标识。 要列出配置的可用存储器分配,请运行
ibmcloud sat storage assignment ls --config CONFIG
。 --config CONFIG
- Satellite 存储器配置的名称或标识。 要列出可用的存储配置,请运行
ibmcloud sat storage config ls
。 -q
- 不显示每日消息或更新提示。
ibmcloud sat storage assignment create
创建分配,以在 Satellite 位置的集群中部署存储器配置。
ibmcloud sat storage assignment create --config CONFIG [--name NAME] [-q] (--cluster CLUSTER | --group GROUP | --service-cluster-id CLUSTER)
命令选项
--cluster CLUSTER
,-c CLUSTER
- 指定用于分配的 Satellite 集群的标识。 要查找群集 ID,请运行
ibmcloud oc cluster ls --provider satellite
。 --config CONFIG
- 指定分配的 Satellite 存储器配置。要查找配置,请运行
ibmcloud sat storage config ls
。 --group GROUP
,-g GROUP
- 指定用于分配的集群组。 要查找群组,请运行
ibmcloud sat group ls
。 --name NAME
- 提供 Satellite 存储器分配的名称。
-q
- 不显示每日消息或更新提示。
--service-cluster-id CLUSTER
- 指定用于分配的服务集群的标识。 要查找服务群集 ID,请运行
ibmcloud sat service ls --location <location>
。
ibmcloud sat storage assignment get
获取 Satellite 存储器分配的详细信息。
ibmcloud sat storage assignment get --assignment ASSIGNMENT [--output OUTPUT] [-q]
命令选项
--assignment ASSIGNMENT
- 指定 Satellite 存储器分配的标识。
--output OUTPUT
- 以提供的格式打印命令输出。 接受的值:
json
-q
- 不显示每日消息或更新提示。
ibmcloud sat storage assignment ls
列出您的 IBM Cloud 帐户中的 Satellite 存储器分配。
要以服务管理员身份列出服务群集的所有分配:ibmcloud sat storage assignment ls --service-cluster-id CLUSTER。
要以位置管理员身份列出服务群集的所有分配:ibmcloud sat storage assignment ls --location LOCATION --service-cluster-id CLUSTER。
要列出配置的所有分配:ibmcloud sat storage assignment ls --config CONFIG。
ibmcloud sat storage assignment ls [--output OUTPUT] [-q] (--cluster CLUSTER | --config CONFIG | --location LOCATION | --service-cluster-id CLUSTER)
命令选项
--cluster CLUSTER
,-c CLUSTER
- 指定用于分配的 Satellite 集群的标识。 要获取群集 ID,请运行
ibmcloud oc cluster ls --provider satellite
。 --config CONFIG
- 指定 Satellite 存储配置的名称或标识。 要列出可用的存储配置,请运行
ibmcloud sat storage config ls
。 --location LOCATION
- 指定 Satellite 位置的名称。 要列出可用位置,请运行
ibmcloud sat location ls
。 此选项不能由服务管理员使用。 --output OUTPUT
- 以提供的格式打印命令输出。 接受的值:
json
-q
- 不显示每日消息或更新提示。
--service-cluster-id CLUSTER
- 指定用于分配的服务集群的标识。 要查找服务群集 ID,请运行
ibmcloud sat service ls --location <location>
。
ibmcloud sat storage assignment patch
将存储器配置更改应用于关联的分配。
ibmcloud sat storage assignment patch --assignment ASSIGNMENT [-f] [-q]
命令选项
--assignment ASSIGNMENT
- 指定 Satellite 存储器分配的标识。 要列出可用分配,请运行
ibmcloud sat storage assignment ls
。 -f
- 强制此命令运行,而不显示用户提示。
-q
- 不显示每日消息或更新提示。
ibmcloud sat storage assignment rm
移除 Satellite 存储器分配。 从 Satellite 位置的所有集群中删除 Kubernetes 资源,但是保留配置。
ibmcloud sat storage assignment rm --assignment ASSIGNMENT [-f] [-q]
命令选项
--assignment ASSIGNMENT
- 指定 Satellite 存储器分配的标识。 要查找任务,请运行
ibmcloud sat storage assignment ls
。 -f
- 强制此命令运行,而不显示用户提示。
-q
- 不显示每日消息或更新提示。
ibmcloud sat storage assignment update
更新 Satellite 存储器分配。
ibmcloud sat storage assignment update --assignment ASSIGNMENT [-f] [--group GROUP ...] [--name NAME] [-q]
命令选项
--assignment ASSIGNMENT
- 指定 Satellite 存储器分配的标识。
-f
- 强制此命令运行,而不显示用户提示。
--group GROUP
,-g GROUP
- 指定用于分配的新集群组。 要列出可用的组,请运行
ibmcloud sat group ls
。 --name NAME
- 为 Satellite 存储器分配提供新名称。
-q
- 不显示每日消息或更新提示。
ibmcloud sat storage config class add
创建定制 Satellite 存储类。
ibmcloud sat storage config class add --config-name NAME --name NAME --param PARAM [--param PARAM ...] [-q]
命令选项
--config-name NAME
- 指定定制存储类的存储配置的名称。 要列出 Satellite 存储配置,请运行
ibmcloud sat storage config ls
。 --name NAME
- 提供定制存储类的名称。
--param PARAM
,-p PARAM
- 为存储类参数指定
key=value
对。 要查看存储模板中的存储类参数,请运行ibmcloud sat storage template get
。 -q
- 不显示每日消息或更新提示。
ibmcloud sat storage config class get
获取 Satellite 存储类的详细信息。
ibmcloud sat storage config class get --class CLASS --config CONFIG [--output OUTPUT] [-q]
命令选项
--class CLASS
- 指定 Satellite 存储类的名称。
--config CONFIG
- 指定 Satellite 存储配置的名称或标识。 要列出 Satellite 存储配置,请运行
ibmcloud sat storage config ls
。 --output OUTPUT
- 以提供的格式打印命令输出。 接受的值:
json
-q
- 不显示每日消息或更新提示。
ibmcloud sat storage config class ls
列出 Satellite 存储器配置中的存储类
ibmcloud sat storage config class ls --config CONFIG [--output OUTPUT] [-q] [--show-params]
命令选项
--config CONFIG
- 指定 Satellite 存储配置的名称或标识。 要列出 Satellite 存储配置,请运行
ibmcloud sat storage config ls
。 --output OUTPUT
- 以提供的格式打印命令输出。 接受的值:
json
-q
- 不显示每日消息或更新提示。
--show-params
- 包含此选项以列出所有存储类参数详细信息。
ibmcloud sat storage config create
创建 Satellite 存储器配置,以在集群中安装存储器驱动程序。
ibmcloud sat storage config create --location LOCATION --name NAME --template-name NAME [--param PARAM ...] [-q] [--template-version VERSION]
命令选项
--location LOCATION
- 输入存储配置的位置的标识或名称。 要查找可用位置,请运行
ibmcloud sat location ls
。 --name NAME
- 指定存储器配置的名称。
--param PARAM
,-p PARAM
- 为配置参数指定
key=value
对。 要查看存储模板中的配置参数,请运行ibmcloud sat storage template get
。 -q
- 不显示每日消息或更新提示。
--template-name NAME
- 指定 Satellite 存储器配置模板名称。 要列出可用的存储配置模板,请运行
ibmcloud sat storage template ls
。 --template-version VERSION
- 指定 Satellite 存储器配置模板版本。 如果不包含此选项,那么将使用缺省版本。 要列出可用的存储配置模板,请运行
ibmcloud sat storage template ls
。
ibmcloud sat storage config get
获取 Satellite 存储器配置的详细信息。
ibmcloud sat storage config get --config CONFIG [--output OUTPUT] [-q]
命令选项
--config CONFIG
- 指定 Satellite 存储配置的名称或标识。 要列出可用配置,请运行
ibmcloud sat storage config ls
。 --output OUTPUT
- 以提供的格式打印命令输出。 接受的值:
json
-q
- 不显示每日消息或更新提示。
ibmcloud sat storage config ls
列出您的 IBM Cloud 帐户中的 Satellite 存储器配置。
ibmcloud sat storage config ls [--location LOCATION] [--output OUTPUT] [-q]
命令选项
--location LOCATION
- 指定包含要列示的配置的位置的标识或名称。 要查找可用位置,请运行
ibmcloud sat location ls
。 --output OUTPUT
- 以提供的格式打印命令输出。 接受的值:
json
-q
- 不显示每日消息或更新提示。
ibmcloud sat storage config param set
设置 Satellite 存储配置的配置和私钥参数。
ibmcloud sat storage config param set --config CONFIG --param PARAM [--param PARAM ...] [--apply] [-f] [-q]
命令选项
--apply
- 将最新的 Satellite 存储配置版本应用于某个配置的所有分配。 要列出配置的分配,请运行
ibmcloud sat storage assignment ls --config CONFIG
。 --config CONFIG
- 指定存储器配置的名称或标识。 要列出 Satellite 存储配置,请运行
ibmcloud sat storage config ls
。 -f
- 强制此命令运行,而不显示用户提示。
--param PARAM
,-p PARAM
- 为配置参数指定
key=value
对。 要查看存储模板中的配置参数,请运行ibmcloud sat storage template get
。 -q
- 不显示每日消息或更新提示。
ibmcloud sat storage config patch
将最新补丁更新应用于 Satellite 存储配置。 补丁更新包含同一主版本中的漏洞修复和错误修订。
ibmcloud sat storage config patch --config CONFIG [-f] [--include-assignments] [-q]
命令选项
--config CONFIG
- 指定 Satellite 存储配置的名称或标识。 要列出可用配置,请运行
ibmcloud sat storage config ls
。 -f
- 强制此命令运行,而不显示用户提示。
--include-assignments
- 包含此选项可将存储配置的分配修补为最新的配置版本。
-q
- 不显示每日消息或更新提示。
ibmcloud sat storage config rm
移除 Satellite 存储器配置
ibmcloud sat storage config rm --config CONFIG [-f] [--include-assignments] [-q]
命令选项
--config CONFIG
- 指定 Satellite 存储配置的名称或标识。 要列出可用配置,请运行
ibmcloud sat storage config ls
。 -f
- 强制此命令运行,而不显示用户提示。
--include-assignments
- 包含此选项以除去存储器配置以及任何关联的分配。
-q
- 不显示每日消息或更新提示。
ibmcloud sat storage template get
获取 Satellite 存储器模板的详细信息
ibmcloud sat storage template get --name NAME --version VERSION [--output OUTPUT] [-q]
命令选项
--name NAME
- 指定存储器模板名称。 要列出可用的存储模板,请运行
ibmcloud sat storage template ls
。 --output OUTPUT
- 以提供的格式打印命令输出。 接受的值:
json
-q
- 不显示每日消息或更新提示。
--version VERSION
- 指定存储器模板版本。 要列出可用的存储模板,请运行
ibmcloud sat storage template ls
。
ibmcloud sat storage template ls
列出可用的 Satellite 存储器模板。
ibmcloud sat storage template ls [-q]
命令选项
-q
- 不显示每日消息或更新提示。
ibmcloud sat subscription create
为集群创建 Satellite 预订。 创建预订后,关联的 Satellite 配置版本将自动部署到预订的集群。
ibmcloud sat subscription create --config CONFIG --group GROUP [--group GROUP ...] --name NAME [-q] (--auth-required --gitref GITREF --gitref-type TYPE --path PATH --repository REPOSITORY | --version VERSION)
命令选项
--auth-required
- 提供连接到远程存储库所需的认证私钥。 请参阅 https://ibm.biz/sat-config-private-repo 以获取详细信息。 策略:GitOps。
--config CONFIG
- 指定要用于预订的配置的名称。 要查找可用配置,请运行
ibmcloud sat config ls
。 --gitref GITREF
- 指定要用于 Satellite 预订的 GitRef。 策略:GitOps。
--gitref-type TYPE
- 指示要用于 Satellite 预订的 GitRef 的类型。 策略:GitOps。 允许的值 :branch,commit,tag 和 release
--group GROUP
,-g GROUP
- 指定要预订配置的集群组的名称或标识。 要查找可用的群集组,请运行
ibmcloud sat group ls
。 --name NAME
- 输入预订的名称。
--path PATH
- 提供远程存储库中要用于 Satellite 预订的存储库文件或发布资产的路径。 策略:GitOps。
-q
- 不显示每日消息或更新提示。
--repository REPOSITORY
- 指定要用于预订的远程存储库的 URL。 策略:GitOps。
--version VERSION
- 指示要用于预订的现有配置版本的名称或标识。 要查找版本,请运行
ibmcloud sat config get --config <configuration_name_or_ID>
。 策略:直接上载。
ibmcloud sat subscription get
获取 Satellite 预订的详细信息。
ibmcloud sat subscription get --subscription SUBSCRIPTION [--output OUTPUT] [-q]
命令选项
--output OUTPUT
- 以提供的格式打印命令输出。 接受的值:
json
-q
- 不显示每日消息或更新提示。
--subscription SUBSCRIPTION
- 输入 Satellite 订阅的名称或 ID。 要查找订阅,请运行
ibmcloud sat subscription ls
。
ibmcloud sat subscription identity set
更新 Satellite 订阅,以便使用您的身份管理资源。
ibmcloud sat subscription identity set --subscription SUBSCRIPTION [-f] [-q]
命令选项
-f
- 强制此命令运行,而不显示用户提示。
-q
- 不显示每日消息或更新提示。
--subscription SUBSCRIPTION
- 指定 Satellite 预订的名称或标识。 要列出订阅列表,请运行
ibmcloud sat subscription ls
。
ibmcloud sat subscription ls
列出 IBM Cloud 帐户中的所有 Satellite 预订。
ibmcloud sat subscription ls [--cluster CLUSTER] [--output OUTPUT] [-q]
命令选项
--cluster CLUSTER
,-c CLUSTER
- 指定 Satellite 集群名称或标识。 要查找已注册的群集,请运行
ibmcloud sat cluster ls
。 --output OUTPUT
- 以提供的格式打印命令输出。 接受的值:
json
-q
- 不显示每日消息或更新提示。
ibmcloud sat subscription rm
移除 Satellite 预订。 Kubernetes 资源不再部署到集群。
ibmcloud sat subscription rm --subscription SUBSCRIPTION [-f] [-q]
命令选项
-f
- 强制此命令运行,而不显示用户提示。
-q
- 不显示每日消息或更新提示。
--subscription SUBSCRIPTION
- 提供 Satellite 预订的名称或标识。 要列出订阅列表,请运行
ibmcloud sat subscription ls
。
ibmcloud sat subscription update
更新 Satellite 预订。
ibmcloud sat subscription update --subscription SUBSCRIPTION [-f] [--group GROUP] [--name NAME] [-q] (--auth-required --gitref GITREF --gitref-type TYPE --path PATH --repository REPOSITORY | --version VERSION)
命令选项
--auth-required
- 提供连接到远程存储库所需的认证私钥。 策略:GitOps。
-f
- 强制此命令运行,而不显示用户提示。
--gitref GITREF
- 指定要用于 Satellite 预订的 GitRef。 策略:GitOps。
--gitref-type TYPE
- 指示要用于此 Satellite 预订的 GitRef 的类型。 策略:GitOps。 允许的值 :branch,commit,tag 和 release
--group GROUP
,-g GROUP
- 指定要预订配置的新集群组。
--name NAME
- 提供 Satellite 预订的新名称。
--path PATH
- 指示远程存储库中要用于 Satellite 预订的存储库文件或发行版资产的路径。 策略:GitOps。
-q
- 不显示每日消息或更新提示。
--repository REPOSITORY
- 提供要用于 Satellite 预订的远程存储库的 URL。 策略:GitOps。
--subscription SUBSCRIPTION
- 指定 Satellite 预订的名称或标识。 要列出订阅列表,请运行
ibmcloud sat subscription ls
。 --version VERSION
- 指示要用于 Satellite 预订的现有配置版本。 策略:直接上载。