// Module included in the following assemblies:
//
// * rosa_cli/rosa-manage-objects-cli.adoc
:_mod-docs-content-type: REFERENCE
[id="rosa-list-objects_{context}"]
= List and describe objects

This section describes the `list` and `describe` commands for clusters and resources.

[id="rosa-list-oaddon_{context}"]
== list addon

List the managed service add-on installations.

.Syntax
[source,terminal]
----
$ rosa list addons --cluster=<cluster_name> | <cluster_id>
----

.Arguments
[cols="30,70"]
|===
|Option |Definition

|--cluster
|Required: The name or ID (string) of the cluster to list the add-ons for.
|===

.Optional arguments inherited from parent commands
[cols="30,70"]
|===
|Option |Definition

|--help
|Shows help for this command.

|--debug
|Enables debug mode.

|--profile
|Specifies an AWS profile (string) from your credentials file.
|===


[id="rosa-list-break-glass-credential_{context}"]
== List break glass credentials

List all of the break glass credentials for a cluster.

.Syntax
[source,terminal]
----
$ rosa list break-glass-credential [arguments]
----

.Arguments
[cols="30,70"]
|===
|Option |Definition

|--cluster <cluster_name>\|<cluster_id>
|Required. The name or ID of the cluster to which the break glass credentials have been added.
|===

.Optional arguments inherited from parent commands
[cols="30,70"]
|===
|Option |Definition

|--help
|Shows help for this command.

|--debug
|Enables debug mode.

|--profile
|Specifies an AWS profile (string) from your credentials file.
|===

.Example

List all of the break glass credentials for a cluster named `mycluster`.

[source,terminal]
----
$ rosa list break-glass-credential --cluster=mycluster
----

[id="rosa-list-clusters_{context}"]
== list clusters

List all of your clusters.

.Syntax
[source,terminal]
----
$ rosa list clusters [arguments]
----

.Arguments
[cols="30,70"]
|===
|Option |Definition

|--count
|The number (integer) of clusters to display. Default: `100`
|===

.Optional arguments inherited from parent commands
[cols="30,70"]
|===
|Option |Definition

|--help
|Shows help for this command.

|--debug
|Enables debug mode.

|--profile
|Specifies an AWS profile (string) from your credentials file.
|===

[id="rosa-list-external-auth-provider_{context}"]
== list external-auth-provider

List any external authentication providers for a cluster.

.Syntax
[source,terminal]
----
$ rosa list external-auth-provider --cluster=<cluster_name> | <cluster_id> [arguments]
----

.Arguments
[cols="30,70"]
|===
|Option |Definition

|--cluster
|Required: The name or ID string of the cluster that the external authentication provider will be listed for.
|===

.Optional arguments inherited from parent commands
[cols="30,70"]
|===
|Option |Definition

|--help
|Shows help for this command.

|--debug
|Enables debug mode.

|--profile
|Specifies an AWS profile string from your credentials file.
|===

.Example
List any external authentication providers for a cluster named `mycluster`.

[source,terminal]
----
$ rosa list external-auth-provider --cluster=mycluster
----

[id="rosa-list-idps_{context}"]
== list idps

List all of the identity providers (IDPs) for a cluster.

.Syntax
[source,terminal]
----
$ rosa list idps --cluster=<cluster_name> | <cluster_id> [arguments]
----

.Arguments
[cols="30,70"]
|===
|Option |Definition

|--cluster
|Required: The name or ID (string) of the cluster that the IDPs will be listed for.
|===

.Optional arguments inherited from parent commands
[cols="30,70"]
|===
|Option |Definition

|--help
|Shows help for this command.

|--debug
|Enables debug mode.

|--profile
|Specifies an AWS profile (string) from your credentials file.
|===

.Example
List all identity providers (IDPs) for a cluster named `mycluster`.

[source,terminal]
----
$ rosa list idps --cluster=mycluster
----

[id="rosa-list-iamserviceaccounts_{context}"]
== list iamserviceaccounts

List IAM roles that were created for OpenShift service accounts.

.Syntax
[source,terminal]
----
$ rosa list iamserviceaccounts [arguments]
----

.Arguments
[cols="30,70"]
|===
|Option |Definition

|--cluster <cluster_name>\|<cluster_id>
|The name or ID of the cluster to filter service account roles by.

|--namespace <namespace_name>
|The OpenShift namespace to filter service account roles by.

|===

.Optional arguments inherited from parent commands
[cols="30,70"]
|===
|Option |Definition

|--help
|Shows help for this command.

|--debug
|Enables debug mode.

|--output
|The output format. Allowed formats are `json` or `yaml`.

|--profile
|Specifies an AWS profile from your credentials file.

|===

.Examples
List all IAM service account roles.

[source,terminal]
----
$ rosa list iamserviceaccounts
----

List IAM service account roles for a specific cluster.

[source,terminal]
----
$ rosa list iamserviceaccounts --cluster=mycluster
----

List IAM service account roles for a specific namespace in a cluster.

[source,terminal]
----
$ rosa list iamserviceaccounts --cluster=mycluster --namespace=production
----

[id="rosa-describe-iamserviceaccount_{context}"]
== describe iamserviceaccount

Show detailed information about an IAM role created for an OpenShift service account.

.Syntax
[source,terminal]
----
$ rosa describe iamserviceaccount --cluster=<cluster_name> | <cluster_id> [arguments]
----

.Arguments
[cols="30,70"]
|===
|Option |Definition

a|--cluster <cluster_name>\|<cluster_id>
|Required. The name or ID of the cluster.

|--name <service_account_name>
|The name of the OpenShift service account. Required when `--role-name` is not specified.

|--namespace <namespace_name>
|The OpenShift namespace for the service account. Default: `default`

|--role-name <role_name>
|The name of the IAM role to describe. If not specified, the role name will be auto-detected using the service account details.

|===

.Optional arguments inherited from parent commands
[cols="30,70"]
|===
|Option |Definition

|--help
|Shows help for this command.

|--debug
|Enables debug mode.

|--output
|The output format. Allowed formats are `json` or `yaml`.

|--profile
|Specifies an AWS profile from your credentials file.

|===

.Examples
Describe an IAM role for a service account named `my-app` in the `default` namespace.

[source,terminal]
----
$ rosa describe iamserviceaccount --cluster=mycluster --name=my-app
----

Describe an IAM role by specifying the role name directly.

[source,terminal]
----
$ rosa describe iamserviceaccount --cluster=mycluster --role-name=my-custom-role
----

[id="rosa-list-ingresses_{context}"]
== list ingresses

List all of the API and ingress endpoints for a cluster.

.Syntax
[source,terminal]
----
$ rosa list ingresses --cluster=<cluster_name> | <cluster_id> [arguments]
----

.Arguments
[cols="30,70"]
|===
|Option |Definition

|--cluster
|Required: The name or ID (string) of the cluster that the IDPs will be listed for.
|===

.Optional arguments inherited from parent commands
[cols="30,70"]
|===
|Option |Definition

|--help
|Shows help for this command.

|--debug
|Enables debug mode.

|--profile
|Specifies an AWS profile (string) from your credentials file.
|===

.Example
List all API and ingress endpoints for a cluster named `mycluster`.

[source,terminal]
----
$ rosa list ingresses --cluster=mycluster
----

== list instance-types

List all of the available instance types for use with ROSA. Availability is based on the account's AWS quota.

.Syntax
[source,terminal]
----
$ rosa list instance-types [arguments]
----

.Optional arguments inherited from parent commands
[cols="30,70"]
|===
|Option |Definition

|--help
|Shows help for this command.

|--debug
|Enables debug mode.

|--output
|The output format. Allowed formats are `json` or `yaml`.

|--profile
|Specifies an AWS profile (string) from your credentials file.
|===

.Example
List all instance types.

[source,terminal]
----
$ rosa list instance-types
----

[id="rosa-list-kubeletconfigs_{context}"]
== list kubeletconfigs

List the `KubeletConfig` objects configured on a cluster.

.Syntax
[source,terminal]
----
$ rosa list kubeletconfigs --cluster=<cluster_name> | <cluster_id> [arguments]
----

.Arguments
[cols="30,70"]
|===
|Option |Definition

|--cluster
|Required: The name or ID (string) of the cluster that the machine pools will be listed for.
|===

.Optional arguments inherited from parent commands
[cols="30,70"]
|===
|Option |Definition

|--help
|Shows help for this command.

|--debug
|Enables debug mode.

// |--profile
// |Specifies an AWS profile (string) from your credentials file.
|===

.Example
List all of the `KubeletConfig` objects on a cluster named `mycluster`.

[source,terminal]
----
$ rosa list kubeletconfigs --cluster=mycluster
----

[id="rosa-list-machinepools_{context}"]
== list machinepools

List the machine pools configured on a cluster.

.Syntax
[source,terminal]
----
$ rosa list machinepools --cluster=<cluster_name> | <cluster_id> [arguments]
----

.Arguments
[cols="30,70"]
|===
|Option |Definition

|--cluster
|Required: The name or ID (string) of the cluster that the machine pools will be listed for.
|===

.Optional arguments inherited from parent commands
[cols="30,70"]
|===
|Option |Definition

|--help
|Shows help for this command.

|--debug
|Enables debug mode.

|--profile
|Specifies an AWS profile (string) from your credentials file.
|===

.Example
List all of the machine pools on a cluster named `mycluster`.

[source,terminal]
----
$ rosa list machinepools --cluster=mycluster
----

[id="rosa-list-regions_{context}"]
== list regions

List all of the available regions for the current AWS account.

.Syntax
[source,terminal]
----
$ rosa list regions [arguments]
----

.Arguments
[cols="30,70"]
|===
|Option |Definition

ifdef::openshift-rosa[]
|--multi-az
|Lists regions that provide support for multiple availability zones.
endif::openshift-rosa[]
|===

.Optional arguments inherited from parent commands
[cols="30,70"]
|===
|Option |Definition

|--help
|Shows help for this command.

|--debug
|Enables debug mode.

|--profile
|Specifies an AWS profile (string) from your credentials file.
|===

.Example
List all of the available regions.

[source,terminal]
----
$ rosa list regions
----

[id="rosa-list-upgrades_{context}"]
== list upgrades

List all available and scheduled cluster version upgrades.

.Syntax
[source,terminal]
----
$ rosa list upgrades --cluster=<cluster_name> | <cluster_id> [arguments]
----

.Arguments
[cols="30,70"]
|===
|Option |Definition

|--cluster
|Required: The name or ID (string) of the cluster that the available upgrades will be listed for.
|===

.Optional arguments inherited from parent commands
[cols="30,70"]
|===
|Option |Definition

|--help
|Shows help for this command.

|--debug
|Enables debug mode.

|--profile
|Specifies an AWS profile (string) from your credentials file.
|===

.Example
List all of the available upgrades for a cluster named `mycluster`.

[source,terminal]
----
$ rosa list upgrades --cluster=mycluster
----

[id="rosa-list-users_{context}"]
== list users
List the cluster administrator and dedicated administrator users for a specified cluster.

.Syntax
[source,terminal]
----
$ rosa list users --cluster=<cluster_name> | <cluster_id> [arguments]
----

.Arguments
[cols="30,70"]
|===
|Option |Definition

|--cluster
|Required: The name or ID (string) of the cluster that the cluster administrators will be listed for.
|===

.Optional arguments inherited from parent commands
[cols="30,70"]
|===
|Option |Definition

|--help
|Shows help for this command.

|--debug
|Enables debug mode.

|--profile
|Specifies an AWS profile (string) from your credentials file.
|===

.Example
List all of the cluster administrators and dedicated administrators for a cluster named `mycluster`.

[source,terminal]
----
$ rosa list users --cluster=mycluster
----

[id="rosa-list-versions_{context}"]
== list versions

List all of the OpenShift versions that are available for creating a cluster.

.Syntax
[source,terminal]
----
$ rosa list versions [arguments]
----

.Optional arguments inherited from parent commands
[cols="30,70"]
|===
|Option |Definition

|--help
|Shows help for this command.

|--debug
|Enables debug mode.

|--profile
|Specifies an AWS profile (string) from your credentials file.
|===

.Example
List all of the OpenShift Container Platform versions.

[source,terminal]
----
$ rosa list versions
----

[id="rosa-describe-admin_{context}"]
== describe admin

Show the details of a specified `cluster-admin` user and a command to log in to the cluster.

.Syntax
[source,terminal]
----
$ rosa describe admin --cluster=<cluster_name> | <cluster_id> [arguments]
----

.Arguments
[cols="30,70"]
|===
|Option |Definition

|--cluster
|Required: The name or ID (string) of the cluster to which the cluster-admin belongs.
|===

.Optional arguments inherited from parent commands
[cols="30,70"]
|===
|Option |Definition

|--help
|Shows help for this command.

|--debug
|Enables debug mode.

|--profile
|Specifies an AWS profile (string) from your credentials file.
|===

.Example
Describe the `cluster-admin` user for a cluster named `mycluster`.

[source,terminal]
----
$ rosa describe admin --cluster=mycluster
----

[id="rosa-describe-addon_{context}"]
== describe addon

Show the details of a managed service add-on.

.Syntax
[source,terminal]
----
$ rosa describe addon <addon_id> | <addon_name> [arguments]
----

.Optional arguments inherited from parent commands
[cols="30,70"]
|===
|Option |Definition

|--help
|Shows help for this command.

|--debug
|Enables debug mode.

|--profile
|Specifies an AWS profile (string) from your credentials file.
|===

.Example
Describe an add-on named `dbaas-operator`.

[source,terminal]
----
$ rosa describe addon dbaas-operator
----
[id="rosa-describe-break-glass-credential_{context}"]
== describe break glass credential

Shows the details for a break glass credential for a specific cluster.

.Syntax
[source,terminal]
----
$ rosa describe break-glass-credential --id=<break_glass_credential_id> --cluster=<cluster_name>| <cluster_id> [arguments]
----

.Arguments
[cols="30,70"]
|===
|Option |Definition

|--cluster
|Required: The name or ID (string) of the cluster.
|--id
|Required: The ID (string) of the break glass credential.
|--kubeconfig
|Optional: Retrieves the kubeconfig from the break glass credential.
|===

.Optional arguments inherited from parent commands
[cols="30,70"]
|===
|Option |Definition

|--help
|Shows help for this command.

|--debug
|Enables debug mode.

|--profile
|Specifies an AWS profile (string) from your credentials file.
|===

[id="rosa-describe-cluster_{context}"]
== describe cluster

Shows the details for a cluster.

.Syntax
[source,terminal]
----
$ rosa describe cluster --cluster=<cluster_name> | <cluster_id> [arguments]
----

.Arguments
[cols="30,70"]
|===
|Option |Definition

|--cluster
|Required: The name or ID (string) of the cluster.
|===

.Optional arguments inherited from parent commands
[cols="30,70"]
|===
|Option |Definition

|--help
|Shows help for this command.

|--debug
|Enables debug mode.

|--external-id <arn_string>
|An optional unique identifier that might be required when you assume a role in another account.

|--profile
|Specifies an AWS profile (string) from your credentials file.

|--get-role-policy-bindings
|Lists the policies that are attached to the STS roles assigned to the cluster.
|===


.Example
Describe a cluster named `mycluster`.
[source,terminal]
----
$ rosa describe cluster --cluster=mycluster
----

[id="rosa-describe-kubeletconfig_{context}"]
== describe kubeletconfig

Show the details of a custom `KubeletConfig` object.

.Syntax
[source,terminal]
----
$ rosa describe kubeletconfig --cluster=<cluster_name|cluster_id> [flags]
----

.Flags
[cols="30,70"]
|===
|Option |Definition

a|-c, --cluster <cluster_name>\|<cluster_id>
|Required. The name or ID of the cluster for which you want to view the `KubeletConfig` object.

|-h, --help
|Shows help for this command.

|--name
a| 
ifdef::openshift-rosa[]
Optional.
endif::openshift-rosa[]
ifdef::openshift-rosa-hcp[]
Required.
endif::openshift-rosa-hcp[]
Specifies the name of the `KubeletConfig` object to describe.

|-o, --output string

|-o, --output string
|The output format. You can specify either `json` or `yaml`.

|===

[id="rosa-describe-machinepool_{context}"]
== describe machinepool

Describes a specific machine pool configured on a cluster.

.Syntax
[source,terminal]
----
$ rosa describe machinepool --cluster=[<cluster_name>|<cluster_id>] --machinepool=<machinepool_name> [arguments]
----

.Arguments
[cols="30,70"]
|===
|Option |Definition

|--cluster
|Required: The name or ID (string) of the cluster.

|--machinepool
|Required: The name or ID (string) of the machinepool.

|===

.Optional arguments inherited from parent commands
[cols="30,70"]
|===
|Option |Definition

|--help
|Shows help for this command.

|--debug
|Enables debug mode.

|--profile
|Specifies an AWS profile (string) from your credentials file.
|===

.Example
Describe a machine pool named `mymachinepool` on a cluster named `mycluster`.
[source,terminal]
----
$ rosa describe machinepool --cluster=mycluster --machinepool=mymachinepool
----
