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.
The Cisco Fog Director Apps pages provide information about Cisco IOx apps, and provide access to features for managing these apps and performing related operations.
When you log in to Cisco Fog Director, the Apps View page appears, If no apps have yet been added to Cisco Fog Director, this page displays “Welcome to Cisco Fog Director” and displays the ADD NEW APP button and the IMPORT APPS button.
If at least one app has been added, this page includes these areas:
To access the Apps pages, log in to Cisco Fog Director as described in the “Accessing Cisco Fog Director” section, and then click the APPS tab. The Apps View page displays.
This chapter includes these sections:
The Installed Apps area on the Apps View page lists each app that is installed through Cisco Fog Director on at least one device, provides information about these apps, and provides access to related features.
For each installed app, area includes the items that Table 4-1 describes.
|
|
---|---|
Displays the name and version of the app and an app 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. |
|
Displays text and a chart that provide information about the states of an app. App states can include the following:
The text that describes each state shows the number of devices on which the app in that state and the total number of devices on which the app is installed For example, “8/12 Running” means that the app is installed on 12 devices and is running on 8 of them. The donut chart provides a visual representation of each state of an app as a percentage of the number of devices on which the app is installed. Hover your mouse pointer over any section of a chart to see what state that section represents and the percentage of devices on which the app is in that state. Click a chart to display monitoring information for the app, as described in the “Monitoring an App” section. |
|
Host name of up to five devices on which the app has consumed the most CPU resources during the past 24 hours. The percentage value next to a host name indicates the average amount of CPU resources the app consumed on the device during the past 24 hours. Click a host name to display device detailed information about the device. See the “Viewing Detailed Information about a Device” section for more information. |
|
Host name of up to five devices on which the app has consumed the most RAM resources during the past 24 hours, and the amount of memory, in MG, consumed on each device. The percentage value next to a host name indicates the average amount of RAM resources the app consumed on the device during the past 24 hours. Click a host name to display device details information about the device. See the See the “Viewing Detailed Information about a Device” section for more information. |
|
Appears if an app is not currently installed on any device. Click to remove the app from the Installed Apps area. |
The Available Apps area on the Apps View page lists each app that has been published, provides information about these apps, and provides access to related features. An available app is ready to be installed on one or more devices.
You can display this area in either of these views:
The following sections provide more detailed information:
The Available Apps area appears in App Install view by default when you access the Apps View page. When this area is in the App Edit view, you can change to the App Install view by clicking the SWITCH TO APP INSTALL VIEW button or by clicking the APPS tab.
In App Install view, the Available Apps area includes the items that Table 4-2 describes.
|
|
---|---|
Displays the name, version, and icon of each available 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. |
|
The Available Apps area appears in App Edit view when this area is in App Install view and you click the SWITCH TO APP EDIT VIEW button.
In App Edit view, the Available Apps area includes the items that Table 4-3 describes.
|
|
---|---|
Displays the name. version, and icon of each available app. Click an app icon to display more detailed information about the app and to access features for administering the app. |
|
Click to change the Available Apps area to App Install view. See the “Available Apps Area: App Install View” section. |
|
See the “Unpublishing an App” section. |
|
See the “Removing an App” section. |
When the Available Apps area is in App Edit view and you click an app icon, a configuration page displays. The items that this page displays vary depending on the type of the app, and can include the items that Table 4-4 describes.
|
|
---|---|
The icon that appears in Cisco Fog Director for the app. This icon comes from an image file that you specify. You can click Edit Icon to select an image file as described in the “Editing an App Icon, Description, and Release Notes” section. |
|
Entity that authored the app, as specified in the app metadata. |
|
Resource profile of the app, which specifies the amount of host system CPU and memory (RAM) resources that the app requires on a device. For information about assigning resource profiles to an app, see Cisco IOx Local Manager Reference Guide. |
|
Amount of disk space, in MB, that the app requires on a device. |
|
Appears if you configured links for an app. Click a link to go to the configured resource. See the “Configuring App Links” section. |
|
Lets you upload a newer version of an app to Cisco Fog Director. See the “Upgrading an App” section. |
|
Click to publish the app, which makes the app available for installation on devices. See the “Publishing an App” section. |
|
Click to save updates that you make to the description or release notes for the app. See the “Editing an App Icon, Description, and Release Notes” section. |
|
Brief description of the app that appears when you view detailed information for the app. You can click Edit next to “Description” to enter description text as described in the “Editing an App Icon, Description, and Release Notes” section. |
|
Notes for the app that appears when you view detailed information for the app. For example, notes might include a list and descriptions of features added in an updated app. You can click Edit next to “Release Notes” to enter release note text as described in the “Editing an App Icon, Description, and Release Notes” section. |
|
Let you configure external links for an app. See the “Configuring App Links” section. |
The Unpublished Apps area on the Apps View page on the Apps View page lists each app that has been uploaded to Cisco Fog Director and is not yet published. An unpublished app must be published before it can be installed on one or more devices.
The Unpublished Apps area includes the items that Table 4-5 describes.
|
|
---|---|
Lets you upload an app to Cisco Fog Director. See the “Adding an App” section. |
|
Displays the name, version, and icon of each unpublished app. Click an icon to display additional information for the app. The page that appears is the same page that the “Available Apps Area: App Edit View” section describes. |
|
Lets you publish an app, which makes it available for installation on a device. See the “Publishing an App” section. |
|
To view detailed information about an installed app or available, click its icon in the Installed Apps area or in the Available Apps area on the Apps View page. The App Configuration page displays.
This page includes information and features that apply to the app. The items that this page displays vary depending on the state of the app, and can include the items that Table 4-6 describes.
|
|
---|---|
The name of the app, its version, and the date and time it was last updated. |
|
Entity that authored the app, as specified in the app metadata. |
|
Amount of disk space, in MB, that the app requires on a device. |
|
Appears if you configured links for an app. Click a link to go to the configured resource. See the “Configuring App Links” section. |
|
Lets you install an app on one or more devices. See the “Installing an App” section. |
|
Displays information about the operation of the app and its resource consumption on devices See the “Monitoring an App” section. |
|
Lets you uninstall an app from one or more devices. See the “Uninstalling an App” section. |
|
Shows the number of devices on which the app has been successfully installed. The EDIT CONFIGURATION button under this display lets you update configuration parameters that apply to an app, These items may include configuration information, resource profile, networking, and port information. See the “Reconfiguring App Parameters” section for more information. |
|
Shows the number of devices on which an installation, update, uninstall, or reconfiguration action failed for the app. Hover your mouse pointer over this area to see more detailed information about specific action failure types. You can click the RETRY NOW button retry an action. See the “Retrying a Failed Action for an App” section for more information. |
|
After you add and publish a newer version of an already-published app, this field displays the number of devices on which the app should be upgraded. You can click the UPGRADE button to perform the upgrade. See the “Upgrading an App” section for more information. |
|
Displays information about the devices on which the app is installing. This information includes:
or host name of a device to see the status of the app installation process on that device. |
|
Includes a chart that provides a visual representation of the number of devices on which the app in a particular state. Hover your mouse pointer over any section of a chart to see what state that section represents and the number of devices on which the app is in that state. Click any section of the chart to display a table with detailed information about each device on which the app is in the state. This table includes the following:
|
|
Brief description of the app. See the “Editing an App Icon, Description, and Release Notes” section for related information. |
|
Release notes for the app. See the “Editing an App Icon, Description, and Release Notes” section for related information. |
Adding a Cisco IOx app uploads the app to Cisco Fog Director. When you add an app, it appears in the Unpublished area on the Apps View page and becomes available to be published.
To add an app, follow these steps:
Step 1 On the Apps View page, click the ADD NEW APP button.
If other apps have already been added, this button appears In the Unpublished Apps area,
Step 2 In the dialog box that appears, Click the Select App Package button.
Step 3 Follow the on-screen prompts to locate and select the app that you want to add.
The app is added to Cisco Fog Director and a page with the items that Table 4-7 displays. The items in this page depend on the type of app that you added.
|
|
---|---|
Click to add an icon for the app. See the “Editing an App Icon, Description, and Release Notes” section. |
|
Entity that authored the app, as specified in the app metadata. |
|
Resource profile of the app, which specifies the amount of host system CPU and memory (RAM) resources that the app requires on a device. For information about assigning resource profiles to an app, see Cisco IOx Local Manager Reference Guide. |
|
Let you configure external links for an app. See the “Configuring App Links” section. |
|
Lets you upload a newer version of an app to Cisco Fog Director. See the “Upgrading an App” section. |
|
Click to publish the app, which makes the app available for installation on devices. See the “Publishing an App” section. |
|
Click to save updates that you make to the description or release notes for the app. See the “Editing an App Icon, Description, and Release Notes” section. |
|
Brief description of the app that appears when you view detailed information for the app. You can click Edit next to “Description” to enter description text as described in the “Editing an App Icon, Description, and Release Notes” section. |
|
Notes for the app that appears when you view detailed information for the app. For example, notes might include a list and descriptions of features added in an updated app. You can click Edit next to “Release Notes” to enter release note text as described in the “Editing an App Icon, Description, and Release Notes” section. |
You can publish an app after it has been added to Cisco Fog Director. A published app becomes available to install on devices.
To publish an app, take any of these actions:
After you perform the Publish action, the app moves from the Unpublished Apps area to the Available Apps area on the Apps View page.
Unpublishing an app moves the app to the unpublished area and makes it unavailable for installation on any device. Unpublishing an app does not remove it from devices on which it is installed already.
To unpublish an app, follow these steps:
Step 1 In the Available Apps area on the Apps View page, click SWITCH TO APP EDIT VIEW.
Step 2 Click the Unpublish button under the icon for the app.
You can install a published app on a device that has been added or imported to Cisco Fog Director.
The following sections provide additional information:
To view options for installing an app, click the INSTALL button on the Apps Configuration page for the app.
The Filter Devices page displays. This page includes the items that Table 4-8 describes.
To install an app on one or more devices, perform the following steps.
If you are installing an app on multiple devices and want to stop the installation procedure at any time, unpublish the app as described in the “Unpublishing an App” section.
Step 1 Take either of these actions:
Step 2 In the Installed Devices table, check the check box for each device on which you want to install the app.
For detailed information about this table and locating devices, see the “Install App Options” section.
Step 3 Click the ADD SELECTED DEVICES button.
The devices that you selected and on which the app can be installed are added to the Selected Devices table. The app will be installed on the devices that this table lists. For detailed information about this table and about removing devices from this table, see the “Install App Options” section.
Step 4 Click the Next button near the bottom of the page.
The Installation Summary page appears. This page lets you review and configure operations that are performed by Cisco Fog Director on the devices on which you are installing the app.
Step 5 (Optional) In the Installation Summary page, expand Selected Devices (if it is not expanded already) to review the following information for each device that you selected:
Step 6 In the Installation Summary page, take the following actions as needed:
By default, the system adds a tag with the app name to each device. You can change this name, or, if you do not want a tag to be added, delete all text in this field. See the “Managing Tags for a Device” section for related information.
– Host Name—Host name of the device.
– IP Address—IP address of the device.
– Tags—Tags that are assigned to the device.
– Health—Icons that represent information about CPU use or memory use on the device. Hover your mouse pointer over an icon to see more detailed information.
– Incompatibility Cause—A brief description of why the app cannot be installed on the device.
– Pagination controls—Click a control to go to the first, next, last, previous, or specific page in the table, and to designate the maximum number of devices that can appear on each page.
Step 7 (Optional) In the Installation Summary page, expand Customize Configuration to view and update configuration information for this app.
The configuration items that display are defined in the package_config.ini file for the app. The value that each field displays is the default value for that item as defined by the app. You can make updates in these fields as needed.
Step 8 (Optional) In the Installation Summary page, expand Configure Resource Profile to view and update the resource profiles that have been assigned for the app on each device.
You can update the resource profile for a specific device, some devices, or all devices.
The device squares in the box in the middle of the Configure Resource Profile area represent devices on which you are installing the app. You can hover your mouse pointer over a device square to display the Edit Resource Profile dialog box. This dialog box shows the host name and IP address of the device, tags assigned to the device, and the resource profile that has been assigned for the app on the device. You can click the hostname and IP address in the dialog box to exit the installation and display the Device Details page for the device.
To update a resource profile on one or more devices, take these actions:
a. If you want to limit the device squares displays to one or more specific devices, take either of these actions:
– To limit the device display to a specific device based on its hostname or IP address, enter all or part of the hostname or IP address in the Search Hostname, IP Address field.
– To limit the device display to specific devices based a tag, choose a tag from the Show drop-down list.
– To change the resource profile for a specific device, hover your mouse pointer over the device square for that device, and in the Edit Resource Profile dialog box, choose a resource profile from the Select Profile drop-down list.
– To change the resource profile for all devices for which a device square displayed, click the desired profile radio button and then click the REASSIGN PROFILE button:
- Exact matching profile —Assigns the resource profile that is defined for the app in its metadata, if the resources are available on a device
- Largest available profile —Assigns the largest resource profile that is currently available on each device on which you are installing
Step 9 (Optional) In the Installation Summary page, expand Configure Networking to view and update the network from which the app obtains its IP address or addresses on each device.
The Configure Networking area is available only if its options apply to this installation.
You can update the network for a specific device, some of devices, or all devices.
The device squares in the box in the middle of the Configure Networking area represent devices on which you are installing the app. You can hover your mouse pointer over a device square to display the Edit Network Details dialog box. This dialog box shows the host name and IP address of the device, tags assigned to the device, and the network that has been assigned for the app on the device.
To update the network for an app on one or more devices, take these actions:
a. If you want to limit the device squares to one or more specific devices, take either of these actions:
– To limit the device display to a specific device based on its hostname or IP address, enter all or part of the hostname or IP address in the Search Hostname, IP Address field.
– To limit the device display to specific devices based a tag, choose a tag from the Show drop-down list.
– To change the network for a specific device, hover your mouse pointer over the device square for that device, and in the Edit Network Details dialog box. choose a network from the Select Network drop-down list. Network options are:
- iox-bridge0 —App obtains its IP address from a DCHP pool that is configured in Cisco IOS
- iox-nat0 —App obtains its IP address from an internal network address translator
– To change the network for all devices for which a device square displayed, click either of the following radio buttons and then click the REASSIGN NETWORKS button:
- Bridged —App obtains its IP address from a DCHP pool that is configured in Cisco IOS
- NATed —App obtains its IP address from an internal network address translator
Step 10 (Optional) In the Installation Summary page, expand Configure Device Resource Ports to view and update the serial port that an app uses on a device.
The Configure Device Resource Ports area is available only if the app requests a serial port.
The device squares in the box in the middle of the Configure Device Resource Ports area represent devices on which you are installing the app. You can hover your mouse pointer over a device square to display the Edit Serial Details dialog box. This dialog box shows the host name and IP address of the device, tags assigned to the device, and the serial port that has been assigned for the app on the device.
To update a serial port for an app on one or more devices, take these actions:
a. If you want to limit the device squares to one or more specific devices, take either of these actions:
– To limit the device display to a specific device based on its hostname or IP address, enter all or part of the hostname or IP address in the Search Hostname, IP Address field.
– To limit the device display to specific devices based a tag, choose a tag from the Show drop-down list.
b. Hover your mouse pointer over the device square for the device that you want to update, and in the Edit Serial Details dialog box, choose a port from the Select Serial Port drop-down list.
Step 11 (Optional) In the Installation Summary page, expand Network Status to view network, resource, and related information for apps and devices.
The Network Status area displays the following information:
– Cartridges —Cisco cartridges that a PAAS app requires to run. These cartridges must already be uploaded to Cisco Fog Director (see Chapter 7, “Managing Cartridges”) and are installed automatically on the device as part of the app installation process.
– CPU Availability —Number of free CPU units on the device.
– Memory Availability —Amount of free RAM, in MB, on the device.
Step 12 When you are satisfied with the information on the Installation Summary page, click the DONE, LET’S GO button.
The App Configuration page appears, as described in the “Viewing Detailed Information about an Installed or Available App” section.
While the app is installing on a device, the status of the installation displays for that device. Click the device to see the progress of the installation.
If the Actions Failed display on this page indicates that the installation failed on any device, you can click the RETRY NOW button to try the installation on these devices again. See the “Retrying a Failed Action for an App” section.
You can uninstall an app from any device on which it is running. Uninstalling an app removes it from the device and releases device CPU and memory (RAM) resources that were reserved for it.
You can uninstall an app that is in any state.
The following sections provide additional information:
To view options for uninstalling an app, click the UNINSTALL APP button on the Apps Configuration page for the app.
A page displays that includes the items that Table 4-9 describes.
To remove an installed app from one or more devices, follow these steps:
Step 1 Take either of these actions:
Step 2 In the Installed Devices table, check the check box for each device from which you want to uninstall the app.
For detailed information about this table and locating devices, see the “Uninstall App Options” section.
Step 3 Click the ADD SELECTED DEVICES button.
The devices with checked check boxes are added to the Selected Devices table. The app will be uninstalled from devices that this table lists. For detailed information about this table and about removing devices from this table, see the “Uninstall App Options” section.
Step 4 Click the DONE, LET’S GO button.
When an new version of an installed app becomes available, you can upgrade the app. This process includes uploading the app for Cisco Fog Director and then upgrading devices with the new app version.
To upgrade an app, follow these steps:
Step 1 f you are not viewing the page that displays when you add an app, take these actions:
a. In the Available Apps area on the Apps View page, make sure that you are in App Edit view.
b. In this area, click the icon for the app for the app to upgrade.
Step 2 Take these actions to upload the new version of the app to Cisco Fog Director:
c. Click the UPGRADE PKG button.
d. In the dialog box that displays, click the Select New App Package button, and then follow the on-screen prompts to locate and select the app file that you want.
The app file that you select uploads to Cisco Fog Director.
Step 3 Click the Publish button on the Configuration page.
The app is published, which makes it available for upgrading, and the Apps View page displays.
Step 4 Take these actions to upgrade devices with the app that you uploaded:
a. In the Installed Apps area on the Apps View page, click the icon for the app to upgrade.
b. Click the UPGRADE button, which appears under the “Upgrade Required on” displays.
The Filter Devices page appears. This page includes the items that Table 4-8 describes.
c. In the table, check the check box for each device on which you want to upgrade the app, and then click the ADD SELECTED DEVICES button.
d. Click the DONE, LET’S GO button.
The App Configuration page appears, as described in the “Viewing Detailed Information about an Installed or Available App” section.
While the app is upgrading on a device, the status of the upgrade displays for that device. Click the device to see the progress of the upgrade.
If the Actions Failed display on this page indicates that the upgrade failed on any device, you can click the RETRY NOW button to try the upgrade on these devices again. See the “Retrying a Failed Action for an App” section.
After you upgrade an app, you can revert to the most recent previously installed version of that app, if needed.
The following sections provide additional information:
If you have upgraded an app and then published the upgraded version, you can revert to the previous version of the app.
To revert to the previous version of a published app, follow these steps:
Step 1 Uninstall the app from each device on which it is installed, as described in the “Uninstalling an App” section.
Step 2 Unpublish the app, as described in the “Unpublishing an App” section.
The previous version of the app appears in the Published area on the Apps View page.
If you have upgraded an app but not published the upgraded version, you can revert to the previous version of the app.
To revert to the previous version of an unpublished app, remove the app as described in the “Removing an App” section. The previous version of the app appears in the Unpublished area on the Apps View page.
Removing an app removes it from Cisco Fog Director.
To remove an app, follow these steps:
Step 1 Uninstall the app as described in the “Uninstalling an App” section.
The app moves to the Available Apps area on the Apps View page.
Step 2 In the Available Apps area, click SWITCH TO APP EDIT VIEW.
Step 3 Click the Remove button under the icon for the app.
The app moves to the Unpublished Apps area on the Apps View page.
Step 4 In the Unpublished Apps area, click the Remove button under the icon for the app.
You can add or update the following items for an app:
This icon comes from an image file that you specify. The image size should be 250 x 250 pixels. The system accepts images that are other sizes, but those images are scaled and may not appear as desired. The image file can in any of these formats: ai, bmp, drw, gif, ico, jpe, jpeg, jpg, pct, png, psd, psp, raw, scf, svg, svgz, tif, or tiff.
To add or update an icon, description, or release notes for an app, follow these steps:
Step 1 If you are not viewing the page that displays when you add an app, take these actions:
a. In the Available Apps area on the Apps View page, make sure that you are in App Edit view.
b. In this area, click the icon for the app for which you want to add or update the icon, description, or release notes.
Step 2 To add or update an icon, take these actions:
b. Follow the on-screen prompts to locate and select the image file for the icon that you want.
Step 3 To add or update a description, take these actions:
a. Click Edit next to “Description.”
b. In the edit area that appears, type the description. You can use the formatting tools at the top of the Edit area to format the text and perform related operations.
Step 4 To add or update release notes, take these actions:
a. Click Edit next to “Release Notes.”
b. In the edit area that appears, type the notes. You can use the formatting tools at the top of the Edit area to format the text and perform related operations.
You can reconfigure a variety of items that apply to an app. Depending on the app, items that you can reconfigure include:
The following sections provide additional information:
To view options for reconfiguring an app, take either of these actions:
If you clicked Edit Configuration from the Apps Configuration page, the Reconfigure App page appears, which displays that includes the items that Table 4-10 describes.
You can reconfigure an app from the Apps View page or the Devices View page, as described in the following sections:
Reconfiguring an app from the Apps View page is useful if you want to apply the reconfiguration to multiple devices.
To reconfigure an app from the Apps View page, perform the following steps. The items that you can reconfigure depend on the app, so some configuration options that the following procedure includes may not be available for some apps.
Make sure that the app is installed as described in the “Installing an App” section.
Step 1 Take one of these actions:
Step 2 In the Installed Devices table, check the check box for each device on which you want to reconfigure the app.
For detailed information about this table and locating devices, see the “Reconfigure App Options” section.
Step 3 Click the ADD SELECTED DEVICES button.
The devices with checked check boxes are added to the Selected Devices table. The app can be reconfigured on devices that this table list. For detailed information about this table and about removing devices from this table, see the “Reconfigure App Options” section.
Step 4 To to change configuration information for this app, take these actions:
a. Click the Expand icon next to Customize Configuration.
The configuration items that display are defined in the package_config.ini file for the app.
b. Make updates as needed in the fields that appear.
The value that each field displays is the default value for that item as defined by the app. To see the current value of an item on a particular device, from the Devices tab, choose a device, and then click EDIT CONFIGURATION near the bottom of the page that displays for the device.
c. (Optional) Check the Restart app after configuration check box if you want the app to restart after you save the configuration updates. Some apps require a restart after a configuration change.
d. Click the DONE, LET’S GO button to complete the changes to configuration information.
Step 5 To reconfigure resource profiles that have been assigned for the app, take these actions:
a. Click the Expand icon next to Customize Resources, if this area is not expanded already.
b. Click the Expand icon next to Configure Resource Profiles.
You can update the resource profile for a specific device, some devices, or all devices.
The device squares in the box in the middle of the Configure Resource Profile area represent devices on which you are installing the app. You can hover your mouse pointer over a device square to display the Edit Resource Profile dialog box. This dialog box shows the host name and IP address of the device, tags assigned to the device, and the resource profile that has been assigned for the app on the device. You can click the hostname and IP address in the dialog box to exit the reconfigure procedure and display the Device Details page for the device.
c. If you want to limit the device squares displays to one or more specific devices, take either of these actions:
– To limit the device display to a specific device based on its hostname or IP address, enter all or part of the hostname or IP address in the Search Hostname, IP Address field.
– To limit the device display to specific devices based a tag, choose a tag from the Show drop-down list.
– To change the resource profile for a specific device, hover your mouse pointer over the device square for that device, and in the Edit Resource Profile dialog box. choose a resource profile from the Select Profile drop-down list.
– To change the resource profile for all devices for which a device square displayed, click the desired profile radio button and then click the Reassign Profile button:
- Exact matching profile —Assigns the resource profile that is defined for the app in its metadata, if the resources are available on a device
- Largest available profile —Assigns the largest resource profile that is currently available on a device
e. If you are finished reconfiguring the app, click the EDIT RESOURCES button. Otherwise, continue to the following step.
Step 6 To reconfigure the network from which the app obtains its IP address or addresses, take these actions:
a. Click the Expand icon next to Customize Resources, if this area is not expanded already.
b. Click the Expand icon next to Configure Networking.
You can update the network for a specific device, some devices, or all devices.
The device squares in the box in the middle of the Configure Networking area represent devices on which you are installing the app. You can hover your mouse pointer over a device square to display the Edit Network Details dialog box. This dialog box shows the host name and IP address of the device, tags assigned to the device, and the network that has been assigned for the app on the device.
c. If you want to limit the device squares to one or more specific devices, take either of these actions:
– To limit the device display to a specific device based on its hostname or IP address, enter all or part of the hostname or IP address in the Search Hostname, IP Address field.
– To limit the device display to specific devices based a tag, choose a tag from the Show drop-down list.
– To change the network for a specific device, Hover your mouse pointer over the device square for that device, and in the Edit Network Details dialog box, choose a network from the Select Network drop-down list. Network options are:
- iox-bridge0 —App obtains its IP address from a DCHP pool that is configured in Cisco IOS
- iox-nat0 —App obtains its IP address from an internal network address translator
– To change the network for all devices for which a device square displayed, click either of these radio buttons and then click the REASSIGN NETWORKS button:
- Bridged —App obtains its IP address from a DCHP pool that is configured in Cisco IOS
- NATed —App obtains its IP address from an internal network address translator
e. If you are finished reconfiguring the app, click the EDIT RESOURCES button. Otherwise, continue to the following step.
Step 7 To reconfigure the serial port that the app uses on a device, take these actions:
a. Click the Expand icon next to Customize Resources, if this area is not expanded already.
b. Click the Expand icon next to Configure Device Resource Ports.
The device squares in the box in the middle of the Configure Device Resource Ports area represent devices on which you are installing the app. You can hover your mouse pointer over a device square to display the Edit Serial Details dialog box. This dialog box shows the host name and IP address of the device, tags assigned to the device, and the serial port that has been assigned for the app on the device.
a. If you want to limit the device squares to one or more specific devices, take either of these actions:
– To limit the device display to a specific device based on its hostname or IP address, enter all or part of the hostname or IP address in the Search Hostname, IP Address field.
– To limit the device display to specific devices based a tag, choose a tag from the Show drop-down list.
b. Hover your mouse pointer over the device square for the device that you want to update, and in the Edit Serial Details dialog box, choose a port from the Select Serial Port drop-down list.
c. When you are finished reconfiguring resources, click the EDIT RESOURCES button.
Reconfiguring an app from the Devices View page applies the reconfiguration to a specified device.
To reconfigure an app from the Devices View page, follow these steps:
Make sure that the app is installed as described in the “Installing an App” section.
Step 1 On the Devices page, choose the device on which you want to reconfigure the app.
Step 2 Click Edit Configuration under the app that you want to reconfigure.
The configuration items that display are defined in the package_config.ini file for the app.
Step 3 Make updates as needed in the fields that appear.
The value that each field displays is the value for that item on the device that you chose.
Step 4 (Optional) Check the Restart app after configuration check box if you want the app to restart after you save the configuration updates. Some apps require a restart after a configuration change.
Step 5 Click the RECONFIGURE APP button.
You can use app link to associate links to external resources with an app. For example, you could include a link to a web site or document that provides information about an app, or you could include a link to a reference guide or configuration guide for an app. You can associate as many links as needed with an app.
After you configure a link for an app, the link appears in the under App Links on the App Configuration page, and in the Apps area on the Device Details page. Click a link to go to the configured resource.
The following sections describe how add, update, or delete app links.
To configure and app link, follow these steps:
Step 1 If you are not viewing the page that displays when you add an app, take these actions:
a. In the Available Apps area on the Apps View page, make sure that you are in App Edit view.
b. In this area, click the icon for the app for which you want to add links.
Step 2 Click the App Links button .
Step 3 In the first field, enter a name for the link.
For example, enter the name of the web page or a document that the link references.
Step 4 In the second field, enter the URL of the link.
Step 5 In the third field, enter a brief description of the linked resource.
Step 6 Take either of these actions:
To update or delete an app link, follow these steps:
Step 1 If you are not viewing the page that displays when you add an app, take these actions:
a. In the Available Apps area on the Apps View page, make sure that you are in App Edit view.
b. In this area, click the icon for the app for which you want to add links.
Step 2 Take either of these actions
Step 3 In the fields that display, update the name a name of the link, the URL of the link, or the description of the link as needed.
Step 4 Take either of these actions:
If any of the following actions fails on one or more devices, you can use the RETRY NOW button on the App Configuration page to retry the action:
To retry a failed action, follow these steps:
Step 1 From the App Configuration page for the app, click the RETRY NOW button.
This button is available only if an action failed.
The Select Retry Actions page appears. This page includes the following information for each device on which the action failed:
Step 2 In the device table, check the check box for each device to which you want to apply the retry or remove action.
Step 3 Take either of these actions:
The Cisco Fog Director export and import features let you back up and restore apps. This feature can be useful for creating an archive of apps or for importing apps to another Cisco Fog Director.
The export feature saves all apps that appear in the Available and the Unpublished areas on the Apps View page to a zip file outside of Cisco Fog Director. The import feature restores apps that have been exported to a zip file.
The following sections describe these features in detail:
Exporting apps lets you save apps in an export file, which is a zip file named exportedApps.zip that is stored outside of Cisco Fog Director. This action affects all apps that appear in the Available and the Unpublished areas on the Apps View.
`To export an app, follow these steps:
Step 1 In the Available Apps area on the Apps View page, make sure that you are in App Edit view, and then click the EXPORT APPS button.
Step 2 Follow the on-screen prompts to save the app in the location of your choice.
The file is named exportedApps.zip.
When you import apps that you exported as described in the “Exporting Apps” section, the apps are added to Cisco Fog Director. If an app already exists in the Cisco Fog Director to which you are importing, the app is not restored.
To import an app, follow these steps:
Step 1 On the Apps View page, take either of these actions:
Step 2 In the Import Apps dialog box that displays, click the Select Apps Archive button.
Step 3 Follow the on-screen prompts to locate and select the exportedApps.zip export file that you want to import.
When the import process completes, the Import Apps Dialog box confirms the completion. It also provides information about any apps that could not be imported (you might need to scroll down in the dialog box to see this information).
Monitoring an app provides information about the operation of an app across all devices on which it is installed. This information can be useful for evaluating the operation of the app or for troubleshooting. The following sections describe the app monitoring features:
To view general monitoring information about an installed app, take any of these actions:
The App Monitoring page displays. This page includes information and features that apply to the app, and includes some or all of the items that Table 4-11 describes.
|
|
---|---|
Shows the number of devices on which the app has been successfully installed. |
|
Click to display detailed information about the app, as described in the “Viewing Detailed Information about an Installed or Available App” section. |
|
Shows the number of devices on which the app has been in Running state or in Stopped state during the designated time period. Hover your mouse pointer over any part of the chart to see detailed information about a data point. You can click Day, Week, or Month above this graph to designate the time period for the information. |
|
Show information about devices on which an app is running and on which an app is stopped. For each state, a chart shows the name of the state, and the number of devices on which the app is in that state, and the percentage of devices on which the app is installed that the app is in that state. You can click the following buttons under a status chart:
|
|
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. Click a chart to display a table with detailed information about the corresponding resource consumption for individual devices. The tables include the following items:
|
To view general monitoring information about an installed app, click either of these buttons on the App Monitoring page:
This button is dimmed if the app is not in the Running state on at least one device.
This button is dimmed if the app is not in the Stopped state on at least one device.
The Running Devices or Stopped devices tab in the table provide information for devices on which the app is in the corresponding state. The Error tab provides information about devices on which the app is in an error state of some kind.
This table includes the items that Table 4-5 describes.
|
|
---|---|
Type all or part of a host name or IP address of a device to display information for devices with matching information. The table display updates as you type. |
|
Host name of the device on which the app is in the state. Click a host name to display device details information for the device. See the “Viewing Detailed Information about a Device” section. |
|
IP Address of the device on which the app is in the state. Click an IP address to display device details information for the device. See the “Viewing Detailed Information about a Device” section. |
|
Tags that have been assigned to the device. See the “Managing Tags for a Device” section. |
|
Icons that represent information about CPU use or memory use on the device. Hover your mouse pointer over an icon to see more detailed information. |
|
View App Log button |
Click to display log information that is generated by the app on a device. |
Click a control to go to the first, next, last, previous, or specific page in the table. |