openshift/openshift-docs
1
0
Fork 0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 21:46:22 +01:00
Code Issues Releases Activity
Files
fd7984cfcdc722eaa70f93fd7f5da48ba445a590
openshift-docs/modules/rosa-list-objects.adoc

1124 lines
22 KiB
Plaintext
Raw Blame History

// 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-describe-access-request_{context}"]
== describe access-request
Shows detailed information about access requests.
.Syntax
[source,terminal]
----
$ rosa describe describe access-request --id <access_request_id>
----
.Arguments
[cols="30,70"]
|===
|Option |Definition
| --id string
| Required. The ID of your access request.
|-o, --output string
|Specify your output format. You may use either `json` or `yaml`.
|===
include::snippets/rosa-cli-default-flags.adoc[]
.Examples
Shows the details of the access request with an ID of `A1B2C3D4` and produces the results in a .yaml output.
[source,terminal]
----
$ rosa describe describe access-request --id A1B2C3D4 -output yaml
----
[id="rosa-list-access-request_{context}"]
== list access-request
Lists all access requests in either `Pending` or `Approved` status. If you use the '--cluster' flag, the CLI lists all access requests in any status for the specified cluster.
.Syntax
[source,terminal]
----
$ rosa list access-request [arguments]
----
.Arguments
[cols="30,70"]
|===
|Option |Definition
|-c, --cluster string
|Required: The name or ID (string) of the cluster that the machine pools will be listed for.
|-o, --output string
|Specify your output format. You may use either `json` or `yaml`.
|===
include::snippets/rosa-cli-default-flags.adoc[]
.Example
Lists all Access Requests for cluster `foo`.
[source,terminal]
----
$ rosa list access-request --cluster foo
----
[id="rosa-list-account-roles_{context}"]
== list account-roles
Lists all account roles and policies for the current AWS account.
.Syntax
[source,terminal]
----
$ rosa list account-roles [arguments]
----
.Arguments
[cols="30,70"]
|===
|Option |Definition
|-c, --cluster string
|Required: The name or ID (string) of the cluster that the machine pools will be listed for.
|-o, --output string
|Specify your output format. You may use either `json` or `yaml`.
|===
include::snippets/rosa-cli-default-flags.adoc[]
.Example
Lists all AWS account roles associated with your account.
[source,terminal]
----
$ rosa list account-roles
----
[id="rosa-describe-addon-installation_{context}"]
== describe addon-installation
Shows detailed information about an add-on installation.
.Arguments
[cols="30,70"]
|===
|Option |Definition
|-c, --cluster string
|Required: The name or ID (string) of the cluster that the machine pools will be listed for.
| --addon string
|Required: Name or ID of the add-on installation.
|===
include::snippets/rosa-cli-default-flags.adoc[]
.Examples
Describes the `bar` add-on installation on cluster `foo`.
[source,terminal]
----
$ rosa describe addon-installation --cluster foo --addon bar
----
[id="rosa-describe-admin_{context}"]
== describe admin
Shows 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.
|===
include::snippets/rosa-cli-default-flags.adoc[]
.Example
Describes the `cluster-admin` user for a cluster named `mycluster`.
[source,terminal]
----
$ rosa describe admin --cluster=mycluster
----
[id="rosa-describe-addon_{context}"]
== describe addon
Shows the details of a managed service add-on.
.Syntax
[source,terminal]
----
$ rosa describe addon <addon_id> | <addon_name> [arguments]
----
include::snippets/rosa-cli-default-flags.adoc[]
.Example
Describes an add-on named `dbaas-operator`.
[source,terminal]
----
$ rosa describe addon dbaas-operator
----
[id="rosa-list-oaddon_{context}"]
== list addon
Lists the managed service add-on installations.
.Syntax
[source,terminal]
----
$ rosa list addons [arguments]
----
.Arguments
[cols="30,70"]
|===
|Option |Definition
|--cluster
|Required: The name or ID (string) of the cluster to list the add-ons for.
|-o, --output string
|Specify your output format. You may use either `json` or `yaml`.
|===
include::snippets/rosa-cli-default-flags.adoc[]
.Example
Lists all add-on installations on a cluster named `mycluster`.
[source,terminal]
----
$ rosa list addons --cluster=mycluster
----
ifdef::openshift-rosa[]
[id="rosa-describe-autoscaler_{context}"]
== describe autoscaler
Shows detailed information about the configuration for a specified cluster's autoscaler.
[NOTE]
====
Cluster autoscalers are only supported on {product-title} clusters that use self-hosted control planes.
====
.Syntax
[source,terminal]
----
$ rosa describe autoscaler [flag]
----
.Arguments
[cols="30,70"]
|===
|Option |Definition
|--cluster
|Required: The name or ID (string) of the cluster.
|-o, --output string
|Specify your output format. You may use either `json` or `yaml`.
|===
include::snippets/rosa-cli-default-flags.adoc[]
.Examples
Describes the autoscaler for cluster `foo`.
[source,terminal]
----
$ rosa describe autoscaler --cluster foo
----
endif::openshift-rosa[]
[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.
|===
include::snippets/rosa-cli-default-flags.adoc[]
[id="rosa-list-break-glass-credential_{context}"]
== List break-glass-credential
Lists 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.
|===
include::snippets/rosa-cli-default-flags.adoc[]
.Example
Lists all of the break glass credentials for a cluster named `mycluster`.
[source,terminal]
----
$ rosa list break-glass-credential --cluster=mycluster
----
[id="rosa-describe-cluster_{context}"]
== describe cluster
Shows the details for a cluster.
.Syntax
[source,terminal]
----
$ rosa describe cluster [arguments]
----
.Arguments
[cols="30,70"]
|===
|Option |Definition
|--cluster
|Required: The name or ID (string) of the cluster.
|--external-id <arn_string>
|An optional, unique identifier that might be required when you assume a role in another account.
|--get-role-policy-bindings
|Lists the policies that are attached to the STS roles assigned to the cluster.
|===
include::snippets/rosa-cli-default-flags.adoc[]
.Example
Describes a cluster named `mycluster`.
[source,terminal]
----
$ rosa describe cluster --cluster=mycluster
----
[id="rosa-list-clusters_{context}"]
== list clusters
Lists all of your clusters.
.Syntax
[source,terminal]
----
$ rosa list clusters [flag]
----
.Arguments
[cols="30,70"]
|===
|Option |Definition
|-a, --all
|Lists all clusters across different AWS accounts under the same Red Hat organization
|-o, --output string
|Specify your output format. You may use either `json` or `yaml`.
|--get-role-policy-bindings
|Lists the policies that are attached to the STS roles assigned to the cluster.
|===
include::snippets/rosa-cli-default-flags.adoc[]
[id="rosa-list-dns-domain_{context}"]
== list dns-domain
Lists all DNS domains.
.Syntax
[source,terminal]
----
$ rosa list dns-domain [arguments]
----
.Arguments
[cols="30,70"]
|===
|Option |Definition
|-a, --all
|Lists all DNS domains. The default options lists just user defined domains.
| --hosted-cp
|Filters the list to only DNS Domains used for hosted control plane clusters.
|-o, --output string
|Specify your output format. You may use either `json` or `yaml`.
|===
include::snippets/rosa-cli-default-flags.adoc[]
.Example
Lists all DNS Domains tied to your organization ID.
[source,terminal]
----
$ rosa list dns-domain
----
[id="rosa-describe-external-auth-provider_{context}"]
== describe external-auth-provider
Shows detailed information about an external authentication provider on a cluster.
.Syntax
[source,terminal]
----
$ rosa describe external-auth-provider [arguments]
----
.Arguments
[cols="30,70"]
|===
|Option |Definition
|--cluster
|Required: The name or ID (string) of the cluster.
|--name string
|The name for the external authentication provider of the cluster to target.
|-o, --output string
|Specify your output format. You may use either `json` or `yaml`.
|===
include::snippets/rosa-cli-default-flags.adoc[]
.Examples
Shows details of an external authentication provider named `exauth` on a cluster named `mycluster`.
[source,terminal]
----
$ rosa describe external-auth-provider exauth --cluster=mycluster
----
[id="rosa-list-external-auth-provider_{context}"]
== list external-auth-provider
Lists 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.
|===
include::snippets/rosa-cli-default-flags.adoc[]
.Example
Lists any external authentication providers for a cluster named `mycluster`.
[source,terminal]
----
$ rosa list external-auth-provider --cluster=mycluster
----
[id="rosa-list-gates_{context}"]
== list gates
Lists all available OCP Gates for a specific OCP release or by cluster upgrade version.
.Syntax
[source,terminal]
----
$ rosa list gates [arguments]
----
.Arguments
[cols="30,70"]
|===
|Option |Definition
|--cluster
|Required: The name or ID (string) of the cluster.
|--gate string
|Gate type. Options are `sts` and `ocp`.
|-o, --output string
|Specify your output format. You may use either `json` or `yaml`.
|--version string
|Specified OpenShift version.
|===
include::snippets/rosa-cli-default-flags.adoc[]
.Example
* Lists all OCP gates for an OCP version.
+
[source,terminal]
----
$ rosa list gates --version 4.19
----
* Lists all STS gates for an OCP version.
+
[source,terminal]
----
$ rosa list gates --gate sts --version 4.19
----
* Lists all OCP gates for an OCP version.
+
[source,terminal]
----
$ rosa list gates --gate ocp --version 4.19
----
* Lists available gates for a cluster upgrade version.
+
[source,terminal]
----
$ rosa list gates -c mycluster --version 4.19.7
----
[id="rosa-list-idps_{context}"]
== list idps
Lists all of the identity providers (IDPs) for a cluster.
.Syntax
[source,terminal]
----
$ rosa list idps [arguments]
----
.Arguments
[cols="30,70"]
|===
|Option |Definition
|--cluster
|Required: The name or ID (string) of the cluster that the IDPs will be listed for.
|===
include::snippets/rosa-cli-default-flags.adoc[]
.Example
Lists all identity providers (IDPs) for a cluster named `mycluster`.
[source,terminal]
----
$ rosa list idps --cluster=mycluster
----
[id="rosa-describe-ingress_{context}"]
== describe ingress
Shows detailed information about the specified ingress within cluster.
.Syntax
[source,terminal]
----
$ rosa describe ingress [ingress]
----
.Arguments
[cols="30,70"]
|===
|Option |Definition
|--cluster
|Required: The name or ID (string) of the cluster.
| --ingress string
|Specify the ingress of the cluster to target
|-o, --output string
|Specify your output format. You may use either `json` or `yaml`.
|===
include::snippets/rosa-cli-default-flags.adoc[]
.Examples
Shows the details of an ingress named `a1b2c3d4` on cluster named `mycluster`.
[source,terminal]
----
$ rosa describe ingress a1b2c3d4 -c mycluster
----
[id="rosa-list-ingresses_{context}"]
== list ingresses
Lists all of the API and ingress endpoints for a cluster.
.Syntax
[source,terminal]
----
$ rosa list ingresses [arguments]
----
.Arguments
[cols="30,70"]
|===
|Option |Definition
|--cluster
|Required: The name or ID (string) of the cluster that the IDPs will be listed for.
|===
include::snippets/rosa-cli-default-flags.adoc[]
.Example
Lists all API and ingress endpoints for a cluster named `mycluster`.
[source,terminal]
----
$ rosa list ingresses --cluster=mycluster
----
[id="rosa-list-instance-types_{context}"]
== list instance-types
Lists all of the available instance types for use with {product-title}. Availability is based on the account's AWS quota.
.Syntax
[source,terminal]
----
$ rosa list instance-types [arguments]
----
include::snippets/rosa-cli-default-flags.adoc[]
.Example
Lists all instance types.
[source,terminal]
----
$ rosa list instance-types
----
[id="rosa-describe-kubeletconfig_{context}"]
== describe kubeletconfig
Shows the details of a custom `KubeletConfig` object.
.Syntax
[source,terminal]
----
$ rosa describe kubeletconfig --cluster=<cluster_name|cluster_id> [arguments]
----
.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
|The output format. You can specify either `json` or `yaml`.
|===
[id="rosa-list-kubeletconfigs_{context}"]
== list kubeletconfigs
Lists 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
a|-c, --cluster <cluster_name>\|<cluster_id>
|Required. The name or ID of the cluster that the machine pools will be listed for.
|===
include::snippets/rosa-cli-default-flags.adoc[]
.Example
Lists all of the `KubeletConfig` objects on a cluster named `mycluster`.
[source,terminal]
----
$ rosa list kubeletconfigs --cluster=mycluster
----
[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.
|===
include::snippets/rosa-cli-default-flags.adoc[]
.Example
Describes a machine pool named `mymachinepool` on a cluster named `mycluster`.
[source,terminal]
----
$ rosa describe machinepool --cluster=mycluster --machinepool=mymachinepool
----
[id="rosa-list-machinepools_{context}"]
== list machinepools
Lists 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.
|===
include::snippets/rosa-cli-default-flags.adoc[]
.Example
Lists all of the machine pools on a cluster named `mycluster`.
[source,terminal]
----
$ rosa list machinepools --cluster=mycluster
----
[id="rosa-list-ocm-roles_{context}"]
== list ocm-roles
Lists all OCM roles for the current AWS account.
.Syntax
[source,terminal]
----
$ rosa list ocm-roles [arguments]
----
.Arguments
[cols="30,70"]
|===
|Option |Definition
|-o, --output string
|The output format. You can specify either `json` or `yaml`.
|===
include::snippets/rosa-cli-default-flags.adoc[]
[id="rosa-list-oidc-config_{context}"]
== list oidc-config
Lists the OIDC Configuration resources associated with your AWS account.
.Syntax
[source,terminal]
----
$ rosa list oidc-config
----
.Arguments
[cols="30,70"]
|===
|Option |Definition
|-o, --output string
|The output format. You can specify either `json` or `yaml`.
|===
include::snippets/rosa-cli-default-flags.adoc[]
[id="rosa-list-oidc-providers_{context}"]
== list oidc-providers
Lists all of the OIDC providers for the current AWS account.
.Syntax
[source,terminal]
----
$ rosa list oidc-providers [arguments]
----
.Arguments
[cols="30,70"]
|===
|Option |Definition
a|-c, --cluster <cluster_name>\|<cluster_id>
|Required. The name or ID of the cluster that the OIDC providers will be listed for.
|--oidc-config-id string
|This argument filters OIDC providers by OIDC config ID. It returns one provider linked to the config ID.
|-o, --output string
|The output format. You can specify either `json` or `yaml`.
|===
include::snippets/rosa-cli-default-flags.adoc[]
[id="rosa-list-operator-roles_{context}"]
== list operator-roles
Lists all Operator roles and policies for the current AWS account.
.Syntax
[source,terminal]
----
$ rosa list operator-roles [arguments]
----
.Arguments
[cols="30,70"]
|===
|Option |Definition
a|-c, --cluster <cluster_name>\|<cluster_id>
|Required. The name or ID of the cluster.
|-o, --output string
|The output format. You can specify either `json` or `yaml`.
|--prefix string
|List only Operator roles that are associated with the given prefix. The prefix must match up to `openshift|kube-system`.
|--version string
|List only Operator roles that are associated with the given version.
|===
include::snippets/rosa-cli-default-flags.adoc[]
[id="rosa-list-regions_{context}"]
== list regions
Lists all of the available regions for the current AWS account.
.Syntax
[source,terminal]
----
$ rosa list regions [arguments]
----
ifdef::openshift-rosa[]
.Arguments
[cols="30,70"]
|===
|Option |Definition
|--multi-az
|Lists regions that provide support for multiple availability zones.
|===
endif::openshift-rosa[]
include::snippets/rosa-cli-default-flags.adoc[]
.Example
Lists all of the available regions.
[source,terminal]
----
$ rosa list regions
----
[id="rosa-describe-tuning-configs_{context}"]
== describe tuning-configs
Shows detailed information about a tuning config for a cluster.
.Syntax
[source,terminal]
----
$ rosa describe tuning-config --cluster <cluster-name-or-id> <tuning-name>
----
.Arguments
[cols="30,70"]
|===
|Option |Definition
a|-c, --cluster <cluster_name>\|<cluster_id>
|Required. The name or ID of the cluster.
|-o, --output string
|The output format. You can specify either `json` or `yaml`.
|===
include::snippets/rosa-cli-default-flags.adoc[]
.Examples
Describes the `tuned1` tuned config on cluster `foo`.
[source,terminal]
----
$ rosa describe tuning-config --cluster foo tuned1
----
[id="rosa-list-tuning-configs_{context}"]
== list tuning-configs
Lists tuning configuration resources for a cluster.
.Syntax
[source,terminal]
----
$ rosa list tuning-configs --cluster <cluster-name-or-id>
----
.Arguments
[cols="30,70"]
|===
|Option |Definition
a|-c, --cluster <cluster_name>\|<cluster_id>
|Required. The name or ID of the cluster.
|-o, --output string
|The output format. You can specify either `json` or `yaml`.
|===
include::snippets/rosa-cli-default-flags.adoc[]
.Example
Lists all tuning configuration for a cluster named `mycluster`.
[source,terminal]
----
$ rosa list tuning-configs -c mycluster
----
[id="rosa-describe-upgrade_{context}"]
== describe upgrade
Shows detailed information about an upgrade.
.Syntax
[source,terminal]
----
$ rosa describe upgrade [arguments]
----
.Arguments
[cols="30,70"]
|===
|Option |Definition
a|-c, --cluster <cluster_name>\|<cluster_id>
|Required. The name or ID of the cluster.
| --machinepool string
|The name of the machine pool of the cluster to target.
|===
include::snippets/rosa-cli-default-flags.adoc[]
[id="rosa-list-upgrades_{context}"]
== list upgrades
Lists 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.
| --machinepool string
|The name of the machine pool of the cluster to target.
|-o, --output string
|The output format. You can specify either `json` or `yaml`.
|===
include::snippets/rosa-cli-default-flags.adoc[]
.Example
Lists all of the available upgrades for a cluster named `mycluster`.
[source,terminal]
----
$ rosa list upgrades --cluster=mycluster
----
[id="rosa-list-user-roles_{context}"]
== list user-roles
Lists all user roles for current AWS account.
.Syntax
[source,terminal]
----
$ rosa list user-roles
----
.Arguments
[cols="30,70"]
|===
|Option |Definition
|-o, --output string
|The output format. You can specify either `json` or `yaml`.
|===
include::snippets/rosa-cli-default-flags.adoc[]
[id="rosa-list-users_{context}"]
== list users
Lists 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.
|===
include::snippets/rosa-cli-default-flags.adoc[]
.Example
Lists 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
Lists all of the OpenShift versions that are available for creating a cluster.
.Syntax
[source,terminal]
----
$ rosa list versions [arguments]
----
include::snippets/rosa-cli-default-flags.adoc[]
.Example
Lists all of the {product-title} versions.
[source,terminal]
----
$ rosa list versions
----
View Git Blame Copy Permalink