Troubleshooting Commands

The following commands are available to troubleshoot the Cisco APIC-EM:

Root Commands

The following tables in this section describe the commands that you can issue on the Grapevine root to troubleshoot the Cisco APIC-EM.


Note

Enter the grape help command on Grapevine root to view a list of available commands. For more details on a specific command, type grape help command_from_list. For example, by entering grape help update , a new list of commands including history and upload appears. By further entering grape help update upload, specific command information and usage are then displayed.

The following table displays the read-only Grapevine root commands. Use these commands to display controller status, network configurations, service versions, and other key Cisco APIC-EM data to assist in troubleshooting procedures.

Table 1 Root Commands—Read Only

Command

Description

grape client display [client_id]

Displays the number of Grapevine clients that are currently running. This command also displays any clients that have faulted.

grape client status [client_id]

Displays the status of the Grapevine clients.

grapectl status

Displays the running services, their process identifiers (PID number), and uptime.

grape host status [host_id]

Displays all of the services on the host where it is issued.

grape instance display [service_type version]

Displays the Cisco APIC-EM services that are currently running.

grape instance status [service_type version]

Displays the status of the Cisco APIC-EM services.

grape network display

Displays the current external network configuration used by both Grapevine and the Cisco APIC-EM including:

  • IP addresses

  • Netmask

  • DNS servers

grape release display current

Displays the versions of the Cisco APIC-EM services that are currently running.

grape release display latest

Displays the latest available versions of the Cisco APIC-EM services.

grape root display [root_id]

Displays the Grapevine root properties, including:

  • hostname

  • interfaces

  • root ID

  • version

grape service display [service_type [version]]

Displays the Cisco APIC-EM services that are currently installed.

grape update history

Displays the Cisco APIC-EM update history and release version.

grape update_service display

Displays the current automatic services update configuration.

Additional fields in the command output indicate the last time the Cisco cloud was polled for updates (last_connect_time), as well as the Cisco cloud status(last_connect_status). For example, whether the Cisco cloud is reachable, unreachable, etc.

grape version

Displays the version of Grapevine that the Grapevine root is running.

sudo service grapevine status

Determines the status of the Grapevine root core services and whether all of the root core services are running. You will be prompted to enter your Grapevine password for this command.

The following table displays the read and write Grapevine root commands. Use these commands to perform delete, harvest, update, and capture actions on the controller.


Caution

You should exercise caution when issuing any of the read/write commands in this table.

Table 2 Root Commands-Read and Write

Command

Description

grape application disable application_name version

The grape application disable command disables an application installed on the Cisco APIC-EM.

Note   

The controller's GUI also provides the user with the ability to display, disable, or enable applications, as well as providing application definitions, versions, services provided, and other important information. See the Cisco Application Policy Infrastructure Controller Enterprise Module Deployment Guide for detailed information about this controller GUI feature. We recommend that you use the controller's GUI when working with the applications.

grape application display application_name version

The grape application display command displays applications currently installed on the Cisco APIC-EM. This command also displays detailed information about each application's properties and their values.

grape application enable application_name version

The grape application enable command enables an application that has been uploaded to the Cisco APIC-EM.

grape application remove application_name version

The grape application remove command removes an application.

grape application status application_name version

The grape application status command displays the status (enabled or disabled) of applications that have been uploaded onto the Cisco APIC-EM. This command also displays the time when enabled.

grape application upload application_bundle

The grape application upload command uploads an application bundle to the Cisco APIC-EM. After an upload, you can then enable the application using the grape application enable command.

grape backup delete

Deletes the existing controller backup file.

Note   

If you are unable to back up your current controller database, then you may want to delete it and restore an earlier smaller controller backup file.

grape host evacuate host_id

Harvests all of the services on the host where it is issued. If you issue this command on a host in a multi-host cluster, then the services are harvested and transferred to the remaining two hosts in the cluster. If you issue this command on a host in a single host configuration, all the services are harvested.

grape release update force

Updates a service for Cisco APIC-EM.

Use this command to force a service update.

grape config update tls_minimum

Use this command to set the TLS version to use for security for the controller. For information about supported TLS versions for the controller, see the Cisco Application Policy Infrastructure Controller Enterprise Module Deployment Guide.

rca

The rca command runs a root cause analysis script that creates a tar file that contains log files, configuration files, and the command output. After running this command and creating the tar file, you can send the file to Cisco support for assistance in resolving an issue.

For examples of using this command:

reset_grapevine

The reset_grapevine command returns the configuration settings back to values that you configured when running the configuration wizard for the first time. The configuration settings are saved to a .JSON file. This .JSON file is located at: $ /etc/grapevine/controller-config.json.

For examples of using this command:

reset_grapevine factory

The reset_grapevine factory command returns the configuration settings back to their factory defaults.

Caution   

This command shuts down both Cisco APIC-EM and the host (physical or virtual) where the controller resides. After running this command, you will need to access the host and reboot it.

For examples of using this command:

Client Commands

The following table describes commands that you can issue on the Grapevine client to troubleshoot the Cisco APIC-EM.

Table 3 Client Commands- Read Only

Command

Description

grape version

Displays the version of Grapevine that the Grapevine client is running.

grapectl status

Displays the running services, their process identifiers (PID number), and uptime.