Satellite コマンドの CLI リファレンス
Satellite ロケーションの作成と管理を自動化する場合には、以下のコマンドを参照してください。
- CLI をインストールするには、 CLI のインストール を参照してください。
- すべての IBM Cloud Satellite コマンドの上位マップを表示するには、 CLI マップ を参照してください。
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。 コネクター ID を確認するには、
ibmcloud sat connector lsを実行します。 --endpoint ENDPOINT- この ACL を有効にするエンドポイントの名前または ID。
--location LOCATION- Satellite ロケーションの名前または ID。 場所の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
1つ以上の有効なエンドポイントを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。 コネクター ID を確認するには、
ibmcloud sat connector lsを実行します。 --endpoint ENDPOINT- この ACL を有効にするエンドポイントの名前または ID。
--location LOCATION- Satellite ロケーションの名前または ID。 場所の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。 コネクター ID を確認するには、
ibmcloud sat connector lsを実行します。 --location LOCATION- Satellite ロケーションの名前または ID。 場所のIDまたは名前を見つけるには、
ibmcloud sat location lsを実行する。 --output OUTPUT- 指定された形式でコマンド出力を表示します。 受け入れられる値:
json -q- その日のメッセージを表示せず、リマインダーも更新しません。
ibmcloud sat acl endpoint rm
ACL から 1 つ以上の有効なエンドポイントを削除します。
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。 コネクター ID を確認するには、
ibmcloud sat connector lsを実行します。 --endpoint ENDPOINT- この ACL に対して無効にするエンドポイントの名前または ID。
--location LOCATION- Satellite ロケーションの名前または ID。 場所の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。 コネクター ID を確認するには、
ibmcloud sat connector lsを実行します。 --location LOCATION- Satellite ロケーションの名前または ID。 場所の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。 コネクター ID を確認するには、
ibmcloud sat connector lsを実行します。 --location LOCATION- Satellite ロケーションの名前または ID。 場所の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。 コネクター ID を確認するには、
ibmcloud sat connector lsを実行します。 --location LOCATION- Satellite ロケーションの名前または ID。 場所のIDまたは名前を見つけるには、
ibmcloud sat location lsを実行する。 -q- その日のメッセージを表示せず、リマインダーも更新しません。
ibmcloud sat acl subnet add
ACLに1つ以上のサブネットを追加する。
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。 コネクター ID を確認するには、
ibmcloud sat connector lsを実行します。 --location LOCATION- Satellite ロケーションの名前または ID。 場所の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から1つまたは複数のサブネットを削除する。
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。 コネクター ID を確認するには、
ibmcloud sat connector lsを実行します。 --location LOCATION- Satellite ロケーションの名前または ID。 場所の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。 コネクター ID を確認するには、
ibmcloud sat connector lsを実行します。 --location LOCATION- Satellite ロケーションの名前または ID。 場所のIDまたは名前を見つけるには、
ibmcloud sat location lsを実行する。 --name NAME- ACLの新しい名前。
-q- その日のメッセージを表示せず、リマインダーも更新しません。
ibmcloud sat agent attach
特定のプラットフォームのSatelliteコネクタ・エージェントを取得します。 Windows 用のエージェント .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 コネクターの ID です。
--output OUTPUT- 指定された形式でコマンド出力を表示します。 受け入れられる値:
json -q- その日のメッセージを表示せず、リマインダーも更新しません。
ibmcloud sat cluster get
登録済みクラスターの詳細を取得します。
ibmcloud sat cluster get --cluster CLUSTER [--output OUTPUT] [-q]
コマンド・オプション
--cluster CLUSTER,-c CLUSTER- クラスター名または ID を指定します。 登録されているクラスターをリストするには、
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- クラスター ID で登録済みクラスターをフィルタリングします。
--limit LIMIT- 返されるクラスターの数を制限します。
--output OUTPUT- 指定された形式でコマンド出力を表示します。 受け入れられる値:
json -q- その日のメッセージを表示せず、リマインダーも更新しません。
ibmcloud sat cluster register
Satellite 構成でクラスタを登録するための kubectl コマンドを取得します。 クラスターにログインし、以下のコマンドを実行して 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- クラスター名または ID を指定します。 登録されているクラスターをリストするには、
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 構成の名前または ID を指定します。 使用可能な構成をリストするには、
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 構成の名前または ID を指定します。 使用可能な構成をリストするには、
ibmcloud sat config lsを実行します。 --name NAME- Satellite 構成の新しい名前を指定します。
-q- その日のメッセージを表示せず、リマインダーも更新しません。
ibmcloud sat config rm
Satellite 構成を削除します。 最初に、関連付けられているすべてのサブスクリプションを削除する必要があります。 すべてのバージョンが削除されます。 保持するリソース定義をすべてバックアップします。
ibmcloud sat config rm --config CONFIG [-f] [-q]
コマンド・オプション
--config CONFIG- Satellite 構成の名前または ID を指定します。 使用可能な構成をリストするには、
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 構成の名前または ID を指定します。 使用可能な構成をリストするには、
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 構成の名前または ID を指定します。 使用可能な構成をリストするには、
ibmcloud sat config lsを実行します。 --output OUTPUT- 指定された形式でコマンド出力を表示します。 受け入れられる値:
json -q- その日のメッセージを表示せず、リマインダーも更新しません。
--save-config- 構成バージョンをダウンロードして一時ファイルに保存します。
--version VERSION- Satellite 構成バージョンの名前または ID を指定します。 構成内のバージョンをリストするには、
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 構成の名前または ID を指定します。 使用可能な構成をリストするには、
ibmcloud sat config lsを実行します。 -f- ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。
-q- その日のメッセージを表示せず、リマインダーも更新しません。
--version VERSION- Satellite 構成バージョンの名前または ID を示します。 バージョンを一覧表示するには、
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 コネクターの ID です。
--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 コネクターの ID です。
-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。 コネクター ID を確認するには、
ibmcloud sat connector lsを実行します。 --endpoint ENDPOINT- エンドポイントの名前または ID を指定します。 すべてのエンドポイントを一覧表示するには、
ibmcloud sat endpoint lsを実行する。 --location LOCATION- Satellite ロケーションの名前または ID。 場所のIDまたは名前を見つけるには、
ibmcloud sat location lsを実行する。 --output OUTPUT- 指定された形式でコマンド出力を表示します。 受け入れられる値:
json -q- その日のメッセージを表示せず、リマインダーも更新しません。
ibmcloud sat endpoint authn rotate
既存の認証証明書を新しいものに置き換える。 要求フローには 2 つの TLS 接続があります。 source オプションは、ソースと Connector サービス間の 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。 コネクター 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- エンドポイントの名前または ID を指定します。 すべてのエンドポイントを一覧表示するには、
ibmcloud sat endpoint lsを実行する。 --location LOCATION- Satellite ロケーションの名前または ID。 場所のIDまたは名前を見つけるには、
ibmcloud sat location lsを実行する。 -q- その日のメッセージを表示せず、リマインダーも更新しません。
--source-ca-cert-file FILE- source-tls-mode が mutual の場合に、ソース・クライアントの証明書を検証するために使用されるトラステッド CA 証明書またはチェーン。 例えば、
myCA.pemなどです。 --source-cert-file FILE- ソース・クライアントに提示するサーバー証明書。 例えば、
myCert.pemなどです。 --source-key-file FILE- サーバー証明書の暗号化に使用されるサーバー秘密鍵。 例えば、
myKey.pemなどです。
ibmcloud sat endpoint authn set
エンドポイントの認証設定を行う。 要求フローには 2 つの TLS 接続があります。 source オプションは、ソースと Connector サービス間の 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。 コネクター 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- エンドポイントの名前または ID を指定します。 すべてのエンドポイントを一覧表示するには、
ibmcloud sat endpoint lsを実行する。 --location LOCATION- Satellite ロケーションの名前または ID。 場所のIDまたは名前を見つけるには、
ibmcloud sat location lsを実行する。 -q- その日のメッセージを表示せず、リマインダーも更新しません。
--source-ca-cert-file FILE- source-tls-mode が mutual の場合に、ソース・クライアントの証明書を検証するために使用されるトラステッド 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。 コネクター ID を確認するには、
ibmcloud sat connector lsを実行します。 --dest-hostname HOSTNAME- 接続先の宛先の完全修飾ドメイン名 (FQDN) または外部からアクセス可能な IP アドレスを指定します。
cloudエンドポイントの場合、この値はパブリック IP アドレス、またはプライベート・クラウド・サービスのエンドポイントなど、 IBM Cloud 内でアクセス可能なプライベート IP アドレスに解決する必要があります。locationエンドポイントでは、この値は Satellite ロケーションのコントロールプレーンホスト、または Satellite Connector のエージェントが実行される場所から解決され、到達可能でなければならない。 --dest-port PORT- 宛先リソースが着信要求を listen するポートを指定します。 ポートが宛先のプロトコルと一致していることを確認してください。
--dest-protocol PROTOCOL- 宛先のプロトコルを指定します。 このオプションを指定しない場合、宛先プロトコルはソース・プロトコルから継承されます。 受け入れられる値:
TCP、TLS --dest-type TYPE- IBM Cloud (
cloud) または Satellite (location) のどちらかで、デスティネーション リソースの実行場所を指定します。使用可能なオプション：場所、クラウド --idle-timeout-seconds SECONDS- 宛先へのアクティブな接続のタイムアウト間隔を秒単位で指定します。 タイムアウトが宛先サービスおよびプロトコルの
keep-alive設定と互換性があることを確認してください。 --location LOCATION- Satellite ロケーションの名前または ID。 場所のIDまたは名前を見つけるには、
ibmcloud sat location lsを実行する。 --name NAME- エンドポイントの名前を指定します。
--output OUTPUT- 指定された形式でコマンド出力を表示します。 受け入れられる値:
json -q- その日のメッセージを表示せず、リマインダーも更新しません。
--sni SNItlsまたはhttpsソース・プロトコルを指定し、TLS ハンドシェイクに別のホスト名を追加したい場合は、サーバー名インジケータを指定する。--source-protocol PROTOCOL- ソースが宛先リソースを接続するために使用するプロトコルを指定します。 http://ibm.biz/endpoint-protocols を参照してください。 利用可能なオプション：TCP、TLS、 HTTP、 HTTPS、 HTTP-tunnel
ibmcloud sat endpoint disable
エンドポイントを無効にする。
ibmcloud sat endpoint disable --endpoint ENDPOINT [-f] [-q] (--connector-id ID | --location LOCATION)
コマンド・オプション
--connector-id ID- Satellite コネクタの ID。 コネクター ID を確認するには、
ibmcloud sat connector lsを実行します。 --endpoint ENDPOINT- エンドポイントの名前または ID を指定します。 すべてのエンドポイントを一覧表示するには、
ibmcloud sat endpoint ls (--connector-id ID | --location LOCATION)を実行する。 -f- ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。
--location LOCATION- Satellite ロケーションの名前または ID。 場所の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。 コネクター ID を確認するには、
ibmcloud sat connector lsを実行します。 --endpoint ENDPOINT- エンドポイントの名前または ID を指定します。 すべてのエンドポイントを一覧表示するには、
ibmcloud sat endpoint ls (--connector-id ID | --location LOCATION)を実行する。 -f- ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。
--location LOCATION- Satellite ロケーションの名前または ID。 場所の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。 コネクター ID を確認するには、
ibmcloud sat connector lsを実行します。 --endpoint ENDPOINT- エンドポイントの名前または ID を指定します。 すべてのエンドポイントを一覧表示するには、
ibmcloud sat endpoint ls (--connector-id ID | --location LOCATION)を実行する。 --location LOCATION- Satellite ロケーションの名前または ID。 場所の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。 コネクター ID を確認するには、
ibmcloud sat connector lsを実行します。 --location LOCATION- Satellite ロケーションの名前または ID。 場所の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。 コネクター ID を確認するには、
ibmcloud sat connector lsを実行します。 --endpoint ENDPOINT- エンドポイントの名前または ID を指定します。 すべてのエンドポイントを一覧表示するには、
ibmcloud sat endpoint ls (--connector-id ID | --location LOCATION)を実行する。 --location LOCATION- Satellite ロケーションの名前または ID。 場所の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。 コネクター ID を確認するには、
ibmcloud sat connector lsを実行します。 --dest-hostname HOSTNAME- 接続先の宛先の完全修飾ドメイン名 (FQDN) または外部からアクセス可能な IP アドレスを指定します。
cloudエンドポイントの場合、この値はパブリック IP アドレス、またはプライベート・クラウド・サービスのエンドポイントなど、 IBM Cloud 内でアクセス可能なプライベート IP アドレスに解決する必要があります。locationエンドポイントでは、この値は Satellite ロケーションのコントロールプレーンホスト、または Satellite Connector のエージェントが実行される場所から解決され、到達可能でなければならない。 --dest-port PORT- 宛先リソースが着信要求を listen するポートを指定します。 ポートが宛先のプロトコルと一致していることを確認してください。
--dest-protocol PROTOCOL- 宛先のプロトコルを指定します。 このオプションを指定しない場合、宛先プロトコルはソース・プロトコルから継承されます。 受け入れられる値:
TCP、TLS --endpoint ENDPOINT- エンドポイントの名前または ID を指定します。 すべてのエンドポイントを一覧表示するには、
ibmcloud sat endpoint ls (--connector-id ID | --location LOCATION)を実行する。 --idle-timeout-seconds SECONDS- 宛先へのアクティブな接続のタイムアウト間隔を秒単位で指定します。 タイムアウトが宛先サービスおよびプロトコルの
keep-alive設定と互換性があることを確認してください。 --location LOCATION- Satellite ロケーションの名前または ID。 場所のIDまたは名前を見つけるには、
ibmcloud sat location lsを実行する。 --name NAME- エンドポイントの新しい名前を指定します。
-q- その日のメッセージを表示せず、リマインダーも更新しません。
--sni SNItlsまたは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。 コネクター ID を確認するには、
ibmcloud sat connector lsを実行します。 --endpoint ENDPOINT- この ACL を有効にするエンドポイントの名前または ID。
--location LOCATION- Satellite ロケーションの名前または ID。 場所の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 を使用する] 1つ以上の有効なエンドポイントを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。 コネクター ID を確認するには、
ibmcloud sat connector lsを実行します。 --endpoint ENDPOINT- この ACL を有効にするエンドポイントの名前または ID。
--location LOCATION- Satellite ロケーションの名前または ID。 場所の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。 コネクター ID を確認するには、
ibmcloud sat connector lsを実行します。 --location LOCATION- Satellite ロケーションの名前または ID。 場所のIDまたは名前を見つけるには、
ibmcloud sat location lsを実行する。 --output OUTPUT- 指定された形式でコマンド出力を表示します。 受け入れられる値:
json -q- その日のメッセージを表示せず、リマインダーも更新しません。
ibmcloud sat experimental acl endpoint rm
[2024-10-01に活動停止！ 代わりに ibmcloud sat acl endpoint rm を使用する] ACL から 1 つ以上の有効なエンドポイントを削除します。
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。 コネクター ID を確認するには、
ibmcloud sat connector lsを実行します。 --endpoint ENDPOINT- この ACL に対して無効にするエンドポイントの名前または ID。
--location LOCATION- Satellite ロケーションの名前または ID。 場所の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。 コネクター ID を確認するには、
ibmcloud sat connector lsを実行します。 --location LOCATION- Satellite ロケーションの名前または ID。 場所の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。 コネクター ID を確認するには、
ibmcloud sat connector lsを実行します。 --location LOCATION- Satellite ロケーションの名前または ID。 場所の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。 コネクター ID を確認するには、
ibmcloud sat connector lsを実行します。 --location LOCATION- Satellite ロケーションの名前または ID。 場所のIDまたは名前を見つけるには、
ibmcloud sat location lsを実行する。 -q- その日のメッセージを表示せず、リマインダーも更新しません。
ibmcloud sat experimental acl subnet add
[2024-10-01に活動停止！ 代わりに ibmcloud sat acl subnet add を使用する] 1つ以上のサブネットを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。 コネクター ID を確認するには、
ibmcloud sat connector lsを実行します。 --location LOCATION- Satellite ロケーションの名前または ID。 場所の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 から 1 つ以上のサブネットを削除します。
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。 コネクター ID を確認するには、
ibmcloud sat connector lsを実行します。 --location LOCATION- Satellite ロケーションの名前または ID。 場所の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。 コネクター ID を確認するには、
ibmcloud sat connector lsを実行します。 --location LOCATION- Satellite ロケーションの名前または ID。 場所のIDまたは名前を見つけるには、
ibmcloud sat location lsを実行する。 --name NAME- ACLの新しい名前。
-q- その日のメッセージを表示せず、リマインダーも更新しません。
ibmcloud sat experimental agent attach
[2024-09-01に活動停止！ ibmcloud sat agent attach の代わりに] Satellite コネクタ・エージェントを特定のプラットフォーム用に取得します。 Windows 用のエージェント .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 コネクターの ID です。
--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 コネクターの ID です。
--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 コネクターの ID です。
-f- ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。
-q- その日のメッセージを表示せず、リマインダーも更新しません。
ibmcloud sat experimental endpoint authn get
[2024-10-01に活動停止！ 代わりに ibmcloud sat endpoint authn get を使用] Get the authentication settings for an endpoint.
ibmcloud sat experimental endpoint authn get --endpoint ENDPOINT [--output OUTPUT] [-q] (--connector-id ID | --location LOCATION)
コマンド・オプション
--connector-id ID- Satellite コネクタの ID。 コネクター ID を確認するには、
ibmcloud sat connector lsを実行します。 --endpoint ENDPOINT- エンドポイントの名前または ID を指定します。 すべてのエンドポイントを一覧表示するには、
ibmcloud sat endpoint lsを実行する。 --location LOCATION- Satellite ロケーションの名前または ID。 場所のIDまたは名前を見つけるには、
ibmcloud sat location lsを実行する。 --output OUTPUT- 指定された形式でコマンド出力を表示します。 受け入れられる値:
json -q- その日のメッセージを表示せず、リマインダーも更新しません。
ibmcloud sat experimental endpoint authn rotate
[2024-10-01に活動停止！ 代わりに ibmcloud sat endpoint authn rotate を使用する] 既存の認証証明書を新しいものに置き換える。 要求フローには 2 つの TLS 接続があります。 source オプションは、ソースと Connector サービス間の 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。 コネクター 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- エンドポイントの名前または ID を指定します。 すべてのエンドポイントを一覧表示するには、
ibmcloud sat endpoint lsを実行する。 --location LOCATION- Satellite ロケーションの名前または ID。 場所のIDまたは名前を見つけるには、
ibmcloud sat location lsを実行する。 -q- その日のメッセージを表示せず、リマインダーも更新しません。
--source-ca-cert-file FILE- source-tls-mode が mutual の場合に、ソース・クライアントの証明書を検証するために使用されるトラステッド 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 を使います] エンドポイントの認証設定を行います。 要求フローには 2 つの TLS 接続があります。 source オプションは、ソースと Connector サービス間の 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。 コネクター 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- エンドポイントの名前または ID を指定します。 すべてのエンドポイントを一覧表示するには、
ibmcloud sat endpoint lsを実行する。 --location LOCATION- Satellite ロケーションの名前または ID。 場所のIDまたは名前を見つけるには、
ibmcloud sat location lsを実行する。 -q- その日のメッセージを表示せず、リマインダーも更新しません。
--source-ca-cert-file FILE- source-tls-mode が mutual の場合に、ソース・クライアントの証明書を検証するために使用されるトラステッド 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 構成に登録する必要があります。
ibmcloud sat group attach --cluster CLUSTER [--cluster CLUSTER ...] --group GROUP [-q]
コマンド・オプション
--cluster CLUSTER,-c CLUSTER- クラスター名またはクラスター ID を指定します。 登録されているクラスターをリストするには、
ibmcloud sat cluster lsを実行します。 --group GROUP,-g GROUP- Satellite クラスター・グループの名前または ID を指定します。 使用可能なクラスター・グループをリストするには、
ibmcloud sat group lsを実行します。 -q- その日のメッセージを表示せず、リマインダーも更新しません。
ibmcloud sat group create
クラスター・グループを作成します。 その後、クラスター・グループを Satellite 構成にサブスクライブできます。
ibmcloud sat group create --name NAME [--cluster CLUSTER ...] [-q]
コマンド・オプション
--cluster CLUSTER,-c CLUSTER- クラスター・グループに追加するクラスターの名前または ID を指定します。 登録されているクラスターをリストするには、
ibmcloud sat cluster lsを実行します。 --name NAME- Satellite クラスター・グループの名前を指定します。
-q- その日のメッセージを表示せず、リマインダーも更新しません。
ibmcloud sat group detach
Satellite クラスター・グループから 1 個以上のクラスターを削除し、グループのサブスクリプションによって管理されていた Kubernetes リソースを削除します。
ibmcloud sat group detach --cluster CLUSTER [--cluster CLUSTER ...] --group GROUP [-f] [-q]
コマンド・オプション
--cluster CLUSTER,-c CLUSTER- クラスター名またはクラスター ID を指定します。 クラスタグループ内のクラスタを一覧表示するには、
ibmcloud sat group get --group <cluster_group_name_or_ID>を実行します。 -f- ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。
--group GROUP,-g GROUP- Satellite クラスター・グループの名前または ID を指定します。 使用可能なクラスター・グループをリストするには、
ibmcloud sat group lsを実行します。 -q- その日のメッセージを表示せず、リマインダーも更新しません。
ibmcloud sat group get
Satellite クラスター・グループの詳細情報を取得します。
ibmcloud sat group get --group GROUP [--output OUTPUT] [-q]
コマンド・オプション
--group GROUP,-g GROUP- Satellite クラスター・グループの名前または ID を指定します。 登録されているクラスターをリストするには、
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 クラスター・グループの名前または ID を指定します。 使用可能なクラスター・グループをリストするには、
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- ホストの割り当て先となるクラスターの名前または ID。 利用可能なクラスタを一覧表示するには、
ibmcloud sat cluster lsを実行する。 クラスターが指定されない場合、ホストは自動的に Satellite コントロール・プレーンに割り当てられます。 --host HOST- 割り当てるホストの名前または ID。 ラベルに基づいてホストを自動的に割り当てるには、このオプションを含めないでください。 ホスト 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。 場所のIDまたは名前を見つけるには、
ibmcloud sat location lsを実行する。 -q- その日のメッセージを表示せず、リマインダーも更新しません。
--worker-pool POOL,-p POOL- ホストを割り当てるクラスター内のワーカー・プールの名前または ID。 ワーカー・プールが指定されていない場合、ホストはデフォルトのワーカー・プールに割り当てられます。
--zone ZONE- ホストの割り当て先となるゾーンの名前または ID。 利用可能なゾーンを見つけるには、
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。 場所の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。 ホストIDを調べるには、
ibmcloud sat host ls <location_ID_or_name>を実行する。 --location LOCATION- Satellite ロケーションの名前または ID。 場所の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。 場所の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- 削除するホストの名前または ID。
--location LOCATION- Satellite ロケーションの名前または ID。 場所の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- 割り当てるホストの名前または ID。 ラベルに基づいてホストを自動的に割り当てるには、このオプションを含めないでください。
--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。 場所のIDまたは名前を見つけるには、
ibmcloud sat location lsを実行する。 -q- その日のメッセージを表示せず、リマインダーも更新しません。
--zone ZONE- ホストを関連付けるゾーンの名前または ID。 クラスターなどのリソースに割り当てられているホストのゾーンを変更することはできません。 最初にそれらを割り当て解除する必要があります。 利用可能なゾーンをリストアップするには、
ibmcloud sat location get --location <ID>を実行する。
ibmcloud sat key ls
IBM Cloud アカウント内のすべての Satellite 構成キーをリストします。
ibmcloud sat key ls [--output OUTPUT] [-q]
コマンド・オプション
--output OUTPUT- 指定された形式でコマンド出力を表示します。 受け入れられる値:
json -q- その日のメッセージを表示せず、リマインダーも更新しません。
ibmcloud sat key rm
Satellite 構成キーを削除します。 このキーをまだ使用しているクラスターは、Satellite 構成に接続できません。
ibmcloud sat key rm --key KEY [-f] [-q]
コマンド・オプション
-f- ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。
--key KEY- Satellite 構成キーの名前または ID。
-q- その日のメッセージを表示せず、リマインダーも更新しません。
ibmcloud sat key rotate
管理対象クラスターが Satellite Config に接続するために使用する新しい鍵を生成します。
ibmcloud sat key rotate --name NAME [-f] [-q]
コマンド・オプション
-f- ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。
--name NAME- 新規 Satellite 構成鍵の名前。
-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- ロケーションのゾーンを指定します。 高可用性を実現するには、
--ha-zone ZONE1_NAME --ha-zone ZONE2_NAME --ha-zone ZONE3_NAMEのように3つのゾーンを指定してください。 ゾーンの名前は、ホストを作成する予定のインフラストラクチャー・プロバイダー内の対応するゾーンの名前と正確に一致している必要があります。 --managed-from REGION- Satellite ロケーションの管理元となる IBM Cloud リージョンを選択します。 パフォーマンスを向上させるために、オンプレミス・データ・センターに近い地域を選択します。 https://ibm.biz/sat-region を参照してください。
--name NAME- Satellite ロケーションの名前を指定します。 ロケーション名はアルファベットで始まり、アルファベット、数字、ピリオド(.)、ハイフン(-)を含むことができ、36文字未満でなければならない。 他の場所が削除されても、名前を再使用しないでください。
--physical-address ADDRESS- Satelliteの場所の物理アドレス。
--pod-network-interface-selection SELECTION- 内部ポッド・ネットワークのノード・ネットワーク・インターフェースを選択する方法。 このオプションは、
--coreos-enabledオプションで Red Hat CoreOS も有効にしている場合にのみ使用できる。 直接の URL またはIPアドレスを提供するには、can-reach=<url>またはcan-reach=<ip_address>を指定します。 ネットワーク・インターフェースを選択するには、interface=<network_interface>を指定します。 --pod-subnet SUBNET- カスタム・サブネット CIDR を指定して、ポッドのプライベート 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。 場所の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。 場所の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の形式で指定します。 マルチゾーン・クラスターの場合は、各ゾーンから 1 つの IP アドレスを使用します。 IPアドレスを見つけるには、ibmcloud sat host ls --location <location_ID_or_name>を実行し、infrastructureというラベルが貼られたホストのWorker IPを探す。 --location LOCATION- Satellite ロケーションの名前または ID。 場所の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。 場所の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。 場所の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- リソースの履歴 ID です。
--output OUTPUT- 指定された形式でコマンド出力を表示します。 受け入れられる値:
json -q- その日のメッセージを表示せず、リマインダーも更新しません。
--resource RESOURCE- Kubernetes リソース ID を指定します。 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 リソース ID。
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 リソースが実行される登録済みクラスターの名前または ID を指定します。 登録されたクラスタを見つけるには、
ibmcloud sat cluster lsを実行します。 --limit LIMIT- 返される検索のリソース項目の最大数を指定します。
--output OUTPUT- 指定された形式でコマンド出力を表示します。 受け入れられる値:
json -q- その日のメッセージを表示せず、リマインダーも更新しません。
--search SEARCH- ポッド名や名前空間名など、Kubernetes リソースの検索結果をフィルタリングするためのストリングを指定します。
--subscription SUBSCRIPTION- Satellite サブスクリプション ID または名前を指定します。 サブスクリプションを検索するには、
ibmcloud sat cluster lsを実行します。
ibmcloud sat service ls
ロケーション内のすべての Satellite サービス・クラスターをリストして、要求されたホスト・リソースなどの詳細を確認します。
ibmcloud sat service ls --location LOCATION [--output OUTPUT] [-q]
コマンド・オプション
--location LOCATION- Satellite ロケーションの名前または ID。 場所のIDまたは名前を見つけるには、
ibmcloud sat location lsを実行する。 --output OUTPUT- 指定された形式でコマンド出力を表示します。 受け入れられる値:
json -q- その日のメッセージを表示せず、リマインダーも更新しません。
ibmcloud sat storage assignment autopatch disable
storage assignment autopatch disable コマンドはベータ機能です。
Satellite ストレージ割り当ての自動パッチを無効にします。
ibmcloud sat storage assignment autopatch disable --config CONFIG [-q] (--all | --assignment ASSIGNMENT)
コマンド・オプション
--all- ストレージ構成のすべての Satellite ・ストレージ割り当てに対する自動パッチを無効にします。
--assignment ASSIGNMENT- Satellite ストレージ割り当ての ID。 コンフィギュレーションの利用可能なストレージ割り当てを一覧表示するには、
ibmcloud sat storage assignment ls --config CONFIGを実行する。 --config CONFIG- サテライト ストレージ構成の名前または ID 。 使用可能なストレージ構成をリストするには、
ibmcloud sat storage config lsを実行します。 -q- その日のメッセージを表示せず、リマインダーも更新しません。
ibmcloud sat storage assignment autopatch enable
storage assignment autopatch enable コマンドはベータ機能です。
Satellite ・ストレージ割り当ての自動パッチを有効にします。
ibmcloud sat storage assignment autopatch enable --config CONFIG [-q] (--all | --assignment ASSIGNMENT)
コマンド・オプション
--all- ストレージ構成のすべての Satellite ・ストレージ割り当てに対して自動パッチを有効にします。
--assignment ASSIGNMENT- Satellite ストレージ割り当ての ID。 コンフィギュレーションの利用可能なストレージ割り当てを一覧表示するには、
ibmcloud sat storage assignment ls --config CONFIGを実行する。 --config CONFIG- サテライト ストレージ構成の名前または ID 。 使用可能なストレージ構成をリストするには、
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 を指定します。 クラスター 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 を指定します。 サービス・クラスター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 ストレージ割り当ての ID を指定します。
--output OUTPUT- 指定された形式でコマンド出力を表示します。 受け入れられる値:
json -q- その日のメッセージを表示せず、リマインダーも更新しません。
ibmcloud sat storage assignment ls
IBM Cloud アカウント内の Satellite ストレージ割り当てをリストします。
サービス管理者としてサービス クラスターのすべての割り当てを一覧表示するには: ibmcloud sat storage assignment ls--service-cluster-id集まる。
ロケーション管理者としてサービス クラスターのすべての割り当てを一覧表示するには: ibmcloud sat storage assignment ls--location位置--service-cluster-id集まる。
設定のすべての割り当てを一覧表示するには：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 を指定します。 クラスタIDを取得するには、
ibmcloud oc cluster ls --provider satelliteを実行する。 --config CONFIG- Satellite ストレージ構成の名前または ID を指定します。 使用可能なストレージ構成をリストするには、
ibmcloud sat storage config lsを実行します。 --location LOCATION- Satellite ロケーションの名前を指定します。 利用可能なロケーションをリストアップするには、
ibmcloud sat location lsを実行する。 このオプションをサービス管理者が使用することはできません。 --output OUTPUT- 指定された形式でコマンド出力を表示します。 受け入れられる値:
json -q- その日のメッセージを表示せず、リマインダーも更新しません。
--service-cluster-id CLUSTER- 割り当てのサービス・クラスターの ID を指定します。 サービス・クラスターIDを見つけるには、
ibmcloud sat service ls --location <location>を実行します。
ibmcloud sat storage assignment patch
関連する割り当てにストレージ構成の変更を適用します。
ibmcloud sat storage assignment patch --assignment ASSIGNMENT [-f] [-q]
コマンド・オプション
--assignment ASSIGNMENT- Satellite ストレージ割り当ての ID を指定します。 利用可能な割り当てを一覧表示するには、
ibmcloud sat storage assignment lsを実行する。 -f- ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。
-q- その日のメッセージを表示せず、リマインダーも更新しません。
ibmcloud sat storage assignment rm
Satellite ストレージ割り当てを削除します。 Kubernetes リソースは Satellite ロケーションのすべてのクラスターから削除されますが、構成は残ります。
ibmcloud sat storage assignment rm --assignment ASSIGNMENT [-f] [-q]
コマンド・オプション
--assignment ASSIGNMENT- Satellite ストレージ割り当ての ID を指定します。 割り当てを見つけるには、
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 ストレージ割り当ての ID を指定します。
-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 ストレージ構成の名前または ID を指定します。 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 ストレージ構成の名前または ID を指定します。 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- ストレージ構成のロケーションの ID または名前を入力します。 利用可能なロケーションを見つけるには、
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 ストレージ構成の名前または ID を指定します。 使用可能な構成をリストするには、
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- リストする構成が含まれているロケーションの ID または名前を指定します。 利用可能なロケーションを見つけるには、
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- ストレージ構成の名前または ID を指定します。 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 ストレージ構成の名前または ID を指定します。 使用可能な構成をリストするには、
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 ストレージ構成の名前または ID を指定します。 使用可能な構成をリストするには、
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- 構成をサブスクライブするクラスター・グループの名前または ID を指定します。 利用可能なクラスタグループを見つけるには、
ibmcloud sat group lsを実行する。 --name NAME- サブスクリプションの名前を入力します。
--path PATH- Satellite サブスクリプションに使用する、リモート・リポジトリー内のリポジトリー・ファイルまたはリリース・アセットへのパスを指定します。 戦略: GitOps。
-q- その日のメッセージを表示せず、リマインダーも更新しません。
--repository REPOSITORY- サブスクリプションに使用するリモート・リポジトリーの URL を指定します。 戦略: GitOps。
--version VERSION- サブスクリプションに使用する既存の構成バージョンの名前または ID を指定します。 バージョンを調べるには、
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 サブスクリプションを更新して、リソースの管理に自分のIDを使用する。
ibmcloud sat subscription identity set --subscription SUBSCRIPTION [-f] [-q]
コマンド・オプション
-f- ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。
-q- その日のメッセージを表示せず、リマインダーも更新しません。
--subscription SUBSCRIPTION- Satellite サブスクリプションの名前または ID を指定します。 購読の一覧を表示するには、
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 クラスター名または ID を指定します。 登録されたクラスタを見つけるには、
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 サブスクリプションの名前または ID を指定します。 購読の一覧を表示するには、
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 サブスクリプションの名前または ID を指定します。 購読の一覧を表示するには、
ibmcloud sat subscription lsを実行する。 --version VERSION- Satellite サブスクリプションに使用する既存の構成バージョンを示します。 戦略: 直接アップロード。