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:77
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 hostname 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. |
|
Displays the following options:
|
|
Click this field and then choose from the following options to display in the Device table only devices that meet designated criteria. When you choose an option, it displays in the Device Filters field and the Device table updates automatically. You can add as many device filter options as needed. To remove a device filter option from this field, click the X icon next to the option. – Online —Choose this option to display only devices that are on line – Offline —Choose this option to display only devices that are not on line – Day —Choose this option to display only devices with which Cisco Fog Director successfully interacted over the past 24 hours – Week —Choose this option to display only devices with which Cisco Fog Director successfully interacted beginning from the current time 7 days ago – Month —Choose this option to display only devices with which Cisco Fog Director successfully interacted beginning with the current time 28 days ago – Never —Choose this option to display only devices with which Cisco Fog Director has not successfully interacted – Not Discovered —Choose this option to display only devices that Cisco Fog Director has not yet discovered – Discovering —Choose this option to display only devices that Cisco Fog Director is in the process of discovering – Discovered —Choose this option to display only devices that Cisco Fog Director has discovered – Discovery Failed —Choose this option to display only devices that Cisco Fog Director tried to discover was unable to discover (for example, because the device is unreachable) |
|
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 hostname 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 hostname 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 button , Start button , Remove 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.
If service packages have been installed for an app on a device, this area also provides information about each service package. For more information, see, IOx Services Architecture , which is available here: https://developer.cisco.com/docs/iox/#iox-services-architecture/iox-services-architecture .
Name of the person who is responsible for the device or the app. |
|
Shows the name of the device profile that is associated with the device. Hover your mouse pointer over the name to see the following summary information about the device profile:
For related information, see the “Managing Device Profiles” section. |
|
This message appears when the Cisco IOx framework detects that the SSD in the host system is nearing the end of its expected lifetime, if the host system supports obtaining and sending this information. When the expected remaining lifetime of an SSD is between 6% and 15% of its total expected lifetime, a warning-level message appears. When the expected remaining lifetime of an SSD is 5% or less than its total expected lifetime, a critical-level message appears. |
|
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 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. |
|
Click to display the Diagnostics window, which lets you view diagnostic information about errors, events, memory, disk operation, processes, networking, apps, app manager jobs, and app lifecycle tasks on the device. |
|
Click to display a window that lets you view 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 cause Cisco Fog Director to rediscover the device and update information that displays on the Device Details page. |
|
Shows the amount of CPU (in units), memory (in MB), and disk (in MB) resources that are in use and available for apps on the device. Hover your mouse pointer over a chart to see more detailed information. |
|
Displays the following information:
|
|
Displays the following fields and buttons, which allow you to manage layers that are on a device. For related information, see the “Managing Layers” section.
– IN USE —At least one app in Running state is using the layer – NOT IN USE —No installed app is using the layer
|
|
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. |
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.
To display the items for an app, click the Expand button next to the app name. To hide the items for an app, click the Collapse button next to the app name.
Displays the name and version of the app and an icon for the app. Click an app icon to display more detailed information about the app and to access features for managing the app, as described in the “Viewing Detailed Information about an Installed or Available App” section. |
|
Start the app, which initiates its operation on the device and puts the app in Running state. |
|
Stops the app, which shuts down its operation on he device and puts the app in Stopped state. You cannot stop an app that provides services if the services that it provides are being used by one or more other apps that are in Running state. To stop an app that provides services, first stop each app that uses the services that it provides. |
|
Appear only for an app that is not in Running state. Removes the app from the device. See the “Removing an App from a Device” section. |
|
Health state of the app on the device. Health states are:
The following links can appear to the right of certain health states:
– The top line displays a app monitor script status code of 1 if a health script is included in the app package or a code of 0 if a monitor script is not included. This line also displays how long ago the information in this window was captured. – Click STANDARD ERROR to display the standard error that is generated by app monitor script. – Click STANDARD OUTPUT to display the standard output generated by app monitor script. |
|
Available if you configured links for an app. Click a link to go to the configured resource. See the “Configuring App Links” section. |
|
Appears if the app requires services that are provided by another app. Hover your mouse pointer over this text to see the name and version number of the app that provides the services. |
|
Appears for a app that provides services. Hover your mouse pointer over this text to see the name and version number of each app that requires the services that this app provides. |
|
Resource profile that is configured for the app. Hover your mouse pointer over the resource profile name to see system CPU and memory (RAM) resources that the app requires on the device. |
|
|
|
Click to cause Cisco Fog Director to rediscover the device and update information that displays in the Apps area. |
|
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. |
|
Lets you update configuration for the app. The items that display are defined in the package_config.ini file for the app. |
|
(This tab name displays the name of a log files that was generated by the app.) |
By default, displays first 10 lines of a log file that was generated by the app on the device. This area includes these items:
– Log file list—Name of each log file that was generated by the app on the device. Click a file name to display content from that file. – Log displays area—By default, displays the first 10 lines of the log file that is selected in the list. This area displays information for the first file in the Log File list when you first access the View all App Logs window. – Drop down list—Choose an option to update the log file display for the selected file ( Last 10 lines , Last 25 lines , Last 100 lines , or Full log ). – REFRESH button—Click to update the log file display with current information for the selected file. |
Lets you upload one or more app data files for the app. An app data file is a file that an app requires, such as a configuration file. This area includes these items:
Each file that you select appears in a list of files to upload under the SELECT FILES button. To remove a file from this list, click the Remove icon next to the file. You can use these fields to upload as many app data files as needed. |
|
Displays all logs that the app generates on the device Click Refresh to update the display with current 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. |
|
Click to display detailed information about operations that affected the app, including who performed the operation (Who column), what the operation was (What column), when the operation occurred (When column), and a brief system message relating to the operation (Message column). When detailed information displays, you can choose an option from the Show drop-down list to display only operations whose “What” information corresponds to that option. Choose All to display information for all operations. Click a control to go to the first, next, last, previous, or specific page in the list of detailed operations. From the Items per page drop-down list, choose the maximum number of device profile that appear in each page of the list. |
|
When detailed information about operations that affected the app displays, click to hide the detailed information. |
|
The following charts 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 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 Devices” 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. |
|
Identifier of the network element for the device. This ID typically uses a hierarchical naming convention, for example, us-west.cal.ne1. Space, hyphen (-), and underscore (_) characters are not allowed. The maximum length is 135 characters. |
|
Device profile to associate to the device. If you do not specify a device profile, the default device profile is used. To enter a device profile, start typing the name of the profile to display profiles that begin with the characters you type, then click the one that you want. For related information, see the “Managing Device Profiles” section. |
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, perform the following steps.
Note For security reasons, you may not want to include valid user name, password, port, or contact information when you create an import file. In this case, use dummy values in these fields and do not check the Discover devices after import check box when you import the import file. Then, after you import the import file, you can use the Device Edit feature to update these values for the devices. For more information, see the “Editing Devices” section.
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 Devices” 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 import 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 Check the Discover devices after import check box if you want Cisco Fog Director to discover the devices after they are imported.
If you do not choose to discover the devices now, you can discover them later as described in the “Rediscovering Devices” section.
Step 4 Click the Select devices csv button and follow the on-screen prompts to locate and select the CSV file that you want to import.
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 hostname of the device for which you want to edit attributes.
The Edit Device dialog box displays. This dialog box shows information that relates to 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:
A device profile is a set of events monitoring, metrics monitoring, communication, and security configuration settings that can be associated with one or more devices.
There is always a device profile called “System Default Profile” that associated with a device if the device does not have another device profile associated with it.
To view options for managing device profiles, on the Devices View page, click the Additional Actions button and then click PROFILES .
The Profiles page displays. This page includes the items that Table 5-4 describes.
Displays the Adds New Profile window, which you use to add a device profile to Cisco Fog Director. See the “Adding a Device Profile” section. |
|
Displays detailed information about a device profile for which the corresponding check box is checked. See the “Viewing a Device Profile” section. This button is dimmed if you do not check a check box for a device profile. |
|
Displays the following options. This button is dimmed if you do not check a check box for a device profile.
|
|
Type all or part of a device profile name to display information for devices profiles with matching names. The Device Profile list display updates as you type. |
|
Displays the device profiles that have been created in Cisco Fog Director and that can be associated with devices. This list includes the following items for each device profile
|
|
Click a control to go to the first, next, last, previous, or specific page in the table. From the Items per page drop-down list, choose the maximum number of device profile that appear in each page of the table. |
Adding a device profile specifies the configuration settings that the profile includes and makes the profile available to associate with devices.
To add a device profile, follow these steps:
Step 1 In Cisco Fog Director, click the DEVICES tab.
Step 2 On the Devices View page, click the Additional Actions button and then click PROFILES .
Step 3 On the Profiles page, click the ADD button.
The Add New Profile window displays.
Step 4 In the Add New Profile window, take these actions:
a. In the Profile Name field, enter a name for the device profile.
b. If you want to set this device profile the default device profile, check the Mark this Profile as Default check box.
c. In the MONITORING tab, take these actions:
– From the Events Collection Frequency drop-down list, choose and option to specify how often Cisco Fog Director collects events information from the device. This information is shown in various summary and detail displays throughout Cisco Fog Director. The default value is Every 2 hrs .
– From the Metrics Collection Frequency drop-down list, choose and option to specify how often Cisco Fog Director collects metrics information such as CPU, memory, and network resource use from the device. This information is shown in various summary and detail displays throughout Cisco Fog Director. The default value is Every 2 hrs .
– In the Heartbeat Miss Count field, enter the number of consecutive failed attempts of Cisco Fog Director to poll a device after which Cisco Fog Director indicates that it has lost contact with the device. The default value is 3.
– Check the Enable Auto Recovery check box if you want to enable the auto recovery feature on devices that are associated with this device profile. This check box is checked by default. See the “Recovering an App on a Device” section for related information.
d. In the COMMUNICATION tab, take these actions:
– In the Default timeout for control actions field, enter the amount of time, in seconds, after which Cisco Fog Director generates an error if it does not receive a response to a control request that it sends to a device. The default value is 600 seconds (10 minutes).
– In the Timeout for file transfers field, enter the mount of time, in seconds, after which Cisco Fog Director generates an error if an attempt to transfer an app, service, or cartridge file from Cisco Fog Director to a device does not execute. The default value is 3600 seconds (1 hour).
– In the Proxy address field, enter the IP address of an HTTP proxy server that Cisco Fog Director uses to communicate with a device, if such proxy communication is configured in your deployment.
– In the Proxy port field, enter the HTTP proxy server port that Cisco Fog Director uses to communicate with a device, if such proxy communication is configured in your deployment. You can type a number or use the arrow buttons to enter a value.
e. In the SECURITY tab, take these actions:
– Check the Verify SSL Certificates check box if you want Cisco Fog Director to validate certificates as part of the SSL handshake when it contacts the devices with which this device profile is associated. If you enable this feature and validation fails, Cisco Fog Director cannot communicate with the device.
This validation process requires that a public key certificate and corresponding private key be imported to the device by using Cisco IOx Local Manager. If the device public key certificate is self-signed, import this public key certificate into Cisco Fog Director. If the device public key certificate is signed by a trusted Certificate Authority (CA), import the trust anchors (public key certificate of CA) into Cisco Fog Director.
To import certificates to Cisco Fog Director now, hover your mouse pointer over the information icon next to “Verify SSL Certificate,” click the Click here link in the message that displays, and use the Trust Anchors page that displays to import the certificates.
Note Check the Verify App Signature check box if you want to enable App Package Signature Verification on the device. When this option is enabled, the Cisco application-hosting framework verifies the app when the app is installed or upgraded on a device with which this device profile is associated. If the app signature is not verified, the installation fails. The system performs this verification in two steps. First, it uses local trust anchors on the device to ensure that the embedded package certificate in the application is trusted. Next, it ensures that the embedded package signature is valid.
For related information, see Configure IOx Package Signature Validation, which is available here: https://www.cisco.com/c/en/us/support/docs/cloud-systems-management/iox/
212472-configure-iox-package-signature-validati.html.
– (Optional) If you checked the Verify App Signature , check click Browse and navigate to and select the trust anchor (a .tar.gz or .tgz certificate file) that is required for the app signature to be verified. The trust anchor is uploaded to Cisco Fog Director when you click the SAVE button. When you install an app, Cisco Fog Director pushes this trust anchor file to the device. If the trust anchor file exists on the device, Cisco Fog Director overwrites the existing file.
After you import a trust anchor file, the file name displays on this tab. Click the remove icon next to the file name to remove from the list, it if needed.
You do not need to upload a trust anchor file if a trust anchor for app signature verification already exists on the device.
Step 5 (Optional) Click the Show Advanced button on any tab to the Advanced area, which contains the following tabs:
– Host Name—Hostname of the device
– IP Address—IP address of the device
– Tags—Tags that are assigned to a device
– Pagination controls—Click a control to go to the first, next, last, previous, or specific page in the table
– Items per page drop-down list—Choose the maximum number of devices that appear in each page of the table
You can click a name in the Host Name column or an IP address in the IP Address column to display the Device Details page for the corresponding device.
The button changes to Hide Advanced . Click the Hide Advanced button to collapse the JSON code display.
Step 6 Click the SAVE button to save the device profile.
To exit the Add New Profile window without saving the device profile, click the Cancel button.
You can view detailed information about any device profile.
To view a device profile, follow these steps:
Step 1 In Cisco Fog Director, click the DEVICES tab.
Step 2 On the Devices View page, click the Additional Actions button .
Step 3 Take either of these actions:
2. On the Profiles page, check the check box for the profile that you want to view, and then click the VIEW button.
The Edit Devices page displays.
2. In the Device table on the Edit View page, check the check box for the device for which you want to view the device profile and then click ADD SELECTED DEVICES .
3. In the Edit Devices Information area, click the Show Profile Details link.
The View Profile window displays if you clicked the VIEW button, or the Profile Details window displays if you clicked the Show Profile Details link. These windows include the items that Table 5-5 describes.
How often Cisco Fog Director collects events information from a device. This information is shown in various summary and detail displays throughout Cisco Fog Director. |
|
How often Cisco Fog Director collects metrics information such as CPU, memory, and network resource use from a device. This information is shown in various summary and detail displays throughout Cisco Fog Director. |
|
Number of consecutive failed attempts of Cisco Fog Director to poll a device after which Cisco Fog Director indicates that it has lost contact with the device. |
|
If checked, the auto recovery feature is enabled on device that are associated with this device profile. See the “Recovering an App on a Device” section for related information. |
|
Amount of time, in seconds, after which Cisco Fog Director generates an error if it does not receive a response to a control request that it sends to a device. |
|
Amount of time, in seconds, after which Cisco Fog Director generates an error if an attempt to transfer an app, service, or cartridge file from Cisco Fog Director to a device does not execute. |
|
IP address of an HTTP proxy server that Cisco Fog Director uses to communicate with a device, if such proxy communication is configured in your deployment. |
|
HTTP proxy server port that Cisco Fog Director uses to communicate with a device, if such proxy communication is configured in your deployment. You can type a number or use the arrow buttons to enter a value. |
|
If checked, Cisco Fog Director validates certificates as part of the SSL handshake when it contacts the devices with which this device profile is associated. |
|
If checked, App Package Signature Verification is enabled on the device. When this option is enabled, the Cisco application-hosting framework verifies the signature of an app when the app is installed or upgraded on a device with which this device profile is associated. If the app signature is not verified, the installation fails. |
|
Name of the trust anchor (certificate file) on the device that is compared with a certificate in the app during the app signature verification process. |
|
Click to display the Overview tab and the Devices tab. The button changes to Hide Advanced . Click the Hide Advanced button to collapse the advanced display. |
|
– Host Name—Hostname of the device – IP Address—IP address of the device – Tags—Tags that are assigned to a device. – Pagination controls—Click a control to go to the first, next, last, previous, or specific page in the table – Items per page drop-down list—Choose the maximum number of devices that appear in each page of the table Click a name in the Host Name column or an IP address in the IP Address column to display the Device Details page for the corresponding device. |
You can edit device profile security options.
To a device profile, follow these steps:
Step 1 In Cisco Fog Director, click the DEVICES tab.
Step 2 On the Devices View page, click the Additional Actions button and then click PROFILES .
Step 3 On the Profiles page, take one of these actions, check the check box for the profile that you want to edit, click the Additional Actions button , and then choose EDIT .
The Edit Profile window displays. It includes the items that Table 5-6 describes. You can view options in the MONITORING and CONMMUNICATION tab and update options in the SECURITY tab.
Step 4 If you make configuration updates in the Edit Profile window, click the UPDATE button to save your changes.
How often Cisco Fog Director collects events information from a device. This information is shown in various summary and detail displays throughout Cisco Fog Director. |
|
How often Cisco Fog Director collects metrics information such as CPU, memory, and network resource use from a device. This information is shown in various summary and detail displays throughout Cisco Fog Director. |
|
Amount of time, in seconds, after which Cisco Fog Director generates an error if it does not receive a response to a control request that it sends to a device. |
|
Amount of time, in seconds, after which Cisco Fog Director generates an error if an attempt to transfer an app, service, or cartridge file from Cisco Fog Director to a device does not execute. |
|
IP address of an HTTP proxy server that Cisco Fog Director uses to communicate with a device, if such proxy communication is configured in your deployment. |
|
HTTP proxy server port that Cisco Fog Director uses to communicate with a device, if such proxy communication is configured in your deployment. You can type a number or use the arrow buttons to enter a value. |
|
Check this check box if you want Cisco Fog Director to validate certificates as part of the SSL handshake when it contacts the devices with which this device profile is associated. This validation process requires that the certificates (or trust anchors ) that are present on a device also be imported to Cisco Fog Director. To import certificates to Cisco Fog Director now, hover your mouse pointer over the information icon next to “Verify SSL Certificate,” click the Click here link in the message that displays, and use the Trust Anchors page that displays to import the certificates. For related information, see the “Importing a Trust Anchor” section. |
|
Check this check box if you want to enable App Package Signature Verification on the device. When this option is enabled, the Cisco application-hosting framework verifies the app when the app is installed or upgraded on a device with which this device profile is associated. If the app signature is not verified, the installation fails. The system performs this verification by comparing a certificate on the device with a certificate in the app. |
|
The following radio buttons appear if the Verify App Signature check box is checked:
You can hover your mouse pointer over the trust anchor name to see the checksum value certificate.
After you import a trust anchor file, the file name displays under the BROWSE button. Click the X next to the file name to remove from the list, it if needed. |
|
Click to display the Overview tab and the Devices tab. The button changes to Hide Advanced . Click the Hide Advanced button to collapse the advanced display. |
|
– Host Name—Hostname of the device – IP Address—IP address of the device – Tags—Tags that are assigned to a device – Pagination controls—Click a control to go to the first, next, last, previous, or specific page in the table – Items per page drop-down list—Choose the maximum number of devices that appear in each page of the table Click a name in the Host Name column or an IP address in the IP Address column to display the Device Details page for the corresponding device. |
|
Click to update the device profile with changes that you made and exit the Edit Profile window. |
|
Click to exit the Edit Profile window without saving any changes. |
You can set any device profile as the default. The system automatically associates the default device profile with devices that do not have another device profile associated with them.
To set a device profile as the default, follow these steps:
Step 1 In Cisco Fog Director, click the DEVICES tab.
Step 2 On the Devices View page, click the Additional Actions button and then click PROFILES .
Step 3 On the Profiles page, take these actions:
a. Check the check box for the profile that you want to set as the default.
b. Click the Additional Actions button and then choose MARK AS DEFATUL .
The DEFAULT field in the Device Profile list in the Profiles page updates to show “DEFAULT” for this device profile and to show “NON DEFAULT” for other device profiles.
Deleting a device profile removes it from Cisco Fog Director. You cannot delete a device profile that is set as the default or a device profile that is associated with one or more devices.
To delete device profile as the default, follow these steps:
Step 1 In Cisco Fog Director, click the DEVICES tab.
Step 2 On the Devices View page, click the Additional Actions button and then click PROFILES .
Step 3 On the Profiles page, take these actions:
a. Check the check box for the profile that you want to delete.
b. Click the Additional Actions button and then choose DELETE .
Rediscovering devices causes Cisco Fog Director to discover device information (including host name and serial ID), capabilities (including CPU, memory, disk and network resources), and states of apps for the devices that you select.
To rediscover devices, follow these steps:
Step 1 In Cisco Fog Director, click the DEVICES tab.
Step 2 On the Devices View page, click the Additional Actions button and then click RE-DISCOVER .
The Re-Discover Devices page displays. The top part of this page displays the Devices table, which lists the devices that can be rediscovered.
Step 3 If you want to limit the devices that display in the Devices table to one or more specific devices, take the appropriate action:
Step 4 In the Installed Devices table, check the check box for each device that you want to be rediscovered.
Step 5 Click the ADD SELECTED DEVICES button.
The devices with checked check boxes are added to the Selected Devices table. The devices that this table lists will be rediscovered.
To remove a device from this table, click the x icon in the Action column that corresponds to the device to remove.
Step 6 Click the DONE, LET’S GO button.
Cisco Fog Director rediscovers the devices that you selected.
For security reasons, you may not want to include valid user name, password, port, or contact information when you create an import file. In this case, you can use dummy values for this information and uncheck the Discover devices after import check box when you import the import file. Then, after you import the import file, you can use the Device Edit feature to update these values for the devices. (For related information, see the “Importing Devices” section.)
The Edit Devices feature lets you update user name, password, port, and contact information for multiple devices simultaneously.
The following sections provide additional information:
To view options for editing devices on the Devices View page, click the Additional Actions button and then click EDIT .
The Edit Devices page displays. This page includes the items that Table 5-7 describes.
Provides information about each device that has been added to Cisco Fog Director, and includes the following items:
|
|
Click to add devices with checked check boxes to the Selected Devices table. |
|
Provides information about each device for which you want to edit information. Devices appear in this table after you check their check boxes in the Installed Devices table and then click ADD SELECTED DEVICES . This table includes the following items:
|
|
Appears when one or more devices appear in the Selected Devices table, and includes the following items. The Username, Port, Password, and Contact Details page can be edited only if you checked the Exclude readonly devices check box in the Selected Devices table. Check the check box next to a field name to cause Cisco Fog Director to update devices with information in the corresponding field when you click the DONE, LET’S GO button.
|
|
Appears when one or more devices appear in the Selected Devices table. Click to update the devices in the Selected Devices table with the information in the Edit Devices Information fields. |
Step 1 In Cisco Fog Director, click the DEVICES tab.
Step 2 On the Devices View page, click the Additional Actions button and then click EDIT .
The Edit Devices page displays. The top part of this page displays the Devices table, which lists the devices that have been added to Cisco Fog Director.
Step 3 In the Installed Devices table, check the check box for each device for which you want to edit information.
For detailed information about this table and locating devices, see the “Edit Device Options” section.
Step 4 Click the ADD SELECTED DEVICES button.
The devices that you selected are added to the Selected Devices table. The information that you provide will be updated on the devices that this table lists. For detailed information about this table and about removing devices from this table, see the “Edit Device Options” section.
Step 5 In the Edit Devices information area, take the following actions.
You might need to scroll down to see this area.
Step 6 Click the DONE, LET’S GO button.
The devices that you selected are updated with the information that you entered.
Deleting a device removes it from Cisco Fog Director.
You delete as described in the following sections:
To delete single 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 hostname of the device that you want to delete.
The Delete dialog box displays.
Step 4 Click OK in the delete dialog box.
To delete several devices from Cisco Fog Director at the same time, follow these steps:
Step 1 In Cisco Fog Director, click the DEVICES tab.
Step 2 On the Devices View page, click the Additional Actions button and then click DELETE .
The Delete Devices page displays. The top part of this page displays the Devices table, which lists the devices that you can delete.
Step 3 If you want to limit the devices that display in the Devices table to one or more specific devices, take the appropriate action:
Step 4 In the Installed Devices table, check the check box for each device that you want to delete.
Step 5 Click the ADD SELECTED DEVICES button.
The devices with checked check boxes are added to the Selected Devices table. The devices that this table lists will be deleted.
To remove a device from this table, click the x icon in the Action column that corresponds to the device to remove.
Step 6 Click the DONE, LET’S GO button.
The devices that you selected are removed from Cisco Fog Director.
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 devices in the Device table on the Devices View page as described in the following sections:
To assign a tag to a single 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. If the tag does not already exist, the system creates a new one with the name that you enter.
You can assign tags to or remove tags from several devices at the same time. Tags that you assign must already have been created in Cisco Fog Director as described in as described in the “Managing Tags for One Device” section,
To assign tags to or remove tags from multiple devices, follow these steps
Step 1 In Cisco Fog Director, click the DEVICES tab.
Step 2 On the Devices View page, click the Additional Actions button and then click TAG .
The Tag page displays. The top part of this page displays the Devices table, which lists the devices on which you can assign or remove a tag.
Step 3 If you want to limit the devices that display in the Devices table to one or more specific devices, take the appropriate action:
Step 4 In the Installed Devices table, check the check box for each device on which you want assign or remove a tag.
Step 5 Click the ADD SELECTED DEVICES button.
The devices with checked check boxes are added to the Selected Devices table. Tags will be assigned to or removed from the devices that this table lists.
To remove a device from this table, click the x icon in the Action column that corresponds to the device to remove.
Step 6 In the Tag Configuration area, take either of these actions:
b. In the Tag field, enter the tag that you want to assign. The system displays a list of tags with initial characters that match the characters you type. To display a list of all tags, press the Spacebar in this field.
b. In the Tag field, enter the tag that you want to remove. The system displays a list of tags with initial characters that match the characters you type. To display a list of all tags, press the Spacebar in this field.
After you choose a tag, a the system displays the number of devices on which the tag is assigned.
Step 7 Click the DONE, LET’S GO button.
The designated tag is assigned to or removed from all devices that you selected.
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 and stop an app from the App Monitoring Page by using the as described in the START and STOP buttons under the Status Charts as described in the “Viewing General Monitoring Information” section).
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.
You cannot stop an app that provides services if the services that it provides are being used by one or more other apps that are in Running state. Before you stop an app that provides services, stop each app that uses the services that it provides.
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 hostname of the device for which you want to delete unused cartridges.
Step 3 Click the CARTRIDGES tab under the Host Information area.
Step 4 In the Unused Cartridges area on the page that displays, click the DELETE UNUSED CARTRIDGES button.
The Layers tab on the Device Details page provides options for viewing information about and managing layers on a device. A layer is a component of a Docker image from which an app package has been created.
When you upload or upgrade an app package from a Docker image, Cisco Fog Director automatically identifies the layers that the image requires and transfers only the component layers that do not exist on the device.
When you uninstall an app, the system does not automatically remove from the device the layers that relate to that app. Similarly, when you upgrade an app and the new version no longer needs some layers that were used by the older version, the system does not automatically remove from the device the layers that are no longer used. In both cases, if you want to remove unused layers from the device, you must remove them manually.
You can delete any layer that is not in use by an installed app.
To delete layers that are not used by installed apps 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 hostname of the device for which you want to delete layers.
Step 3 Click the LAYERS tab under the Host Information area.
Step 4 In the Layers tab, take either of these actions:
You can click the check box at the top of the list of layers to quickly check boxes for all layers. You cannot delete a layer that is in use by an installed app.
Cisco Fog Director can detect if an app has become corrupted. An app can become corrupted as a result of a variety of issues, such as issues with its configuration or missing or damaged files.
Cisco Fog Director provides features for recovering an app that is corrupted. The recovery features apply only to apps that are in managed state . (An app is in this state when you can manage it on a device by using Cisco Fog Director. See the “Understanding Managed and Unmanaged States for Apps” section.)
App recovery features include the following:
The recovery process can involve reinstalling an app, reactivating an app, installing cartridges, and so on. A successful recovery process fixes problems that Cisco Fog Director identifies and returns the app returns to normal operation.
To manually recover an app on 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 hostname of the device from which you want to remove the app.
Step 3 Click the Expand button next to the name of the app that you want to recover.
The App Info area for the app displays
Step 4 In the App Info area, click Recover link, which appears next to the App Health state for an app for which you can attempt a recovery action.
Cisco Fog Director attempts to recover the app. If the recovery is successful, the App Health state updates to display HEALTHY .
Cisco Fog Director lets you view the following information that relates to a device. This information can help you monitor and diagnose issues on a device.
To view diagnostic information 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 hostname of the device for which you want to create a log file.
Step 3 Click the DEVICE DIAGNOSTICS button next near the top right of the screen.
The Diagnostics window displays. This window includes these tabs:
Table 5-8 describes the items in Diagnostics window in detail.
Step 4 (Optional) To view information about errors, events, app manager jobs, or app lifecycle tasks, click the corresponding tab.
See Table 5-8 for more detailed information.
Step 5 (Optional) To obtain summary or detailed information that relates to memory use, disk operation, processes, networking, or apps click the SYSTEM tab, and then take either of these actions:
Summary or detail information appears in the SYSTEM tab. To exit this information display, click the BACK button. To update this display with current information, click the REFRESH button.
See Table 5-8 for more detailed information.
Table 5-8 describes the items in the Diagnostics window.
The top part of this window includes tabs, the search field (for the ERRORS and EVENTS tab), and the REFRESH button. The bottom part of this window contains the Information area, which displays information for the tab that you choose.
You can click any field title in the Information area, except on the RUN DIAGNOSTICS tab, to toggle the information in that table in default, ascending, or descending alphanumeric order by that field. An up arrow in a field indicates that the information is in ascending alphanumeric order by that field. A down arrow in a field indicates descending order.
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 hostname 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:
The Device Logs window displays. This window lets you view information in any of the device files that the device generates. You can take the following actions in this window:
– Click a log file name near the top of the window to display the first 10 lines from that file, if the device supports tailing of device log files. Otherwise, the entire log file displays.
– Choose an option from the drop-down list to update the display of lines for the file that you chose. Options are Last 10 Lines , Last 25 Lines , Last 100 Lines , or Full log , if the device supports tailing of log files. If the device does not support tailing, Full log is the only option.
– Click the Refresh button to update the log file display with current information.
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 of the page, click the app_id .pem link that displays in the sample command, where app_id is the identifier of the app.
b. In the dialog box that displays, 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 600.
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 displays 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.