diff --git a/modules/rosa-list-objects.adoc b/modules/rosa-list-objects.adoc index 5821674fc1..32a3bd4f78 100644 --- a/modules/rosa-list-objects.adoc +++ b/modules/rosa-list-objects.adoc @@ -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= --machinepool=| [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 +----