Este conteúdo não está disponível no idioma selecionado.

Chapter 5. Administrator CLI Operations


5.1. Overview

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 oadm command is used for administrator CLI operations, which is a symlink that can be used on hosts that have the openshift binary, such as a master. If you are on a workstation that does not have the openshift binary, you can also use oc adm in place of oadm, if oc is available.

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

The administrator CLI allows interaction with the various objects that are managed by OpenShift Enterprise. Many common oadm operations are invoked using the following syntax:

$ oadm <action> <option>
Copy to Clipboard Toggle word wrap

This specifies:

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

5.3. Basic CLI Operations

5.3.1. new-project

Creates a new project:

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

5.3.2. policy

Manages authorization policies:

$ oadm policy
Copy to Clipboard Toggle word wrap

5.3.3. groups

Manages groups:

$ oadm groups
Copy to Clipboard Toggle word wrap

5.4. Install CLI Operations

5.4.1. router

Installs a router:

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

5.4.2. ipfailover

Installs an IP failover group for a set of nodes:

$ oadm ipfailover <ipfailover_config>
Copy to Clipboard Toggle word wrap

5.4.3. registry

Installs an integrated container registry:

$ oadm registry
Copy to Clipboard Toggle word wrap

5.5. Maintenance CLI Operations

5.5.1. build-chain

Outputs the inputs and dependencies of any builds:

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

5.5.2. manage-node

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

$ oadm manage-node
Copy to Clipboard Toggle word wrap

5.5.3. prune

Removes older versions of resources from the server:

$ oadm prune
Copy to Clipboard Toggle word wrap

5.6. Settings CLI Operations

5.6.1. config

Changes kubelet configuration files:

$ oadm config <subcommand>
Copy to Clipboard Toggle word wrap

5.6.2. create-kubeconfig

Creates a basic .kubeconfig file from client certificates:

$ oadm create-kubeconfig
Copy to Clipboard Toggle word wrap

5.6.3. create-api-client-config

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

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

5.7. Advanced CLI Operations

5.7.1. create-bootstrap-project-template

Creates a bootstrap project template:

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

5.7.2. create-bootstrap-policy-file

Creates the default bootstrap policy:

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

5.7.3. create-login-template

Creates a login template:

$ oadm create-login-template
Copy to Clipboard Toggle word wrap

5.7.4. overwrite-policy

Resets the policy to the default values:

$ oadm overwrite-policy
Copy to Clipboard Toggle word wrap

5.7.5. create-node-config

Creates a configuration bundle for a node:

$ oadm create-node-config
Copy to Clipboard Toggle word wrap

5.7.6. ca

Manages certificates and keys:

$ oadm ca
Copy to Clipboard Toggle word wrap

5.8. Other CLI Operations

5.8.1. version

Displays the version of the indicated object:

$ oadm version
Copy to Clipboard Toggle word wrap

5.8.2. help

Displays help about any command:

$ oadm help <command>
Copy to Clipboard Toggle word wrap
Voltar ao topo
Red Hat logoGithubredditYoutubeTwitter

Aprender

Experimente, compre e venda

Comunidades

Sobre a documentação da Red Hat

Ajudamos os usuários da Red Hat a inovar e atingir seus objetivos com nossos produtos e serviços com conteúdo em que podem confiar. Explore nossas atualizações recentes.

Tornando o open source mais inclusivo

A Red Hat está comprometida em substituir a linguagem problemática em nosso código, documentação e propriedades da web. Para mais detalhes veja o Blog da Red Hat.

Sobre a Red Hat

Fornecemos soluções robustas que facilitam o trabalho das empresas em plataformas e ambientes, desde o data center principal até a borda da rede.

Theme

© 2025 Red Hat