コマンド・オプション

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

例

ACL を作成します。

ibmcloud sat acl create --location LOCATION --connector-id CONNECTOR_ID --name NAME

コマンド・オプション

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

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

例

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

ibmcloud sat acl endpoint add \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --acl-id ACL_ID

コマンド・オプション

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

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

例

ACL に対して有効なエンドポイントをすべてリストする。

ibmcloud sat acl endpoint ls \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --acl-id ACL_ID

コマンド・オプション

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

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

例

ACL から 1 つ以上の有効なエンドポイントを削除します。

ibmcloud sat acl endpoint rm \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --acl-id ACL_ID

コマンド・オプション

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

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

例

ACLの詳細を表示します。

ibmcloud sat acl get --location LOCATION --connector-id CONNECTOR_ID --acl-id ACL_ID

コマンド・オプション

--connector-id ID

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

--location LOCATION

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

--output OUTPUT

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

-q

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

例

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

ibmcloud sat acl ls --location LOCATION --connector-id CONNECTOR_ID --output json

コマンド・オプション

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

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

例

ACLを削除する。

ibmcloud sat acl rm --location LOCATION --connector-id CONNECTOR_ID --acl-id ACL_ID

コマンド・オプション

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

例

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

ibmcloud sat acl subnet add \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --acl-id ACL_ID

コマンド・オプション

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

例

ACLから1つまたは複数のサブネットを削除する。

ibmcloud sat acl subnet rm \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --acl-id ACL_ID

コマンド・オプション

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

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

例

ACLの名前を更新する。

ibmcloud sat acl update \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --acl-id ACL_ID

コマンド・オプション

--platform PLATFORM

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

-q

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

例

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

ibmcloud sat agent attach --platform PLATFORM -q

コマンド・オプション

--connector-id ID

Satellite コネクターの ID です。

--output OUTPUT

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

-q

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

例

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

ibmcloud sat agent ls --connector-id CONNECTOR_ID --output json -q

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

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

--output OUTPUT

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

-q

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

例

登録済みクラスターの詳細を取得します。

ibmcloud sat cluster get --cluster CLUSTER_NAME_OR_ID --output json -q

コマンド・オプション

--filter FILTER

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

--limit LIMIT

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

--output OUTPUT

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

-q

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

例

IBM Cloud アカウント内のすべての登録済みクラスターをリストします。

ibmcloud sat cluster ls --filter FILTER --limit LIMIT --output json

コマンド・オプション

--name NAME

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

-q

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

--silent

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

例

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

ibmcloud sat cluster register --silent SILENT --name NAME -q

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

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

-f

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

-q

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

例

クラスター登録を削除します。

ibmcloud sat cluster unregister --cluster CLUSTER_NAME_OR_ID -f -q

コマンド・オプション

--data-location LOCATION

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

--name NAME

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

--provider PROVIDER

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

-q

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

例

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

ibmcloud sat config create \
  --name NAME \
  --data-location LOCATION \
  --provider PROVIDER_ID

コマンド・オプション

--config CONFIG

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

--output OUTPUT

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

-q

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

例

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

ibmcloud sat config get --config CONFIG --output json -q

コマンド・オプション

--output OUTPUT

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

-q

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

例

IBM Cloud アカウント内のすべての Satellite 構成をリストします。

ibmcloud sat config ls --output json -q

コマンド・オプション

--config CONFIG

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

--name NAME

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

-q

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

例

Satellite 構成の名前を変更します。

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

コマンド・オプション

--config CONFIG

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

-f

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

-q

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

例

Satellite 構成を削除します。

ibmcloud sat config rm --config CONFIG -f -q

コマンド・オプション

--config CONFIG

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

--description DESCRIPTION

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

--file-format FORMAT

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

--name NAME

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

-q

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

--read-config CONFIG

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

例

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

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

コマンド・オプション

--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> を実行します。

例

Satellite 構成バージョンの詳細を取得します。

ibmcloud sat config version get \
  --config CONFIG \
  --version VERSION \
  --save-config SAVE-CONFIG

コマンド・オプション

--config CONFIG

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

-f

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

-q

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

--version VERSION

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

例

Satellite 構成バージョンを削除します。

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

コマンド・オプション

--name NAME

Satellite コネクターの名前。

-q

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

--region REGION

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

例

Satellite コネクターを作成します。

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

コマンド・オプション

--connector-id ID

Satellite コネクターの ID です。

--output OUTPUT

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

-q

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

例

Satellite コネクターの詳細を表示します。

ibmcloud sat connector get --connector-id CONNECTOR_ID --output json -q

コマンド・オプション

--after AFTER

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

--first FIRST

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

--output OUTPUT

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

-q

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

例

IBM Cloud アカウントで「 Satellite 」コネクタを確認してください。

ibmcloud sat connector ls --after AFTER --first FIRST --output json

コマンド・オプション

--connector-id ID

Satellite コネクターの ID です。

-f

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

-q

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

例

Satellite コネクターを削除します。

ibmcloud sat connector rm --connector-id CONNECTOR_ID -f -q

コマンド・オプション

--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 get \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --endpoint ENDPOINT

コマンド・オプション

--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 rotate \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --endpoint ENDPOINT

コマンド・オプション

--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 authn set \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --endpoint ENDPOINT

コマンド・オプション

--connector-id ID

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

--dest-hostname HOSTNAME

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

--dest-port PORT

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

--dest-protocol PROTOCOL

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

--dest-type TYPE

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

--idle-timeout-seconds SECONDS

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

--location LOCATION

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

--name NAME

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

--output OUTPUT

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

-q

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

--sni SNI

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

--source-protocol PROTOCOL

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

例

エンドポイントを作成します。

ibmcloud sat endpoint create \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --name NAME

コマンド・オプション

--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 disable \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --endpoint ENDPOINT

コマンド・オプション

--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 \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --endpoint ENDPOINT

コマンド・オプション

--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 get \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --endpoint ENDPOINT

コマンド・オプション

--connector-id ID

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

--location LOCATION

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

--output OUTPUT

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

-q

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

例

Satellite ロケーション内のすべてのエンドポイントをリストします。

ibmcloud sat endpoint ls --location LOCATION --connector-id CONNECTOR_ID --output json

コマンド・オプション

--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 rm \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --endpoint ENDPOINT

コマンド・オプション

--connector-id ID

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

--dest-hostname HOSTNAME

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

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

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

--source-protocol PROTOCOL

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

例

エンドポイントを更新します。

ibmcloud sat endpoint update \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --endpoint ENDPOINT

コマンド・オプション

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

例

ACL を作成します。

ibmcloud sat experimental acl create \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --name NAME

コマンド・オプション

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

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

例

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

ibmcloud sat experimental acl endpoint add \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --acl-id ACL_ID

コマンド・オプション

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

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

例

ACL に対して有効なエンドポイントをすべてリストする。

ibmcloud sat experimental acl endpoint ls \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --acl-id ACL_ID

コマンド・オプション

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

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

例

ACL から 1 つ以上の有効なエンドポイントを削除します。

ibmcloud sat experimental acl endpoint rm \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --acl-id ACL_ID

コマンド・オプション

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

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

例

ACLの詳細を表示します。

ibmcloud sat experimental acl get \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --acl-id ACL_ID

コマンド・オプション

--connector-id ID

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

--location LOCATION

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

--output OUTPUT

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

-q

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

例

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

ibmcloud sat experimental acl ls \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --output json

コマンド・オプション

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

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

例

ACLを削除する。

ibmcloud sat experimental acl rm \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --acl-id ACL_ID

コマンド・オプション

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

例

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

ibmcloud sat experimental acl subnet add \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --acl-id ACL_ID

コマンド・オプション

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

例

ACLから1つまたは複数のサブネットを削除する。

ibmcloud sat experimental acl subnet rm \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --acl-id ACL_ID

コマンド・オプション

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

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

例

ACLの名前を更新する。

ibmcloud sat experimental acl update \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --acl-id ACL_ID

コマンド・オプション

--platform PLATFORM

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

-q

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

例

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

ibmcloud sat experimental agent attach --platform PLATFORM -q

コマンド・オプション

--connector-id ID

Satellite コネクターの ID です。

--output OUTPUT

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

-q

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

例

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

ibmcloud sat experimental agent ls --connector-id CONNECTOR_ID --output json -q

コマンド・オプション

--name NAME

Satellite コネクターの名前。

-q

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

--region REGION

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

例

Satellite コネクターを作成します。

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

コマンド・オプション

--connector-id ID

Satellite コネクターの ID です。

--output OUTPUT

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

-q

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

例

Satellite コネクターの詳細を表示します。

ibmcloud sat experimental connector get --connector-id CONNECTOR_ID --output json -q

コマンド・オプション

--after AFTER

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

--first FIRST

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

--output OUTPUT

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

-q

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

例

IBM Cloud アカウントで「 Satellite 」コネクタを確認してください。

ibmcloud sat experimental connector ls --after AFTER --first FIRST --output json

コマンド・オプション

--connector-id ID

Satellite コネクターの ID です。

-f

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

-q

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

例

Satellite コネクターを削除します。

ibmcloud sat experimental connector rm --connector-id CONNECTOR_ID -f -q

コマンド・オプション

--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 get \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --endpoint ENDPOINT

コマンド・オプション

--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 rotate \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --endpoint ENDPOINT

コマンド・オプション

--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 endpoint authn set \
  --location LOCATION \
  --connector-id CONNECTOR_ID \
  --endpoint ENDPOINT

コマンド・オプション

--description DESCRIPTION

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

--location-id ID

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

--name NAME

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

-q

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

例

Satelliteの場所の名前または説明を更新する。

ibmcloud sat experimental location update \
  --location-id LOCATION \
  --name NAME \
  --description IP_ADDRESS

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

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

--group GROUP, -g GROUP

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

-q

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

例

クラスター・グループにクラスターを追加します。

ibmcloud sat group attach --group GROUP --cluster CLUSTER_NAME_OR_ID -q

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

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

--name NAME

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

-q

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

例

クラスター・グループを作成します。

ibmcloud sat group create --name NAME --cluster CLUSTER_NAME_OR_ID -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

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

例

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

ibmcloud sat group detach --group GROUP --cluster CLUSTER_NAME_OR_ID -f

コマンド・オプション

--group GROUP, -g GROUP

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

--output OUTPUT

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

-q

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

例

Satellite クラスター・グループの詳細情報を取得します。

ibmcloud sat group get --group GROUP --output json -q

コマンド・オプション

--output OUTPUT

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

-q

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

例

IBM Cloud アカウント内のすべての Satellite クラスター・グループをリストします。

ibmcloud sat group ls --output json -q

コマンド・オプション

-f

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

--group GROUP, -g GROUP

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

-q

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

例

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

ibmcloud sat group rm --group GROUP -f -q

コマンド・オプション

--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 」フィールドを確認してください。

例

Satellite ロケーション・コントロール・プレーンまたはクラスターにホストを割り当てます。

ibmcloud sat host assign \
  --location LOCATION \
  --cluster CLUSTER_NAME_OR_ID \
  --worker-pool POOL_NAME

コマンド・オプション

--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 attach \
  --location LOCATION \
  --host-label HOSTNAME \
  --reset-key RESET-KEY

コマンド・オプション

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

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

例

Satellite ホストの詳細を表示します。

ibmcloud sat host get --location LOCATION --host HOSTNAME --output json

コマンド・オプション

--location LOCATION

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

--output OUTPUT

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

-q

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

例

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

ibmcloud sat host ls --location LOCATION --output json -q

コマンド・オプション

-f

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

--host HOST

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

--location LOCATION

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

-q

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

例

Satellite ロケーションからホストを削除します。

ibmcloud sat host rm --location LOCATION --host HOSTNAME -f

コマンド・オプション

--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 host update --location LOCATION --host-label HOSTNAME --zone ZONE

コマンド・オプション

--output OUTPUT

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

-q

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

例

IBM Cloud アカウント内のすべての Satellite 構成キーをリストします。

ibmcloud sat key ls --output json -q

コマンド・オプション

-f

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

--key KEY

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

-q

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

例

Satellite 構成キーを削除します。

ibmcloud sat key rm --key KEY -f -q

コマンド・オプション

-f

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

--name NAME

新規 Satellite 構成鍵の名前。

-q

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

例

管理対象クラスターが Satellite Config に接続するために使用する新しい鍵を生成します。

ibmcloud sat key rotate --name NAME -f -q

コマンド・オプション

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

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

--pod-subnet SUBNET

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

例

Satellite ロケーションを作成します。

ibmcloud sat location create \
  --pod-subnet SUBNET_CIDR \
  --service-subnet SUBNET_CIDR \
  --name NAME

コマンド・オプション

--location LOCATION

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

--output OUTPUT

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

-q

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

--subdomain SUBDOMAIN

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

例

Satellite ロケーションにある登録済みサブドメインの詳細を表示します。

ibmcloud sat location dns get --location LOCATION --subdomain DOMAIN --output json

コマンド・オプション

--location LOCATION

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

--output OUTPUT

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

-q

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

例

Satellite ロケーション内の登録済みサブドメインをリストします。

ibmcloud sat location dns ls --location LOCATION --output json -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

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

例

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

ibmcloud sat location dns register --location LOCATION --ip IP_ADDRESS --output json

コマンド・オプション

--location LOCATION

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

--output OUTPUT

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

-q

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

例

Satellite ロケーションの詳細を表示します。

ibmcloud sat location get --location LOCATION --output json -q

コマンド・オプション

--output OUTPUT

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

-q

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

例

IBM Cloud アカウント内の Satellite ロケーションをすべてリストします。

ibmcloud sat location ls --output json -q

コマンド・オプション

-f

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

--location LOCATION

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

-q

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

例

ロケーションを削除します。

ibmcloud sat location rm --location LOCATION -f -q

コマンド・オプション

--description DESCRIPTION

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

--location-id ID

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

--name NAME

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

-q

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

例

Satelliteの場所の名前または説明を更新する。

ibmcloud sat location update \
  --location-id LOCATION \
  --name NAME \
  --description IP_ADDRESS

コマンド・オプション

-q

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

例

現在のユーザー・メッセージを表示します。

ibmcloud sat messages -q

コマンド・オプション

--history HISTORY

リソースの履歴 ID です。

--output OUTPUT

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

-q

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

--resource RESOURCE

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

--save-data

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

例

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

ibmcloud sat resource get \
  --resource RESOURCE \
  --history HISTORY \
  --save-data SAVE-DATA

コマンド・オプション

--limit LIMIT

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

--output OUTPUT

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

-q

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

--resource RESOURCE

Kubernetes リソース ID。

例

Kubernetes リソースの履歴を取得します。

ibmcloud sat resource history get --resource RESOURCE --limit LIMIT --output json

コマンド・オプション

--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 を実行してください。

例

Satellite によって管理される Kubernetes リソースを検索します。

ibmcloud sat resource ls --search SEARCH --limit LIMIT --cluster CLUSTER_NAME_OR_ID

コマンド・オプション

--location LOCATION

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

--output OUTPUT

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

-q

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

例

ロケーション内のすべての Satellite サービス・クラスターをリストして、要求されたホスト・リソースなどの詳細を確認します。

ibmcloud sat service ls --location LOCATION --output json -q

コマンド・オプション

--all

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

--assignment ASSIGNMENT

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

--config CONFIG

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

-q

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

例

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

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

コマンド・オプション

--all

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

--assignment ASSIGNMENT

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

--config CONFIG

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

-q

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

例

Satellite のストレージ割り当てに対して、自動パッチ適用を有効にします。

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

コマンド・オプション

--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> を実行してください。

例

Satellite ロケーション内のクラスターにストレージ構成をデプロイするための割り当てを作成します。

ibmcloud sat storage assignment create \
  --name NAME \
  --group GROUP \
  --service-cluster-id CLUSTER_NAME_OR_ID

コマンド・オプション

--assignment ASSIGNMENT

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

--output OUTPUT

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

-q

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

例

Satellite ストレージの割り当ての詳細を取得します。

ibmcloud sat storage assignment get --assignment ASSIGNMENT --output json -q

コマンド・オプション

--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> を実行してください。

例

IBM Cloud アカウント内の Satellite ストレージ割り当てをリストします。

ibmcloud sat storage assignment ls \
  --service-cluster-id CLUSTER_NAME_OR_ID \
  --cluster CLUSTER_NAME_OR_ID \
  --config CONFIG

コマンド・オプション

--assignment ASSIGNMENT

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

-f

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

-q

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

例

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

ibmcloud sat storage assignment patch --assignment ASSIGNMENT -f -q

コマンド・オプション

--assignment ASSIGNMENT

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

-f

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

-q

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

例

Satellite ストレージ割り当てを削除します。

ibmcloud sat storage assignment rm --assignment ASSIGNMENT -f -q

コマンド・オプション

--assignment ASSIGNMENT

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

-f

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

--group GROUP, -g GROUP

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

--name NAME

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

-q

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

例

Satellite ストレージの割り当てを更新します。

ibmcloud sat storage assignment update \
  --assignment ASSIGNMENT \
  --name NAME \
  --group GROUP

コマンド・オプション

--config-name NAME

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

--name NAME

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

--param PARAM, -p PARAM

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

-q

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

例

カスタム Satellite ストレージ・クラスを作成します。

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

コマンド・オプション

--class CLASS

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

--config CONFIG

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

--output OUTPUT

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

-q

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

例

Satellite ストレージ・クラスの詳細を取得します。

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

コマンド・オプション

--config CONFIG

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

--output OUTPUT

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

-q

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

--show-params

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

例

Satellite のストレージ構成に含まれるストレージクラスを列挙してください。

ibmcloud sat storage config class ls \
  --config CONFIG \
  --show-params SHOW-PARAMS \
  --output json

コマンド・オプション

--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 を実行してください。

例

クラスターにストレージ・ドライバーをインストールする Satellite ストレージ構成を作成します。

ibmcloud sat storage config create \
  --name NAME \
  --template-name NAME \
  --template-version VERSION

コマンド・オプション

--config CONFIG

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

--output OUTPUT

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

-q

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

例

Satellite ストレージ構成の詳細を取得します。

ibmcloud sat storage config get --config CONFIG --output json -q

コマンド・オプション

--location LOCATION

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

--output OUTPUT

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

-q

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

例

IBM Cloud アカウント内の Satellite ストレージ構成をリストします。

ibmcloud sat storage config ls --location LOCATION --output json -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

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

例

Satellite ストレージ構成の構成パラメーターと秘密パラメーターを設定します。

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

コマンド・オプション

--config CONFIG

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

-f

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

--include-assignments

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

-q

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

例

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

ibmcloud sat storage config patch \
  --config CONFIG \
  --include-assignments INCLUDE-ASSIGNMENTS \
  -f

コマンド・オプション

--config CONFIG

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

-f

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

--include-assignments

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

-q

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

例

Satellite ストレージ構成を削除します。

ibmcloud sat storage config rm \
  --config CONFIG \
  --include-assignments INCLUDE-ASSIGNMENTS \
  -f

コマンド・オプション

--name NAME

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

--output OUTPUT

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

-q

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

--version VERSION

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

例

Satellite のストレージテンプレートの詳細を確認します。

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

コマンド・オプション

-q

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

例

使用可能な Satellite ストレージ・テンプレートをリストします。

ibmcloud sat storage template ls -q

コマンド・オプション

--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> を実行してください。 戦略: 直接アップロード。

例

クラスターの Satellite サブスクリプションを作成します。

ibmcloud sat subscription create \
  --auth-required AUTH-REQUIRED \
  --name NAME \
  --group GROUP \
  --config CONFIG

コマンド・オプション

--output OUTPUT

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

-q

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

--subscription SUBSCRIPTION

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

例

Satellite サブスクリプションの詳細情報を取得します。

ibmcloud sat subscription get --subscription IP_ADDRESS --output json -q

コマンド・オプション

-f

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

-q

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

--subscription SUBSCRIPTION

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

例

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

ibmcloud sat subscription identity set --subscription IP_ADDRESS -f -q

コマンド・オプション

--cluster CLUSTER, -c CLUSTER

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

--output OUTPUT

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

-q

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

例

IBM Cloud アカウント内の Satellite サブスクリプションをすべてリストします。

ibmcloud sat subscription ls --cluster CLUSTER_NAME_OR_ID --output json -q

コマンド・オプション

-f

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

-q

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

--subscription SUBSCRIPTION

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

例

Satellite サブスクリプションを削除します。

ibmcloud sat subscription rm --subscription IP_ADDRESS -f -q

コマンド・オプション

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

例

Satellite サブスクリプションを更新します。

ibmcloud sat subscription update \
  --auth-required AUTH-REQUIRED \
  --subscription IP_ADDRESS \
  --name NAME \
  --group GROUP