1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00

Merge pull request #66551 from openshift-cherrypick-robot/cherry-pick-66546-to-enterprise-4.14

[enterprise-4.14] [OSDOCS-8263]: Add reference to describe machinepool command
This commit is contained in:
Brandi McElveen Munilla
2023-10-19 11:01:29 -04:00
committed by GitHub

View File

@@ -523,3 +523,48 @@ Describe a cluster named `mycluster`.
$ rosa describe cluster --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> --machinepool=<machinepool_name>| <cluster_id> <machinepool_id> [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
----