acl commands

View and manage Satellite access control lists (ACLs).

• acl endpoint: Configure endpoints for an ACL.
• acl subnet: Configure subnets for an ACL.
  • ibmcloud sat acl create
  • ibmcloud sat acl endpoint add
  • ibmcloud sat acl endpoint ls
  • ibmcloud sat acl endpoint rm
  • ibmcloud sat acl get
  • ibmcloud sat acl ls
  • ibmcloud sat acl rm
  • ibmcloud sat acl subnet add
  • ibmcloud sat acl subnet rm
  • ibmcloud sat acl update

agent commands

Attach or view Satellite Connector Agents.

* [`ibmcloud sat agent attach`](/docs/satellite?topic=satellite-satellite-cli-reference#agent-attach-cli)
* [`ibmcloud sat agent ls`](/docs/satellite?topic=satellite-satellite-cli-reference#agent-ls-cli)

cluster commands

Register and manage clusters for use with Satellite configurations.

* [`ibmcloud sat cluster get`](/docs/satellite?topic=satellite-satellite-cli-reference#cluster-get-cli)
* [`ibmcloud sat cluster ls`](/docs/satellite?topic=satellite-satellite-cli-reference#cluster-ls-cli)
* [`ibmcloud sat cluster register`](/docs/satellite?topic=satellite-satellite-cli-reference#cluster-register-cli)
* [`ibmcloud sat cluster unregister`](/docs/satellite?topic=satellite-satellite-cli-reference#cluster-unregister-cli)

config commands

View and manage Satellite Configuration.

• config version: View and manage Satellite configuration versions.
  • ibmcloud sat config create
  • ibmcloud sat config get
  • ibmcloud sat config ls
  • ibmcloud sat config rename
  • ibmcloud sat config rm
  • ibmcloud sat config version create
  • ibmcloud sat config version get
  • ibmcloud sat config version rm

connector commands

Create, view, and modify Satellite connectors.

* [`ibmcloud sat connector create`](/docs/satellite?topic=satellite-satellite-cli-reference#connector-create-cli)
* [`ibmcloud sat connector get`](/docs/satellite?topic=satellite-satellite-cli-reference#connector-get-cli)
* [`ibmcloud sat connector ls`](/docs/satellite?topic=satellite-satellite-cli-reference#connector-ls-cli)
* [`ibmcloud sat connector rm`](/docs/satellite?topic=satellite-satellite-cli-reference#connector-rm-cli)

endpoint commands

View and manage Satellite endpoints.

• endpoint authn: Configure authentication settings for an endpoint.
  • ibmcloud sat endpoint authn get
  • ibmcloud sat endpoint authn rotate
  • ibmcloud sat endpoint authn set
  • ibmcloud sat endpoint create
  • ibmcloud sat endpoint disable
  • ibmcloud sat endpoint enable
  • ibmcloud sat endpoint get
  • ibmcloud sat endpoint ls
  • ibmcloud sat endpoint rm
  • ibmcloud sat endpoint update

experimental commands

[Expires on 2024-11-25] Experiment with new commands. IMPORTANT: Commands here will retire after the [date] in their description.

• experimental acl: [Deactivated on 2024-10-01! Use ibmcloud sat acl instead] View and manage Satellite access control lists (ACLs).
• experimental agent: [Deactivated on 2024-09-01! Use ibmcloud sat agent instead] Attach or view Satellite Connector Agents.
• experimental connector: [Deactivated on 2024-11-18! Use ibmcloud sat connector instead] Create, view, and modify Satellite connectors.
• experimental endpoint: [Expires on 2024-10-01] View and manage Satellite endpoints.
• experimental location: [Deactivated on 2024-11-25! Use ibmcloud sat location instead] Create, view, and modify Satellite locations.
  • ibmcloud sat experimental acl create
  • ibmcloud sat experimental acl endpoint add
  • ibmcloud sat experimental acl endpoint ls
  • ibmcloud sat experimental acl endpoint rm
  • ibmcloud sat experimental acl get
  • ibmcloud sat experimental acl ls
  • ibmcloud sat experimental acl rm
  • ibmcloud sat experimental acl subnet add
  • ibmcloud sat experimental acl subnet rm
  • ibmcloud sat experimental acl update
  • ibmcloud sat experimental agent attach
  • ibmcloud sat experimental agent ls
  • ibmcloud sat experimental connector create
  • ibmcloud sat experimental connector get
  • ibmcloud sat experimental connector ls
  • ibmcloud sat experimental connector rm
  • ibmcloud sat experimental endpoint authn get
  • ibmcloud sat experimental endpoint authn rotate
  • ibmcloud sat experimental endpoint authn set
  • ibmcloud sat experimental location update

group commands

View and manage Satellite cluster groups. Cluster groups are used to subscribe clusters to Satellite configurations of Kubernetes resources.

* [`ibmcloud sat group attach`](/docs/satellite?topic=satellite-satellite-cli-reference#group-attach-cli)
* [`ibmcloud sat group create`](/docs/satellite?topic=satellite-satellite-cli-reference#group-create-cli)
* [`ibmcloud sat group detach`](/docs/satellite?topic=satellite-satellite-cli-reference#group-detach-cli)
* [`ibmcloud sat group get`](/docs/satellite?topic=satellite-satellite-cli-reference#group-get-cli)
* [`ibmcloud sat group ls`](/docs/satellite?topic=satellite-satellite-cli-reference#group-ls-cli)
* [`ibmcloud sat group rm`](/docs/satellite?topic=satellite-satellite-cli-reference#group-rm-cli)

host commands

View and modify Satellite hosts.

* [`ibmcloud sat host assign`](/docs/satellite?topic=satellite-satellite-cli-reference#host-assign-cli)
* [`ibmcloud sat host attach`](/docs/satellite?topic=satellite-satellite-cli-reference#host-attach-cli)
* [`ibmcloud sat host get`](/docs/satellite?topic=satellite-satellite-cli-reference#host-get-cli)
* [`ibmcloud sat host ls`](/docs/satellite?topic=satellite-satellite-cli-reference#host-ls-cli)
* [`ibmcloud sat host rm`](/docs/satellite?topic=satellite-satellite-cli-reference#host-rm-cli)
* [`ibmcloud sat host update`](/docs/satellite?topic=satellite-satellite-cli-reference#host-update-cli)

key commands

View and manage Satellite Config keys.

* [`ibmcloud sat key ls`](/docs/satellite?topic=satellite-satellite-cli-reference#key-ls-cli)
* [`ibmcloud sat key rm`](/docs/satellite?topic=satellite-satellite-cli-reference#key-rm-cli)
* [`ibmcloud sat key rotate`](/docs/satellite?topic=satellite-satellite-cli-reference#key-rotate-cli)

location commands

Create, view, and modify Satellite locations.

• location dns: Set and manage subdomains for the hosts assigned to the control plane in a Satellite location.
  • ibmcloud sat location create
  • ibmcloud sat location dns get
  • ibmcloud sat location dns ls
  • ibmcloud sat location dns register
  • ibmcloud sat location get
  • ibmcloud sat location ls
  • ibmcloud sat location rm
  • ibmcloud sat location update

messages commands

View the current user messages.

* [`ibmcloud sat messages`](/docs/satellite?topic=satellite-satellite-cli-reference#messages-cli)

resource commands

Search and view Kubernetes resources that are managed by a Satellite configuration.

• resource history: Get history for a Kubernetes resource.
  • ibmcloud sat resource get
  • ibmcloud sat resource history get
  • ibmcloud sat resource ls

service commands

View Satellite service clusters.

* [`ibmcloud sat service ls`](/docs/satellite?topic=satellite-satellite-cli-reference#service-ls-cli)

storage commands

View and manage Satellite storage resources.

• storage assignment: View and manage Satellite storage assignments.
• storage config: View and manage Satellite storage configurations.
• storage template: View the Satellite storage templates.
  • Beta ibmcloud sat storage assignment autopatch disable
  • Beta ibmcloud sat storage assignment autopatch enable
  • ibmcloud sat storage assignment create
  • ibmcloud sat storage assignment get
  • ibmcloud sat storage assignment ls
  • ibmcloud sat storage assignment patch
  • ibmcloud sat storage assignment rm
  • ibmcloud sat storage assignment update
  • ibmcloud sat storage config class add
  • ibmcloud sat storage config class get
  • ibmcloud sat storage config class ls
  • ibmcloud sat storage config create
  • ibmcloud sat storage config get
  • ibmcloud sat storage config ls
  • ibmcloud sat storage config param set
  • ibmcloud sat storage config patch
  • ibmcloud sat storage config rm
  • ibmcloud sat storage template get
  • ibmcloud sat storage template ls

subscription commands

View and manage Satellite subscriptions to deploy Kubernetes configuration files to your clusters.

• subscription identity: Manage the identity used to apply the Satellite subscription.
  • ibmcloud sat subscription create
  • ibmcloud sat subscription get
  • ibmcloud sat subscription identity set
  • ibmcloud sat subscription ls
  • ibmcloud sat subscription rm
  • ibmcloud sat subscription update