The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
A device is a Cisco IOS device that supports Cisco IOx. You can install Cisco IOx apps on these devices only.
The Cisco Fog Director Device pages provide information about devices, and provide access to features for monitoring and troubleshooting devices, and for administering apps on devices.
To access the Devices pages, log in to Cisco Fog Director as described in the “Accessing Cisco Fog Director” section, and then click the DEVICES tab. The Devices View page displays.
This chapter includes these sections:
The Devices View page, which displays when you choose the DEVICES tab in Cisco Fog Manager, provides general information about devices that have been added or uploaded to Cisco Fog Manager.
This page includes the items that Table 5-1 describes.
Number of devices with which Cisco Fog Director successfully interacted over the past month. The chart can include sections for day, week, month, and never. Hover your mouse pointer over a section of the cart to see the percentage of devices that correspond to that section. |
|
Number of devices with which Cisco Fog Director can communicate. Hover your mouse pointer over a section of the cart to see the percentage of devices that correspond to that section. |
|
Includes the following charts, which provide information about resources that IOx apps consumed on devices during the past 24 hours. Hover your mouse pointer over any circle in a chart to see the host name of the device for which that circle provides information. Double-click any circle in a chart to display detailed information about the device for which that circle provides information, as described in the “Viewing Detailed Information about a Device” section .
|
|
Displays the Adds New Device window, which you use to add a device to Cisco Fog Director. See the “Adding Devices” section. |
|
Lets you add devices to Cisco Fog Director by importing a CSV file in which information for the devices is defined. See the “Importing Devices” section. |
|
Provides information about each device that has been added to Cisco Fog Director. This table includes the following:
To see additional information about a device or access various functions for a device, click the Expand icon to the left of the device host name in the Device table. The following row in this table describes the items that appear. |
|
The following items appear when you click the Expand icon to the left of the device host name in the Device table:
– Downtime - today—Amount of time during the past 24 hours that the app was in Stopped state. – CPU - mean %age today—Average (mean) percentage of CPU resources that the app used on the device during the past 24 hours. – Memory - mean Kb today—Average (mean) memory (RAM) in KB, that the app consumed on the device during the past 24 hours. – Action— Stop App button , Start App button , Remove App button , depending on the state of the app. See the “Starting or Stopping an App on a Device” section or the “Removing an App from a Device” section. |
To view detailed information about a device, take any of these actions:
The Device Details page displays. This page includes information and features that apply to the app, as the following sections describe:
The Device Details area on the Device Details page provides detailed information about a device, and includes the items that Table 5-1 describes.
Amount of time that the device has been operating since it last started. |
|
How long ago Cisco Fog Director last communicated with the device, or a brief explanation of why the last attempt to communicate with the device was unsuccessful. |
|
Name of the person who is responsible for the device or the app. |
|
Displays the following information:
|
|
Includes the following (see “Managing Cartridges,” for more information about cartridges):
|
|
Displays the following information. For related information, see the “Managing Outstanding and Expired Actions for Apps” section.
– Check box—Check the check box for each app for which you want to cancel additional retries of the corresponding action on the device. You can click the check box in the title row of the table to quickly check all boxes in the table. – App—Name of the app to which the outstanding action relates. – Action—Type of the outstanding action ( Install , Edit , Upgrade , or Uninstall ). – Next Attempt at—Date and time that Cisco Fog Director will next attempt to perform the action on the device, according to the action plan that is in effect for this action. – Pending Attempts—Maximum number of additional times that Cisco Fog Director will attempt to perform the action on the device, according to the action plan that is in effect for this action. |
|
Opens the Cisco IOx Local Manager application in a new browser tab or window. This application is installed on a device as part of the installation of the Cisco IOx framework on that device. It provides a web-based user interface that you can use to manage, administer, monitor, and troubleshoot apps on the host system, and to perform a variety of related activities. For detailed information about this application, see Cisco IOx Local Manager Reference Guide . |
|
Turns Cisco IOx debug log collection on or off for the device. See the “Obtaining Device Logs” section. |
|
Click to display log information that is generated by the device. If the Collect Debug Logs option is set to Yes on this Device Details page, the device log also includes debug information. See the “Obtaining Device Logs” section. |
|
Click to obtain a log file that contains log information that was generated by the device. If the Collect Debug Logs option is set to Yes on this Device Details page, the log file also includes debug information. See the “Obtaining Device Logs” section. |
The Apps area on the Device Details page includes the items that Table 5-3 describes for each Cisco IOx app that is installed on the device. Some items might not appear depending on your deployment.
Includes the following information:
|
|
Includes the following information:
|
|
Shows the states that the app was in on the device over the past month. Hover your mouse pointer over any section of a chart to see the name of the state, the date and time that the app entered the state, and the amount of time the app was in the state. |
|
Displays the following charts, which provide information about device resources that the app consumes:
You can click Day , Week , or Month above these charts to designate the time period for the information that the charts display. Hover your mouse pointer over any part of a chart to see detailed information about a data point. |
|
Displays log information that was generated by the app on the device. Click Refresh to update the display with current information. |
|
Lets you update configuration for the app. The items that display are defined in the package_config.ini file for the app. |
|
Lets you change the following settings for an app:
If you make changes in this tab, click the RECONFIGURE SETTINGS button to send the updated information to the device. For detailed information about these settings, see the “Install App Procedure” section. |
|
Displays all logs that the app generates on the device Click Refresh to update the display with current information. |
|
Displays the command that you can use to access the app via a console. See the “Accessing an App via a Console” section. |
Adding a device makes it manageable by Cisco Fog Director and available for the installation and running of IOx apps.
All devices that you add to Cisco Fog Director should be configured to synchronize their time from same NTP server. In this way, Cisco Fog Director can accurately aggregate data from the servers.
To add a device, follow these steps:
Step 1 In Cisco Fog Director, click the DEVICES tab.
Step 2 On the Devices View page, click the ADD button.
The Add New Device window displays.
Step 3 In the Add New Device window, enter information for the device to add, as described in the following table:
Required. Cisco IOS user name that is configured on the device. |
|
Required. Cisco IOS password that is configured on the device. |
|
Optional. One or more tags for the device. (See the “Managing Tags for a Device” section for an explanation of tags.) To enter more than one tag, separate each tag by pressing the Tab key. |
|
Optional. Contact information of the person who is responsible for the device. |
|
Step 4 In the Add New Device window, take one of these actions:
Importing devices provides you with a convenient way to add several devices to Cisco Fog Director at once. The import process involves creating a comma-separated value (CSV) file that includes information about each device to be added, and then importing that file to Cisco Fog Director.
The following sections provide detailed information:
To import devices to Cisco Fog Director, you begin by creating a CSV import file. This file includes one record for each device that is to be added Cisco Fog Director.
Cisco Fog Director provides a sample CSV file that you can use to create your own file.
Cisco recommends that you use Microsoft Excel to edit the sample CSV file, then use the Save As command in Excel to save the file as a CSV (Comma delimited) type.
An import file must adhere to these guidelines:
To use the sample CSV file to create an import file, follow these steps:
Step 1 In Cisco Fog Director, click the DEVICES tab.
Step 2 On the Devices View page, click the IMPORT button.
Step 3 Click Download Sample CSV and follow the on-screen prompts to open a sample CSV file or save it in to the location of your choice.
Step 4 If you saved the sample CSV file, open it with Microsoft Excel or another editor that can open a CSV file.
Step 5 For each device to be added, create a record for it that includes the following information:
Required. Cisco IOS user name that is configured on the device. |
|
Required. Cisco IOS password that is configured on the device. |
|
Optional. One or more tags for the device. (See the “Managing Tags for a Device” section for an explanation of tags.) If you include more than one tag, separate each tag with a comma. Enclose the tag or tag string of tags with double quotation marks (“). |
|
Optional. Contact information of the person who is responsible for the device. |
|
Step 6 Save the import file as a CSV (Comma delimited) type in the location of your choice.
You can give this file any valid Windows file name.
After you create an import file as described in the “Creating an Import File” section, you can import the file to Cisco Fog Director. Doing so adds the devices that the file defines to Cisco Fog Director.
If the import file includes a record for a device that already exists in Cisco Fog Director, the information for that device is updated with the information in the record.
To use the sample CSV file to create an import file, follow these steps:
Step 1 In Cisco Fog Director, click the DEVICES tab.
Step 2 On the Devices View page, click the IMPORT button.
Step 3 Click the Select devices csv button and follow the on-screen prompts to locate and select the CSV file that you want to import.
Cisco Fog Director discovers the devices that the import file includes and the devices appear in the Devices table.
Editing attributes for a device lets you update various information for the device.
To edit device information, follow these steps:
Step 1 In Cisco Fog Director, click the DEVICES tab.
Step 2 In the Device table, click the Expand icon to the left of the device host name of the device for which you want to edit attributes.
The Edit Device dialog box displays. This dialog box shows the IP address of the device and provides fields in which you can enter or update information.
Step 4 In the Edit Device dialog box, enter information in the following fields as needed:
Valid values are 0 through 65535. The default port is 844.
Step 5 In the Edit Device dialog box, take either of these actions:
Deleting a device removes it from Cisco Fog Director.
To delete a device from Cisco Fog Director, perform the following steps:
Step 1 In Cisco Fog Director, click the DEVICES tab.
Step 2 In the Device table, click the Expand icon to the left of the device host name of the device that you want to delete.
The Delete dialog box displays.
Step 4 Click OK in the delete dialog box.
A tag is a brief descriptive label that you assign to a device. For example, a tag could be the name of an administrator, the name of an app, or the purpose of an app. Tags are useful for categorizing devices. In some areas on the Apps pages, you can display devices with matching tags.
The following guidelines apply to tags:
You manage tags for a device in the Device table on the Devices View page.
To assign a tag to device, click the Enter new tag field in the Tags column that corresponds to the device, enter the tag that you want, and then press the Enter key or the Tab key.
Starting an app initiates its operation on a host device and puts the app in Running state. CPU and memory (RAM) resources that were reserved for the app become in use.
Stopping an app shuts down its operation on a host device and puts the app in Stopped state. CPU and memory (RAM) resources that were used by the app remain reserved for it but stop being used.
The following sections describe how to start and stop an app from the DEVICES tab:
You also can start or stop an app from the App Monitoring page by clicking the START or STOP button under a status chart. See the “Viewing General Monitoring Information” section for more information.
Starting an app initiates its operation on a host device and puts the app in Running state.
To start an app on a device, follow these steps:
Step 1 In Cisco Fog Director, click the DEVICES tab.
Step 2 Take either of these actions:
Step 3 If the app is running, take either of these actions:
Stopping an app shuts down its operation on a host device and puts the app in Stopped state.
To stop an app on a device, follow these steps:
Step 1 In Cisco Fog Director, click the DEVICES tab.
Step 2 Take either of these actions:
Step 3 If the app is running, take either of these actions:
Removing an app from a device removes it from the host device and releases CPU and memory (RAM) resources that were reserved for the app.
To remove an app from a device, follow these steps:
Step 1 In Cisco Fog Director, click the DEVICES tab.
Step 2 Take either of these actions:
Step 3 If the app is running, take either of these actions:
Step 4 Take either of these actions:
For system maintenance and to free disk space on a device, you can delete cartridges that have been installed on the device but that are not used by any apps. Deleting cartridges removes them and their metadata from a device.
To delete unused cartridges from a device, follow these steps:
Step 1 In Cisco Fog Director, click the DEVICES tab.
Step 2 In the Device table on the Devices View page, click the IP address or the host name of the device for which you want to delete unused cartridges.
Step 3 In the Unused Cartridges area on the page that displays, click the DELETE UNUSED CARTRIDGES button.
To troubleshoot a device, you can view and download a device log file that you can review or provide to Cisco for assistance. The file contains log information that was generated by the device. If the Collect Debug Logs option on the Device Details page is set to Yes , the log file also includes debug information.
To create a log file for a device, follow these steps:
Step 1 In Cisco Fog Director, click the DEVICES tab.
Step 2 In the Device table on the Devices View page, click the IP address or the host name of the device for which you want to create a log file.
Step 3 Click the Yes button next to Collect Debug Logs near the top right of the screen.
Step 4 Try to reproduce the issue that you are troubleshooting.
Step 5 Take either of these actions:
Step 6 (Optional) To stop collecting log information, click the No button next to Collect Debug Logs.
You can access an installed on a device via a console. After you access an app, you can use Linux console commands to obtain information about it.
Cisco Fog Director provides the command and related information that you can use to access an app via a console.
To access an app via a console, perform the following steps.
Use Cisco IOS configuration options to forward an SSH port on the router that you want to use for console access to port 22.
Step 1 Take any of these actions to display the Device Details page for the device on which you want to access the app via a console:
Step 2 On the Device Details page, take these actions to obtain the private key that you need for console access:
a. In the App Console Support area at the bottom ob the page, click the app_id .pem link that appears in the sample command, where app_id is the identifier of the app.
b. In the dialog box that appears, follow the prompts to download the app_id .pem file.
c. Use a text editor to open the app_id .pem file, highlight and copy all text that displays.
Make sure to include the “-----BEGIN RSA PRIVATE KEY-----” and “-----END RSA PRIVATE KEY-----” text.
Step 3 On the system from which you logged in to Cisco Fog Director, take these actions:
a. Use a text editor to create a text file called app_id .pem, where app_id is the identifier of the app whose container or VM you want to access.
b. Paste the private key that you copied into this file, and save it locally.
c. Make sure that this file has the Linux permission 700.
Step 4 Take these actions to connect to the host system from a console:
a. From the console system, start an SSH client.
b. Enter the following command to obtain the SSH port required for console access:
prompt% show running-config | i 22
c. Enter the command that appears in the App Console Support area on the Device Details page.
– Replace SSH_PORT with the port number for console access.
– Replace app_id .pem with the path to the file that you created in Step 3, if the file is not in the current directory.
d. Use the commands in your SSH client to complete the connection process.