Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
ON THIS PAGE
 

How to Use the Broadband Edge Event Collection and Visualization Utility Commands

SUMMARY After you have installed Broadband Edge Event Collection and Visualization, you can perform numerous administrative functions.

Access Broadband Edge Event Collection and Visualization Utility Commands

You can use the Broadband Edge Event Collection and Visualization utility script (ecav) to administer the application and to access the CLI that you use for configuring operations. The Broadband Edge Event Collection and Visualization installation places the utility script in /usr/local/bin.

The ecav utility script performs the tasks you need to do to manage Broadband Edge Event Collection and Visualization but masks the complexity of the kubectl command. This masking of the kubectl commands simplifies your administrative duties.

The ecav utility script uses the Kubernetes kubectl utility commands to do the following:

  • Create and delete objects.
  • Provide log access.
  • Conduct interactive sessions with pod containers.
  • Display the status of the Broadband Edge Event Collection and Visualization objects.

Table 1 lists the commands that you can invoke with the ecav utility script and describes the action that each command initiates.

Table 1: Broadband Edge Event Collection and Visualization Utility Script Commands

Command Name

Action

ecav clean [--release release-number][--docker][--dry-run][--uninstall]

Removes unused software releases and you can use it to uninstall the application.

This command offers the following options:

  • release release-number—The release numbers that you want to clean up (remove). The default is to remove unused releases. Specify the desired release numbers.

  • docker—Cleans the local docker cache.

  • dry-run—Lists the releases or containers that will be removed by the command.

  • uninstall—Uninstalls all software releases and removes BBE Edge Event Collection and Visualization from the system.

sudo -E ecav cluster-rename --context context-name --new-name new-name

Renames a cluster to which Broadband Edge Event Collection and Visualization is connected. Renaming the cluster does not impact the Broadband Edge Event Collection and Visualization service. To run this command, you need sudo root privileges.

This command offers the following options:

  • context context-name—The old Kubernetes cluster name to rename. Specify the name of the cluster.

  • new-name new-name—The new name of the Kubernetes cluster. Specify a new name.

ecav ip --context context-name [-o| --output json] [--detail]

Displays the IP addresses of every service with an external IP address.

This command offers the following options:

  • context context-name—The Kubernetes cluster name. Specify the name of the cluster.

  • output json—Allows you to request the output in JSON format.

  • detail—Displays detailed IP information.

sudo -E ecav link --version software-release --context context-name

Links a cluster to a specific software version. To run this command, you need sudo root privileges.

This command offers the following options:

  • version software-release—Specify the software release to link to the cluster specific repository.

  • context context-name—The Kubernetes cluster name to link to the software release. Specify the name of the cluster.

sudo -E ecav rollout --context context-name --version software-release]

Upgrade a Broadband Edge Event Collection and Visualization service. To run this command, you need sudo root privileges.

This command offers the following options:

  • context context-name—The Kubernetes cluster name on which to roll out the new software version. Specify the name of the cluster.

  • version software-release—The software release to roll out. Specify the software release number.

sudo -E ecav setup --context context-name [--default] [--update]

Sets up the Broadband Edge Event Collection and Visualization application as part of the installation process. To run this command, you need sudo root privileges.

This command offers the following options:

  • context context-name—The Kubernetes cluster name on which to run startup. Specify the name of the cluster.

  • default—Setup uses the default values that were enter when BBE Cloudsetup created cluster.

  • update—You will only be prompted for missing values during setup.

sudo -E ecav start --context context-name

Starts a specific Broadband Edge Event Collection and Visualization service. To run this command, you need sudo root privileges.

This command offers the following option:

  • context context-name—The Kubernetes cluster name on which to start a Broadband Edge Event Collection and Visualization. Specify the name of the cluster.

ecav status --context context-name [-o|--output json]

Displays the current status of the Broadband Edge Event Collection and Visualization services.

This command offers the following options:

  • context context name—The Kubernetes cluster name. Specify the name of the cluster.

  • output—Allows you to request the output in JSON format.

sudo -E ecav stop --context context-name -now

Stop all Broadband Edge Event Collection and Visualization services. To run this command, you need sudo root privileges.

This command offers the following option:

  • context context-name—The Kubernetes cluster name on which to stop Broadband Edge Event Collection and Visualization. Specify the name of the cluster.

  • now—If this optional command is not entered, stop will begin after a two minute period.

sudo -E ecav unlink --context context-name

Unlink components associated with the cluster. To run this command, you need sudo root privileges.

This command offers the following options:

  • context context-name—The Kubernetes cluster name to uninstall. Specify the name of the cluster.

ecav version [--context context-name] [-o|--output json] [--detail]

Displays the version of the following:

  • Every running microservice in the Broadband Edge Event Collection and Visualization instance.

  • The Broadband Edge Event Collection and Visualization utility.

  • All available Broadband Edge Event Collection and Visualization software releases on the system.

This command offers the following options:

  • context context-name—The Kubernetes cluster name. Specify the name of the cluster.

  • output—Allows you to request the output in JSON format.

  • detail—Displays all available software versions.

Use the following general syntax to issue a command:

  • For a short option:

  • For a long option:

To display a list of available commands with a brief description, use either the h or help option:

To display the options for a specific command:

Start Broadband Edge Event Collection and Visualization Services

Use the ecav utility script to start all BBE Event Collection and Visualization services.

  • Execute this command to start all BBE Event Collection and Visualization services:

    Note:

    We do not recommend that you stop the BBE Event Collection and Visualization services.

Check the Status of the Broadband Edge Event Collection and Visualization Service

Use the ecav status utility script to check the status of the BBE Event Collection and Visualization service. The status can show whether or not the service is running.

To check detailed information about the service, run the following command:

For example:

Uninstall and Remove Broadband Edge Event Collection and Visualization

Use the ecav utility script to uninstall the BBE Event Collection and Visualization configuration. The clean command uninstalls and removes all BBE Event Collection and Visualization versions from your system.

To uninstall BBE Event Collection and Visualization:

  1. On the jump host where you installed BBE Event Collection and Visualization, run the stop command.
  2. Run the unlink command.
  3. Run the clean command.