oadm-groups-prune man page

oadm groups prune ā€” Prune OpenShift groups referencing missing records on an external provider.


oadm groups prune [Options]


Prune OpenShift Groups referencing missing records on from an external provider.

In order to prune OpenShift Group records using those from an external provider, determine which Groups you wish to prune. For instance, all or some groups may be selected from the current Groups stored in OpenShift that have been synced previously. Any combination of a literal whitelist, a whitelist file and a blacklist file is supported. The path to a sync configuration file that was used for syncing the groups in question is required in order to describe how data is requested from the external record store. Default behavior is to indicate all OpenShift groups for which the external record does not exist, to run the pruning process and commit the results, use the --confirm flag.



path to the group blacklist file


if true, modify OpenShift groups; if false, display groups


path to the sync config


path to the group whitelist file

Options Inherited from Parent Commands


DEPRECATED: The API version to use when talking to the server


Username to impersonate for the operation


Path to the file container Azure container registry configuration information.


Path to a cert. file for the certificate authority


Path to a client certificate file for TLS


Path to a client key file for TLS


The name of the kubeconfig cluster to use


Path to the config file to use for CLI requests.


The name of the kubeconfig context to use


The Google Cloud Platform Service Account JSON Key to use for authentication.


If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure


Maximum number of seconds between log flushes


Require server version to match client version

-n, --namespace=""

If present, the namespace scope for this CLI request


The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.


The address and port of the Kubernetes API server


Bearer token for authentication to the API server


The name of the kubeconfig user to use


  # Prune all orphaned groups
  oadm groups prune --sync-config=/path/to/ldap-sync-config.yaml --confirm
  # Prune all orphaned groups except the ones from the blacklist file
  oadm groups prune --blacklist=/path/to/blacklist.txt --sync-config=/path/to/ldap-sync-config.yaml --confirm
  # Prune all orphaned groups from a list of specific groups specified in a whitelist file
  oadm groups prune --whitelist=/path/to/whitelist.txt --sync-config=/path/to/ldap-sync-config.yaml --confirm
  # Prune all orphaned groups from a list of specific groups specified in a whitelist
  oadm groups prune groups/group_name groups/other_name --sync-config=/path/to/ldap-sync-config.yaml --confirm

See Also



June 2016, Ported from the Kubernetes man-doc generator

Referenced By


Openshift CLI User Manuals June 2016