Configuration Manager (CM) - quick reference guide

Introduction

The Configuration Manager is a tool that manages the Cloud Foundry deployment. It is composed of a server and a client. The server is running on the inception container. The client is installed in your installation directory and interacts with the server. This is a quick reference guide only.

Command-line general format

./cm [-f <format>] [-u <s_url>] [-t <timeout_sec>] [--cacert <certificate_path>] [--insecure] [--token <token>] <cmd> [<options>...] [<sub-command>] [<options>...]

Enter the following commands for details:

• ./cm -h
• ./cm ... <cmd> -h
• ./cm ... <cmd>... <sub-commad> -h

The default values for the options -f, -u, -t, and --cacert are set during the installation. Run ./cm api to get more details.

API

• Usage: Manage the access to the api that is running on the server from the client
• Show: ./cm api
• Set: ./cm [-f yaml|text|json] [-u <api_url>] [-t <timeout_sec>] [--insecure] [--token <token>] [--cacert <certificate_path>] [-k] [-token <token>] api save
• Remove: ./cm api remove

CFP

• Usage: Manage component versions
• Show: ./cm cfp

Configuration

• Usage: Manage the deployment configuration
• Show: ./cm bmxconfig
• Set: ./cm bmxconfig save -c <configuraiton_file_path>
• Add certificates for the management domain in the configuration file: ./cm bmxconfig add-certificates -c <configuraiton_file_path> --mgt --key <key_file_path> --cert <cert_file_path> --rootca <rootcA_file_path>
• Add certificates for the applications' domain in the configuration file: ./cm bmxconfig add-certificates -c <configuraiton_file_path> --apps --key <key_file_path> --cert <cert_file_path> --rootca <rootcA_file_path>
• Validate: ./cm bmxconfig validate

Engine

• Usage: Manage the deployment engine
• Show engine status: ./cm engine
• Reset: ./cm engine reset

Extension

• Usage: Manage the IBM or the customer extensions
• Show: ./cm extension -e <extension_name>
• Register: ./cm extension -e <extenstion_name> -p <extension_zip_path> [--force]
• Post Configuration: ./cm extension -e <extension_name> save -c <config_file>
• Deploy: ./cm extension -e <extension_name> deploy [--from-state <state_name>] [to-state <state_name>] --wait
• Unregister: ./cm extension -e <extenstion_name> unregister
• Reset: ./cm extension -e <extenstion_name> reset
• Logs: ./cm extension -e <extenstion_name> [--state <state_name>] [--follow]

Extensions

• Usage: Display the available extensions
• Show: ./cm extenstions

Logs

• Usage: Display deployment logs or extension logs
• Show: ./cm logs [-e <extension_name>] [--state <state_name>] [--follow]

State

• Usage: Manage the deployment state
• Show: ./cm state [-e <extension_name>] -s <state_name>
• Set new status for a state: ./cm state [-e <extension_name>] -s <state_name> set --status <STATUS>
• Set new timeout for a state: ./cm state [-e <extension_name>] -s <state_name> set --timeout <timeout_min>

States

• Usage: Manage the states of a deployment
• Show: ./cm states [-e <extension_name>]
• Find states with a given status: ./cm states [-e <extension_name>] --status <STATUS>
• Insert a state in a deployment: ./cm states [-e <extension_name>] insert --state-path <state_file_path> --insert-extension-name <extension_name> [--state-name <state_name_reference> | --position <position_to_insert>] [--before]
• Delete a state from a deployment: ./cm states [-e <extension_name>] delete [--state-name <state_name> | --position <position_to_delete]
• Set status by range: ./cm states [-e <extension_name>] set-status-by-range --status <new_status> --from-state <from_state_name> [--from-included] --to-state <to_state_name> [--to-included]

Status

• Usage: Display the server status
• Show: ./cm status

Token

• Usage: Create a new token on the server for API communication
• Create: ./cm token create -c <token_path>