コマンド・オプション

--connector-id

Satellite コネクタのID。 コネクター ID を確認するには、 ibmcloud sat connector ls を実行します。

--endpoint

この ACL を有効にするエンドポイントの名前または ID。

--location

Satellite ロケーションの名前または ID。 ロケーションIDまたは名前を確認するには、 ibmcloud sat location ls を実行してください。

--name

ACLの名称。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--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。

例

ACLを作成する

ibmcloud sat acl create --name NAME --subnet SUBNET --connector-id ID

コマンド・オプション

--acl-id

ACLのIDを指定してください。 すべてのACLを一覧表示するには、次のコマンドを実行します。ibmcloud sat acl ls。

--connector-id

Satellite コネクタのID。 コネクター ID を確認するには、 ibmcloud sat connector ls を実行します。

--endpoint

この ACL を有効にするエンドポイントの名前または ID。

--location

Satellite ロケーションの名前または ID。 ロケーションIDまたは名前を確認するには、 ibmcloud sat location ls を実行してください。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

ACLに1つ以上の有効なエンドポイントを追加する

ibmcloud sat acl endpoint add --acl-id ID --endpoint ENDPOINT --connector-id ID

例

ヘルプを表示します

ibmcloud sat acl endpoint help

コマンド・オプション

--acl-id

ACLのIDを指定してください。 すべてのACLを一覧表示するには、次のコマンドを実行します。ibmcloud sat acl ls。

--connector-id

Satellite コネクタのID。 コネクター ID を確認するには、 ibmcloud sat connector ls を実行します。

--location

Satellite ロケーションの名前または ID。 ロケーションIDまたは名前を確認するには、 ibmcloud sat location ls を実行してください。

--output

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

ACLに対して有効になっているすべてのエンドポイントを一覧表示する

ibmcloud sat acl endpoint ls --acl-id ID --connector-id ID

コマンド・オプション

--acl-id

ACLのIDを指定してください。 すべてのACLを一覧表示するには、次のコマンドを実行します。ibmcloud sat acl ls。

--connector-id

Satellite コネクタのID。 コネクター ID を確認するには、 ibmcloud sat connector ls を実行します。

--endpoint

この ACL に対して無効にするエンドポイントの名前または ID。

--location

Satellite ロケーションの名前または ID。 ロケーションIDまたは名前を確認するには、 ibmcloud sat location ls を実行してください。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

ACLから、有効になっているエンドポイントを1つ以上削除する

ibmcloud sat acl endpoint rm --acl-id ID --endpoint ENDPOINT --connector-id ID

コマンド・オプション

--acl-id

ACLのIDを指定してください。 すべてのACLを一覧表示するには、次のコマンドを実行します。ibmcloud sat acl ls。

--connector-id

Satellite コネクタのID。 コネクター ID を確認するには、 ibmcloud sat connector ls を実行します。

--location

Satellite ロケーションの名前または ID。 ロケーションIDまたは名前を確認するには、 ibmcloud sat location ls を実行してください。

--output

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

ACLの詳細を表示する

ibmcloud sat acl get --acl-id ID --connector-id ID

例

ヘルプを表示します

ibmcloud sat acl help

コマンド・オプション

--connector-id

Satellite コネクタのID。 コネクター ID を確認するには、 ibmcloud sat connector ls を実行します。

--location

Satellite ロケーションの名前または ID。 ロケーションIDまたは名前を確認するには、 ibmcloud sat location ls を実行してください。

--output

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

Satellite コネクタまたはロケーションのすべてのACLを一覧表示する

ibmcloud sat acl ls --connector-id ID

コマンド・オプション

--acl-id

ACLのIDを指定してください。 すべてのACLを一覧表示するには、次のコマンドを実行します。ibmcloud sat acl ls。

--connector-id

Satellite コネクタのID。 コネクター ID を確認するには、 ibmcloud sat connector ls を実行します。

--location

Satellite ロケーションの名前または ID。 ロケーションIDまたは名前を確認するには、 ibmcloud sat location ls を実行してください。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

ACLを削除する

ibmcloud sat acl rm --acl-id ID --connector-id ID

コマンド・オプション

--acl-id

ACLのIDを指定してください。 すべてのACLを一覧表示するには、次のコマンドを実行します。ibmcloud sat acl ls。

--connector-id

Satellite コネクタのID。 コネクター ID を確認するには、 ibmcloud sat connector ls を実行します。

--location

Satellite ロケーションの名前または ID。 ロケーションIDまたは名前を確認するには、 ibmcloud sat location ls を実行してください。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--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。

例

ACLに1つ以上のサブネットを追加する

ibmcloud sat acl subnet add --acl-id ID --subnet SUBNET --connector-id ID

例

ヘルプを表示します

ibmcloud sat acl subnet help

コマンド・オプション

--acl-id

ACLのIDを指定してください。 すべてのACLを一覧表示するには、次のコマンドを実行します。ibmcloud sat acl ls。

--connector-id

Satellite コネクタのID。 コネクター ID を確認するには、 ibmcloud sat connector ls を実行します。

--location

Satellite ロケーションの名前または ID。 ロケーションIDまたは名前を確認するには、 ibmcloud sat location ls を実行してください。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--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。

例

ACLから1つ以上のサブネットを削除する

ibmcloud sat acl subnet rm --acl-id ID --subnet SUBNET --connector-id ID

コマンド・オプション

--acl-id

ACLのIDを指定してください。 すべてのACLを一覧表示するには、次のコマンドを実行します。ibmcloud sat acl ls。

--connector-id

Satellite コネクタのID。 コネクター ID を確認するには、 ibmcloud sat connector ls を実行します。

--location

Satellite ロケーションの名前または ID。 ロケーションIDまたは名前を確認するには、 ibmcloud sat location ls を実行してください。

--name

ACLの新しい名称。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

ACLの名前を更新する

ibmcloud sat acl update --acl-id ID --name NAME --connector-id ID

コマンド・オプション

--platform

Satelliteコネクタ・エージェントのプラットフォーム。 Docker については、https://ibm.biz/satconagent のドキュメントを参照してください。 利用可能なオプション: windows, docker

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

特定のプラットフォーム用の Satellite コネクタエージェントを取得する

ibmcloud sat agent attach --platform PLATFORM

例

ヘルプを表示します

ibmcloud sat agent help

コマンド・オプション

--connector-id

Satellite コネクターの ID です。

--output

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

Satellite コネクタに紐づくすべてのエージェントを一覧表示する

ibmcloud sat agent ls --connector-id ID

コマンド・オプション

-c, --cluster

クラスター名または ID を指定します。 登録されているクラスターをリストするには、ibmcloud sat cluster ls を実行します。

--output

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

登録済みクラスタの詳細を取得する

ibmcloud sat cluster get --cluster CLUSTER

例

ヘルプを表示します

ibmcloud sat cluster help

コマンド・オプション

--filter

クラスター ID で登録済みクラスターをフィルタリングします。

--limit

返されるクラスターの数を制限します。

--output

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

IBM Cloud アカウントに登録されているすべてのクラスターを一覧表示する

ibmcloud sat cluster ls

コマンド・オプション

--name

登録するクラスターの名前を指定します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--silent

サイレント。 出力で登録コマンドのみを返します。

例

Satellite 構成にクラスタを登録するための kubectl コマンドを取得する

ibmcloud sat cluster register --name NAME

コマンド・オプション

-c, --cluster

クラスター名または ID を指定します。 登録されているクラスターをリストするには、ibmcloud sat cluster ls を実行します。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

クラスタの登録を削除する

ibmcloud sat cluster unregister --cluster CLUSTER

コマンド・オプション

--data-location

Satellite 構成データを保管する IBM リージョンを指定します。 戦略: 直接アップロード。

--name

Satellite 構成の名前を指定します。

--provider

Satellite 構成のリモート GitOps プロバイダーを示します。 このプロバイダーは、Kubernetes リソース定義を保管します。 戦略: GitOps。 許可される値: github、gitlab

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

Satellite ワークロード内のクラスターにデプロイする Kubernetes リソースを指定する構成を作成します

ibmcloud sat config create --name NAME --data-location LOCATION

コマンド・オプション

--config

Satellite 構成の名前または ID を指定します。 使用可能な構成をリストするには、ibmcloud sat config ls を実行します。

--output

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

Satellite の構成に関する詳細（その構成に関連付けられているバージョンやサブスクリプションなど）を取得する

ibmcloud sat config get --config CONFIG

例

ヘルプを表示します

ibmcloud sat config help

コマンド・オプション

--output

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

IBM Cloud アカウント内のすべての Satellite の設定を一覧表示する

ibmcloud sat config ls

コマンド・オプション

--config

Satellite 構成の名前または ID を指定します。 使用可能な構成をリストするには、ibmcloud sat config ls を実行します。

--name

Satellite 構成の新しい名前を指定します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

Satellite の設定の名前を変更する

ibmcloud sat config rename --config CONFIG --name NAME

コマンド・オプション

--config

Satellite 構成の名前または ID を指定します。 使用可能な構成をリストするには、ibmcloud sat config ls を実行します。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

Satellite の設定を削除する

ibmcloud sat config rm --config CONFIG

コマンド・オプション

--config

Satellite 構成の名前または ID を指定します。 使用可能な構成をリストするには、ibmcloud sat config ls を実行します。

--description

Satellite 構成バージョンの説明を追加します。

--file-format

構成バージョンのファイル・フォーマットを示します。 使用可能なオプション: yaml

--name

Satellite 構成バージョンの名前を指定します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--read-config

構成バージョン・ファイルのファイル・パスを指定します。

例

Satellite ワークロードの既存の Kubernetes リソースを更新するための構成バージョンを作成します

ibmcloud sat config version create \
  --config CONFIG \
  --file-format FORMAT \
  --name NAME \
  --read-config CONFIG

コマンド・オプション

--config

Satellite 構成の名前または ID を指定します。 使用可能な構成をリストするには、ibmcloud sat config ls を実行します。

--output

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--save-config

構成バージョンをダウンロードして一時ファイルに保存します。

--version

Satellite 構成バージョンの名前または ID を指定します。 構成内のバージョンをリストするには、ibmcloud sat config get --config <configuration_name_or_ID> を実行します。

例

Satellite の構成バージョンの詳細を確認する

ibmcloud sat config version get --config CONFIG --version VERSION

例

ヘルプを表示します

ibmcloud sat config version help

コマンド・オプション

--config

Satellite 構成の名前または ID を指定します。 使用可能な構成をリストするには、ibmcloud sat config ls を実行します。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--version

Satellite 構成バージョンの名前または ID を示します。 バージョンを一覧表示するには、 ibmcloud sat config get --config <configuration_name_or_ID> を実行してください。

例

Satellite の設定バージョンを削除する

ibmcloud sat config version rm --config CONFIG --version VERSION

コマンド・オプション

--name

Satellite コネクターの名前。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--region

Satellite コネクターを管理するための IBM Cloud 地域。

例

Satellite コネクタを作成する

ibmcloud sat connector create --name NAME --region REGION

コマンド・オプション

--connector-id

Satellite コネクターの ID です。

--output

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

Satellite コネクタの詳細を表示する

ibmcloud sat connector get --connector-id ID

例

ヘルプを表示します

ibmcloud sat connector help

コマンド・オプション

--after

Satellite コネクタをカーソルの後に表示する。

--first

次のSatelliteコネクターを、最初のコネクター数まで表示する。

--output

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

IBM Cloud アカウントで Satellite コネクタを確認する

ibmcloud sat connector ls

コマンド・オプション

--connector-id

Satellite コネクターの ID です。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

Satellite コネクタを削除する

ibmcloud sat connector rm --connector-id ID

コマンド・オプション

--connector-id

Satellite コネクタのID。 コネクター ID を確認するには、 ibmcloud sat connector ls を実行します。

--endpoint

エンドポイントの名前または ID を指定します。 すべてのエンドポイントを表示するには、 ibmcloud sat endpoint ls を実行してください。

--location

Satellite ロケーションの名前または ID。 ロケーションIDまたは名前を確認するには、 ibmcloud sat location ls を実行してください。

--output

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

エンドポイントの認証設定を取得する

ibmcloud sat endpoint authn get --endpoint ENDPOINT --connector-id ID

例

ヘルプを表示します

ibmcloud sat endpoint authn help

コマンド・オプション

--connector-id

Satellite コネクタのID。 コネクター ID を確認するには、 ibmcloud sat connector ls を実行します。

--dest-ca-cert-file

宛先サーバーの証明書を検証するために使用されるトラステッド CA 証明書またはチェーン。 例えば、 myCA.pem などです。

--dest-cert-file

宛先サーバーへの認証に使用されるクライアント証明書。 例えば、 myCert.pem などです。

--dest-key-file

クライアント証明書の暗号化に使用されるクライアント秘密鍵。 例えば、 myKey.pem などです。

--endpoint

エンドポイントの名前または ID を指定します。 すべてのエンドポイントを表示するには、 ibmcloud sat endpoint ls を実行してください。

--location

Satellite ロケーションの名前または ID。 ロケーションIDまたは名前を確認するには、 ibmcloud sat location ls を実行してください。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--source-ca-cert-file

source-tls-mode が mutual の場合に、ソース・クライアントの証明書を検証するために使用されるトラステッド CA 証明書またはチェーン。 例えば、 myCA.pem などです。

--source-cert-file

ソース・クライアントに提示するサーバー証明書。 例えば、 myCert.pem などです。

--source-key-file

サーバー証明書の暗号化に使用されるサーバー秘密鍵。 例えば、 myKey.pem などです。

例

既存の認証証明書を新しいものに置き換える

ibmcloud sat endpoint authn rotate --endpoint ENDPOINT --connector-id ID

コマンド・オプション

--connector-id

Satellite コネクタのID。 コネクター ID を確認するには、 ibmcloud sat connector ls を実行します。

--dest-ca-cert-file

宛先サーバーの証明書を検証するために使用されるトラステッド CA 証明書またはチェーン。 例えば、 myCA.pem などです。

--dest-cert-file

宛先サーバーへの認証に使用されるクライアント証明書。 例えば、 myCert.pem などです。

--dest-key-file

クライアント証明書の暗号化に使用されるクライアント秘密鍵。 例えば、 myKey.pem などです。

--dest-tls-mode

デスティネーション TLS モード。 許容される値:simple 、mutual 、none

--endpoint

エンドポイントの名前または ID を指定します。 すべてのエンドポイントを表示するには、 ibmcloud sat endpoint ls を実行してください。

--location

Satellite ロケーションの名前または ID。 ロケーションIDまたは名前を確認するには、 ibmcloud sat location ls を実行してください。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--source-ca-cert-file

source-tls-mode が mutual の場合に、ソース・クライアントの証明書を検証するために使用されるトラステッド CA 証明書またはチェーン。 例えば、 myCA.pem などです。

--source-cert-file

ソース・クライアントに提示するサーバー証明書。 例えば、 myCert.pem などです。

--source-key-file

サーバー証明書の暗号化に使用されるサーバー秘密鍵。 例えば、 myKey.pem などです。

--source-tls-mode

出典： TLS モード。 受け入れられる値: simple、 mutual

例

エンドポイントの認証設定を行う

ibmcloud sat endpoint authn set --endpoint ENDPOINT --connector-id ID

コマンド・オプション

--connector-id

Satellite コネクタのID。 コネクター ID を確認するには、 ibmcloud sat connector ls を実行します。

--dest-hostname

接続先の宛先の完全修飾ドメイン名 (FQDN) または外部からアクセス可能な IP アドレスを指定します。 cloud のエンドポイントについては、この値はパブリック IP アドレス、または IBM Cloud 内でアクセス可能なプライベート IP アドレス（プライベートクラウドサービスのエンドポイントなど）に解決される必要があります。 location エンドポイントの場合、この値は、 Satellite のロケーションについてはコントロールプレーンホストから解決可能かつ到達可能である必要があり、 Satellite コネクタの場合はエージェントが実行されている場所から解決可能かつ到達可能である必要があります。

--dest-port

宛先リソースが着信要求を listen するポートを指定します。 ポートが宛先のプロトコルと一致していることを確認してください。

--dest-protocol

宛先のプロトコルを指定します。 このオプションを指定しない場合、宛先プロトコルはソース・プロトコルから継承されます。 受け入れられる値: TCP、 TLS

--dest-type

宛先リソースの実行場所を指定します。 IBM Cloud （cloud ）または Satellite のロケーション（location ）のいずれかです。利用可能なオプション：location、cloud

--idle-timeout-seconds

宛先へのアクティブな接続のタイムアウト間隔を秒単位で指定します。 タイムアウトが宛先サービスおよびプロトコルの keep-alive 設定と互換性があることを確認してください。

--location

Satellite ロケーションの名前または ID。 ロケーションIDまたは名前を確認するには、 ibmcloud sat location ls を実行してください。

--name

エンドポイントの名前を指定します。

--output

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--sni

tls または https のソースプロトコルを指定し、 TLS のハンドシェイクに別のホスト名を追加したい場合は、サーバー名インジケータを指定してください。

--source-protocol

ソースが宛先リソースを接続するために使用するプロトコルを指定します。 参照 http://ibm.biz/endpoint-protocols。 利用可能なオプション： TCP、 TLS、 HTTP、 HTTPS、 HTTP-tunnel

例

エンドポイントの作成

ibmcloud sat endpoint create \
  --dest-hostname HOSTNAME \
  --dest-port PORT \
  --dest-type TYPE \
  --name NAME \
  --source-protocol PROTOCOL \
  --connector-id ID

コマンド・オプション

--connector-id

Satellite コネクタのID。 コネクター ID を確認するには、 ibmcloud sat connector ls を実行します。

--endpoint

エンドポイントの名前または ID を指定します。 すべてのエンドポイントを表示するには、 ibmcloud sat endpoint ls (--connector-id ID | --location LOCATION) を実行してください。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

--location

Satellite ロケーションの名前または ID。 ロケーションIDまたは名前を確認するには、 ibmcloud sat location ls を実行してください。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

エンドポイントを無効にする

ibmcloud sat endpoint disable --endpoint ENDPOINT --connector-id ID

コマンド・オプション

--connector-id

Satellite コネクタのID。 コネクター ID を確認するには、 ibmcloud sat connector ls を実行します。

--endpoint

エンドポイントの名前または ID を指定します。 すべてのエンドポイントを表示するには、 ibmcloud sat endpoint ls (--connector-id ID | --location LOCATION) を実行してください。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

--location

Satellite ロケーションの名前または ID。 ロケーションIDまたは名前を確認するには、 ibmcloud sat location ls を実行してください。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

エンドポイントを有効にする

ibmcloud sat endpoint enable --endpoint ENDPOINT --connector-id ID

コマンド・オプション

--connector-id

Satellite コネクタのID。 コネクター ID を確認するには、 ibmcloud sat connector ls を実行します。

--endpoint

エンドポイントの名前または ID を指定します。 すべてのエンドポイントを表示するには、 ibmcloud sat endpoint ls (--connector-id ID | --location LOCATION) を実行してください。

--location

Satellite ロケーションの名前または ID。 ロケーションIDまたは名前を確認するには、 ibmcloud sat location ls を実行してください。

--output

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

エンドポイントの詳細を表示する

ibmcloud sat endpoint get --endpoint ENDPOINT --connector-id ID

例

ヘルプを表示します

ibmcloud sat endpoint help

コマンド・オプション

--connector-id

Satellite コネクタのID。 コネクター ID を確認するには、 ibmcloud sat connector ls を実行します。

--location

Satellite ロケーションの名前または ID。 ロケーションIDまたは名前を確認するには、 ibmcloud sat location ls を実行してください。

--output

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

Satellite のロケーションにあるすべてのエンドポイントを一覧表示する

ibmcloud sat endpoint ls --connector-id ID

コマンド・オプション

--connector-id

Satellite コネクタのID。 コネクター ID を確認するには、 ibmcloud sat connector ls を実行します。

--endpoint

エンドポイントの名前または ID を指定します。 すべてのエンドポイントを表示するには、 ibmcloud sat endpoint ls (--connector-id ID | --location LOCATION) を実行してください。

--location

Satellite ロケーションの名前または ID。 ロケーションIDまたは名前を確認するには、 ibmcloud sat location ls を実行してください。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

エンドポイントを削除する

ibmcloud sat endpoint rm --endpoint ENDPOINT --connector-id ID

コマンド・オプション

--connector-id

Satellite コネクタのID。 コネクター ID を確認するには、 ibmcloud sat connector ls を実行します。

--dest-hostname

接続先の宛先の完全修飾ドメイン名 (FQDN) または外部からアクセス可能な IP アドレスを指定します。 cloud のエンドポイントについては、この値はパブリック IP アドレス、または IBM Cloud 内でアクセス可能なプライベート IP アドレス（プライベートクラウドサービスのエンドポイントなど）に解決される必要があります。 location エンドポイントの場合、この値は、 Satellite のロケーションについてはコントロールプレーンホストから解決可能かつ到達可能である必要があり、 Satellite コネクタの場合はエージェントが実行されている場所から解決可能かつ到達可能である必要があります。

--dest-port

宛先リソースが着信要求を listen するポートを指定します。 ポートが宛先のプロトコルと一致していることを確認してください。

--dest-protocol

宛先のプロトコルを指定します。 このオプションを指定しない場合、宛先プロトコルはソース・プロトコルから継承されます。 受け入れられる値: TCP、 TLS

--endpoint

エンドポイントの名前または ID を指定します。 すべてのエンドポイントを表示するには、 ibmcloud sat endpoint ls (--connector-id ID | --location LOCATION) を実行してください。

--idle-timeout-seconds

宛先へのアクティブな接続のタイムアウト間隔を秒単位で指定します。 タイムアウトが宛先サービスおよびプロトコルの keep-alive 設定と互換性があることを確認してください。

--location

Satellite ロケーションの名前または ID。 ロケーションIDまたは名前を確認するには、 ibmcloud sat location ls を実行してください。

--name

エンドポイントの新しい名前を指定します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--sni

tls または https のソースプロトコルを指定し、 TLS のハンドシェイクに別のホスト名を追加したい場合は、サーバー名インジケータを指定してください。

--source-protocol

ソースが宛先リソースを接続するために使用するプロトコルを指定します。 参照 http://ibm.biz/endpoint-protocols。 有効な値： TCP、 TLS、 HTTP、 HTTPS、 HTTP-tunnel

例

エンドポイントを更新する

ibmcloud sat endpoint update --endpoint ENDPOINT --connector-id ID

例

ヘルプを表示します

ibmcloud sat experimental endpoint help

例

ヘルプを表示します

ibmcloud sat experimental help

コマンド・オプション

-c, --cluster

クラスター名またはクラスター ID を指定します。 登録されているクラスターをリストするには、ibmcloud sat cluster ls を実行します。

-g, --group

Satellite クラスター・グループの名前または ID を指定します。 使用可能なクラスター・グループをリストするには、ibmcloud sat group ls を実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

クラスターグループにクラスターを追加する

ibmcloud sat group attach --cluster CLUSTER --group GROUP

コマンド・オプション

-c, --cluster

クラスター・グループに追加するクラスターの名前または ID を指定します。 登録されているクラスターをリストするには、ibmcloud sat cluster ls を実行します。

--name

Satellite クラスター・グループの名前を指定します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

クラスターグループを作成する

ibmcloud sat group create --name NAME

コマンド・オプション

-c, --cluster

クラスター名またはクラスター ID を指定します。 クラスターグループ内のクラスターを一覧表示するには、 ibmcloud sat group get --group <cluster_group_name_or_ID> を実行してください。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-g, --group

Satellite クラスター・グループの名前または ID を指定します。 使用可能なクラスター・グループをリストするには、ibmcloud sat group ls を実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

Satellite クラスターグループから1つ以上のクラスターを削除し、そのグループのサブスクリプションによって管理されていた Kubernetes リソースを削除します

ibmcloud sat group detach --cluster CLUSTER --group GROUP

コマンド・オプション

-g, --group

Satellite クラスター・グループの名前または ID を指定します。 登録されているクラスターをリストするには、ibmcloud sat cluster ls を実行します。

--output

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

Satellite クラスターグループの詳細情報を取得する

ibmcloud sat group get --group GROUP

例

ヘルプを表示します

ibmcloud sat group help

コマンド・オプション

--output

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

IBM Cloud アカウント内のすべての Satellite クラスターグループを一覧表示する

ibmcloud sat group ls

コマンド・オプション

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-g, --group

Satellite クラスター・グループの名前または ID を指定します。 使用可能なクラスター・グループをリストするには、ibmcloud sat group ls を実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

Satellite クラスターグループを削除します。これにより、クラスターのサブスクリプションが解除され、そのグループのサブスクリプションによって管理されていた Kubernetes リソースが削除されます

ibmcloud sat group rm --group GROUP

コマンド・オプション

--cluster

ホストの割り当て先となるクラスターの名前または ID。 利用可能なクラスタの一覧を表示するには、 ibmcloud sat cluster ls を実行してください。 クラスターが指定されない場合、ホストは自動的に Satellite コントロール・プレーンに割り当てられます。

--host

割り当てるホストの名前または ID。 ラベルに基づいてホストを自動的に割り当てるには、このオプションを含めないでください。 ホスト ID を取得するには、ibmcloud sat host ls --location <location_ID_or_name> を実行します。

--host-label, --hl

Satellite コントロールプレーンまたは Red Hat OpenShift クラスターに割り当てるホストを識別するためのラベルを、キーと値のペアとして入力してください。 このラベルを持ち、割り当てられていない最初のホストが、コントロール・プレーンまたはクラスターに自動的に割り当てられます。 使用可能なホスト・ラベルを見つけるには、ibmcloud sat host get --host <host_name_or_ID> --location <location_name_or_ID> を実行します。

--location

Satellite ロケーションの名前または ID。 ロケーションIDまたは名前を確認するには、 ibmcloud sat location ls を実行してください。

-p, --worker-pool

ホストを割り当てるクラスター内のワーカー・プールの名前または ID。 ワーカー・プールが指定されていない場合、ホストはデフォルトのワーカー・プールに割り当てられます。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--zone

ホストの割り当て先となるゾーンの名前または ID。 利用可能なゾーンを確認するには、 ibmcloud sat location get --location <location_name_or_ID> を実行し、「 Host Zones 」フィールドを確認してください。

例

Satellite のロケーション制御プレーンまたはクラスターにホストを割り当てる

ibmcloud sat host assign --location LOCATION

コマンド・オプション

--host-label, --hl

Satellite コントロールプレーンまたは Red Hat OpenShift クラスターに割り当てるホストを識別するためのラベルを、キーと値のペアとして入力してください。 このラベルを持ち、割り当てられていない最初のホストが、コントロール・プレーンまたはクラスターに自動的に割り当てられます。 使用可能なホスト・ラベルを見つけるには、ibmcloud sat host get --host <host_name_or_ID> --location <location_name_or_ID> を実行します。

--host-link-agent-endpoint

リンク・エージェントがリンク・トンネル・サーバーへの接続に使用するエンドポイント。

--location

Satellite ロケーションの名前または ID。 ロケーションIDまたは名前を確認するには、 ibmcloud sat location ls を実行してください。

--operating-system

自分のロケーションに接続するホストのオペレーティング・システム。 RHCOS ホストを接続するには、ロケーションで RHCOS が有効になっている必要があります。 受け入れられる値: RHEL、 RHCOS

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--reset-key

コントロールプレーンが、そのロケーション内のホストを接続および割り当てるために使用するキーをリセットします。 https://ibm.biz/reset-key を参照してください。

例

ホスト上で実行して、そのホストを自分のロケーションに紐付けることができるスクリプトを作成し、ダウンロードしてください

ibmcloud sat host attach --location LOCATION

コマンド・オプション

--host

Satellite ホスト ID。 ホストIDを確認するには、 ibmcloud sat host ls <location_ID_or_name> を実行してください。

--location

Satellite ロケーションの名前または ID。 ロケーションIDまたは名前を確認するには、 ibmcloud sat location ls を実行してください。

--output

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

Satellite ホストの詳細を表示する

ibmcloud sat host get --host HOST --location LOCATION

例

ヘルプを表示します

ibmcloud sat host help

コマンド・オプション

--location

Satellite ロケーションの名前または ID。 ロケーションIDまたは名前を確認するには、 ibmcloud sat location ls を実行してください。

--output

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

Satellite のロケーションに接続されているすべてのホストを一覧表示します。これには、クラスターやコントロールプレーンに割り当てられているホストも含まれます

ibmcloud sat host ls --location LOCATION

コマンド・オプション

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

--host

削除するホストの名前または ID。

--location

Satellite ロケーションの名前または ID。 ロケーションIDまたは名前を確認するには、 ibmcloud sat location ls を実行してください。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

Satellite のロケーションからホストを削除する

ibmcloud sat host rm --host HOST --location LOCATION

コマンド・オプション

--host

割り当てるホストの名前または ID。 ラベルに基づいてホストを自動的に割り当てるには、このオプションを含めないでください。

--host-label, --hl

Satellite コントロールプレーンまたは Red Hat OpenShift クラスターに割り当てるホストを識別するためのラベルを、キーと値のペアとして入力してください。 このラベルを持ち、割り当てられていない最初のホストが、コントロール・プレーンまたはクラスターに自動的に割り当てられます。 使用可能なホスト・ラベルを見つけるには、ibmcloud sat host get --host <host_name_or_ID> --location <location_name_or_ID> を実行します。

--location

Satellite ロケーションの名前または ID。 ロケーションIDまたは名前を確認するには、 ibmcloud sat location ls を実行してください。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--zone

ホストを関連付けるゾーンの名前または ID。 クラスターなどのリソースに割り当てられているホストのゾーンを変更することはできません。 最初にそれらを割り当て解除する必要があります。 利用可能なゾーンの一覧を表示するには、 ibmcloud sat location get --location <ID> を実行してください。

例

ゾーンやラベルなどのホスト情報を更新する

ibmcloud sat host update --host HOST --location LOCATION

例

ヘルプを表示します

ibmcloud sat key help

コマンド・オプション

--output

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

IBM Cloud アカウント内のすべての「 Satellite 」設定キーを一覧表示する

ibmcloud sat key ls

コマンド・オプション

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

--key

Satellite 構成キーの名前または ID。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

Satellite の設定キーを削除する

ibmcloud sat key rm --key KEY

コマンド・オプション

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

--name

新規 Satellite 構成鍵の名前。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

マネージドクラスターが Satellite Configに接続するために使用する新しいキーを生成します

ibmcloud sat key rotate --name NAME

コマンド・オプション

--capability

Satellite ロケーションの機能です。

--coreos-enabled

Satellite ロケーションに対して Red Hat CoreOS 機能を有効にします。 この操作は元に戻せません。 https://ibm.biz/infra-os を参照してください。

--cos-bucket

Satellite ロケーション・コントロール・プレーン・データを保管する IBM Cloud Object Storage バケットの名前を指定します。 それ以外の場合は、新しいバケットが作成されます。

--description

Satellite ロケーションの説明を入力します。

--ha-zone

ロケーションのゾーンを指定します。 高可用性を確保するには、ロケーションとして「 --ha-zone ZONE1_NAME --ha-zone ZONE2_NAME --ha-zone ZONE3_NAME 」の3つのゾーンを指定してください。 ゾーンの名前は、ホストを作成する予定のインフラストラクチャー・プロバイダー内の対応するゾーンの名前と正確に一致している必要があります。

--managed-from

Satellite ロケーションの管理元となる IBM Cloud リージョンを選択します。 パフォーマンスを向上させるために、オンプレミス・データ・センターに近い地域を選択します。 参照 https://ibm.biz/sat-region。

--name

Satellite ロケーションの名前を指定します。 場所名は文字で始まり、文字、数字、ピリオド（.）、ハイフン（-）を含めることができ、36文字未満でなければなりません。 他の場所が削除されても、名前を再使用しないでください。

--physical-address

Satelliteの場所の物理アドレス。

--pod-network-interface-selection

内部ポッド・ネットワークのノード・ネットワーク・インターフェースを選択する方法。 このオプションは、 Red Hat CoreOS を、 --coreos-enabled オプションとともに有効にしている場合にのみ使用できます。 直接の URL またはIPアドレスを提供するには、 can-reach=<url> または can-reach=<ip_address> を指定します。 ネットワーク・インターフェースを選択するには、 interface=<network_interface> を指定します。

--pod-subnet

カスタム・サブネット CIDR を指定して、ポッドのプライベート IP アドレスを提供します。 このオプションは、Red Hat CoreOS を --coreos-enabled オプションとともに有効にした場合にのみ使用されます。 サブネットは /23 以上でなければなりません。 https://ibm.biz/sat-location-create を参照してください。 デフォルト値:「172.16.0.0/16」

--provider

Satellite ロケーションに使用するインフラストラクチャー・プロバイダーを指定します。 このオプションを含める場合は、--provider-credential オプションも含める必要があります。 許容値: aws、 azure、 gcp、 vmware

--provider-credential

Satellite ロケーションのインフラストラクチャー・プロバイダーの資格情報を持つローカル・マシン上の JSON ファイルへのパスを指定します。 資格情報の形式はプロバイダー固有の形式です。 http://ibm.biz/sat-infra-creds を参照してください。

--provider-region

Satellite ロケーションのホストを作成する予定のインフラストラクチャー・プロバイダー内のリージョンを指定します。 このオプションを含める場合は、--provider オプションも含める必要があります。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--service-subnet

カスタム・サブネット CIDR を指定して、サービスのプライベート IP アドレスを提供します。 このオプションは、Red Hat CoreOS を --coreos-enabled オプションとともに有効にした場合にのみ使用されます。 サブネットは /24 以上でなければなりません。 https://ibm.biz/sat-location-create を参照してください。 デフォルト値: 172.20.0.0/16

例

Satellite ロケーションの作成

ibmcloud sat location create --managed-from REGION --name NAME

コマンド・オプション

--location

Satellite ロケーションの名前または ID。 ロケーションIDまたは名前を確認するには、 ibmcloud sat location ls を実行してください。

--output

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--subdomain

サブドメイン名を指定します。 既存のサブドメインをリストするには、ibmcloud sat location dns ls --location <ID>を実行します。

例

Satellite の場所にある登録済みサブドメインの詳細を表示する

ibmcloud sat location dns get --location LOCATION --subdomain SUBDOMAIN

例

ヘルプを表示します

ibmcloud sat location dns help

コマンド・オプション

--location

Satellite ロケーションの名前または ID。 ロケーションIDまたは名前を確認するには、 ibmcloud sat location ls を実行してください。

--output

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

Satellite の場所にある登録済みサブドメインを一覧表示する

ibmcloud sat location dns ls --location LOCATION

コマンド・オプション

--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

Satellite ロケーションの名前または ID。 ロケーションIDまたは名前を確認するには、 ibmcloud sat location ls を実行してください。

--output

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

Satellite のロケーション内で、コントロールプレーンに割り当てられたホストのサブドメインを設定します

ibmcloud sat location dns register --ip IP --location LOCATION

コマンド・オプション

--location

Satellite ロケーションの名前または ID。 ロケーションIDまたは名前を確認するには、 ibmcloud sat location ls を実行してください。

--output

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

Satellite の店舗の詳細を見る

ibmcloud sat location get --location LOCATION

例

ヘルプを表示します

ibmcloud sat location help

コマンド・オプション

--output

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

IBM Cloud アカウント内のすべての Satellite の拠点を一覧表示する

ibmcloud sat location ls

コマンド・オプション

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

--location

Satellite ロケーションの名前または ID。 ロケーションIDまたは名前を確認するには、 ibmcloud sat location ls を実行してください。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

場所を削除する

ibmcloud sat location rm --location LOCATION

コマンド・オプション

--description

「 Satellite 」の場所について、新しい説明を入力してください。 説明文の長さは400バイトに制限されている。

--location-id

Satellite のロケーションID。 ロケーションIDを確認するには、 ibmcloud sat location ls を実行してください。

--name

「 Satellite 」の場所の新しい名前を指定してください。 場所名は文字で始まり、文字、数字、ピリオド（.）、ハイフン（-）を含めることができ、36文字未満でなければなりません。 削除された場所の名前を含め、名前を再利用しないでください。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

Satellite のロケーションの名前または説明を更新する

ibmcloud sat location update --location-id ID

コマンド・オプション

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

現在のユーザーメッセージを表示する

ibmcloud sat messages

コマンド・オプション

--history

リソースの履歴 ID です。

--output

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--resource

Kubernetes リソース ID を指定します。 Kubernetes のリソースを検索するには、 ibmcloud sat resource ls を実行してください。

--save-data

Kubernetes リソース定義をダウンロードして一時ファイルに保存します。

例

Satellite 構成によって管理されている Kubernetes リソースの詳細を表示する

ibmcloud sat resource get --resource RESOURCE

例

ヘルプを表示します

ibmcloud sat resource help

コマンド・オプション

--limit

返される履歴項目の最大数を指定します。

--output

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--resource

Kubernetes リソース ID。

例

Kubernetes リソースの履歴を取得する

ibmcloud sat resource history get --resource RESOURCE

例

ヘルプを表示します

ibmcloud sat resource history help

コマンド・オプション

-c, --cluster

Kubernetes リソースが実行される登録済みクラスターの名前または ID を指定します。 登録済みのクラスターを検索するには、 ibmcloud sat cluster ls を実行してください。

--limit

返される検索のリソース項目の最大数を指定します。

--output

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--search

ポッド名や名前空間名など、Kubernetes リソースの検索結果をフィルタリングするためのストリングを指定します。

--subscription

Satellite サブスクリプション ID または名前を指定します。 サブスクリプションを検索するには、 ibmcloud sat cluster ls を実行してください。

例

Kubernetes のリソースを検索（管理元：） Satellite

ibmcloud sat resource ls --cluster CLUSTER

例

ヘルプを表示します

ibmcloud sat service help

コマンド・オプション

--location

Satellite ロケーションの名前または ID。 ロケーションIDまたは名前を確認するには、 ibmcloud sat location ls を実行してください。

--output

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

お使いのロケーションにあるすべての Satellite サービスクラスターを一覧表示し、要求されたホストリソースなどの詳細を確認します

ibmcloud sat service ls --location LOCATION

コマンド・オプション

--all

ストレージ構成のすべての Satellite ・ストレージ割り当てに対する自動パッチを無効にします。

--assignment

Satellite ストレージ割り当ての ID。 この構成で利用可能なストレージ割り当ての一覧を表示するには、 ibmcloud sat storage assignment ls --config CONFIG を実行してください。

--config

サテライト ストレージ構成の名前または ID 。 使用可能なストレージ構成をリストするには、ibmcloud sat storage config ls を実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

Satellite のストレージ割り当てに対する自動パッチ適用を無効にする

ibmcloud sat storage assignment autopatch disable --config CONFIG --all

コマンド・オプション

--all

ストレージ構成のすべての Satellite ・ストレージ割り当てに対して自動パッチを有効にします。

--assignment

Satellite ストレージ割り当ての ID。 この構成で利用可能なストレージ割り当ての一覧を表示するには、 ibmcloud sat storage assignment ls --config CONFIG を実行してください。

--config

サテライト ストレージ構成の名前または ID 。 使用可能なストレージ構成をリストするには、ibmcloud sat storage config ls を実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

Satellite のストレージ割り当てで自動パッチ適用を有効にする

ibmcloud sat storage assignment autopatch enable --config CONFIG --all

例

ヘルプを表示します

ibmcloud sat storage assignment autopatch help

コマンド・オプション

-c, --cluster

割り当ての Satellite クラスターの ID を指定します。 クラスター ID を見つけるには、ibmcloud oc cluster ls --provider satellite を実行します。

--config

割り当ての Satellite ・ストレージ構成を指定します。 構成を検索するには、 ibmcloud sat storage config ls を実行します。

-g, --group

割り当てのクラスター・グループを指定します。 クラスターグループを検索するには、 ibmcloud sat group ls を実行してください。

--name

Satellite ストレージ割り当ての名前を指定します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--service-cluster-id

割り当て用のサービス・クラスターの ID を指定します。 サービスクラスタ ID を確認するには、 ibmcloud sat service ls --location <location> を実行してください。

例

Satellite のロケーション内のクラスターにストレージ構成を展開するためのアサインメントを作成します

ibmcloud sat storage assignment create --config CONFIG --cluster CLUSTER

コマンド・オプション

--assignment

Satellite ストレージ割り当ての ID を指定します。

--output

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

Satellite のストレージ割り当ての詳細を確認する

ibmcloud sat storage assignment get --assignment ASSIGNMENT

例

ヘルプを表示します

ibmcloud sat storage assignment help

コマンド・オプション

-c, --cluster

割り当ての Satellite クラスターの ID を指定します。 クラスタIDを取得するには、 ibmcloud oc cluster ls --provider satellite を実行してください。

--config

Satellite ストレージ構成の名前または ID を指定します。 使用可能なストレージ構成をリストするには、ibmcloud sat storage config ls を実行します。

--location

Satellite ロケーションの名前を指定します。 利用可能な場所の一覧を表示するには、 ibmcloud sat location ls を実行してください。 このオプションをサービス管理者が使用することはできません。

--output

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--service-cluster-id

割り当てのサービス・クラスターの ID を指定します。 サービスクラスタ ID を確認するには、 ibmcloud sat service ls --location <location> を実行してください。

例

IBM Cloud アカウント内の Satellite ストレージの割り当てを一覧表示する

ibmcloud sat storage assignment ls --cluster CLUSTER

コマンド・オプション

--assignment

Satellite ストレージ割り当ての ID を指定します。 利用可能な割り当てを一覧表示するには、 ibmcloud sat storage assignment ls を実行してください。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

関連する割り当てにストレージ構成の変更を適用する

ibmcloud sat storage assignment patch --assignment ASSIGNMENT

コマンド・オプション

--assignment

Satellite ストレージ割り当ての ID を指定します。 課題を検索するには、 ibmcloud sat storage assignment ls を実行してください。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

Satellite のストレージ割り当てを削除する

ibmcloud sat storage assignment rm --assignment ASSIGNMENT

コマンド・オプション

--assignment

Satellite ストレージ割り当ての ID を指定します。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-g, --group

割り当ての新規クラスター・グループを指定します。 利用可能なグループの一覧を表示するには、 ibmcloud sat group ls を実行してください。

--name

Satellite ストレージ割り当ての新しい名前を指定します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

Satellite のストレージ割り当てを更新する

ibmcloud sat storage assignment update --assignment ASSIGNMENT

コマンド・オプション

--config-name

カスタム・ストレージ・クラスのストレージ構成の名前を指定します。 Satellite のストレージ構成を一覧表示するには、 ibmcloud sat storage config ls を実行してください。

--name

カスタム・ストレージ・クラスの名前を指定します。

-p, --param

ストレージクラスパラメータに対して、 key=value の組み合わせを指定します。 ストレージテンプレート内のストレージクラスパラメータを確認するには、 ibmcloud sat storage template get を実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

Satellite のカスタムストレージクラスを作成する

ibmcloud sat storage config class add --config-name NAME --name NAME --param PARAM

コマンド・オプション

--class

Satellite ストレージ・クラスの名前を指定します。

--config

Satellite ストレージ構成の名前または ID を指定します。 Satellite のストレージ構成を一覧表示するには、 ibmcloud sat storage config ls を実行してください。

--output

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

Satellite のストレージクラスの詳細を確認する

ibmcloud sat storage config class get --class CLASS --config CONFIG

例

ヘルプを表示します

ibmcloud sat storage config class help

コマンド・オプション

--config

Satellite ストレージ構成の名前または ID を指定します。 Satellite のストレージ構成を一覧表示するには、 ibmcloud sat storage config ls を実行してください。

--output

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--show-params

すべてのストレージ・クラス・パラメーターの詳細をリストするには、このオプションを含めます。

例

Satellite ストレージ構成内のストレージ・クラスをリストします

ibmcloud sat storage config class ls --config CONFIG

コマンド・オプション

--location

ストレージ構成のロケーションの ID または名前を入力します。 利用可能な場所を確認するには、 ibmcloud sat location ls を実行してください。

--name

ストレージ構成の名前を指定します。

-p, --param

設定パラメータとして、 key=value のペアを指定してください。 ストレージテンプレートの構成パラメータを確認するには、 ibmcloud sat storage template get を実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--template-name

Satellite ストレージ構成テンプレートの名前を指定します。 利用可能なストレージ構成テンプレートを一覧表示するには、 ibmcloud sat storage template ls を実行してください。

--template-version

Satellite ストレージ構成テンプレートのバージョンを指定します。 このオプションを指定しない場合は、デフォルト・バージョンが使用されます。 利用可能なストレージ構成テンプレートを一覧表示するには、 ibmcloud sat storage template ls を実行してください。

例

クラスタにストレージドライバをインストールするために、 Satellite のストレージ構成を作成します

ibmcloud sat storage config create --location LOCATION --name NAME --template-name NAME

コマンド・オプション

--config

Satellite ストレージ構成の名前または ID を指定します。 使用可能な構成をリストするには、ibmcloud sat storage config ls を実行します。

--output

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

Satellite のストレージ構成の詳細を確認する

ibmcloud sat storage config get --config CONFIG

例

ヘルプを表示します

ibmcloud sat storage config help

コマンド・オプション

--location

リストする構成が含まれているロケーションの ID または名前を指定します。 利用可能な場所を確認するには、 ibmcloud sat location ls を実行してください。

--output

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

IBM Cloud アカウント内の Satellite のストレージ構成を一覧表示する

ibmcloud sat storage config ls

例

ヘルプを表示します

ibmcloud sat storage config param help

コマンド・オプション

--apply

最新の Satellite ストレージ構成バージョンを、構成のすべての割り当てに適用します。 設定の割り当て一覧を表示するには、 ibmcloud sat storage assignment ls --config CONFIG を実行します。

--config

ストレージ構成の名前または ID を指定します。 Satellite のストレージ構成を一覧表示するには、 ibmcloud sat storage config ls を実行してください。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-p, --param

設定パラメータとして、 key=value のペアを指定してください。 ストレージテンプレートの構成パラメータを確認するには、 ibmcloud sat storage template get を実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

Satellite ストレージ構成の設定パラメータとシークレットパラメータを設定する

ibmcloud sat storage config param set --config CONFIG --param PARAM

コマンド・オプション

--config

Satellite ストレージ構成の名前または ID を指定します。 使用可能な構成をリストするには、ibmcloud sat storage config ls を実行します。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

--include-assignments

このオプションを指定すると、ストレージ構成の割り当てが最新の設定バージョンに更新されます。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

Satellite のストレージ構成に最新のパッチ更新を適用する

ibmcloud sat storage config patch --config CONFIG

コマンド・オプション

--config

Satellite ストレージ構成の名前または ID を指定します。 使用可能な構成をリストするには、ibmcloud sat storage config ls を実行します。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

--include-assignments

ストレージ構成および関連する割り当てを削除するには、このオプションを含めます。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

Satellite のストレージ構成を削除する

ibmcloud sat storage config rm --config CONFIG

例

ヘルプを表示します

ibmcloud sat storage help

コマンド・オプション

--name

ストレージ・テンプレートの名前を指定します。 利用可能なストレージテンプレートを一覧表示するには、 ibmcloud sat storage template ls を実行してください。

--output

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--version

ストレージ・テンプレートのバージョンを指定します。 利用可能なストレージテンプレートを一覧表示するには、 ibmcloud sat storage template ls を実行してください。

例

Satellite ストレージ・テンプレートの詳細を取得します

ibmcloud sat storage template get --name NAME --version VERSION

例

ヘルプを表示します

ibmcloud sat storage template help

コマンド・オプション

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

利用可能な Satellite ストレージテンプレートを一覧表示する

ibmcloud sat storage template ls

コマンド・オプション

--auth-required

リモート・リポジトリーに接続するために必要な認証シークレットを指定します。 詳しくは、「 https://ibm.biz/sat-config-private-repo 」を参照してください。 戦略: GitOps。

--config

サブスクリプションに使用する構成の名前を指定します。 利用可能な構成を確認するには、 ibmcloud sat config ls を実行してください。

-g, --group

構成をサブスクライブするクラスター・グループの名前または ID を指定します。 利用可能なクラスターグループを確認するには、 ibmcloud sat group ls を実行してください。

--gitref

Satellite サブスクリプションに使用する GitRef を指定します。 戦略: GitOps。

--gitref-type

Satellite サブスクリプションに使用する GitRef のタイプを示します。 戦略: GitOps。 許可される値: branch、commit、tag、release

--name

サブスクリプションの名前を入力します。

--path

Satellite サブスクリプションに使用する、リモート・リポジトリー内のリポジトリー・ファイルまたはリリース・アセットへのパスを指定します。 戦略: GitOps。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--repository

サブスクリプションに使用するリモート・リポジトリーの URL を指定します。 戦略: GitOps。

--version

サブスクリプションに使用する既存の構成バージョンの名前または ID を指定します。 バージョンを確認するには、 ibmcloud sat config get --config <configuration_name_or_ID> を実行してください。 戦略: 直接アップロード。

例

クラスタ用の Satellite サブスクリプションを作成する

ibmcloud sat subscription create \
  --config CONFIG \
  --group GROUP \
  --name NAME \
  --auth-required \
  --gitref GITREF \
  --gitref-type TYPE \
  --path PATH \
  --repository REPOSITORY

コマンド・オプション

--output

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--subscription

Satellite のサブスクリプションの名前またはIDを入力してください。 サブスクリプションを検索するには、 ibmcloud sat subscription ls を実行してください。

例

Satellite のサブスクリプションに関する詳細情報をご覧ください

ibmcloud sat subscription get --subscription SUBSCRIPTION

例

ヘルプを表示します

ibmcloud sat subscription help

例

ヘルプを表示します

ibmcloud sat subscription identity help

コマンド・オプション

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--subscription

Satellite サブスクリプションの名前または ID を指定します。 購読リストを表示するには、 ibmcloud sat subscription ls を実行してください。

例

Satellite サブスクリプションを更新し、自身のIDを使用してリソースを管理できるようにする

ibmcloud sat subscription identity set --subscription SUBSCRIPTION

コマンド・オプション

-c, --cluster

Satellite クラスター名または ID を指定します。 登録済みのクラスターを検索するには、 ibmcloud sat cluster ls を実行してください。

--output

指定された形式でコマンド出力を表示します。 受け入れられる値: json

-q

その日のメッセージを表示せず、リマインダーも更新しません。

例

IBM Cloud アカウント内のすべての Satellite サブスクリプションを一覧表示する

ibmcloud sat subscription ls

コマンド・オプション

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--subscription

Satellite サブスクリプションの名前または ID を指定します。 購読リストを表示するには、 ibmcloud sat subscription ls を実行してください。

例

Satellite のサブスクリプションを解除する

ibmcloud sat subscription rm --subscription SUBSCRIPTION

コマンド・オプション

--auth-required

リモート・リポジトリーに接続するために必要な認証シークレットを指定します。 戦略: GitOps。

-f

ユーザー・プロンプトを表示せず、強制的にコマンドを実行します。

-g, --group

構成をサブスクライブする新規クラスター・グループを指定します。

--gitref

Satellite サブスクリプションに使用する GitRef を指定します。 戦略: GitOps。

--gitref-type

この Satellite サブスクリプションに使用する GitRef のタイプを示します。 戦略: GitOps。 許可される値: branch、commit、tag、release

--name

Satellite サブスクリプションの新しい名前を指定します。

--path

Satellite サブスクリプションに使用する、リモート・リポジトリー内のリポジトリー・ファイルまたはリリース・アセットへのパスを指定します。 戦略: GitOps。

-q

その日のメッセージを表示せず、リマインダーも更新しません。

--repository

Satellite サブスクリプションに使用するリモート・リポジトリーの URL を指定します。 戦略: GitOps。

--subscription

Satellite サブスクリプションの名前または ID を指定します。 購読リストを表示するには、 ibmcloud sat subscription ls を実行してください。

--version

Satellite サブスクリプションに使用する既存の構成バージョンを示します。 戦略: 直接アップロード。

例

Satellite のサブスクリプションを更新する

ibmcloud sat subscription update \
  --subscription SUBSCRIPTION \
  --auth-required \
  --gitref GITREF \
  --gitref-type TYPE \
  --path PATH \
  --repository REPOSITORY