admin_cli_operations.adoc

Administrator CLI Operations

• Overview
• Common Operations
• Basic CLI Operations
  • new-project
  • policy
  • groups
• Maintenance CLI Operations
• Other CLI Operations
  • version
  • help

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 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.

Common Operations

The administrator CLI allows interaction with the various objects that are managed by {product-title}. Many common oc adm operations are invoked using the following syntax:

$ oc adm <action> <option>

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.

Basic CLI Operations

new-project

Creates a new project:

$ oc adm new-project <project_name>

policy

Manages authorization policies:

$ oc adm policy

groups

Manages groups:

$ oc adm groups

Maintenance CLI Operations

Other CLI Operations

version

Displays the version of the indicated object:

$ oc adm version

help

Displays help about any command:

$ oc adm help <command>