CEE CLI Guide

Cloud Execution Environment

1	Introduction
1.1	Scope
1.2	Prerequisites
2	ACDC.py
3	ceescalein
4	cic-data-backup
4.1	changePolicy
4.2	clean
4.3	create
4.4	help
4.5	list
4.6	show
4.7	showHistory
4.8	showLog
4.9	showPolicy
5	pre-cic-data-restore
6	cic-data-restore
7	expandcee
8	healthcheck.py
9	neutron
9.1	device
9.2	deviceport
9.3	host
9.4	port-create
9.5	staticroute
10	nova
10.1	forcemove
10.2	redefine
11	watchmen-client
11.1	active-alarm-list
11.2	alarm-history
11.3	snmp-trap-config-add
11.4	snmp-trap-config-list
11.5	snmp-trap-config-remove
Reference List

1 Introduction

This document describes how to use specific command line interface (CLI) commands in the Cloud Execution Environment (CEE).

1.1 Scope

This document provides information on the CEE-specific CLI commands.

The CLI in CEE is based on the OpenStack CLI. For more information on the OpenStack CLI, refer to the Command-Line Interface Reference.

For information on the Atlas CLI, refer to the Atlas CLI End User Guide.

For information on the CSC CLI in CEE with SDN TI, refer to Using the CLI, Reference [2] and CSC Application Command List, Reference [1].

For information on the ScaleIO CLI, refer to the Dell EMC ScaleIO Version 2.x CLI Reference Guide.

1.2 Prerequisites

Ensure that the following conditions are met:

CEE system is installed.
Access to vFuel and the vCICs is available, refer to the CEE Connectivity User Guide.

2 ACDC.py

This section describes the ACDC.py command used in CEE to perform the data collection procedure described in the Data Collection Guideline.

This command can be issued on vFuel.

Syntax

ACDC.py [--blades <faulty_nodes>] [-h | --help]

Description

The ACDC.py command performs the automated CEE data collection procedure. For more information, refer to the Data Collection Guideline.

Optional Arguments

Parameter	Description
`-h` `--help`	Displays information about the `ACDC.py` command.
`--blades <faulty_nodes>`	If this option is used, the script also collects data from the specified compute hosts and ScaleIO servers. Multiple nodes can be added as a comma-separated list.

Example

ACDC.py --blades compute-0-2,compute-0-3,scaleio-0-5

3 ceescalein

This section describes the ceescalein command used for region scale-in, used in the Region Scale-in procedure.

Syntax

ceescalein --names <names> [-h] [--help]

Description

The ceescalein command enables the removal of one or a set of compute hosts at a time. Refer to Region Scale-in.

This command can be issued on vFuel.

Mandatory Arguments

Parameter	Description
`-n <names>` `--names <names>` `--name <names>`	The names of the nodes to be scaled in, as space-separated list.

Optional Arguments

Parameter	Description
`-h` `--help`	This option displays information about the `ceescalein` command.

Example

ceescalein --names compute-100-3 compute-100-5

4 cic-data-backup

This section describes the cic-data-backup commands used for CIC domain data backup. For more information on the backup process, refer to CIC Domain Data Backup.

Syntax

cic-data-backup changePolicy <n>
                clean
                create [<backup_name>]
                help
                list
                show [<backup_ID_or_name>]
                showHistory
                showPolicy
                showLog <n>

These commands can be issued by the ceebackup user.

4.1 changePolicy

Syntax

cic-data-backup changePolicy <n>

Description

The changePolicy command changes the number of backups to be retained.

Example

cic-data-backup changePolicy 8

4.2 clean

Syntax

cic-data-backup clean [-q]

Description

The clean command checks if the backups on all vCICs are consistent and synchronized, and removes any temporary files remaining from aborted backups.

Optional Arguments

Parameter	Description
`-q`	If used, `cic-data-backup clean` resolves inconsistencies without prompting the user.

Example

cic-data-backup clean

4.3 create

Syntax

cic-data-backup create [<name>]

Description

The create command creates a CIC domain data backup.

Optional Arguments

Parameter	Description
`<name>`	The name of the backup. This value must be a string, and must not contain space. If not specified, the default `cic_data_backup` name applies.

Example

cic-data-backup create

4.4 help

Syntax

cic-data-backup help

Description

The help command lists the available parameters of the cic-data-backup command.

Example

cic-data-backup help

4.5 list

Syntax

cic-data-backup list

Description

The list command prints a list of all CIC domain data backups.

Example

cic-data-backup list

4.6 show

Syntax

cic-data-backup show <backup_ID_or_name>

Description

The show command shows the contents of the specified backup directory.

Positional Arguments

Parameter	Description
`<backup_ID_or_name>`	The name or ID of the backup folder.

Example

cic-data-backup show 56e5be90b0e4288105b22906491f056a

4.7 showHistory

Syntax

cic-data-backup showHistory

Description

The showHistory command prints a list of all backups that have been initiated since deployment.

Example

cic-data-backup showHistory

4.8 showLog

Syntax

cic-data-backup showLog <n>

Description

The showLog command prints the last n lines of the CIC domain data backup log file.

Positional Arguments

Parameter	Description
`<n>`	`n` is an integer indicating how many lines of the log file are to be printed.

Example

cic-data-backup showLog 5

4.9 showPolicy

Syntax

cic-data-backup showPolicy

Description

The showPolicy command prints the current retention policy configured on all vCICs.

Example

cic-data-backup showPolicy

5 pre-cic-data-restore

Syntax

pre-cic-data-restore

Description

The pre-cic-data-restore command sets all vCICs to maintenance mode, as part of the restore procedure described in CIC Domain Data Restore.

Example

pre-cic-data-restore

6 cic-data-restore

Syntax

cic-data-restore -f <file> -m <component_name>

Description

The cic-data-restore command restores CIC domain data from a backup file, as part of the restore procedure described in CIC Domain Data Restore.

Mandatory Arguments

Parameter	Description
`-f <file>`	The path of the backup file to be used.
`-m <component_name>`	The component to restore. The available values are: `mysql`, `ldap`, `sdn`, `config`, or `all`.

Example

cic-data-restore -f /var/lib/glance/backup/cic-data-backup.0/cic-data-backup_06032017_071500.tgz –m all

cic-data-restore -f /var/lib/glance/backup/cic-data-backup.0/⇒
cic-data-backup_06032017_071500.tgz –m all

7 expandcee

This section describes the expandcee command used for region expansion and server repair, used in the Region Expansion and Server Replacement procedures.

Syntax

expandcee [--repair]

Description

The expandcee command, if used without any option, installs and verifies any new servers present in the config.yaml file on the Fuel node. See Region Expansion.

If the expandcee --repair is used to repair a compute host, or a vCIC and its host.

This command can be issued on vFuel.

Optional Arguments

Parameter	Description
`--repair`	If using `expandcee` with this option, it repairs a failed compute host or a vCIC and its host.⁽¹⁾

(1) With this command, a vCIC can only be repaired together with the compute host containing the vCIC.

8 healthcheck.py

This section describes the healthcheck.py command used in CEE to perform the health check procedure described in Health Check Procedure.

This command can be issued on vFuel.

Syntax

healthcheck.py [--node <node_name>]
               [--service <service_name>] [--no-color]
               [--smoke] [-s] [--help] [-h]

Description

The healthcheck.py command performs the CEE health check procedure. For more information, refer to Health Check Procedure.

Optional Arguments

Parameter	Description
`-h` `--help`	Displays information about the `healthcheck.py` command.
`--node <node_name>`	If this option is used, the health check displays the verdicts for the services running on a specific node.
`--service <service_name>`	If this option is used, the health check displays the verdicts for the respective service status in the cluster.
`--no-color`	Sets the health check to use non-colored terminal output.
`-s` `--smoke`	Executes a quick set of checks. This option is intended for internal testing purposes.

Example

healthcheck.py --service nova

9 neutron

This section describes the CEE-specific Neutron commands.

9.1 device

Note:: The commands in this section only apply to deployments using managed Extreme switches

This section describes the neutron device commands used in CEE to manage switches.

Syntax

neutron device-create
        device-delete
        device-list
        device-reboot
        device-recover
        device-show
        device-update

These commands can be issued by an admin user.

9.1.1 device-create

Syntax

neutron device-create [--tenant-id <tenant_ID>]
                      [--name <name>] [--model <model>]
                      [--firmware-version <firmware>]
                      [--mgmt-ip-address <ip_address>]
                      [--mgmt-port <port>] [--user-name <username>]
                      [--password <password>] [--vr-total <vr_number>]
                      [-h]

neutron device-create [--tenant-id <tenant_ID>]
                      [--name <name>] [--model <model>]
                      [--firmware-version <firmware>]
                      [--mgmt-ip-address <ip_address>]
                      [--mgmt-port <port>] [--user-name <username>]
                      [--password <password>] ⇒
[--vr-total <vr_number>]
                      [-h]

Description

The device-create command creates a new device in the topology database.

Optional Arguments

Parameter	Description
`-h`	Displays information about the `device-create` command.
`--name <name>`	The name of the device
`--device-type <device_type>`	The type of the device, for example: `switch`, `router`, `hub`
`--vendor <vendor>`	The vendor of the device, for example: `extreme`, `ericsson`
`--model <model>`	The model of the device, for example: `BlackDiamond`
`--firmware-version`	The firmware version of the device
`--mgmt-ip-address⇒` `<ip_address>`	The IP address of the management port
`--mgmt-port <port>`	The port number of the management port. The value range is `0-255`.
`--user-name <user_name>`	The username used to log on to the device
`--password <password>`	The password used to log on to the device
`--vr-total <vr_total>`	Sets the total number of virtual routers. The value range is `0-255`.
`--admin-state-down`	Sets `admin state up` to `false`.
`--tenant-id <tenant_id>`	The ID of the owner tenant
`--request-format {json}`	Sets the format of the request. Deprecated: only `{json}` is supported.

Example

neutron device-create --name TOR1 --device_type TOR_SWITCH --vendor extreme ⇒
--management-ip-address "192.168.2.2" --user-name "extreme_user" ⇒
--password "extreme_password" --vr_total 63

9.1.2 device-delete

Syntax

neutron device-delete [-h] [--request-format {json}] <switch_id>

Description

The device-delete command removes a device from the topology database.

Positional Arguments

Parameter	Description
`<switch_id>`	The ID or name of the device to delete.

Optional Arguments

Parameter	Description
`-h`	Displays information about the `device-delete` command.
`--request-format {json}`	Sets the format of the request. Deprecated: only `{json}` is supported.

Example

neutron device-delete RegionOne_TRAFFIC_SWB_X770

9.1.3 device-list

Syntax

neutron device-list

Description

The device-list command lists the devices in the topology database.

Example

neutron device-list

9.1.4 device-recover

Syntax

neutron device-recover [-h] [--request-format {json}] <switch_id>

neutron device-recover [-h] [--request-format {json}]
                       <switch_id>

Description

The device-recover command starts the recovery process on the specified device.

Positional Arguments

Parameter	Description
`<switch_id>`	ID or name of device to recover.

Optional Arguments

Parameter	Description
`-h`	Displays information about the `device-recover` command.
`--request-format {json}`	Sets the format of the request. Deprecated: only `{json}` is supported.

Example

neutron device-recover RegionOne_TRAFFIC_SWB_X770

9.1.5 device-show

Syntax

neutron device-show [-h] [-f {json,shell,table,value,yaml}]
                    [-c <column>] [--max-width <integer>]
                    [--noindent] [--prefix <prefix>]
                    [--request-format {json}] [-D] [-F <field>]
                    <switch_id>

Description

The device-show command shows the properties of the specified device.

Positional Arguments

Parameter	Description
`<switch_id>`	ID or name of device to look up.

Optional Arguments

Parameter	Description
`-h`	Displays information about the `device-show` command.
`-f {json,shell,table,⇒` `value,yaml}`	Sets the output format.
`-c <column>`	Selects the column to display.
`--max-width <integer>`	Sets the maximum display width of the output.
`--noindent`	Disables the JSON indentation.
`--prefix <prefix>`	Only list items beginning with the specified prefix.
`--request-format {json}`	Sets the format of the request. Deprecated: only `{json}` is supported.
`-D`	Show detailed information.
`-F <field>`	Specifies the field(s) to be returned. This option can be repeated.

Example

neutron device-show RegionOne_TRAFFIC_SWB_X770

9.1.6 device-update

Syntax

neutron device-update [-h] [--request-format {json}] <switch_id> --status=<status>

neutron device-update [-h] [--request-format {json}]
                      <switch_id> --status=<status>

Description

The device-update command updates the given properties of the device.

Positional Arguments

Parameter	Description
`<switch_id>`	The ID or name of the device to update.

Optional Arguments

Parameter	Description
`-h`	Displays information about the `device-update` command.
`--request-format {json}`	Sets the format of the request. Deprecated: only `{json}` is supported.
`--status=<status>`	Updates the status of the switch to the given value. Example values are: `MAINTENANCE`, `UNSUPERVISED`

Example

neutron device-update⇒
RegionOne_TRAFFIC_SWB_X770 --status=MAINTENANCE

9.2 deviceport

Note:: The commands in this section only apply to deployments using managed Extreme switches

This section describes the neutron deviceport commands used in CEE to manage device ports.

Syntax

neutron deviceport-addlink
        deviceport-removelink
        deviceport-create
        deviceport-delete
        deviceport-list
        deviceport-show

These commands can be issued by an admin user.

9.2.1 deviceport-addlink

Syntax

neutron deviceport-addlink [-h] [--request-format {json}]
                           [--port-type <port_type>]
                           <deviceport_id> <interface>

Description

The deviceport-create command creates a connection between a CEE host and a device port.

Positional Arguments

Parameter	Description
`<deviceport_id>`	The ID or name of the device port.
`<interface>`	The interface must be either a device port or a server.

Optional Arguments

Parameter	Description
`-h` `--help`	Displays information about the `deviceport-create`command.
`--request-format {json}`	Sets the format of the request. Deprecated: only `{json}` is supported.
`--port-type <port_type>`

Example

neutron deviceport-addlink TOR1_port1 controller

9.2.2 deviceport-removelink

Syntax

neutron deviceport-removelink [-h] [--request-format {json}] <deviceport_id>

neutron deviceport-removelink [-h] [--request-format {json}]
                            <deviceport_id>

Description

The deviceport-removelink command removes a connection between a CEE host and a device port.

Positional Arguments

Parameter	Description
`<deviceport_id>`	The ID or name of the device port.

Optional Arguments

Parameter	Description
`-h`	Displays information about the `deviceport-removelink` command.
`--request-format {json}`	Sets the format of the request. Deprecated: only `{json}` is supported.

Example

neutron deviceport-removelink TOR1_port1

9.2.3 deviceport-create

Syntax

neutron deviceport-create [-h] [-f {json,shell,table,value,yaml}]
                          [-c <column>] [--max-width <integer>]
                          [--noindent] [--prefix <prefix>]
                          [--request-format {json}]
                          [--tenant-id <tenant_id>]
                          [--name <name>]
                          [--physical-network <physical network>]
                          [--slot-id <slot_id>]
                          [--port-id <port_id>]
                          [--is-master <master>]
                          [--admin-state-down] <device_id>

Description

The deviceport-create command creates a device port on the specified device.

Positional Arguments

Parameter	Description
`<device_id>`	The ID or name of the device where the device port belongs.

Optional Arguments

Parameter	Description
`-h`	Displays information about the `deviceport-create` command.
`-f {json,shell,table,⇒` `value,yaml}`	Sets the output format.
`-c <column>`	Selects the column to display.
`--max-width <integer>`	Sets the maximum display width of the output.
`--noindent`	Disables the JSON indentation.
`--prefix <prefix>`	Only list items beginning with the specified prefix.
`--request-format {json}`	Sets the format of the request. Deprecated: only `{json}` is supported.
`--tenant-id <tenant_id>`	The ID of the owner tenant
`--name <name>`	The name of the device
`--physical-network⇒ <physical_network>`	The name of the physical network
`--slot-id <slot-id>`	The slot ID of the device port
`--port-id <port_id>`	The ID of the port (integer value)
`--is-master <master>`	Configures whether the port is a master port in a LAG.
`--admin-state-down`	Sets `admin state up` to `false`.

Example

neutron deviceport-create TOR1 --name TOR1_port1 --port-id 1 ⇒
--is-master true --physical-network default

9.2.4 deviceport-delete

Syntax

neutron deviceport-delete [-h] [--request-format {json}] <deviceport_id>]

neutron deviceport-delete [-h] [--request-format {json}]
                           <deviceport_id>]

Description

The deviceport-delete command removes a device port from the topology database.

Positional Arguments

Parameter	Description
`<deviceport_id>`	The ID or name of the device port.

Optional Arguments

Parameter	Description
`-h`	Displays information about the `deviceport-delete` command.
`--request-format {json}`	Sets the format of the request. Deprecated: only `{json}` is supported.

Example

neutron deviceport-delete TOR1

9.2.5 deviceport-list

Syntax

neutron deviceport-list

Description

The deviceport-list command lists the device ports created on the specified device.

Example

neutron deviceport-list

9.2.6 deviceport-show

Syntax

neutron deviceport-show [-h] [-f {json,shell,table,value,yaml}]
                        [-c <column>] [--max-width <integer>]
                        [--noindent] [--prefix <prefix>]
                        [--request-format {json}] [-D] [-F <field>]
                        <deviceport_id>

Description

The deviceport-show command shows the properties of the specified device port.

Positional Arguments

Parameter	Description
`<deviceport_id>`	The ID or name of the device port.

Optional Arguments

Parameter	Description
`-h`	Displays information about the `deviceport-show` command.
`-f {json,shell,table,⇒` `value,yaml}`	Sets the output format.
`-c <column>`	Selects the column to display.
`--max-width <integer>`	Sets the maximum display width of the output.
`--noindent`	Disables the JSON indentation.
`--prefix <prefix>`	Only list items beginning with the specified prefix.
`--request-format {json}`	Sets the format of the request. Deprecated: only `{json}` is supported.
`-D`	Show detailed information.
`-F <field>`	Specifies the field(s) to be returned. This option can be repeated.

Example

neutron deviceport-show TOR1

9.2.7 deviceport-update

Syntax

neutron deviceport-show [-h] [--request-format {json}] <deviceport_id>

neutron deviceport-show [-h]
                        [--request-format {json}]
                        <deviceport_id>

Description

The deviceport-show command shows the properties of the specified device port.

Positional Arguments

Parameter	Description
`<deviceport_id>`	The ID or name of the device port.

Optional Arguments

Parameter	Description
`-h`	Displays information about the `deviceport-show` command.
`--request-format {json}`	Sets the format of the request. Deprecated: only `{json}` is supported.

Example

neutron deviceport-show TOR1

9.3 host

Note:: The commands in this section only apply to deployments using managed Extreme switches

This section describes the neutron host commands used in CEE to manage hosts.

Syntax

neutron host-create
        host-delete
        host-list
        host-show
        host-update

These commands can be issued by an admin user.

9.3.1 host-create

Syntax

neutron host-create --name <hostname>] [-h]
                    [-f {json,shell,table,value,yaml}]
                    [-c <column>] [--max-width <integer>]
                    [--noindent] [--prefix <prefix>]
                    [--request-format {json}]
                    [--tenant-id <tenant_id>]
                    [--name <name>] [--network-host]
                    [--compute-host] [--admin-state-down]

Description

The host-create command creates a host in the topology database with specified role(s). Roles can be assigned to a host in any combination. By default, no roles are assigned to the host.

Mandatory Arguments

Parameter	Description
`--name <hostname>`	The name of the host. The host name must be the same as in the `nova hypervisor-list` command to ensure functioning VM connection.

Optional Arguments

Parameter	Description
`-h`	Displays information about the `host-create` command.
`--request-format {json}`	Sets the format of the request. Deprecated: only `{json}` is supported.
`--tenant-id <tenant_id>`	The ID of the owner tenant
`--network-host`	Creates a network host where networking services (for example, DHCP) are running.
`--compute-host`	Creates a compute host where VMs can be deployed.
`--admin-state-down`	Sets `admin state up` to `false`.

Example

neutron host-create --name controller --network-host --computehost

9.3.2 host-delete

Syntax

neutron host-delete [-h] [--request-format {json}] <hostname>

neutron host-delete [-h] [--request-format {json}]
                         <hostname>

Description

The host-delete command removes a host from the Neutron topology database.

Positional Arguments

Parameter	Description
`<hostname>`	ID or name of the host to delete.

Optional Arguments

Parameter	Description
`-h` `--help`	Displays information about the `host-delete` command.

Example

neutron host-delete compute

9.3.3 host-list

Syntax

neutron host-list

Description

The host-list command outputs a list of the registered hosts in the topology database.

Example

neutron host-list

9.3.4 host-show

Syntax

neutron host-show [-h] [-f {json,shell,table,value,yaml}]
                  [-c <column>] [--max-width <integer>]
                  [--noindent] [--prefix <prefix>]
                  [--request-format {json}] [-D]
                  [-F <field>] <hostname>

Description

The host-show command shows the properties of the specified host.

Positional Arguments

Parameter	Description
`<hostname>`	ID or name of host to look up.

Optional Arguments

Parameter	Description
`-h`	Displays information about the `host-show` command.
`-f {json,shell,table,⇒` `value,yaml}`	Sets the output format.
`-c <column>`	Selects the column to display.
`--max-width <integer>`	Sets the maximum display width of the output.
`--noindent`	Disables the JSON indentation.
`--prefix <prefix>`	Only list items beginning with the specified prefix.
`--request-format {json}`	Sets the format of the request. Deprecated: only `{json}` is supported.
`-D`	Show detailed information.
`-F <field>`	Specifies the field(s) to be returned. This option can be repeated.

Example

neutron host-show compute

9.3.5 host-update

Syntax

neutron host-update [-h] [--request-format {json}] <hostname>

neutron host-update [-h]
                    [--request-format {json}] <hostname>

Description

The host-update command updates the given properties of the device.

Positional Arguments

Parameter	Description
`<hostname>`	ID or name of host to update.

Optional Arguments

Parameter	Description
`-h`	Displays information about the `host-update` command.

Example

neutron host-update compute

The standard OpenStack neutron port-create command is extended with the trunkport option, used to create trunkports and subports. For information on trunkports and subports, refer to the hardware-specific OpenStack Networking API in CEE document.

Note:: Once a trunkport or subport is created, the standard OpenStack commands apply to them, as to regular ports, refer to the Command-Line Interface Reference. The attributes set by the trunkport options below cannot be updated, and show up in port-list and port-show outputs.

Syntax

neutron port-create <network_id> [--name <name>]
                    [--trunkport:type <type>]
                    [--trunkport:vid <vlan_id>]
                    [--trunkport:parent_id <trunkport_id>]

Description

The neutron port-create command can be used to create trunkports and subports.

Trunkports can be created using the --trunkport:type trunk option.

Subports can be created using the --trunkport:type subport option, followed by --trunkport:vid <vlan_id> and --trunkport:parent_id <trunkport_id>.

Positional Arguments

Parameter	Description
`<network_id>`	ID or name of the network this port belongs to.

Optional Arguments

Parameter	Description
`--name <name>`	Name of this port.
`--trunkport:type <type>`	Type of the port. The value must be `trunk` for trunkport or `subport`. for subport.
`--trunkport:vid <vlan_id>`	Subport only: The segmentation ID used to access the given subport from the trunkport.
`--trunkport:parent_id <trunkport_id>`	Subport only: The ID of the trunkport where the subport belongs.

Example

Creating trunkport:

neutron port-create net0 --name trunkport0 --trunkport:type trunk

Creating subport:

neutron port-create net1 --name subport1 --trunkport:type subport --trunkport:vid 101 --trunkport:parent_id 6433edfc-d731-43a6-a8ee-fb5218777506

neutron port-create net1 --name subport1 --trunkport:type subport ⇒
--trunkport:vid 101 --trunkport:parent_id 6433edfc-d731-43a6-a8ee-fb5218777506

9.5 staticroute

Note:: The commands in this section only apply to deployments using managed Extreme switches

This section describes the neutron staticroute commands used in CEE to manage static routes.

Syntax

neutron staticroute-create
        staticroute-delete
        staticroute-list
        staticroute-show

These commands can be issued by a tenant user. staticroute-delete can also be issued by an admin user.

9.5.1 staticroute-create

Syntax

neutron staticroute-create [-h]
                           [-f {json,shell,table,value,yaml}]
                           [-c <column>] [--max-width <integer>]
                           [--noindent] [--prefix <prefix>]
                           [--request-format {json}]
                           [--tenant-id <tenant_id>]
                           [--metric <metric>] <router_id>
                           <destination> <nexthop>

Description

The staticroute-create command creates a static route on the given router with the specified destination and nexthop.

Positional Arguments

Parameter	Description
`<router_id>`	ID or name of the router.
`<destination>`	The IP address of the routing destination.
`<nexthop>`	The next hop IP address.

Optional Arguments

Parameter	Description
`-h`	Displays information about the `staticroute-create` command.
`-f {json,shell,table,⇒` `value,yaml}`	Sets the output format.
`-c <column>`	Selects the column to display.
`--max-width <integer>`	Sets the maximum display width of the output.
`--noindent`	Disables the JSON indentation.
`--prefix <prefix>`	Only list items beginning with the specified prefix.
`--request-format {json}`	Sets the format of the request. Deprecated: only `{json}` is supported.
`--tenant-id <tenant_id>`	The ID of the owner tenant
`--metric <metric>`	The ID of the metric

Example

neutron staticroute-create test_router 1.0.0.0/24 10.0.0.5

9.5.2 staticroute-delete

Syntax

neutron staticroute-delete [-h] [--request-format {json}] <staticroute_id>

neutron staticroute-delete [-h]
                           [--request-format {json}]
                           <staticroute_id>

Description

The staticroute-delete command removes the specified static route.

Positional Arguments

Parameter	Description
`<staticroute_id>`	The ID of the static route to delete.

Optional Arguments

Parameter	Description
`-h`	Displays information about the `staticroute-delete` command.
`--request-format {json}`	Sets the format of the request. Deprecated: only `{json}` is supported.

Example

neutron staticroute-delete test_router

9.5.3 staticroute-list

Syntax

neutron staticroute-list

Description

The staticroute-list command lists all defined static routes.

Example

neutron staticroute-list

9.5.4 staticroute-show

Syntax

neutron staticroute-show [-h]
                         [-f {json,shell,table,value,yaml}]
                         [-c <column>] [--max-width <integer>]
                         [--noindent] [--prefix <prefix>]
                         [--request-format {json}] [-D]
                         [-F <field>] <staticroute_id>

Description

The staticroute-show command shows the properties of the given static route.

Positional Arguments

Parameter	Description
`<staticroute_id>`	ID of the static route to look up.

Optional Arguments

Parameter	Description
`-h`	Displays information about the `staticroute-show` command.
`-f {json,shell,table,⇒` `value,yaml}`	Sets the output format.
`-c <column>`	Selects the column to display.
`--max-width <integer>`	Sets the maximum display width of the output.
`--noindent`	Disables the JSON indentation.
`--prefix <prefix>`	Only list items beginning with the specified prefix.
`--request-format {json}`	Sets the format of the request. Deprecated: only `{json}` is supported.
`-D`	Show detailed information.
`-F <field>`	Specifies the field(s) to be returned. This option can be repeated.

Example

neutron staticroute-show test_router

10 nova

This section describes the CEE-specific nova commands. For information on the Compute API, refer to the OpenStack Compute API in CEEdocument.

10.1 forcemove

Syntax

nova forcemove <server> [--ignore-hints]
                       [--ignore-broken-dependencies]
                       [--block-migrate]
                       [--disk-over-commit]

Description

Forcefully migrates or evacuates the given instance, depending on whether the compute host where the VM is located is online. If the compute host is up, forcemove migrates the VM, otherwise it uses evacuation. For more information on this function, refer to the OpenStack Compute API in CEE.

Note:: Successful forcemove operations need to be verified on the target host, and confirmed with the command nova resize-confirm <server> or reverted with the nova resize-revert <server>

Positional Arguments

Parameter	Description
`<server>`	The name or ID of the VM

Optional Arguments

Parameter	Description
`--ignore-hints`	Ignore the persistent scheduling hints. The default value is `False`.
`--ignore-broken-dependencies`	Ignore broken dependencies in the persistent scheduling hints. The default value is `False`.
`--block-migrate`	Add in case of block migration. The default value is `False`.
`--disk-over-commit`	Allow overcommitment. The default value is `False`.

Example

nova forcemove vm1

10.2 redefine

Syntax

nova redefine [--password <password>] <server>

Description

nova redefine defines the properties of VMs on the compute host from the Nova database, if the libvirt XML or the file system image is missing. For more information on this function, refer to the OpenStack Compute API in CEE.

Positional Arguments

Parameter	Description
`<server>`	The name or ID of the VM

Optional Arguments

Parameter	Description
`--password <password>`	Sets the provided admin password on the redefined server.

Example

nova redefine vm1

11 watchmen-client

This section describes the command watchmen-client and its subcommands.

Syntax

watchmen-client [--os-username <OS_Username>]
                [--os-password <OS_Password>]
                [--os-tenant-name <OS_Tenant_Name>]
                [--os-auth-url <OS_Auth_URL>]
                active-alarm-list

watchmen-client [-h]
watchmen-client [--help]

Description

The watchmen-client command with subcommands is used for the following:

Fault management
- Fetching the active alarm list
- Fetching the alarm and alert history
- Adding an SNMP trap endpoint.
- Listing SNMP Trap Endpoints
- Removing an SNMP Trap Endpoint
Configuring SNMP

Optional Arguments

Parameter	Description
`-h`, `--help`	Displays information about the `watchmen-client` command
`--os-username`	Specifies the OS user name. It can be any user that has `watchmen` role.
`--os-password`	Specifies the OS password.
`--os-tenant-name`	Specifies the OS tenant name.
`--os-auth-url`	Specifies the OS authentication URL.

The --os-username, --os-password, --os-tenant-name, and --os-auth-url must be specified in the command each time they are required by a subcommand.

These commands can be issued from root.

Note:: Watchmen CLI also supports the OS_USERNAME, OS_PASSWORD, OS_TENANT_NAME, and OS_AUTH_URL OpenStack environment variables.

11.1 active-alarm-list

Syntax

watchmen-client active-alarm-list [-h] [-tz "<time-zone>"]
watchmen-client active-alarm-list [--help]
                                  [--time-zone
                                  "<time-zone>"]

Description

The active alarm list can be fetched by using the watchmen-client command with the active-alarm-list subcommand. The active alarm list is filtered by the ID of the tenant that executes the watchmen-client command. No filtering is applied if the command is executed by the admin tenant.

Optional Arguments

Parameter	Description
`-h`, `--help`	Displays information about the `active-alarm-list` subcommand
`-tz, --time-zone`	Displays events with specified time-zone. Default time-zone: UTC

Example

root@cic-2:~# watchmen-client --os-username admin --os-password admin --os-tenant-name ⇒
admin --os-auth-url http://192.168.2.31:5000/v2.0 active-alarm-list ⇒
--time-zone "Europe/Stockholm"

11.2 alarm-history

Syntax

watchmen-client alarm-history [-h] [-f <time>] [-t <time>]
                              [-s] [-o {asc,desc}]
                              [-e {alarm,alert}] [-tz "<time-zone>"]
watchmen-client alarm-history [--help] [--from <time>]
                              [--to <time>] [--sort-by]
                              [<field_name>]
                              [--sort-order {asc,desc}]
                              [--event-type {alarm,alert}]
                              [--time-zone "<time-zone>"]

, where:

<time> has the following format: YYYY-MM-DD[[[-hh]-mm]-ss]
The date and time values used in the --from and --to (-f and -t) sections of the command, define a half-open interval. The --from date and time is included in the interval. The --to date and time is excluded.

Description

The alarm and alert history can be fetched by using the watchmen-client command with the alarm-history subcommand.

The alarm and alert history is filtered by the ID of the tenant that executes the watchmen-client command. No filtering is applied if the command is executed by the admin tenant.

Optional Arguments

Parameter	Description
`-h`, `--help`	Displays information about the `alarm-history` subcommand
`-f`, `--from`	Defines the beginning of the time period of the request. This optional argument can be used separately or together with `<-t, --to>`. If none of them is given, the output shows the event history of the actual day.
`-t`, `--to`	Defines the end of the time period of the request. This optional argument can be used separately or together with `<-f, --from>`. If none of them is given, the output shows the event history of the actual day.
`-s`, `--sort-by`	Sort by a given column. Supported values: `active_severity`, `additional_info`, `additional_text`, `event_type`, `is_stateful`, `last_event_time`, `major_type`, `minor_type`, `probable_cause`, `sequence_no`, `source`, `specific_problem`. Default value: `last_event_time`.
`-o`, `--sort-order`	Sort order. Supported values: `asc` for ascending and `desc` for descending order.
`-e`, `--event-type`	Filters events, either for alarms or alerts. Supported values: `alarm` and `alert`
`-tz`, `--time-zone`	Displays events with specified time-zone. Default time-zone: UTC

Example

root@cic1:~# watchmen-client --os-username admin --os-password admin --os-tenant-name ⇒
 admin --os-auth-url http://192.168.2.25:5000/v2.0 alarm-history ⇒
--from 2016-01-25 --to 2016-02-01 --sort-by active_severity --sort-order desc ⇒
--event-type alert -tz "Europe/Stockholm"

11.3 snmp-trap-config-add

Syntax

watchmen-client snmp-trap-config-add [-h] -c <command_string> [-e]
watchmen-client snmp-trap-config-add [--help] --command <command_string> [--enable-append-info]

watchmen-client snmp-trap-config-add [-h]
                                      -c <command_string>
                                     [-e]
watchmen-client snmp-trap-config-add [--help] --command
                                     <command_string>                                     [--enable-append-info]

Description

An SNMP trap endpoint can be added by using the watchmen-client command with the snmp-trap-config-add subcommand.

The events sent to the configured SNMP trap endpoint are filtered by the ID of the tenant that executes the watchmen-client command. No filtering is applied if the command is executed by the admin tenant.

Required Arguments

Parameter	Description
`-c`, `--command`	SNMP trap command. For more information, refer to the Fault Management Configuration Guide

Optional Arguments

Parameter	Description
`-h`, `--help`	Displays information about the `alarm-history` subcommand
`-e`, `--enable-append-info`	Enable `SNMP Appendinfo Trap`

Example

root@cic1:~# watchmen-client --os-username admin --os-password admin --os-tenant-name admin ⇒
--os-auth-url http://192.168.2.25:5000/v2.0 snmp-trap-config-add ⇒
--command <SNMP_TRAP_COMMAND>

11.4 snmp-trap-config-list

Syntax

watchmen-client snmp-trap-config-list [-h]
watchmen-client snmp-trap-config-list [--help]

watchmen-client snmp-trap-config-list [-h]
watchmen-client snmp-trap-config-list [--help]

Description

The SNMP trap endpoints can be listed by using the watchmen-client command with the snmp-trap-config-list subcommand.

The SNMP trap endpoints are filtered by the ID of the tenant that executes the watchmen-client command. No filtering is applied if the command is executed by the admin tenant.

Optional Arguments

Parameter	Description
`-h`, `--help`	Displays information about the `snmp-trap-config-list` subcommand

Example

root@cic1:~# watchmen-client --os-username admin --os-password admin --os-tenant-name ⇒
admin --os-auth-url http://192.168.2.25:5000/v2.0 snmp-trap-config-list

11.5 snmp-trap-config-remove

Syntax

watchmen-client snmp-trap-config-remove [-h] -id <id_of_endpoint>
watchmen-client snmp-trap-config-remove [--help] --config-id <id_of_endpoint>

watchmen-client snmp-trap-config-remove [-h]
                                        -id <id_of_endpoint>
watchmen-client snmp-trap-config-remove [--help]
                                        --config-id
                                        <id_of_endpoint>

Description

An SNMP endpoint can be removed by using the watchmen-client command with the snmp-trap-config-remove subcommand.

The tenant executing the watchmen-client command can only remove those SNMP trap endpoints that were added by the same tenant. There is no such a restriction if the command is executed by the admin tenant.

Required Arguments

Parameter	Description
`-id`, `--config-id`	ID of the SNMP trap endpoint configuration to be removed

Optional Arguments

Parameter	Description
`-h`, `--help`	Displays information about the `snmp-trap-config-remove` subcommand

Example

root@cic1:~# watchmen-client --os-username admin --os-password admin --os-tenant-name admin ⇒
--os-auth-url http://192.168.2.25:5000/v2.0 snmp-trap-config-remove --config-id 16

Reference List


[1] CSC Application Command List, 2/190 77-AXD 101 08/6-V1
[2] Using the CLI, 1/190 80-AXD 101 08/6-V1

1 Introduction

1.1 Scope

1.2 Prerequisites

2 ACDC.py

3 ceescalein

4 cic-data-backup

4.1 changePolicy

4.2 clean

4.3 create

4.4 help

4.5 list

4.6 show

4.7 showHistory

4.8 showLog

4.9 showPolicy

5 pre-cic-data-restore

6 cic-data-restore

7 expandcee

8 healthcheck.py

9 neutron

9.1 device

9.1.1 device-create

9.1.2 device-delete

9.1.3 device-list

9.1.4 device-recover

9.1.5 device-show

9.1.6 device-update

9.2 deviceport

9.2.1 deviceport-addlink

9.2.2 deviceport-removelink

9.2.3 deviceport-create

9.2.4 deviceport-delete

9.2.5 deviceport-list

9.2.6 deviceport-show

9.2.7 deviceport-update

9.3 host

9.3.1 host-create

9.3.2 host-delete

9.3.3 host-list

9.3.4 host-show

9.3.5 host-update

9.4 port-create

9.5 staticroute

9.5.1 staticroute-create

9.5.2 staticroute-delete

9.5.3 staticroute-list

9.5.4 staticroute-show

10 nova

10.1 forcemove

10.2 redefine

11 watchmen-client

11.1 active-alarm-list

11.2 alarm-history

11.3 snmp-trap-config-add

11.4 snmp-trap-config-list

11.5 snmp-trap-config-remove

Reference List