CLI reference for Satellite commands

Refer to these commands when you want to automate the creation and management of your Satellite location.

To install the CLI, see Installing the the CLI.
To view a high-level map of all the IBM Cloud Satellite commands, see the CLI map.

ibmcloud sat commands

The following tables list the ibmcloud sat command groups. For a complete list of all ibmcloud sat commands as they are structured in the CLI, see the CLI map.

`ibmcloud sat cluster get`

Get the details of a registered cluster.

ibmcloud sat cluster get --cluster CLUSTER [--output OUTPUT] [-q]

Command options

--cluster CLUSTER, -c CLUSTER: Specify the cluster name or the ID. To list registered clusters, run ibmcloud sat cluster ls.
--output OUTPUT: Prints the command output in the provided format. Accepted values: json
-q: Do not show the message of the day or update reminders.

`ibmcloud sat cluster ls`

List all registered clusters in your IBM Cloud account.

ibmcloud sat cluster ls [--filter FILTER] [--limit LIMIT] [--output OUTPUT] [-q]

Command options

--filter FILTER: Filter registered clusters by cluster ID.
--limit LIMIT: Limit the number of clusters that are returned.
--output OUTPUT: Prints the command output in the provided format. Accepted values: json
-q: Do not show the message of the day or update reminders.

`ibmcloud sat cluster register`

Get a kubectl command to register your cluster in a Satellite configuration. Log in to your cluster and run this command to install a Satellite Config agent. Clusters that you run in your Satellite location automatically install this agent.

ibmcloud sat cluster register --name NAME [-q] [--silent]

Command options

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

`ibmcloud sat cluster unregister`

Remove a cluster registration. The cluster is no longer subscribed to a Satellite configuration, but the cluster and its existing resources still run.

ibmcloud sat cluster unregister --cluster CLUSTER [-f] [-q]

Command options

--cluster CLUSTER, -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.

`ibmcloud sat config create`

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 [-q] (--data-location LOCATION | --provider PROVIDER)

Command options

--data-location LOCATION: Specify the IBM region to store the Satellite configuration data. Strategy: Direct Upload.
--name NAME: Provide a name for the Satellite configuration.
--provider 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.

`ibmcloud sat config get`

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

ibmcloud sat config get --config CONFIG [--output OUTPUT] [-q]

Command options

--config CONFIG: Specify the name or ID of a Satellite configuration. To list available configurations, run ibmcloud sat config ls.
--output OUTPUT: Prints the command output in the provided format. Accepted values: json
-q: Do not show the message of the day or update reminders.

`ibmcloud sat config ls`

List all Satellite configurations in your IBM Cloud account.

ibmcloud sat config ls [--output OUTPUT] [-q]

Command options

--output OUTPUT: Prints the command output in the provided format. Accepted values: json
-q: Do not show the message of the day or update reminders.

`ibmcloud sat config rename`

Rename a Satellite configuration.

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

Command options

--config CONFIG: Specify the name or ID of a Satellite configuration. To list available configurations, run ibmcloud sat config ls.
--name NAME: Provide a new name for the Satellite configuration.
-q: Do not show the message of the day or update reminders.

`ibmcloud sat config rm`

Remove a Satellite configuration. All associated subscriptions must be removed first. All versions are deleted. Back up any resource definitions that you want to keep.

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

Command options

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

`ibmcloud sat config version create`

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 [--description DESCRIPTION] [-q]

Command options

--config CONFIG: Specify the name or ID of the Satellite configuration. To list available configurations, run ibmcloud sat config ls.
--description DESCRIPTION: Add a description for the Satellite configuration version.
--file-format FORMAT: Indicate the file format of the configuration version. Available options: yaml
--name NAME: Provide a name for the Satellite configuration version.
-q: Do not show the message of the day or update reminders.
--read-config CONFIG: Specify the file path for the configuration version file.

`ibmcloud sat config version get`

Get details for a Satellite configuration version.

ibmcloud sat config version get --config CONFIG --version VERSION [--output OUTPUT] [-q] [--save-config]

Command options

--config CONFIG: Specify the name or ID of the Satellite configuration. To list available configurations, run ibmcloud sat config ls.
--output 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 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>.

`ibmcloud sat config version rm`

Remove a Satellite configuration version.

ibmcloud sat config version rm --config CONFIG --version VERSION [-f] [-q]

Command options

--config 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 VERSION: Indicate the name or ID of the Satellite configuration version. To list versions, run ibmcloud sat config get --config <configuration_name_or_ID>.

`ibmcloud sat endpoint create`

Create an endpoint.

ibmcloud sat endpoint create --dest-hostname HOSTNAME --dest-port PORT --dest-type TYPE --location LOCATION --name NAME --source-protocol PROTOCOL [--dest-protocol PROTOCOL] [--output OUTPUT] [-q] [--sni SNI]

Command options

--dest-hostname 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 PORT: Provide the port that the destination resource listens on for incoming requests. Make sure that the port matches the destination protocol.
--dest-protocol 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 TYPE: Specify where the destination resource runs, either in IBM Cloud (cloud) or your Satellite location (location). Available options: location, cloud
--location LOCATION: The name or ID of the Satellite location. To find the location ID or name, run ibmcloud sat location ls.
--name NAME: Provide a name for the endpoint.
--output 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 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 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

`ibmcloud sat endpoint get`

View the details of an endpoint.

ibmcloud sat endpoint get --endpoint ENDPOINT --location LOCATION [--output OUTPUT] [-q]

Command options

--endpoint ENDPOINT: Specify the name or ID of the endpoint. To find a list of all endpoints, run ibmcloud sat endpoint ls.
--location LOCATION: The name or ID of the Satellite location. To find the location ID or name, run ibmcloud sat location ls.
--output OUTPUT: Prints the command output in the provided format. Accepted values: json
-q: Do not show the message of the day or update reminders.

`ibmcloud sat endpoint ls`

List all endpoints in a Satellite location.

ibmcloud sat endpoint ls --location LOCATION [--output OUTPUT] [-q]

Command options

--location LOCATION: The name or ID of the Satellite location. To find the location ID or name, run ibmcloud sat location ls.
--output OUTPUT: Prints the command output in the provided format. Accepted values: json
-q: Do not show the message of the day or update reminders.

`ibmcloud sat endpoint rm`

Delete an endpoint.

ibmcloud sat endpoint rm --endpoint ENDPOINT --location LOCATION [-q]

Command options

--endpoint ENDPOINT: Specify the name or ID of the endpoint. To find a list of all endpoints, run ibmcloud sat endpoint ls.
--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.

`ibmcloud sat endpoint update`

Update an endpoint. Only the options that you specify are updated.

ibmcloud sat endpoint update --endpoint ENDPOINT --location LOCATION [--dest-hostname HOSTNAME] [--dest-port PORT] [--dest-protocol PROTOCOL] [--dest-type TYPE] [--name NAME] [-q] [--sni SNI] [--source-protocol PROTOCOL]

Command options

--dest-hostname 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 PORT: Provide the port that the destination resource listens on for incoming requests. Make sure that the port matches the destination protocol.
--dest-protocol 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 TYPE: Specify where the destination resource runs, either in IBM Cloud (cloud) or your Satellite location (location). Accepted values: location, cloud
--endpoint ENDPOINT: Specify the name or ID of the endpoint. To find a list of all endpoints, run ibmcloud sat endpoint ls.
--location LOCATION: The name or ID of the Satellite location. To find the location ID or name, run ibmcloud sat location ls.
--name NAME: Provide a new name for the endpoint.
-q: Do not show the message of the day or update reminders.
--sni 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 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

`ibmcloud sat group attach`

Add a cluster to your cluster group. The cluster can run in your Satellite location or in IBM Cloud. To add a cluster that runs in IBM Cloud, you must first register the cluster with Satellite Config.

ibmcloud sat group attach --cluster CLUSTER [--cluster CLUSTER ...] --group GROUP [-q]

Command options

--cluster CLUSTER, -c CLUSTER: Specify the cluster name or ID. To list registered clusters, run ibmcloud sat cluster ls.
--group GROUP, -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.

`ibmcloud sat group create`

Create a cluster group. Then, you can subscribe the cluster group to a Satellite configuration.

ibmcloud sat group create --name NAME [--cluster CLUSTER ...] [-q]

Command options

--cluster CLUSTER, -c CLUSTER: Specify the cluster name or ID to add to the cluster group. To list registered clusters, run ibmcloud sat cluster ls.
--name NAME: Provide a name of the Satellite cluster group.
-q: Do not show the message of the day or update reminders.

`ibmcloud sat group detach`

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 [--cluster CLUSTER ...] --group GROUP [-f] [-q]

Command options

--cluster CLUSTER, -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.
--group GROUP, -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.

`ibmcloud sat group get`

Get detailed information for a Satellite cluster group.

ibmcloud sat group get --group GROUP [--output OUTPUT] [-q]

Command options

--group GROUP, -g GROUP: Specify the name or ID of a Satellite cluster group. To list registered clusters, run ibmcloud sat cluster ls.
--output OUTPUT: Prints the command output in the provided format. Accepted values: json
-q: Do not show the message of the day or update reminders.

`ibmcloud sat group ls`

List all Satellite cluster groups in your IBM Cloud account.

ibmcloud sat group ls [--output OUTPUT] [-q]

Command options

--output OUTPUT: Prints the command output in the provided format. Accepted values: json
-q: Do not show the message of the day or update reminders.

`ibmcloud sat group rm`

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 [-f] [-q]

Command options

-f: Force the command to run without user prompts.
--group GROUP, -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.

`ibmcloud sat host assign`

Assign a host to a Satellite location control plane or cluster.

ibmcloud sat host assign --location LOCATION [--cluster CLUSTER] [--host HOST] [--host-label LABEL ...] [-q] [--worker-pool POOL] [--zone ZONE]

Command options

--cluster 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 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 LABEL, --hl LABEL: 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 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.
--worker-pool POOL, -p 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.
--zone 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.

`ibmcloud sat host attach`

Create and download a script that you can run on your hosts to attach them to your location. For RHCOS enabled locations, the script is an ignition file.

ibmcloud sat host attach --location LOCATION [--host-label LABEL ...] [--host-link-agent-endpoint ENDPOINT] [--operating-system SYSTEM] [-q] [--reset-key]

Command options

--host-label LABEL, --hl LABEL: 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 ENDPOINT: The endpoint that the link agent uses to connect to the link tunnel server.
--location LOCATION: The name or ID of the Satellite location. To find the location ID or name, run ibmcloud sat location ls.
--operating-system 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.

`ibmcloud sat host get`

View the details of a Satellite host.

ibmcloud sat host get --host HOST --location LOCATION [--output OUTPUT] [-q]

Command options

--host HOST: The Satellite host ID. To find the host ID, run ibmcloud sat host ls <location_ID_or_name>.
--location LOCATION: The name or ID of the Satellite location. To find the location ID or name, run ibmcloud sat location ls.
--output OUTPUT: Prints the command output in the provided format. Accepted values: json
-q: Do not show the message of the day or update reminders.

`ibmcloud sat host ls`

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 [--output OUTPUT] [-q]

Command options

--location LOCATION: The name or ID of the Satellite location. To find the location ID or name, run ibmcloud sat location ls.
--output OUTPUT: Prints the command output in the provided format. Accepted values: json
-q: Do not show the message of the day or update reminders.

`ibmcloud sat host rm`

Remove a host from a Satellite location.

ibmcloud sat host rm --host HOST --location LOCATION [-f] [-q]

Command options

-f: Force the command to run without user prompts.
--host HOST: The name or ID of the host to remove.
--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.

`ibmcloud sat host update`

Update host information, such as zones and labels.

ibmcloud sat host update --host HOST --location LOCATION [--host-label LABEL ...] [-q] [--zone ZONE]

Command options

--host HOST: The name or ID of the host to assign. To automatically assign hosts based on labels, do not include this option.
--host-label LABEL, --hl LABEL: 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 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 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>.

`ibmcloud sat key ls`

List all Satellite Config keys in your IBM Cloud account.

ibmcloud sat key ls [--output OUTPUT] [-q]

Command options

--output OUTPUT: Prints the command output in the provided format. Accepted values: json
-q: Do not show the message of the day or update reminders.

`ibmcloud sat key rm`

Remove a Satellite Config key. Any cluster that still uses this key cannot connect to Satellite Config.

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

Command options

-f: Force the command to run without user prompts.
--key KEY: The name or ID of a Satellite Config key.
-q: Do not show the message of the day or update reminders.

`ibmcloud sat key rotate`

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

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

Command options

-f: Force the command to run without user prompts.
--name NAME: The name of the new Satellite Config key.
-q: Do not show the message of the day or update reminders.

`ibmcloud sat location create`

Create a Satellite location. A Satellite location is a representation of an environment in your infrastructure provider. After you create a location, attach hosts from separate zones of your backing infrastructure environment with the ibmcloud sat host attach command.

ibmcloud sat location create --managed-from REGION --name NAME [--coreos-enabled] [--cos-bucket BUCKET] [--description DESCRIPTION] [--ha-zone ZONE ...] [--pod-network-interface-selection SELECTION] [--pod-subnet SUBNET] [--provider PROVIDER] [--provider-credential CREDENTIAL] [--provider-region REGION] [-q] [--service-subnet SUBNET]

Command options

--coreos-enabled: Enable Red Hat CoreOS features for the Satellite location. This action cannot be undone. See https://ibm.biz/infra-os.
--cos-bucket 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 DESCRIPTION: Enter a description for the Satellite location.
--ha-zone 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 REGION: 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 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.
--pod-network-interface-selection 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 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 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 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 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 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

`ibmcloud sat location dns get`

View the details of a registered subdomain in a Satellite location.

ibmcloud sat location dns get --location LOCATION --subdomain SUBDOMAIN [--output OUTPUT] [-q]

Command options

--location LOCATION: The name or ID of the Satellite location. To find the location ID or name, run ibmcloud sat location ls.
--output 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 SUBDOMAIN: Specify the subdomain name. To list existing subdomains, run ibmcloud sat location dns ls --location <ID>.

`ibmcloud sat location dns ls`

List the registered subdomains in a Satellite location.

ibmcloud sat location dns ls --location LOCATION [--output OUTPUT] [-q]

Command options

--location LOCATION: The name or ID of the Satellite location. To find the location ID or name, run ibmcloud sat location ls.
--output OUTPUT: Prints the command output in the provided format. Accepted values: json
-q: Do not show the message of the day or update reminders.

`ibmcloud sat location dns register`

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

ibmcloud sat location dns register --ip IP [--ip IP ...] --location LOCATION [--output OUTPUT] [-q]

Command options

--ip 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 labelled infrastructure.
--location LOCATION: The name or ID of the Satellite location. To find the location ID or name, run ibmcloud sat location ls.
--output OUTPUT: Prints the command output in the provided format. Accepted values: json
-q: Do not show the message of the day or update reminders.

`ibmcloud sat location get`

View the details of a Satellite location.

ibmcloud sat location get --location LOCATION [--output OUTPUT] [-q]

Command options

--location LOCATION: The name or ID of the Satellite location. To find the location ID or name, run ibmcloud sat location ls.
--output OUTPUT: Prints the command output in the provided format. Accepted values: json
-q: Do not show the message of the day or update reminders.

`ibmcloud sat location ls`

List all Satellite locations in your IBM Cloud account.

ibmcloud sat location ls [--output OUTPUT] [-q]

Command options

--output OUTPUT: Prints the command output in the provided format. Accepted values: json
-q: Do not show the message of the day or update reminders.

`ibmcloud sat location rm`

Delete a location. Before you run this command, back up your configurations and remove any hosts and clusters that run in the location. The underlying host infrastructure is not automatically deleted when you delete a location. This action cannot be undone.

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

Command options

-f: Force the command to run without user prompts.
--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.

`ibmcloud sat messages`

View the current user messages.

ibmcloud sat messages [-q]

Command options

-q: Do not show the message of the day or update reminders.

`ibmcloud sat resource get`

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

ibmcloud sat resource get --resource RESOURCE [--history HISTORY] [--output OUTPUT] [-q] [--save-data]

Command options

--history HISTORY: The history ID for the resource.
--output 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 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.

`ibmcloud sat resource history get`

Get history for a Kubernetes resource.

ibmcloud sat resource history get --resource RESOURCE [--limit LIMIT] [--output OUTPUT] [-q]

Command options

--limit LIMIT: Specify the maximum number of history entries to return.
--output 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 RESOURCE: The Kubernetes resource ID.

`ibmcloud sat resource ls`

Search Kubernetes resources that are managed by Satellite.

ibmcloud sat resource ls [--limit LIMIT] [--output OUTPUT] [-q] [--search SEARCH] (--cluster CLUSTER | --subscription SUBSCRIPTION)

Command options

--cluster CLUSTER, -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 LIMIT: Specify the maximum number of resource entries for the search to return.
--output 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 SEARCH: Indicate the string to filter search results of Kubernetes resources, such as a pod or namespace name.
--subscription SUBSCRIPTION: Specify the Satellite subscription ID or name. To find subscriptions, run ibmcloud sat cluster ls.

`ibmcloud sat service ls`

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

ibmcloud sat service ls --location LOCATION [--output OUTPUT] [-q]

Command options

--location LOCATION: The name or ID of the Satellite location. To find the location ID or name, run ibmcloud sat location ls.
--output OUTPUT: Prints the command output in the provided format. Accepted values: json
-q: Do not show the message of the day or update reminders.

`ibmcloud sat storage assignment autopatch disable`

The storage assignment autopatch disable command is a beta feature.

Disable automatic patches for a Satellite storage assignment.

ibmcloud sat storage assignment autopatch disable --config CONFIG [-q] (--all | --assignment ASSIGNMENT)

Command options

--all: Disable automatic patches for all Satellite storage assignments of a storage configuration.
--assignment 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 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.

`ibmcloud sat storage assignment autopatch enable`

The storage assignment autopatch enable command is a beta feature.

Enable automatic patches for a Satellite storage assignment.

ibmcloud sat storage assignment autopatch enable --config CONFIG [-q] (--all | --assignment ASSIGNMENT)

Command options

--all: Enable automatic patches for all Satellite storage assignments of a storage configuration.
--assignment 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 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.

`ibmcloud sat storage assignment create`

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

ibmcloud sat storage assignment create --config CONFIG [--name NAME] [-q] (--cluster CLUSTER | --group GROUP | --service-cluster-id CLUSTER)

Command options

--cluster CLUSTER, -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 CONFIG: Specify the Satellite storage configuration for the assignment. to find configurations, run ibmcloud sat storage config ls.
--group GROUP, -g GROUP: Specify the cluster groups for the assignment. To find cluster groups, run ibmcloud sat group ls.
--name NAME: Provide a name for Satellite storage assignment.
-q: Do not show the message of the day or update reminders.
--service-cluster-id CLUSTER: Specify the ID of the service cluster for the assignment. To find the service cluster ID, run ibmcloud sat service ls --location <location>.

`ibmcloud sat storage assignment get`

Get the details of a Satellite storage assignment.

ibmcloud sat storage assignment get --assignment ASSIGNMENT [--output OUTPUT] [-q]

Command options

--assignment ASSIGNMENT: Specify the ID of a Satellite storage assignment.
--output OUTPUT: Prints the command output in the provided format. Accepted values: json
-q: Do not show the message of the day or update reminders.

`ibmcloud sat storage assignment ls`

List the Satellite storage assignments in your IBM Cloud account.

To list all assignments for a service cluster as Service Admin: ibmcloud sat storage assignment ls --service-cluster-id CLUSTER.

To list all assignments for a service cluster as Location Admin: ibmcloud sat storage assignment ls --location LOCATION --service-cluster-id CLUSTER.

To list all assignments for a configuration: ibmcloud sat storage assignment ls --config CONFIG.

ibmcloud sat storage assignment ls [--output OUTPUT] [-q] (--cluster CLUSTER | --config CONFIG | --location LOCATION | --service-cluster-id CLUSTER)

Command options

--cluster CLUSTER, -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 CONFIG: Specify the name or ID of a Satellite storage configuration. To list available storage configurations, run ibmcloud sat storage config ls.
--location 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 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 CLUSTER: Specify the ID of the service cluster for the assignments. To find the service cluster ID, run ibmcloud sat service ls --location <location>.

`ibmcloud sat storage assignment patch`

Apply storage configuration changes to the associated assignments.

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

Command options

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

`ibmcloud sat storage assignment rm`

Remove a Satellite storage assignment. The Kubernetes resources are deleted from all the clusters in your Satellite location, but the configuration remains.

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

Command options

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

`ibmcloud sat storage assignment update`

Update a Satellite storage assignment.

ibmcloud sat storage assignment update --assignment ASSIGNMENT [-f] [--group GROUP ...] [--name NAME] [-q]

Command options

--assignment ASSIGNMENT: Specify the ID of a Satellite storage assignment.
-f: Force the command to run without user prompts.
--group GROUP, -g GROUP: Specify the new cluster groups for the assignment. To list available groups, run ibmcloud sat group ls.
--name NAME: Provide a new name for the Satellite storage assignment.
-q: Do not show the message of the day or update reminders.

`ibmcloud sat storage config class add`

Create a custom Satellite storage class.

ibmcloud sat storage config class add --config-name NAME --name NAME --param PARAM [--param PARAM ...] [-q]

Command options

--config-name 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 NAME: Provide a name for the custom storage class.
--param PARAM, -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.

`ibmcloud sat storage config class get`

Get the details of a Satellite storage class.

ibmcloud sat storage config class get --class CLASS --config CONFIG [--output OUTPUT] [-q]

Command options

--class CLASS: Specify the name of a Satellite storage class.
--config CONFIG: Specify the name or ID of a Satellite storage configuration. To list Satellite storage configurations, run ibmcloud sat storage config ls.
--output OUTPUT: Prints the command output in the provided format. Accepted values: json
-q: Do not show the message of the day or update reminders.

`ibmcloud sat storage config class ls`

List the storage classes in a Satellite storage configuration

ibmcloud sat storage config class ls --config CONFIG [--output OUTPUT] [-q] [--show-params]

Command options

--config CONFIG: Specify the name or ID of a Satellite storage configuration. To list Satellite storage configurations, run ibmcloud sat storage config ls.
--output 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.

`ibmcloud sat storage config create`

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

ibmcloud sat storage config create --location LOCATION --name NAME --template-name NAME [--param PARAM ...] [-q] [--template-version VERSION]

Command options

--location LOCATION: Enter the ID or name of the location for the storage configuration. To find available locations, run ibmcloud sat location ls.
--name NAME: Specify the name of the storage configuration.
--param PARAM, -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 NAME: Specify the Satellite storage configuration template name. To list available storage configuration templates, run ibmcloud sat storage template ls.
--template-version 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.

`ibmcloud sat storage config get`

Get the details of a Satellite storage configuration.

ibmcloud sat storage config get --config CONFIG [--output OUTPUT] [-q]

Command options

--config CONFIG: Specify the name or ID of a Satellite storage configuration. To list available configurations, run ibmcloud sat storage config ls.
--output OUTPUT: Prints the command output in the provided format. Accepted values: json
-q: Do not show the message of the day or update reminders.

`ibmcloud sat storage config ls`

List the Satellite storage configurations in your IBM Cloud account.

ibmcloud sat storage config ls [--location LOCATION] [--output OUTPUT] [-q]

Command options

--location 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 OUTPUT: Prints the command output in the provided format. Accepted values: json
-q: Do not show the message of the day or update reminders.

`ibmcloud sat storage config param set`

Set the configuration and secret parameters of a Satellite storage configuration.

ibmcloud sat storage config param set --config CONFIG --param PARAM [--param PARAM ...] [--apply] [-f] [-q]

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 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.
--param PARAM, -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.

`ibmcloud sat storage config patch`

Apply the latest patch updates to a Satellite storage configuration. Patch updates contain vulnerability remediations and bug fixes within the same major version.

ibmcloud sat storage config patch --config CONFIG [-f] [--include-assignments] [-q]

Command options

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

`ibmcloud sat storage config rm`

Remove a Satellite storage configuration.

ibmcloud sat storage config rm --config CONFIG [-f] [--include-assignments] [-q]

Command options

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

`ibmcloud sat storage template get`

Get the details of a Satellite storage template

ibmcloud sat storage template get --name NAME --version VERSION [--output OUTPUT] [-q]

Command options

--name NAME: Specify the storage template name. To list available storage templates, run ibmcloud sat storage template ls.
--output 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 VERSION: Specify the storage template version. To list available storage templates, run ibmcloud sat storage template ls.

`ibmcloud sat storage template ls`

List the available Satellite storage templates.

ibmcloud sat storage template ls [-q]

Command options

-q: Do not show the message of the day or update reminders.

`ibmcloud sat subscription create`

Create a Satellite subscription for clusters. After you create the subscription, the associated Satellite configuration version is automatically deployed to the subscribed clusters.

ibmcloud sat subscription create --config CONFIG --group GROUP [--group GROUP ...] --name NAME [-q] (--auth-required --gitref GITREF --gitref-type TYPE --path PATH --repository REPOSITORY | --version VERSION)

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 CONFIG: Specify the name of the configuration to use for the subscription. To find available configurations, run ibmcloud sat config ls.
--gitref GITREF: Specify the GitRef to use for the Satellite subscription. Strategy: GitOps.
--gitref-type TYPE: Indicate the type of GitRef to use for the Satellite subscription. Strategy: GitOps. Allowed values: branch, commit, tag, release
--group GROUP, -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.
--name NAME: Enter a name for the subscription.
--path 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 REPOSITORY: Specify the URL of the remote repository to use for the subscription. Strategy: GitOps.
--version 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.

`ibmcloud sat subscription get`

Get detailed information for a Satellite subscription.

ibmcloud sat subscription get --subscription SUBSCRIPTION [--output OUTPUT] [-q]

Command options

--output 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 SUBSCRIPTION: Enter the name or ID of a Satellite subscription. To find subscriptions, run ibmcloud sat subscription ls.

`ibmcloud sat subscription identity set`

Update the Satellite subscription to use your identity to manage resources.

ibmcloud sat subscription identity set --subscription SUBSCRIPTION [-f] [-q]

Command options

-f: Force the command to run without user prompts.
-q: Do not show the message of the day or update reminders.
--subscription SUBSCRIPTION: Specify the name or ID of a Satellite subscription. To list subscriptions, run ibmcloud sat subscription ls.

`ibmcloud sat subscription ls`

List all Satellite subscriptions in your IBM Cloud account.

ibmcloud sat subscription ls [--cluster CLUSTER] [--output OUTPUT] [-q]

Command options

--cluster CLUSTER, -c CLUSTER: Specify the Satellite cluster name or ID. To find registered clusters, run ibmcloud sat cluster ls.
--output OUTPUT: Prints the command output in the provided format. Accepted values: json
-q: Do not show the message of the day or update reminders.

`ibmcloud sat subscription rm`

Remove a Satellite subscription. The Kubernetes resources are no longer deployed to your clusters.

ibmcloud sat subscription rm --subscription SUBSCRIPTION [-f] [-q]

Command options

-f: Force the command to run without user prompts.
-q: Do not show the message of the day or update reminders.
--subscription SUBSCRIPTION: Provide the name or ID of a Satellite subscription. To list subscriptions, run ibmcloud sat subscription ls.

`ibmcloud sat subscription update`

Update a Satellite subscription.

ibmcloud sat subscription update --subscription SUBSCRIPTION [-f] [--group GROUP] [--name NAME] [-q] (--auth-required --gitref GITREF --gitref-type TYPE --path PATH --repository REPOSITORY | --version VERSION)

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.
--gitref GITREF: Specify the GitRef to use for the Satellite subscription. Strategy: GitOps.
--gitref-type TYPE: Indicate the type of GitRef to use for this Satellite subscription. Strategy: GitOps. Allowed values: branch, commit, tag, release
--group GROUP, -g GROUP: Specify the new cluster groups to subscribe to your configuration.
--name NAME: Provide a new name of the Satellite subscription.
--path 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 REPOSITORY: Provide the URL of the remote repository to use for the Satellite subscription. Strategy: GitOps.
--subscription SUBSCRIPTION: Specify the name or ID of a Satellite subscription. To list subscriptions, run ibmcloud sat subscription ls.
--version VERSION: Indicate the existing configuration version to use for the Satellite subscription. Strategy: Direct Upload.