This documentation is for a release that is no longer maintained
See documentation for the latest supported version 3 or the latest supported version 4.Chapter 5. Administrator CLI Operations
5.1. Overview Copy linkLink copied to clipboard!
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 administrator CLI uses the oadm
command, and is used for administrator operations. This differs from the developer CLI, which uses the oc
command, and is used for basic, project-level operations.
5.2. Common Operations Copy linkLink copied to clipboard!
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>
$ oadm <action> <option>
This specifies:
-
An
<action>
to perform, such asnew-project
orrouter
. -
An available
<option>
to perform the action on as well as a value for the option. Options include--output
or--credentials
.
5.3. Basic CLI Operations Copy linkLink copied to clipboard!
5.3.1. new-project Copy linkLink copied to clipboard!
Creates a new project:
oadm new-project <project_name>
$ oadm new-project <project_name>
5.3.2. policy Copy linkLink copied to clipboard!
Manages authorization policies:
oadm policy
$ oadm policy
5.3.3. groups Copy linkLink copied to clipboard!
Manages groups:
oadm groups
$ oadm groups
5.4. Install CLI Operations Copy linkLink copied to clipboard!
5.4.1. router Copy linkLink copied to clipboard!
Installs a router:
oadm router <router_name>
$ oadm router <router_name>
5.4.2. ipfailover Copy linkLink copied to clipboard!
Installs an IP failover group for a set of nodes:
oadm ipfailover <ipfailover_config>
$ oadm ipfailover <ipfailover_config>
5.4.3. registry Copy linkLink copied to clipboard!
Installs an integrated Docker registry:
oadm registry
$ oadm registry
5.5. Maintenance CLI Operations Copy linkLink copied to clipboard!
5.5.1. build-chain Copy linkLink copied to clipboard!
Outputs the inputs and dependencies of any builds:
oadm build-chain <image-stream>[:<tag>]
$ oadm build-chain <image-stream>[:<tag>]
5.5.2. manage-node Copy linkLink copied to clipboard!
Manages nodes. For example, list or evacuate pods, or mark them ready:
oadm manage-node
$ oadm manage-node
5.5.3. prune Copy linkLink copied to clipboard!
Removes older versions of resources from the server:
oadm prune
$ oadm prune
5.6. Settings CLI Operations Copy linkLink copied to clipboard!
5.6.1. config Copy linkLink copied to clipboard!
Changes kubelet configuration files:
oadm config <subcommand>
$ oadm config <subcommand>
5.6.2. create-kubeconfig Copy linkLink copied to clipboard!
Creates a basic .kubeconfig file from client certificates:
oadm create-kubeconfig
$ oadm create-kubeconfig
5.6.3. create-api-client-config Copy linkLink copied to clipboard!
Creates a configuration file for connecting to the server as a user:
oadm create-api-client-config
$ oadm create-api-client-config
5.7. Advanced CLI Operations Copy linkLink copied to clipboard!
5.7.1. create-bootstrap-project-template Copy linkLink copied to clipboard!
Creates a bootstrap project template:
oadm create-bootstrap-project-template
$ oadm create-bootstrap-project-template
5.7.2. create-bootstrap-policy-file Copy linkLink copied to clipboard!
Creates the default bootstrap policy:
oadm create-bootstrap-policy-file
$ oadm create-bootstrap-policy-file
5.7.3. create-login-template Copy linkLink copied to clipboard!
Creates a login template:
oadm create-login-template
$ oadm create-login-template
5.7.4. overwrite-policy Copy linkLink copied to clipboard!
Resets the policy to the default values:
oadm overwrite-policy
$ oadm overwrite-policy
5.7.5. create-node-config Copy linkLink copied to clipboard!
Creates a configuration bundle for a node:
oadm create-node-config
$ oadm create-node-config
5.7.6. ca Copy linkLink copied to clipboard!
Manages certificates and keys:
oadm ca
$ oadm ca
5.8. Other CLI Operations Copy linkLink copied to clipboard!
5.8.1. version Copy linkLink copied to clipboard!
Displays the version of the indicated object:
oadm version
$ oadm version
5.8.2. help Copy linkLink copied to clipboard!
Displays help about any command:
oadm help <command>
$ oadm help <command>