Command options

--connector-id

The ID of the Satellite connector. To find the connector ID, run ibmcloud sat connector ls.

--endpoint

A name or ID of an endpoint to enable for this ACL.

--location

The name or ID of the Satellite location. To find the location ID or name, run ibmcloud sat location ls.

--name

The name for the ACL.

-q

Do not show the message of the day or update reminders.

--subnet

An IP or CIDR block allowed by this ACL. Value must be fully contained in the following CIDRs: 10.0.0.0/8, 161.26.0.0/16, 166.8.0.0/14, 172.16.0.0/12.

Examples

Create an ACL

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

Command options

--acl-id

Specify the ID of the ACL. To list all ACLs, run ibmcloud sat acl ls.

--connector-id

The ID of the Satellite connector. To find the connector ID, run ibmcloud sat connector ls.

--endpoint

A name or ID of an endpoint to enable for this ACL.

--location

The name or ID of the Satellite location. To find the location ID or name, run ibmcloud sat location ls.

-q

Do not show the message of the day or update reminders.

Examples

Add one or more enabled endpoints to an ACL

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

Examples

Show help

ibmcloud sat acl endpoint help

Command options

--acl-id

Specify the ID of the ACL. To list all ACLs, run ibmcloud sat acl ls.

--connector-id

The ID of the Satellite connector. To find the connector ID, run ibmcloud sat connector ls.

--location

The name or ID of the Satellite location. To find the location ID or name, run ibmcloud sat location ls.

--output

Prints the command output in the provided format. Accepted values: json

-q

Do not show the message of the day or update reminders.

Examples

List all enabled endpoints for an ACL

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

Command options

--acl-id

Specify the ID of the ACL. To list all ACLs, run ibmcloud sat acl ls.

--connector-id

The ID of the Satellite connector. To find the connector ID, run ibmcloud sat connector ls.

--endpoint

A name or ID of an endpoint to disable for this ACL.

--location

The name or ID of the Satellite location. To find the location ID or name, run ibmcloud sat location ls.

-q

Do not show the message of the day or update reminders.

Examples

Remove one or more enabled endpoints from an ACL

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

Command options

--acl-id

Specify the ID of the ACL. To list all ACLs, run ibmcloud sat acl ls.

--connector-id

The ID of the Satellite connector. To find the connector ID, run ibmcloud sat connector ls.

--location

The name or ID of the Satellite location. To find the location ID or name, run ibmcloud sat location ls.

--output

Prints the command output in the provided format. Accepted values: json

-q

Do not show the message of the day or update reminders.

Examples

View the details of an ACL

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

Examples

Show help

ibmcloud sat acl help

Command options

--connector-id

The ID of the Satellite connector. To find the connector ID, run ibmcloud sat connector ls.

--location

The name or ID of the Satellite location. To find the location ID or name, run ibmcloud sat location ls.

--output

Prints the command output in the provided format. Accepted values: json

-q

Do not show the message of the day or update reminders.

Examples

List all ACLs for a Satellite connector or location

ibmcloud sat acl ls --connector-id ID

Command options

--acl-id

Specify the ID of the ACL. To list all ACLs, run ibmcloud sat acl ls.

--connector-id

The ID of the Satellite connector. To find the connector ID, run ibmcloud sat connector ls.

--location

The name or ID of the Satellite location. To find the location ID or name, run ibmcloud sat location ls.

-q

Do not show the message of the day or update reminders.

Examples

Delete an ACL

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

Command options

--acl-id

Specify the ID of the ACL. To list all ACLs, run ibmcloud sat acl ls.

--connector-id

The ID of the Satellite connector. To find the connector ID, run ibmcloud sat connector ls.

--location

The name or ID of the Satellite location. To find the location ID or name, run ibmcloud sat location ls.

-q

Do not show the message of the day or update reminders.

--subnet

An IP or CIDR block allowed by this ACL. Value must be fully contained in the following CIDRs: 10.0.0.0/8, 161.26.0.0/16, 166.8.0.0/14, 172.16.0.0/12.

Examples

Add one or more subnets to an ACL

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

Examples

Show help

ibmcloud sat acl subnet help

Command options

--acl-id

Specify the ID of the ACL. To list all ACLs, run ibmcloud sat acl ls.

--connector-id

The ID of the Satellite connector. To find the connector ID, run ibmcloud sat connector ls.

--location

The name or ID of the Satellite location. To find the location ID or name, run ibmcloud sat location ls.

-q

Do not show the message of the day or update reminders.

--subnet

An IP or CIDR block allowed by this ACL. Value must be fully contained in the following CIDRs: 10.0.0.0/8, 161.26.0.0/16, 166.8.0.0/14, 172.16.0.0/12.

Examples

Remove one or more subnets from an ACL

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

Command options

--acl-id

Specify the ID of the ACL. To list all ACLs, run ibmcloud sat acl ls.

--connector-id

The ID of the Satellite connector. To find the connector ID, run ibmcloud sat connector ls.

--location

The name or ID of the Satellite location. To find the location ID or name, run ibmcloud sat location ls.

--name

The new name for the ACL.

-q

Do not show the message of the day or update reminders.

Examples

Update the name of an ACL

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

Command options

--platform

The platform for the Satellite Connector Agent. For more information about Docker, see the documentation at https://ibm.biz/satconagent Available options: windows, docker

-q

Do not show the message of the day or update reminders.

Examples

Get a Satellite Connector Agent for a specific platform

ibmcloud sat agent attach --platform PLATFORM

Examples

Show help

ibmcloud sat agent help

Command options

--connector-id

The ID of a Satellite connector.

--output

Prints the command output in the provided format. Accepted values: json

-q

Do not show the message of the day or update reminders.

Examples

List all Agents for a Satellite Connector

ibmcloud sat agent ls --connector-id ID

Command options

-c, --cluster

Specify the cluster name or the ID. To list registered clusters, run ibmcloud sat cluster ls.

--output

Prints the command output in the provided format. Accepted values: json

-q

Do not show the message of the day or update reminders.

Examples

Get the details of a registered cluster

ibmcloud sat cluster get --cluster CLUSTER

Examples

Show help

ibmcloud sat cluster help

Command options

--filter

Filter registered clusters by cluster ID.

--limit

Limit the number of clusters that are returned.

--output

Prints the command output in the provided format. Accepted values: json

-q

Do not show the message of the day or update reminders.

Examples

List all registered clusters in your IBM Cloud account

ibmcloud sat cluster ls

Command options

--name

Specify the name of the cluster that you want to register

-q

Do not show the message of the day or update reminders.

--silent

Silent. Return only the registration command in the output.

Examples

Get a kubectl command to register your cluster in a Satellite configuration

ibmcloud sat cluster register --name NAME

Command options

-c, --cluster

Specify the cluster name or the ID. To list registered clusters, run ibmcloud sat cluster ls.

-f

Force the command to run without user prompts.

-q

Do not show the message of the day or update reminders.

Examples

Remove a cluster registration

ibmcloud sat cluster unregister --cluster CLUSTER

Command options

--data-location

Specify the IBM region to store the Satellite configuration data. Strategy: Direct Upload.

--name

Provide a name for the Satellite configuration.

--provider

Indicate the remote GitOps provider for the Satellite configuration. This provider stores the Kubernetes resource definitions. Strategy: GitOps. Allowed values: github, gitlab

-q

Do not show the message of the day or update reminders.

Examples

Create a configuration to specify what Kubernetes resources you want to deploy to your clusters in your Satellite workloads

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

Command options

--config

Specify the name or ID of a Satellite configuration. To list available configurations, run ibmcloud sat config ls.

--output

Prints the command output in the provided format. Accepted values: json

-q

Do not show the message of the day or update reminders.

Examples

Get details of a Satellite configuration, such as the versions or subscriptions that are associated with the configuration

ibmcloud sat config get --config CONFIG

Examples

Show help

ibmcloud sat config help

Command options

--output

Prints the command output in the provided format. Accepted values: json

-q

Do not show the message of the day or update reminders.

Examples

List all Satellite configurations in your IBM Cloud account

ibmcloud sat config ls

Command options

--config

Specify the name or ID of a Satellite configuration. To list available configurations, run ibmcloud sat config ls.

--name

Provide a new name for the Satellite configuration.

-q

Do not show the message of the day or update reminders.

Examples

Rename a Satellite configuration

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

Command options

--config

Specify the name or ID of a Satellite configuration. To list available configurations, run ibmcloud sat config ls.

-f

Force the command to run without user prompts.

-q

Do not show the message of the day or update reminders.

Examples

Remove a Satellite configuration

ibmcloud sat config rm --config CONFIG

Command options

--config

Specify the name or ID of the Satellite configuration. To list available configurations, run ibmcloud sat config ls.

--description

Add a description for the Satellite configuration version.

--file-format

Indicate the file format of the configuration version. Available options: yaml

--name

Provide a name for the Satellite configuration version.

-q

Do not show the message of the day or update reminders.

--read-config

Specify the file path for the configuration version file.

Examples

Create a configuration version to update existing Kubernetes resources for your Satellite workloads

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

Command options

--config

Specify the name or ID of the Satellite configuration. To list available configurations, run ibmcloud sat config ls.

--output

Prints the command output in the provided format. Accepted values: json

-q

Do not show the message of the day or update reminders.

--save-config

Download and save the configuration version to a temporary file.

--version

Specify the name or ID of the Satellite configuration version. To list versions in your configuration, run ibmcloud sat config get --config <configuration_name_or_ID>.

Examples

Get details for a Satellite configuration version

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

Examples

Show help

ibmcloud sat config version help

Command options

--config

Specify the name or ID of the Satellite configuration. To list available configurations, run ibmcloud sat config ls.

-f

Force the command to run without user prompts.

-q

Do not show the message of the day or update reminders.

--version

Indicate the name or ID of the Satellite configuration version. To list versions, run ibmcloud sat config get --config <configuration_name_or_ID>.

Examples

Remove a Satellite configuration version

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

Command options

--name

The name for the Satellite connector.

-q

Do not show the message of the day or update reminders.

--region

The IBM Cloud region to manage your Satellite connector.

Examples

Create a Satellite connector

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

Command options

--connector-id

The ID of a Satellite connector.

--output

Prints the command output in the provided format. Accepted values: json

-q

Do not show the message of the day or update reminders.

Examples

View the details of a Satellite Connector

ibmcloud sat connector get --connector-id ID

Examples

Show help

ibmcloud sat connector help

Command options

--after

Show Satellite Connectors after the given cursor.

--first

View the next Satellite Connectors, up to the first number of Connectors.

--output

Prints the command output in the provided format. Accepted values: json

-q

Do not show the message of the day or update reminders.

Examples

View the Satellite Connectors in your IBM Cloud account

ibmcloud sat connector ls

Command options

--connector-id

The ID of a Satellite connector.

-f

Force the command to run without user prompts.

-q

Do not show the message of the day or update reminders.

Examples

Delete a Satellite connector

ibmcloud sat connector rm --connector-id ID

Command options

--connector-id

The ID of the Satellite connector. To find the connector ID, run ibmcloud sat connector ls.

--endpoint

Specify the name or ID of the endpoint. To list all endpoints, run ibmcloud sat endpoint ls.

--location

The name or ID of the Satellite location. To find the location ID or name, run ibmcloud sat location ls.

--output

Prints the command output in the provided format. Accepted values: json

-q

Do not show the message of the day or update reminders.

Examples

Get the authentication settings for an endpoint

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

Examples

Show help

ibmcloud sat endpoint authn help

Command options

--connector-id

The ID of the Satellite connector. To find the connector ID, run ibmcloud sat connector ls.

--dest-ca-cert-file

Trusted CA certificate or chain used to validate the destination server's certificate. For example myCA.pem.

--dest-cert-file

The client certificate used to authenticate with the destination server. For example myCert.pem.

--dest-key-file

The client private key used to encrypt the client certificate. For example myKey.pem.

--endpoint

Specify the name or ID of the endpoint. To list all endpoints, run ibmcloud sat endpoint ls.

--location

The name or ID of the Satellite location. To find the location ID or name, run ibmcloud sat location ls.

-q

Do not show the message of the day or update reminders.

--source-ca-cert-file

Trusted CA certificate or chain used to validate the source client's certificate when source-tls-mode is mutual. For example myCA.pem.

--source-cert-file

The server certificate to present to the source client. For example myCert.pem.

--source-key-file

The server private key used to encrypt the server certificate. For example myKey.pem.

Examples

Replace existing authentication certificates with new ones

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

Command options

--connector-id

The ID of the Satellite connector. To find the connector ID, run ibmcloud sat connector ls.

--dest-ca-cert-file

Trusted CA certificate or chain used to validate the destination server's certificate. For example myCA.pem.

--dest-cert-file

The client certificate used to authenticate with the destination server. For example myCert.pem.

--dest-key-file

The client private key used to encrypt the client certificate. For example myKey.pem.

--dest-tls-mode

The destination TLS mode. Accepted values: simple, mutual, none

--endpoint

Specify the name or ID of the endpoint. To list all endpoints, run ibmcloud sat endpoint ls.

--location

The name or ID of the Satellite location. To find the location ID or name, run ibmcloud sat location ls.

-q

Do not show the message of the day or update reminders.

--source-ca-cert-file

Trusted CA certificate or chain used to validate the source client's certificate when source-tls-mode is mutual. For example myCA.pem.

--source-cert-file

The server certificate to present to the source client. For example myCert.pem.

--source-key-file

The server private key used to encrypt the server certificate. For example myKey.pem.

--source-tls-mode

The source TLS mode. Accepted values: simple, mutual

Examples

Set authentication settings for an endpoint

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

Command options

--connector-id

The ID of the Satellite connector. To find the connector ID, run ibmcloud sat connector ls.

--dest-hostname

Indicate the fully qualified domain name (FQDN) or the externally accessible IP address of the destination that you want to connect to. For cloud endpoints, this value must resolve to a public IP address or to a private IP address that is accessible within IBM Cloud such as a private cloud service endpoint. For location endpoints, this value must resolve from and be reachable from the control plane hosts for Satellite locations or where the agent runs for Satellite Connector.

--dest-port

Provide the port that the destination resource listens on for incoming requests. Make sure that the port matches the destination protocol.

--dest-protocol

Specify the destination's protocol. If you do not specify this option, the destination protocol is inherited from the source protocol. Accepted values: TCP, TLS

--dest-type

Specify where the destination resource runs, either in IBM Cloud (cloud) or your Satellite location (location). Available options: location, cloud

--idle-timeout-seconds

Specify the timeout interval in seconds for active connections to the destination. Make sure your timeout is compatible with the destination service and protocol keep-alive settings.

--location

The name or ID of the Satellite location. To find the location ID or name, run ibmcloud sat location ls.

--name

Provide a name for the endpoint.

--output

Prints the command output in the provided format. Accepted values: json

-q

Do not show the message of the day or update reminders.

--sni

Specify the server name indicator, if you specify a tls or https source protocol and want a separate hostname to be added to the TLS handshake.

--source-protocol

Provide the protocol that the source uses to connect the destination resource. See http://ibm.biz/endpoint-protocols. Available options: TCP, TLS, HTTP, HTTPS, HTTP-tunnel

Examples

Create an endpoint

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

Command options

--connector-id

The ID of the Satellite connector. To find the connector ID, run ibmcloud sat connector ls.

--endpoint

Specify the name or ID of the endpoint. To list all endpoints, run ibmcloud sat endpoint ls (--connector-id ID | --location LOCATION).

-f

Force the command to run without user prompts.

--location

The name or ID of the Satellite location. To find the location ID or name, run ibmcloud sat location ls.

-q

Do not show the message of the day or update reminders.

Examples

Disable an endpoint

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

Command options

--connector-id

The ID of the Satellite connector. To find the connector ID, run ibmcloud sat connector ls.

--endpoint

Specify the name or ID of the endpoint. To list all endpoints, run ibmcloud sat endpoint ls (--connector-id ID | --location LOCATION).

-f

Force the command to run without user prompts.

--location

The name or ID of the Satellite location. To find the location ID or name, run ibmcloud sat location ls.

-q

Do not show the message of the day or update reminders.

Examples

Enable an endpoint

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

Command options

--connector-id

The ID of the Satellite connector. To find the connector ID, run ibmcloud sat connector ls.

--endpoint

Specify the name or ID of the endpoint. To list all endpoints, run ibmcloud sat endpoint ls (--connector-id ID | --location LOCATION).

--location

The name or ID of the Satellite location. To find the location ID or name, run ibmcloud sat location ls.

--output

Prints the command output in the provided format. Accepted values: json

-q

Do not show the message of the day or update reminders.

Examples

View the details of an endpoint

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

Examples

Show help

ibmcloud sat endpoint help

Command options

--connector-id

The ID of the Satellite connector. To find the connector ID, run ibmcloud sat connector ls.

--location

The name or ID of the Satellite location. To find the location ID or name, run ibmcloud sat location ls.

--output

Prints the command output in the provided format. Accepted values: json

-q

Do not show the message of the day or update reminders.

Examples

List all endpoints in a Satellite location

ibmcloud sat endpoint ls --connector-id ID

Command options

--connector-id

The ID of the Satellite connector. To find the connector ID, run ibmcloud sat connector ls.

--endpoint

Specify the name or ID of the endpoint. To list all endpoints, run ibmcloud sat endpoint ls (--connector-id ID | --location LOCATION).

--location

The name or ID of the Satellite location. To find the location ID or name, run ibmcloud sat location ls.

-q

Do not show the message of the day or update reminders.

Examples

Delete an endpoint

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

Command options

--connector-id

The ID of the Satellite connector. To find the connector ID, run ibmcloud sat connector ls.

--dest-hostname

Indicate the fully qualified domain name (FQDN) or the externally accessible IP address of the destination that you want to connect to. For cloud endpoints, this value must resolve to a public IP address or to a private IP address that is accessible within IBM Cloud such as a private cloud service endpoint. For location endpoints, this value must resolve from and be reachable from the control plane hosts for Satellite locations or where the agent runs for Satellite Connector.

--dest-port

Provide the port that the destination resource listens on for incoming requests. Make sure that the port matches the destination protocol.

--dest-protocol

Specify the destination's protocol. If you do not specify this option, the destination protocol is inherited from the source protocol. Accepted values: TCP, TLS

--endpoint

Specify the name or ID of the endpoint. To list all endpoints, run ibmcloud sat endpoint ls (--connector-id ID | --location LOCATION).

--idle-timeout-seconds

Specify the timeout interval in seconds for active connections to the destination. Make sure your timeout is compatible with the destination service and protocol keep-alive settings.

--location

The name or ID of the Satellite location. To find the location ID or name, run ibmcloud sat location ls.

--name

Provide a new name for the endpoint.

-q

Do not show the message of the day or update reminders.

--sni

Specify the server name indicator, if you specify a tls or https source protocol and want a separate hostname to be added to the TLS handshake.

--source-protocol

Provide the protocol that the source uses to connect the destination resource. See http://ibm.biz/endpoint-protocols. Accepted values: TCP, TLS, HTTP, HTTPS, HTTP-tunnel

Examples

Update an endpoint

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

Examples

Show help

ibmcloud sat experimental endpoint help

Examples

Show help

ibmcloud sat experimental help

Command options

-c, --cluster

Specify the cluster name or ID. To list registered clusters, run ibmcloud sat cluster ls.

-g, --group

Specify the name or ID of a Satellite cluster group. To list available cluster groups, run ibmcloud sat group ls.

-q

Do not show the message of the day or update reminders.

Examples

Add a cluster to your cluster group

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

Command options

-c, --cluster

Specify the cluster name or ID to add to the cluster group. To list registered clusters, run ibmcloud sat cluster ls.

--name

Provide a name of the Satellite cluster group.

-q

Do not show the message of the day or update reminders.

Examples

Create a cluster group

ibmcloud sat group create --name NAME

Command options

-c, --cluster

Specify the cluster name or ID. To list the clusters in your cluster group, run ibmcloud sat group get --group <cluster_group_name_or_ID>.

-f

Force the command to run without user prompts.

-g, --group

Specify the name or ID of a Satellite cluster group. To list available cluster groups, run ibmcloud sat group ls.

-q

Do not show the message of the day or update reminders.

Examples

Removes one or more clusters from your Satellite cluster group and deletes the Kubernetes resources that were managed by the group's subscriptions

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

Command options

-g, --group

Specify the name or ID of a Satellite cluster group. To list registered clusters, run ibmcloud sat cluster ls.

--output

Prints the command output in the provided format. Accepted values: json

-q

Do not show the message of the day or update reminders.

Examples

Get detailed information for a Satellite cluster group

ibmcloud sat group get --group GROUP

Examples

Show help

ibmcloud sat group help

Command options

--output

Prints the command output in the provided format. Accepted values: json

-q

Do not show the message of the day or update reminders.

Examples

List all Satellite cluster groups in your IBM Cloud account

ibmcloud sat group ls

Command options

-f

Force the command to run without user prompts.

-g, --group

Specify the name or ID of a Satellite cluster group. To list available cluster groups, run ibmcloud sat group ls.

-q

Do not show the message of the day or update reminders.

Examples

Remove a Satellite cluster group, which unsubscribes clusters and deletes the Kubernetes resources that were managed by the group's subscriptions

ibmcloud sat group rm --group GROUP

Command options

--cluster

The name or ID of the cluster to assign the host to. To list available clusters, run ibmcloud sat cluster ls. If no cluster is provided, the host is automatically assigned to the Satellite control plane.

--host

The name or ID of the host to assign. To automatically assign hosts based on labels, do not include this option. To retrieve the host ID, run ibmcloud sat host ls --location <location_ID_or_name>.

--host-label, --hl

Enter any labels as key-value pairs to identify the host to assign to your Satellite control plane or Red Hat OpenShift cluster. The first host that has this label and is unassigned is automatically assigned to the control plane or cluster. To find available host labels, run ibmcloud sat host get --host <host_name_or_ID> --location <location_name_or_ID>.

--location

The name or ID of the Satellite location. To find the location ID or name, run ibmcloud sat location ls.

-p, --worker-pool

The name or ID of the worker pool within the cluster to assign the host. If no worker pool is specified, the host is assigned to the default worker pool.

-q

Do not show the message of the day or update reminders.

--zone

The name or ID of the zone to assign the host. To find available zones, run ibmcloud sat location get --location <location_name_or_ID> and look for the Host Zones field.

Examples

Assign a host to a Satellite location control plane or cluster

ibmcloud sat host assign --location LOCATION

Command options

--host-label, --hl

Enter any labels as key-value pairs to identify the host to assign to your Satellite control plane or Red Hat OpenShift cluster. The first host that has this label and is unassigned is automatically assigned to the control plane or cluster. To find available host labels, run ibmcloud sat host get --host <host_name_or_ID> --location <location_name_or_ID>.

--host-link-agent-endpoint

The endpoint that the link agent uses to connect to the link tunnel server.

--location

The name or ID of the Satellite location. To find the location ID or name, run ibmcloud sat location ls.

--operating-system

The operating system of the hosts you want to attach to your location. To attach RHCOS hosts, your location must be RHCOS enabled. Accepted values: RHEL, RHCOS

-q

Do not show the message of the day or update reminders.

--reset-key

Reset the key that the control plane uses to attach and assign hosts in the location. See https://ibm.biz/reset-key.

Examples

Create and download a script that you can run on your hosts to attach them to your location

ibmcloud sat host attach --location LOCATION

Command options

--host

The Satellite host ID. To find the host ID, run ibmcloud sat host ls <location_ID_or_name>.

--location

The name or ID of the Satellite location. To find the location ID or name, run ibmcloud sat location ls.

--output

Prints the command output in the provided format. Accepted values: json

-q

Do not show the message of the day or update reminders.

Examples

View the details of a Satellite host

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

Examples

Show help

ibmcloud sat host help

Command options

--location

The name or ID of the Satellite location. To find the location ID or name, run ibmcloud sat location ls.

--output

Prints the command output in the provided format. Accepted values: json

-q

Do not show the message of the day or update reminders.

Examples

List all hosts that are attached to a Satellite location, including hosts that are assigned to clusters or the control plane

ibmcloud sat host ls --location LOCATION

Command options

-f

Force the command to run without user prompts.

--host

The name or ID of the host to remove.

--location

The name or ID of the Satellite location. To find the location ID or name, run ibmcloud sat location ls.

-q

Do not show the message of the day or update reminders.

Examples

Remove a host from a Satellite location

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

Command options

--host

The name or ID of the host to assign. To automatically assign hosts based on labels, do not include this option.

--host-label, --hl

Enter any labels as key-value pairs to identify the host to assign to your Satellite control plane or Red Hat OpenShift cluster. The first host that has this label and is unassigned is automatically assigned to the control plane or cluster. To find available host labels, run ibmcloud sat host get --host <host_name_or_ID> --location <location_name_or_ID>.

--location

The name or ID of the Satellite location. To find the location ID or name, run ibmcloud sat location ls.

-q

Do not show the message of the day or update reminders.

--zone

The name or ID of the zone to associate the host. You cannot change the zone of hosts that are assigned to a resource, such as a cluster. You must unassign them first. To list available zones, run ibmcloud sat location get --location <ID>.

Examples

Update host information, such as zones and labels

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

Examples

Show help

ibmcloud sat key help

Command options

--output

Prints the command output in the provided format. Accepted values: json

-q

Do not show the message of the day or update reminders.

Examples

List all Satellite Config keys in your IBM Cloud account

ibmcloud sat key ls

Command options

-f

Force the command to run without user prompts.

--key

The name or ID of a Satellite Config key.

-q

Do not show the message of the day or update reminders.

Examples

Remove a Satellite Config key

ibmcloud sat key rm --key KEY

Command options

-f

Force the command to run without user prompts.

--name

The name of the new Satellite Config key.

-q

Do not show the message of the day or update reminders.

Examples

Generate a new key for use by managed clusters to connect to Satellite Config

ibmcloud sat key rotate --name NAME

Command options

--capability

A capability of the Satellite location.

--coreos-enabled

Enable Red Hat CoreOS features for the Satellite location. This action cannot be undone. See https://ibm.biz/infra-os.

--cos-bucket

Specify the name of the IBM Cloud Object Storage bucket to store your Satellite location control plane data. Otherwise, a new bucket is created for you.

--description

Enter a description for the Satellite location.

--ha-zone

Specify the zone for your location. For high availability, specify 3 zones for your location as --ha-zone ZONE1_NAME --ha-zone ZONE2_NAME --ha-zone ZONE3_NAME. The names of the zones must match exactly the names of the corresponding zones in your infrastructure provider where you plan to create hosts.

--managed-from

Select the IBM Cloud region to manage your Satellite location from. Choose a region close to your on-prem data center for better performance. See https://ibm.biz/sat-region.

--name

Specify a name for the Satellite location. Location names must start with a letter, can contain letters, numbers, periods (.), and hyphen (-), and must be fewer than 36 characters. Do not reuse names, even if the other location is deleted.

--physical-address

The physical address of the Satellite location.

--pod-network-interface-selection

The method for selecting the node network interface for the internal pod network. This option can be used only if you also enable Red Hat CoreOS with the --coreos-enabled option. To provide a direct URL or IP address, specify can-reach=<url> or can-reach=<ip_address>. To choose a network interface, specify interface=<network_interface>.

--pod-subnet

Specify a custom subnet CIDR to provide private IP addresses for pods. This option is used only if you enable Red Hat CoreOS with the --coreos-enabled option. The subnet must be /23 or larger. See https://ibm.biz/sat-location-create. Default value: '172.16.0.0/16

--provider

Indicate the infrastructure provider to use for the Satellite location. If you include this option, you must also include the --provider-credential option. Accepted values: aws, azure, gcp, vmware

--provider-credential

Specify the path to a JSON file on your local machine that has the credentials of the infrastructure provider for the Satellite location. The credential format is provider-specific. See http://ibm.biz/sat-infra-creds.

--provider-region

Specify the region in the infrastructure provider where you plan to create the hosts for the Satellite location. If you include this option, you must also include the --provider option.

-q

Do not show the message of the day or update reminders.

--service-subnet

Specify a custom subnet CIDR to provide private IP addresses for services. This option is used only if you enable Red Hat CoreOS with the --coreos-enabled option. The subnet must be /24 or larger. See https://ibm.biz/sat-location-create. Default value: 172.20.0.0/16

Examples

Create a Satellite location

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

Command options

--location

The name or ID of the Satellite location. To find the location ID or name, run ibmcloud sat location ls.

--output

Prints the command output in the provided format. Accepted values: json

-q

Do not show the message of the day or update reminders.

--subdomain

Specify the subdomain name. To list existing subdomains, run ibmcloud sat location dns ls --location <ID>.

Examples

View the details of a registered subdomain in a Satellite location

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

Examples

Show help

ibmcloud sat location dns help

Command options

--location

The name or ID of the Satellite location. To find the location ID or name, run ibmcloud sat location ls.

--output

Prints the command output in the provided format. Accepted values: json

-q

Do not show the message of the day or update reminders.

Examples

List the registered subdomains in a Satellite location

ibmcloud sat location dns ls --location LOCATION

Command options

--ip

Specify the IP address for each control plane host, in the format --ip x.x.x.1 --ip x.x.x.2 --ip x.x.x.3. For multizone clusters, use one IP address from each zone. To find the IP address, run ibmcloud sat host ls --location <location_ID_or_name> and look for Worker IP for hosts labeled infrastructure.

--location

The name or ID of the Satellite location. To find the location ID or name, run ibmcloud sat location ls.

--output

Prints the command output in the provided format. Accepted values: json

-q

Do not show the message of the day or update reminders.

Examples

Set a subdomain for the hosts assigned to the control plane in a Satellite location

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

Command options

--location

The name or ID of the Satellite location. To find the location ID or name, run ibmcloud sat location ls.

--output

Prints the command output in the provided format. Accepted values: json

-q

Do not show the message of the day or update reminders.

Examples

View the details of a Satellite location

ibmcloud sat location get --location LOCATION

Examples

Show help

ibmcloud sat location help

Command options

--output

Prints the command output in the provided format. Accepted values: json

-q

Do not show the message of the day or update reminders.

Examples

List all Satellite locations in your IBM Cloud account

ibmcloud sat location ls

Command options

-f

Force the command to run without user prompts.

--location

The name or ID of the Satellite location. To find the location ID or name, run ibmcloud sat location ls.

-q

Do not show the message of the day or update reminders.

Examples

Delete a location

ibmcloud sat location rm --location LOCATION

Command options

--description

Enter a new description for the Satellite location. The length of the description is limited to 400 bytes.

--location-id

The ID of the Satellite location. To find the location ID, run ibmcloud sat location ls.

--name

Specify a new name for the Satellite location. Location names must start with a letter, can contain letters, numbers, periods (.), and hyphen (-), and must be fewer than 36 characters. Do not reuse names, including names of deleted locations.

-q

Do not show the message of the day or update reminders.

Examples

Update the name or description of a Satellite location

ibmcloud sat location update --location-id ID

Command options

-q

Do not show the message of the day or update reminders.

Examples

View the current user messages

ibmcloud sat messages

Command options

--history

The history ID for the resource.

--output

Prints the command output in the provided format. Accepted values: json

-q

Do not show the message of the day or update reminders.

--resource

Specify the Kubernetes resource ID. To find Kubernetes resources, run ibmcloud sat resource ls.

--save-data

Download and save a Kubernetes resource definition to a temporary file.

Examples

View the details of a Kubernetes resource that is managed by a Satellite configuration

ibmcloud sat resource get --resource RESOURCE

Examples

Show help

ibmcloud sat resource help

Command options

--limit

Specify the maximum number of history entries to return.

--output

Prints the command output in the provided format. Accepted values: json

-q

Do not show the message of the day or update reminders.

--resource

The Kubernetes resource ID.

Examples

Get history for a Kubernetes resource

ibmcloud sat resource history get --resource RESOURCE

Examples

Show help

ibmcloud sat resource history help

Command options

-c, --cluster

Specify the name or ID of the registered cluster that the Kubernetes resource runs in. To find registered clusters, run ibmcloud sat cluster ls.

--limit

Specify the maximum number of resource entries for the search to return.

--output

Prints the command output in the provided format. Accepted values: json

-q

Do not show the message of the day or update reminders.

--search

Indicate the string to filter search results of Kubernetes resources, such as a pod or namespace name.

--subscription

Specify the Satellite subscription ID or name. To find subscriptions, run ibmcloud sat cluster ls.

Examples

Search Kubernetes resources that are managed by Satellite

ibmcloud sat resource ls --cluster CLUSTER

Examples

Show help

ibmcloud sat service help

Command options

--location

The name or ID of the Satellite location. To find the location ID or name, run ibmcloud sat location ls.

--output

Prints the command output in the provided format. Accepted values: json

-q

Do not show the message of the day or update reminders.

Examples

List all Satellite service clusters in your location to review details, such as requested host resources

ibmcloud sat service ls --location LOCATION

Command options

--all

Disable automatic patches for all Satellite storage assignments of a storage configuration.

--assignment

The ID of a Satellite storage assignment. To list available storage assignments of the configuration, run ibmcloud sat storage assignment ls --config CONFIG.

--config

The name or ID of a Satellite storage configuration. To list available storage configurations, run ibmcloud sat storage config ls.

-q

Do not show the message of the day or update reminders.

Examples

Disable automatic patches for a Satellite storage assignment

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

Command options

--all

Enable automatic patches for all Satellite storage assignments of a storage configuration.

--assignment

The ID of a Satellite storage assignment. To list available storage assignments of the configuration, run ibmcloud sat storage assignment ls --config CONFIG.

--config

The name or ID of a Satellite storage configuration. To list available storage configurations, run ibmcloud sat storage config ls.

-q

Do not show the message of the day or update reminders.

Examples

Enable automatic patches for a Satellite storage assignment

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

Examples

Show help

ibmcloud sat storage assignment autopatch help

Command options

-c, --cluster

Specify the ID of the Satellite cluster for the assignment. To find the cluster ID, run ibmcloud oc cluster ls --provider satellite.

--config

Specify the Satellite storage configuration for the assignment. to find configurations, run ibmcloud sat storage config ls.

-g, --group

Specify the cluster groups for the assignment. To find cluster groups, run ibmcloud sat group ls.

--name

Provide a name for Satellite storage assignment.

-q

Do not show the message of the day or update reminders.

--service-cluster-id

Specify the ID of the service cluster for the assignment. To find the service cluster ID, run ibmcloud sat service ls --location <location>.

Examples

Create an assignment to deploy your storage configurations to clusters in your Satellite location

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

Command options

--assignment

Specify the ID of a Satellite storage assignment.

--output

Prints the command output in the provided format. Accepted values: json

-q

Do not show the message of the day or update reminders.

Examples

Get the details of a Satellite storage assignment

ibmcloud sat storage assignment get --assignment ASSIGNMENT

Examples

Show help

ibmcloud sat storage assignment help

Command options

-c, --cluster

Specify the ID of the Satellite cluster for the assignments. To get the cluster ID, run ibmcloud oc cluster ls --provider satellite.

--config

Specify the name or ID of a Satellite storage configuration. To list available storage configurations, run ibmcloud sat storage config ls.

--location

Specify the name of a Satellite location. To list available locations, run ibmcloud sat location ls. This option cannot be used by service administrator.

--output

Prints the command output in the provided format. Accepted values: json

-q

Do not show the message of the day or update reminders.

--service-cluster-id

Specify the ID of the service cluster for the assignments. To find the service cluster ID, run ibmcloud sat service ls --location <location>.

Examples

List the Satellite storage assignments in your IBM Cloud account

ibmcloud sat storage assignment ls --cluster CLUSTER

Command options

--assignment

Specify the ID of a Satellite storage assignment. To list available assignments, run ibmcloud sat storage assignment ls.

-f

Force the command to run without user prompts.

-q

Do not show the message of the day or update reminders.

Examples

Apply storage configuration changes to the associated assignments

ibmcloud sat storage assignment patch --assignment ASSIGNMENT

Command options

--assignment

Specify the ID of a Satellite storage assignment. To find assignments, run ibmcloud sat storage assignment ls.

-f

Force the command to run without user prompts.

-q

Do not show the message of the day or update reminders.

Examples

Remove a Satellite storage assignment

ibmcloud sat storage assignment rm --assignment ASSIGNMENT

Command options

--assignment

Specify the ID of a Satellite storage assignment.

-f

Force the command to run without user prompts.

-g, --group

Specify the new cluster groups for the assignment. To list available groups, run ibmcloud sat group ls.

--name

Provide a new name for the Satellite storage assignment.

-q

Do not show the message of the day or update reminders.

Examples

Update a Satellite storage assignment

ibmcloud sat storage assignment update --assignment ASSIGNMENT

Command options

--config-name

Specify the name of the storage configuration for the custom storage class. To list Satellite storage configurations, run ibmcloud sat storage config ls.

--name

Provide a name for the custom storage class.

-p, --param

Specify a key=value pair for storage class parameters. To see the storage class parameters in a storage template, run ibmcloud sat storage template get.

-q

Do not show the message of the day or update reminders.

Examples

Create a custom Satellite storage class

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

Command options

--class

Specify the name of a Satellite storage class.

--config

Specify the name or ID of a Satellite storage configuration. To list Satellite storage configurations, run ibmcloud sat storage config ls.

--output

Prints the command output in the provided format. Accepted values: json

-q

Do not show the message of the day or update reminders.

Examples

Get the details of a Satellite storage class

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

Examples

Show help

ibmcloud sat storage config class help

Command options

--config

Specify the name or ID of a Satellite storage configuration. To list Satellite storage configurations, run ibmcloud sat storage config ls.

--output

Prints the command output in the provided format. Accepted values: json

-q

Do not show the message of the day or update reminders.

--show-params

Include this option to list all storage class parameter details.

Examples

List the storage classes in a Satellite storage configuration

ibmcloud sat storage config class ls --config CONFIG

Command options

--location

Enter the ID or name of the location for the storage configuration. To find available locations, run ibmcloud sat location ls.

--name

Specify the name of the storage configuration.

-p, --param

Specify a key=value pair for configuration parameters. To see the configuration parameters in a storage template, run ibmcloud sat storage template get.

-q

Do not show the message of the day or update reminders.

--template-name

Specify the Satellite storage configuration template name. To list available storage configuration templates, run ibmcloud sat storage template ls.

--template-version

Specify the Satellite storage configuration template version. If you do not include this option, the default version is used. To list available storage configuration templates, run ibmcloud sat storage template ls.

Examples

Create a Satellite storage configuration to install storage drivers in your clusters

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

Command options

--config

Specify the name or ID of a Satellite storage configuration. To list available configurations, run ibmcloud sat storage config ls.

--output

Prints the command output in the provided format. Accepted values: json

-q

Do not show the message of the day or update reminders.

Examples

Get the details of a Satellite storage configuration

ibmcloud sat storage config get --config CONFIG

Examples

Show help

ibmcloud sat storage config help

Command options

--location

Specify the ID or name of the location that contains the configurations you want to list. To find available locations, run ibmcloud sat location ls.

--output

Prints the command output in the provided format. Accepted values: json

-q

Do not show the message of the day or update reminders.

Examples

List the Satellite storage configurations in your IBM Cloud account

ibmcloud sat storage config ls

Examples

Show help

ibmcloud sat storage config param help

Command options

--apply

Apply the latest Satellite storage configuration version to all assignments of a configuration. To list a configuration's assignments, run ibmcloud sat storage assignment ls --config CONFIG.

--config

Specify the name or ID of the storage configuration. To list Satellite storage configurations, run ibmcloud sat storage config ls.

-f

Force the command to run without user prompts.

-p, --param

Specify a key=value pair for configuration parameters. To see the configuration parameters in a storage template, run ibmcloud sat storage template get.

-q

Do not show the message of the day or update reminders.

Examples

Set the configuration and secret parameters of a Satellite storage configuration

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

Command options

--config

Specify the name or ID of a Satellite storage configuration. To list available configurations, run ibmcloud sat storage config ls.

-f

Force the command to run without user prompts.

--include-assignments

Include this option to patch the assignments of the storage configuration to the latest configuration version.

-q

Do not show the message of the day or update reminders.

Examples

Apply the latest patch updates to a Satellite storage configuration

ibmcloud sat storage config patch --config CONFIG

Command options

--config

Specify the name or ID of a Satellite storage configuration. To list available configurations, run ibmcloud sat storage config ls.

-f

Force the command to run without user prompts.

--include-assignments

Include this option to remove the storage configuration as well as any associated assignments.

-q

Do not show the message of the day or update reminders.

Examples

Remove a Satellite storage configuration

ibmcloud sat storage config rm --config CONFIG

Examples

Show help

ibmcloud sat storage help

Command options

--name

Specify the storage template name. To list available storage templates, run ibmcloud sat storage template ls.

--output

Prints the command output in the provided format. Accepted values: json

-q

Do not show the message of the day or update reminders.

--version

Specify the storage template version. To list available storage templates, run ibmcloud sat storage template ls.

Examples

Get the details of a Satellite storage template

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

Examples

Show help

ibmcloud sat storage template help

Command options

-q

Do not show the message of the day or update reminders.

Examples

List the available Satellite storage templates

ibmcloud sat storage template ls

Command options

--auth-required

Provide the authentication secret required to connect to the remote repository. See https://ibm.biz/sat-config-private-repo for details. Strategy: GitOps.

--config

Specify the name of the configuration to use for the subscription. To find available configurations, run ibmcloud sat config ls.

-g, --group

Specify the name or ID of the cluster groups to subscribe to your configuration. To find available cluster groups, run ibmcloud sat group ls.

--gitref

Specify the GitRef to use for the Satellite subscription. Strategy: GitOps.

--gitref-type

Indicate the type of GitRef to use for the Satellite subscription. Strategy: GitOps. Allowed values: branch, commit, tag, release

--name

Enter a name for the subscription.

--path

Provide the path to the repository files or release assets in the remote repository to use for the Satellite subscription. Strategy: GitOps.

-q

Do not show the message of the day or update reminders.

--repository

Specify the URL of the remote repository to use for the subscription. Strategy: GitOps.

--version

Indicate the name or ID of the existing configuration version to use for the subscription. To find versions, run ibmcloud sat config get --config <configuration_name_or_ID>. Strategy: Direct Upload.

Examples

Create a Satellite subscription for clusters

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

Command options

--output

Prints the command output in the provided format. Accepted values: json

-q

Do not show the message of the day or update reminders.

--subscription

Enter the name or ID of a Satellite subscription. To find subscriptions, run ibmcloud sat subscription ls.

Examples

Get detailed information for a Satellite subscription

ibmcloud sat subscription get --subscription SUBSCRIPTION

Examples

Show help

ibmcloud sat subscription help

Examples

Show help

ibmcloud sat subscription identity help

Command options

-f

Force the command to run without user prompts.

-q

Do not show the message of the day or update reminders.

--subscription

Specify the name or ID of a Satellite subscription. To list subscriptions, run ibmcloud sat subscription ls.

Examples

Update the Satellite subscription to use your identity to manage resources

ibmcloud sat subscription identity set --subscription SUBSCRIPTION

Command options

-c, --cluster

Specify the Satellite cluster name or ID. To find registered clusters, run ibmcloud sat cluster ls.

--output

Prints the command output in the provided format. Accepted values: json

-q

Do not show the message of the day or update reminders.

Examples

List all Satellite subscriptions in your IBM Cloud account

ibmcloud sat subscription ls

Command options

-f

Force the command to run without user prompts.

-q

Do not show the message of the day or update reminders.

--subscription

Provide the name or ID of a Satellite subscription. To list subscriptions, run ibmcloud sat subscription ls.

Examples

Remove a Satellite subscription

ibmcloud sat subscription rm --subscription SUBSCRIPTION

Command options

--auth-required

Provide the authentication secret required to connect to the remote repository. Strategy: GitOps.

-f

Force the command to run without user prompts.

-g, --group

Specify the new cluster groups to subscribe to your configuration.

--gitref

Specify the GitRef to use for the Satellite subscription. Strategy: GitOps.

--gitref-type

Indicate the type of GitRef to use for this Satellite subscription. Strategy: GitOps. Allowed values: branch, commit, tag, release

--name

Provide a new name of the Satellite subscription.

--path

Indicate the path to the repository files or release assets in the remote repository to use for the Satellite subscription. Strategy: GitOps.

-q

Do not show the message of the day or update reminders.

--repository

Provide the URL of the remote repository to use for the Satellite subscription. Strategy: GitOps.

--subscription

Specify the name or ID of a Satellite subscription. To list subscriptions, run ibmcloud sat subscription ls.

--version

Indicate the existing configuration version to use for the Satellite subscription. Strategy: Direct Upload.

Examples

Update a Satellite subscription

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