Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Chapter 5. Administrator CLI Operations

5.1. Overview
Copy link

This topic provides information on the administrator CLI operations and their syntax. You must setup and login with the CLI before you can perform these operations.

The openshift command is used for starting services that make up the OpenShift Container Platform cluster. For example, openshift start [master|node]. However, it is also an all-in-one command that can perform all the same actions as the oc and oc adm commands via openshift cli and openshift admin respectively.

The administrator CLI differs from the normal set of commands under the developer CLI, which uses the oc command, and is used more for project-level operations.

5.2. Common Operations
Copy link

The administrator CLI allows interaction with the various objects that are managed by OpenShift Container Platform. Many common oc adm operations are invoked using the following syntax: 

$ oc adm <action> <option>
Copy to Clipboard Toggle word wrap

This specifies:

  • An <action> to perform, such as new-project or groups.
  • An available <option> to perform the action on as well as a value for the option. Options include --output.
Important

When running oc adm commands, you should run them only from the first master listed in the Ansible host inventory file, by default /etc/ansible/hosts.

5.3. Basic CLI Operations
Copy link

5.3.1. new-project
Copy link

Creates a new project: 

$ oc adm new-project <project_name>
Copy to Clipboard Toggle word wrap

5.3.2. policy
Copy link

Manages authorization policies: 

$ oc adm policy
Copy to Clipboard Toggle word wrap

5.3.3. groups
Copy link

Manages groups: 

$ oc adm groups
Copy to Clipboard Toggle word wrap

5.4. Install CLI Operations
Copy link

5.4.1. router
Copy link

Installs a router: 

$ ocadm router <router_name>
Copy to Clipboard Toggle word wrap

5.4.2. ipfailover
Copy link

Installs an IP failover group for a set of nodes: 

$ oc adm ipfailover <ipfailover_config>
Copy to Clipboard Toggle word wrap

5.4.3. registry
Copy link

Installs an integrated container registry: 

$ oc adm registry
Copy to Clipboard Toggle word wrap

5.5. Maintenance CLI Operations
Copy link

5.5.1. build-chain
Copy link

Outputs the inputs and dependencies of any builds: 

$ oc adm build-chain <image_stream>[:<tag>]
Copy to Clipboard Toggle word wrap

5.5.2. manage-node
Copy link

Manages nodes. For example, list or evacuate pods, or mark them ready: 

$ oc adm manage-node
Copy to Clipboard Toggle word wrap

5.5.3. prune
Copy link

Removes older versions of resources from the server: 

$ oc adm prune
Copy to Clipboard Toggle word wrap

5.6. Settings CLI Operations
Copy link

5.6.1. config
Copy link

Changes kubelet configuration files: 

$ oc adm config <subcommand>
Copy to Clipboard Toggle word wrap

5.6.2. create-kubeconfig
Copy link

Creates a basic .kubeconfig file from client certificates: 

$ oc adm create-kubeconfig
Copy to Clipboard Toggle word wrap

5.6.3. create-api-client-config
Copy link

Creates a configuration file for connecting to the server as a user: 

$ oc adm create-api-client-config
Copy to Clipboard Toggle word wrap

5.7. Advanced CLI Operations
Copy link

5.7.1. create-bootstrap-project-template
Copy link

Creates a bootstrap project template: 

$ oc adm create-bootstrap-project-template
Copy to Clipboard Toggle word wrap

5.7.2. create-bootstrap-policy-file
Copy link

Creates the default bootstrap policy: 

$ oc adm create-bootstrap-policy-file
Copy to Clipboard Toggle word wrap

5.7.3. create-login-template
Copy link

Creates a login template: 

$ oc adm create-login-template
Copy to Clipboard Toggle word wrap

5.7.4. overwrite-policy
Copy link

Resets the policy to the default values: 

$ oc adm overwrite-policy
Copy to Clipboard Toggle word wrap

5.7.5. create-node-config
Copy link

Creates a configuration bundle for a node: 

$ oc adm create-node-config
Copy to Clipboard Toggle word wrap

5.7.6. ca
Copy link

Manages certificates and keys: 

$ oc adm ca
Copy to Clipboard Toggle word wrap

5.8. Other CLI Operations
Copy link

5.8.1. version
Copy link

Displays the version of the indicated object: 

$ oc adm version
Copy to Clipboard Toggle word wrap

5.8.2. help
Copy link

Displays help about any command: 

$ oc adm help <command>
Copy to Clipboard Toggle word wrap
Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat