To enable the Cisco Business Dashboard Probe operation on device, use the cbd probe enable command in Global Configuration mode. To disable the Cisco Business Dashboard Probe operation, use the no form of this command.

Syntax

cbd probe enable

no cbd probe enable

Default Configuration

Cisco Business Dashboard Probe is disabled.

Command Mode

Global Configuration mode

User Guidelines

Use the command to enable the Cisco Business Dashboard Probe on the device.

Example

The following example enables the Cisco Business Dashboard Probe on the device:

switchxxxxxx(config)# cbd probe enable
This operation may take a few seconds....

To configure the details of the Cisco Business Dashboard, use the cbd address command in Global Configuration mode. To remove the details of the Cisco Business Dashboard, use the no form of this command.

Syntax

cbd address {ip-address | hostname} [port port]

no cbd address

Parameters

• address ip-address—Specifies the Cisco Business Dashboard IP address. This can be an IPv4 address.

• address hostname — Specifies the Cisco Business Dashboard as a hostname (Range: 1–158 characters. Maximum label size of each part of the host name: 63).

• port — Specifies the TCP port used to connect to Cisco Business Dashboard. (Range: 1-65535)

Default Configuration

No address is configured. CBD port default is 443.

Command Mode

Global Configuration mode

User Guidelines

Use the cbd address command to configure the Cisco Business Dashboard IP address and the TCP port to use to connect to the Cisco Business Dashboard. The cbd connection enable configuration must be removed prior to making changes to this parameter.

Examples

The following example configures the IPv4 address of the Cisco Business Dashboard to 1.1.1.1 and sets the TCP port to 8443.

switchxxxxxx(config)# cbd address 1.1.1.1 port 8443

In the following example configuration of the Cisco Business Dashboard IPv4 address fails because connection to Dashboard is enabled.

switchxxxxxx(config)# cbd address 1.1.1.1
Command failed!
Please disable connection to Cisco Business Dashboard before configuring this command, using command "no cbd connection enable". Only after configuring all Dashboard settings (Dashboard address, Key parameters, Organization and Network name) re-enable connection (command "cbd connection enable") to allow Probe connection to Cisco Business Dashboard

To configure the organization name of the Cisco Business Dashboard, use the cbd organization name command in Global Configuration mode. To remove Cisco Business Dashboard organization name configuration, use the no form of this command.

Syntax

cbd organization name organization-name

no cbd organization name

Parameters

organization name organization-name—Specifies the Organization name of the Cisco Business Dashboard Probe running on the device. Parameter can be specified as an alphanumeric string, including symbols and white-spaces (Range: 1–64).

Default Configuration

CBD Organization Name is not defined.

Command Mode

Global Configuration mode

User Guidelines

Use the cbd organization name command to configure the Cisco Business Dashboard organization name.The cbd connection enable configuration must be removed prior to making changes to this parameter.

Example

The following example configures the organization name of the Cisco Business Dashboard:

switchxxxxxx(config)# cbd organization name "my organization"

To configure the network name of the Cisco Business Dashboard, use the cbd network name command in Global Configuration mode. To remove Cisco Business Dashboard network name configuration, use the no form of this command.

Syntax

cbd network name network-name

no cbd network name

Parameters

network name network-name—Specifies the site name of the Cisco Business Dashboard Probe running on the device. Network Name can be specified as an alphanumeric string, including symbols and white-spaces (Range: 1–64).

Default Configuration

CBD Network Name is not defined.

Command Mode

Global Configuration mode

User Guidelines

Use the cbd network name command to configure the Cisco Business Dashboard network name. The cbd connection enable configuration must be removed prior to making changes to this parameter.

Example

The following example configures the network name of the Cisco Business Dashboard.

switchxxxxxx(config)# cbd network name "my network"

To configure the key ID and secret of the Cisco Business Dashboard, use the cbd key command in Global Configuration mode. To remove Cisco Business Dashboard key ID and secret configuration, use the no form of this command.

Syntax

cbd key id id-string secret secret-string

encrypted cbd key id id-string secret encrypted-secret-string

no cbd key

Parameters

• id id-string—Specifies the key ID to use for initial authentication between the Cisco Business Dashboard Probe running on the device and the Cisco Business Dashboard (A string of 24 hexadecimal digits).

• secret secret-string— Specifies the secret to use for authentication, can be specified as an alphanumeric string without white-spaces. The key can be up to 160 characters.

• secret encrypted-secret-string — Same as the secret-string parameter, but the secret is in encrypted form.

Default Configuration

CBD key ID and secret are not defined.

Command Mode

Global Configuration mode

User Guidelines

Use the cbd key command to configure the Cisco Business Dashboard key ID and secret. The cbd connection enable configuration must be removed prior to making changes to this parameter.

Example

The following example configures the key ID and secret of the Cisco Business Dashboard used for initial authentication:

switchxxxxxx(config)# cbd key id 5cecde9f21bb450005fb790b secret secretExample123

To configure the probe to connect with Cisco Business Dashboard, use the cbd connection enable command in Global Configuration mode. To disable probe connection to the Cisco Business Dashboard, use the no form of this command.

Syntax

cbd connection enable

no cbd connection enable

Default Configuration

Probe is not enabled for connection to Cisco Business Dashboard.

Command Mode

Global Configuration mode

User Guidelines

Use the cbd connection enable command to enable the probe to connect to the Cisco Business Dashboard. The configuration of this command will trigger the Cisco Business Dashboard Probe to connect to the Cisco Business Dashboard if the CBD Probe is enabled.

The cbd organization name, cbd network name, cbd address and cbd key settings must be configured for the cbd connection enable command to succeed. Use the no cbd connection enable to disconnect the Probe from the Cisco Business Dashboard​ and to allow the user to change the Cisco Business Dashboard​ settings mentioned above.

Examples

The following example enables the probe to connect to the Cisco Business Dashboard:

switchxxxxxx(config)# cbd connection enable

In the following example the command fails because some of the Dashboard settings needed for connection were not configured:

switchxxxxxx(config)# cbd connection enable
Command failed. Please make sure all of the following dashboard parameters are configured: dashboard address, organization name, network name and key;

To reset Cisco Business Dashboard Probe connection to the Cisco Business Dashboard​ use the cbd reset command in Privileged EXEC mode.

Syntax

cbd reset

Command Mode

Privileged EXEC mode

User Guidelines

Use the cbd reset command to reset the connection to the Cisco Business Dashboard. Applying the command will disconnect current connection with Dashboard, flush CBD probe cached data and then attempt to reconnect to the Cisco Business Dashboard.

The command will be executed only if the Probe Agent is enabled (command cbd probe enable) and connection to Cisco Business Dashboard is also enabled (command cbd connection enable).

Examples

The following example executes an attempt to reconnect using the configured key ID and secret:

switchxxxxxx# cbd reset

In the following example the reset command fails because Probe connection to Network Cisco Business Dashboard is not enabled:

switchxxxxxx# cbd reset
Operation failed because Probe connection to Cisco Business Dashboard is not enabled.
Please enable conntection to Cisco Business Dashboard using command "cbd connection enable".

In the following example the reset command fails because Probe agent is not enabled on device:

switchxxxxxx# cbd reset
Operation failed because Probe is not enabled
Please enable Probe using command "cbd probe enable".

To clear the Cisco Business Dashboard Probe database use the clear cbd probe database command in Privileged EXEC mode.

Syntax

clear cbd probe database

Command Mode

Privileged EXEC mode

User Guidelines

Use the clear cbd probe database to clear the Cisco Business Dashboard Probe database.

The command will be executed only if the Cisco Business Dashboard Probe Agent is disabled.

Examples

The following example clears the Cisco Business Dashboard Probe Database:

switchxxxxxx# clear cbd probe database

In the following example, the clear command fails because the Cisco Business Dashboard Probe is enabled on the switch:

switchxxxxxx# clear cbd probe database
Operation failed because Cisco Business Dashboard Probe is enabled on the switch.
Please disable Probe on switch using command "no cbd probe enable".

To display information about Cisco Business Dashboard Probe Configuration and status, use the show cbd command in Privileged EXEC mode.

Syntax

show cbd

Command Mode

Privileged EXEC mode

User Guidelines

Use the show cbd command, to display information about the Cisco Business Dashboard Probe running on the device.

Example

The following example shows the output from the show cbd command:

switchxxxxxx# show cbd
Network Probe is enabled
Operational status: Active
Probe version: 1.1.2.20181019
Dashboard address: 1.1.1.1
Dashboard port: 443
Key ID: MyKey
Key Secret (encrypted): 8nPzy2hzuba9pG3iiC/q0451RynUn7kq94L9WORFrRM=
Organization name: ABC Company
Network name: my network
Dashboard status: connected

The following table describes the different Cisco Business Dashboard Probe setting and behavior and the relevant Administrative & Operational state display.