Cisco IOx Local Manager Pages and Options

This chapter provides detailed reference information about the pages and options that are available in Cisco IOx Local Manager.

This chapter includes these sections:

Cisco IOx Local Manager Tabs

Cisco IOx Local Manager includes the following main tabs in its menu bar. You use these tabs to access the Cisco IOx Local Manager pages:

  • Applications tab—Displays the Applications page, displays general information about the Cisco IOx apps that have been uploaded to the host system, provides options for managing and administering them, and provides an option for adding a new app.

  • Cartridges/Layers tab—Displays the Cartridges/Layers page. This page lists the Cisco cartridges that have been installed on the host system, displays general information about these cartridges, and provides options for installing, deleting, and obtaining additional information about them. It also displays information about the Docker layers that are used by all applications that are installed on the host system, and provides an option for deleting unused layers.

  • System Info tab—Displays the System Info page, which provides hardware, software, network, and resource information that relates to the host system.

  • System Troubleshoot tab—Displays the System Troubleshoot page, which provides options for reviewing events, errors, and diagnostic information on the host system, and managing and obtaining log files and related information for troubleshooting.

  • System Setting tab—Displays the System Settings page, which provides information about the range of NAT IP addresses that are reserved for app, and provides options for managing SSL connections and app signature validation

  • Middleware Service tab—Displays the Middleware Service page, which lists the Cisco Data in Motion services that are available for apps, displays general information about these services, and provides options for starting, stopping, and uploading licenses for them.

  • App-ID tab—When you click the manage option on the Applications tab for an app, a tab with the ID of that app is added to the menu bar. The App-ID tab displays the App-ID page, which provides access to pages for viewing information and performing other activities that relate to a specific app.

    To remove an App-ID tab from the menu bar, hover your mouse over the tab and click its Close button .

On Cisco IOx Local Manager pages:

  • You can click any field title in a table that displays rows of information to toggle the information in that table in ascending or descending alphabetical order by that field.

  • On most pages that display information in multiple areas, you can click an area title to expand or collapse the information in that area.

Applications Page

The Applications page lists the Cisco IOx apps that have been uploaded to the host system, displays general information about these apps, and provides options for managing and administering them.

It also provides buttons for adding an app and refreshing the page

To access the Applications page, choose Applications from the Cisco IOx Local Manager menu bar. The following table describes the fields and options that are available on this page.

Table 1. Applications Page Fields and Options

Item

Description

Uploaded App areas

Each app that has been uploaded to the host system displays in an area that includes the following items:

Name of the app

Displays at the top left of an app area

Description of the app

Displays under the name of the app

Status of the app

Status of the app:

  • DEPLOYED —App is uploaded to the host system. System CPU and RAM resources are not committed to the app. An app with this status can be activated, upgraded, or deleted.

  • ACTIVATED —App is on the host system and ready to run. System CPU and RAM resources have been reserved for the app but are not yet in use. An app with this status can be started or deactivated.

  • RUNNING —App is operating on the host system. System CPU and RAM resources are in use for the app. An app with this status can be stopped.

  • STOPPED —App has been running on the host system but its operation has been stopped. System CPU and RAM resources remain reserved for the app. An app with this state can be started or deactivated.

TYPE

Type of the app (paas , kvm , lxc , or docker ).

VERSION

Version of the app

PROFILE

Resources profile that is assigned to the app (default , c1.tiny , c1.small , c1.medium , c1.large , c1.xlarge , or Custom )

Memory bar

For an app that is in DEPLOYED state, blue shading indicates the relative amount of total memory (RAM) resources on a host system that the app requests. For an app that is in ACTIVATED, RUNNING, or STOPPED, state, green shading indicates the relative amount of total memory resources on a host system that is allocated to the app. The percentage value at the right of the bar indicates the percentage of total memory on the host system that is requested by or allocated to the app.

CPU bar

For an app that is in DEPLOYED state, blue shading indicates the relative amount of CPU resources on a host system that the app requests. For an app that is in ACTIVATED, RUNNING, or STOPPED, state, green shading indicates the relative amount of CPU resources on a host system that is allocated to the app. The percentage value at the right of the bar indicates the percentage of total CPU resources on the host system that is requested by or allocated to the app.

Start button

Appears for an app that has a status of ACTIVATED or STOPPED. Click to start the app. See the Starting an App section.

Stop button

Appears for an app that has a status of RUNNING. Click to stop the app. See the Stopping an App section.

Activate button

Appears for an app that has a status of DEPLOYED. Click to activate the app. See the Activating an App section.

Deactivate button

Appears for an app that has a status of ACTIVATED or STOPPED. Click to deactivate the app See the Deactivating an App section.

Delete button

Appears for an app that has a status of DEPLOYED. Click to remove the app from the host system. See the Deleting an App section.

Manage button

Appears when the app that has any status except DEPLOYED. Click to display the App-ID page for the app. See the App-ID Page section.

Upgrade button

Appears for an app that has a status of DEPLOYED. Click to upgrade the app. See the Upgrading an App section.

Visualization button

Appears for an app is in running state if its descriptor file (package.yaml) file asks for visualization. Click to open a new tab that can show graphs and tables of data that relates to the app. The information that displays depends on what visualization information the app asks for.

General buttons

The first app that has does not include information for an installed app displays the following buttons:

Add New button

Uploads the app to the host system and puts the app in DEPLOYED state. See the Adding/Deploying an App section.

Refresh button

Click to update the page with current information.

Cartridges/Layers Page

The Cartridges/layers page lists the Cisco cartridges that have been installed on the host system, displays general information about these cartridges, and provides options for installing, deleting, and obtaining additional information about them. This page also displays information about the layers that are used by all applications that are installed on the host system, and provides an option for deleting unused layers.

Cartridges are used by PAAS apps, but not for KVM, LXC, or Docker apps. The packages for these apps include only the app logic (such as Python or Java files), but not the Linux operating system files or the root file system that the app requires. Cartridges provide the root file system and Python or Java files that an app requires to run. See the Cartridge Management Workflows section for additional information.

A layer is a component of a Docker image from which an app package has been created

To access the Cartridges/Layers page, choose Cartridges/Layers from the Cisco IOx Local Manager menu bar. The following table describes the fields and options that are available on this page.

Table 2. Cartridges/Layers Page Fields and Options

Item

Description

Cartridges Area

Click the area name to expand or hide the information in this area

Total field

Total number of megabytes that cartridges consume on the disk of the host system.

Id field

Unique identifier of the cartridge.

Name field

Name of the cartridge.

Actions field

Provides options that you can click to execute operations for the cartridge:

Description field

Brief description of the cartridge.

Version field

Version of the cartridge.

Install button

Installs the cartridge on the host system. See the Installing a Cartridge section.

Docker Layers Area

Click the area name to expand or hid the information in this area

Total field

Total number of megabytes that layers consume on the disk of the host system.

Layer Id field

Unique identifier of the layer.

Size field

Number of megabytes that layer consumes on the disk of the host system

Used By field

Name of the app that uses the layer.

Delete Unused Layer button

Deletes layers that are not used by installed apps on the host system. See the Layer Management Workflow section.

System Info Page

The System Info page provides hardware, software, network, and resource information that relates to the host system and to the Cisco IOx infrastructure and framework. The information that this page displays is not specific to any particular app.

To access the System Info page, choose System Info from the Cisco IOx Local Manager menu bar. The following table describes the fields and options that are available on this page.

Table 3. System Info Page Fields and Options

Item

Description

Refresh Stats button

Click to update the page with current information.

Host Info area

Information fields

Provides general information about the host system.

Memory area

Information fields

Provides information about memory use on the host system.

CPU & Processes area

Information fields

Provides information about CPU and processes that are used on the host system.

Inspect Process button

Click to display a pop-up window that provide additional information about processes that are running on the host system.

Monitoring area

Corrupted Apps field

If any apps are corrupted on the host system, this field shows the name of each app.

Disk Status field

Displays the status of the hard disk on the host system, if the host system provides this information.

This information can indicate that disk status is not available, that the last file system consistency check identified errors, or that the file system consistency check cannot recover from disk errors.

IP v4 Routing area

Information fields

Provides IP v4 routing information that relates to the host system.

DNS and NTP Settings area

Information fields

Provides domain information for any DNS and NTP servers that the host system is using.

Storage area

SSD Lifetime Information

Displays the expected remaining lifetime of the SSD on the host system, as a percentage of the total expected lifetime, if the host system provides this information.

If Cisco Local Manager cannot display this information, a message in this field explains why the information is not available.

SSD lifetime information is supported only on Cisco 829 Industrial Integrated Services Routers.

Information fields

Provides information about storage devices that host system is using.

Serial Interfaces area

Information fields

Provides information about serial interface devices that are available on the host system.

Interfaces area

Information fields

Provides information about general interfaces that host system is using.

System Setting Page

The System Setting page provides options for managing internal Cisco IOx networks for apps and managing SSL connections and app signature validation.

Internal Cisco IOx networks allow apps on host systems to communicate with other systems. The network named svcbr_0 is provided by default, and cannot be deleted. Some host systems allow other networks to be added.

If needed, refer to the app documentation or developer for information network configuration that an app requires when it runs.

To access the System Setting page, choose System Setting from the Cisco IOx Local Manager menu bar. The following table describes the fields and options that are available on this page.

Table 4. System Setting Page Fields and Options

Item

Description

Additional Networks area

Add Network button

Click to add an internal network on host systems that support adding internal networks. See the Adding an Internal Network section.

Interface field

Name of the internal Cisco IOx bridge that provides connectivity for this internal network.

Description field

Brief description of the internal network.

Physical Interface field

Physical interface that the internal network uses for connectivity.

Logical Network field

Logical networks that provide bridge and NAT networking modes for the internal network.

Click a logical network name to display a dialog box that provides detailed information about that logical network.

Vlan ID field

Identifier of the VLAN on which this internal network operates, if applicable.

IP Mode field

IP mode of the internal Cisco IOx bridge that provides connectivity for this internal network (dhcp , static , or no_ip_address ).

IP Address field

IP address and subnet mask of the internal Cisco IOx bridge that provides connectivity for this internal network.

Actions field

Provides these options:

SSL/TLS area

Import Certificates button

Click to import a externally signed SSL certificate to the host system.

See the Configuring an SSL Connection section.

Application Signature Validation area

Appears only if the host system supports app signing.

Enable Application Signature / Disable Application Signature toggle button

Click the Enable Application Signature button to enable App Package Signature Verification on the host system. When this option is enabled, the Cisco application-hosting framework verifies the signature of an app when the app is installed on the host system. If the app signature is not verified, the installation fails.

Click the Disable Application Signature button to disable App Package Signature Verification on the host system. When this option is disabled, the Cisco application-hosting framework does not verify the signature of an app when the app is installed on the host system.

See the Configuring App Signature Validation section.

Trust Anchor area

Appears if the host system supports managing trust anchors.

Import Trust Anchor button

Click to import a trust anchor (a .tar or .tar.gz certificate file) to the host system. Use the Import Trust Anchor dialog box that displays to locate and select the trust anchor that you want, and then click OK .

If you enabled application signature verification, apps are validated against this certificate when they are added to the host system. If the validation fails, an app does not install.

See the Configuring App Signature Validation section.

Refresh button

If a certificate already exists on the host system, click to display the certificate. If this certificate is the one that you want to use, you do not need to import a certificate. If you import a certificate, it replaces the one that exists on the host system.

List of trust anchors

Displays the checksum value and metadata for each certificate that you imported.

System Troubleshoot Page

The System Troubleshoot page provides options for reviewing events, errors, and diagnostic information on the host system, and managing and obtaining log files and related information for troubleshooting.

The options on this page are useful for troubleshooting the Cisco IOx framework. For related information, see the following sections.

To access the System Troubleshoot page, choose System Troubleshoot from the Cisco IOx Local Manager menu bar. The following table describes the fields and options that are available on this page.

Table 5. System Troubleshoot Page Fields and Options

Item

Description

Events area

Refresh button

Click to update the fields in the Events area with current information.

The information in these fields does not update automatically while the System Troubleshoot page is displayed.

Device Uptime field

The amount of time that has passed since the host system last started, shown as days, hours, minutes, and seconds.

CAF Uptime field

The amount of time that has passed since the Cisco application-hosting framework last started on the host system, shown as days, hours, minutes, and seconds.

System Time field

The current date and time on the host system.

Current CAF Stats fields

The following fields provide information about the number of items that have been written to the Cisco application-hosting framework log files since the Cisco application-hosting framework last started on the host system:

  • Warning field—Number of warnings.

  • Error field—Number of errors.

  • Critical field—Number of errors that have a severity of critical.

  • Events field—Number of events. An event typically relates to a successful Cisco application-hosting framework operation.

Search field and button

Lets you display specific Events or Errors in the Events list or Errors list. See the Viewing Events section or the Viewing Errors section.

Events button

Click to display the Events list. See the Viewing Events section.

Errors button

Click to display the Errors list. See the Viewing Errors section.

Events list

Appears when you click the Events button. Displays information about events that have occurred on the host system. An event typically relates to a successful Cisco application-hosting framework operation.

See the Viewing Events section.

Errors list

Appears by default or when you click the Errors button. Displays information about errors that have occurred on the host system and lets you view detailed information about an error.

See the Viewing Errors section.

Pagination controls

Let you navigate the Events list or Errors list. See the Viewing Events section or the Viewing Errors section.

Logs area

Refresh button

Click to update the fields in the Logs area with current information.

The information in these fields does not update automatically while the System Troubleshoot page is displayed.

Logging Management button

Click to configure the type and level of information that the host system captures in its log files. See the Configuring Log Files section.

Select Log Type drop-down list

Choose the type of log files that appear in the Log File list. See the Downloading Log Files section.

Log File list

Displays information for each log file, according to the log type option that you choose. See the Downloading Log Files section.

You can drag a border between column headings to resize a column.

Diagnostics area

Diagnostic Type field

Choose the type of diagnostic information to obtain and display. See the Diagnostic Information Workflow section.

Detailed Information check box

Check this check box to display detailed diagnostic information in the Display field. See the Diagnostic Information Workflow section.

Display field

Displays diagnostic information according to the Diagnostic Type option that you chose. See the Diagnostic Information Workflow section.

TechSupport Information area

Tech Support snapshot file name field

Lists the names of snapshot files that you have generated. A file name has the format tech_support_timestamp , where timestamp is the host system date and time that the file was generated. See the .

File Size field

Size of the snapshot file, in bytes.

Download field

Click download to download the corresponding snapshot file to the location of your choice. See the Downloading a Snapshot File section.

Delete field

Click the Delete icon to delete the corresponding snapshot file from the host system. See the Deleting a Snapshot File section.

Generate snapshot file button

Click to generate a snapshot file. See the Generating a Snapshot File section.

Refresh button

Click to update the list of snapshot files with current information.

Core file name field

Lists the name of core dump files that the system generated.

File Size field

Size of the core dump file, in bytes.

Download field

Click download to download the corresponding core dump file to the location of your choice. See the Downloading a Core Dump File section.

Delete field

Click the Delete icon to delete the corresponding core dump file from the host system. See the Deleting a Core Dump File section.

Refresh button

Click to update the list of core dump files with current information.

Middleware Service Page

The Middleware Service page lists the Cisco Data in Motion middleware service that is available for apps, displays general information about this service, and provides options for starting, stopping, and uploading licenses for it. This service runs on the host system.

To access the Middleware Service page, choose Middleware Service from the Cisco IOx Local Manager menu bar. The following table describes the fields and options that are available on this page.

Table 6. Middleware Service Page Fields and Options

Item

Description

Name field

Name of the Cisco Data in Motion service.

Status field

Status of the Cisco Data in Motion service:

  • Running —Service is running on the host system

  • Stopped —Service is not running on the host system

Actions field

Provides options that you can click to execute operations for the Cisco Data in Motion service. Options that appear depend on the status of the service as follows:

Description field

Description of the Cisco Data in Motion service.

Version field

Version of the Cisco Data in Motion service.

Require License field

Indicates whether a license is required for the Cisco Data in Motion service to operate on the host system.

Refresh button

Click to update the page with current information.

App-ID Page

The App-ID page, where App-ID is the ID of an app, includes the following tabs. These tabs provide access to pages for viewing information and performing other activities that relate to a specific app.

  • Resources tab—Displays the Resources page, from which you can assign various resources to an app, activate an app, and deactivate an app. See the App-ID > Resources Page section.

  • App-info tab—Displays the App-info page, from which you can view system and network information that relates to an app. See the App-ID > App-info Page section.

  • App-Config tab—Displays the App-Config page, from which you can update configuration information for an app. See the App-ID > App-Config Page section.

  • App-DataDir tab—Displays the App-DataDir page, from which you can see the contents of the /data directory in an app container, upload files to the /data directory or subdirectory, download files to your local system, and delete files or subdirectories from the /data directory. The files can be configuration files or other files that the app needs when it runs. See the App-ID > App-DataDir Page section.

  • Logs tab—Displays the Logs page, from which you can view information about and download app log files. See the App-ID > Logs Page section.

To access the App-ID page, choose the App-ID tab for the app from the Cisco IOx Local Manager menu bar.

If you do not see the tab for an app, choose the Applications tab, and then click the manage option for the app that you want.

To remove an App-ID tab from the menu bar by, hover your mouse over the tab and click its Close button .

App-ID > Resources Page

The App-ID > Resources page lets you assign a resource profile (host system CPU and memory resources) to an app, designate the network from which the app obtains its IP address, and activate or deactivate an app. This page also shows CPU and memory resources that are available on the host system.

If needed, refer to the app documentation or developer for information regarding resources that an app requires when it runs.

To access the App-ID > Resources page, choose an App-ID tab from the Cisco IOx Local Manager menu bar, and then choose Resources . The following table describes the fields and options that are available on this page.

Table 7. App-ID > Resources Page Fields and Options

Item

Description

Resources title

Click to expand or collapse this page.

Resource Profile area

Profile drop-down list

Provides options for designating the resource profile for an app. A resource profile designates the amount of host system CPU and memory (RAM) resources that the app requires to run, as follows.

  • default —Assigns CPU and memory resources based on the requirement that is specified in the metadata for the app.

  • c1.tiny , c1.small , c1.medium , c1.large , or c1.xlarge —Assigns the CPU and memory resources that the options display. These values are based on the host system hardware.

  • Custom —Lets you enter your own CPU, RAM, and disk space values in the CPU, Memory, and Disk fields

See the Activating an App section for more information.

CPU field

Number of CPU units that the app requires on the host system.

If you choose Custom from the Profile drop-down list, enter a value in this field. If you choose another option, the system enters a value in this field for you.

Memory field

Amount of RAM, in MB, that the app requires on the host system.

If you choose Custom from the Profile drop-down list, enter a value in this field. If you choose another option, the system enters a value in this field for you.

Disk field

Amount of disk space, in MB, that the app requires on the host system.

You can enter a value in this field for any option that you choose from the Profile drop-down list. The value that you enter must be greater than the existing value; you cannot decrease the disk space value.

Vcpu field

Appears only for VM-based apps. Enter the number of virtual CPUs that the app requires on the system.

If you choose Custom from the Profile drop-down list, enter a value in this field. If you choose another option, the system enters a value in this field for you.

Avail. CPU field

Number of available CPU units on the host system.

The system does not allow you to activate an app if the value in the CPU field exceeds this available CPU value.

Avail. Memory field

Amount of available RAM, in MB, on the host system.

The system does not allow you to activate an app if the value in the Memory field exceeds this available memory value.

Max VCPU/App field

Appears only for VM-based apps. Number of virtual CPUs that are available on the host system.

Advanced Settings area

This area appears only if the app type is Docker and the host system supports native Docker.

Docker Options

Enter one or more Docker run options to be used when you activate the app.

This field includes the --rm option by default. For related information, see the following row in this table.

Auto delete container instance

Check this check box to add the --rm run option to the Docker Options field and to use this option when you activate the app.

When you stop an app that you activated and started with the --rm option, the app container instance is deleted automatically and the app goes to DEPLOYED state (rather than STOPPED state).

This check box is checked by default.

Network Configuration area

Network Name drop-down list

Provides options for designating the network from which the app obtains its IP address or addresses. The options that are available in this list depend on the type of host system. Here are examples of some options that can appear:

  • iox-bridge0 —App obtains its IP address from a DCHP pool that is configured in Cisco IOS.

  • ioxnat0 —App obtains its IP address from an internal network address translator.

  • iox-nat_docker0 —App obtains its IP address from an internal native Docker network address translator. (Applicable only to host systems that support native Docker.)

The default network that the Cisco Application Framework returns is selected by default, but you can chose another network.

Port Mapping link

Available when the Network Name option is set to a nat type network

Click to configure mapping of external ports to internal ports for an app. See Step 11 in the Activating an App section.

Interface Setting link

Available when the Network Name option is set to a bridge type network

Click to configure mapping of external ports to internal ports for an app. See the Activating an App section.

Serial Access Configuration area

Appears only if the app metadata requests that a serial port on the host system be assigned for use by the app.

Port_description radio button

Identifies one or more serial ports on the host system that the app metadata requests for use by the app. Port_description is a description of the port usage that comes from the app metadata.

Click the radio button for each port that you want to assign for use by the app.

Activate / Deactivate toggle button

Click to activate or deactivate an app. See the Activating an App section and the Deactivating an App section.

debug mode check box

Appears only for Docker and PAAS type apps. Check this check box to activate the app in debug mode.

If an app that is running in debug mode shuts down unexpectedly, the app does not go to STOPPED state. Instead, the app remains in RUNNING state so that you can use an SSH client to access the app and troubleshoot.

If you want to enable or disable the debug mode of an app that has been activated, you must first deactivate the app.

USB Configuration area

Appears only if the host system can provide this information and if the app metadata requests that a USB port on the host system be assigned for use by the app.

Port_description radio button

Identifies one or more USB ports on the host system that the app metadata requests for use by the app. Port_description is a description of the port usage that comes from the app metadata.

Click the radio button for each port that you want to assign for use by the app.

VNC Options area

Appears only if the host system supports this functionality.

Password field

Enter a password for accessing an app via a VNC session.

Use this password in the VNC client that you use to access the app.

Port field

Enter a port number to be used for accessing the app via a VNC session.

If you do not enter a port number, the system assigns a value.

Valid port numbers are 5900 through 65535.

App-ID > App-info Page

The App-ID > App-info page displays system, resource, and network information that relates to an app. It also provides information that you can use to access an app via a console. Much of the information on this page comes from the app metadata.

To access the App-ID > App-info page, choose an App-ID tab from the Cisco IOx Local Manager menu bar, and then choose App-info . The following table describes the fields and options that are available on this page. Some of the fields on this page appear only when an app is in a specific state or has a specific configuration.

Table 8. App-ID > App-info Page Fields and Options

Item

Description

Application Information area

ID field

ID of the app

State field

Current state of the app (for example, DEPLOYED).

Name field

Name of the app.

Cartridge Required field

For PAAS applications, the name of each cartridge that the app requires. See the Cartridge Management Workflows section.

Version field

Version of the app.

Author field

Author of the app (for example, the company that provided the app).

Author link field

Link to an external page for the author (for example, the website of the author).

Application Type field

Type of the app (PAAS or MV).

Description field

Brief description of the app.

Toolkit service field

Not used.

Debug mode field

If the app was activated in debug mode, this field shows true . Otherwise, this field shows false .

App Access area

Console Access

For an app that has a status of RUNNING, displays the command that you can use to access the app via a console. See the Accessing an App via a Console section.

VNC Access field

For a VM-based app that has a status of RUNNING, displays the password and port number that you entered in the VNC Options area in the App-id >

Resources page. You use this password and port number when you access an app via a VNC session.

Requested Resource area

CPU field

Number of CPU units that the app consumes on the host system.

Memory field

RAM, in MB, that the app consumes on the host system.

Profile field

Resource profile that you assigned to the app. See the Activating an App section.

Disk field

Disk space, in MB, that the app consumes on the host system.

Vcpu field

Number of virtual CPUs that are available on the host system for a VM-based app.

Network Information area

interface-name field

Name of the network interfaces that the app uses for network access. Click an interface name to display a dialog box that shows the following information, as available:

  • interface-name—Name of the network interface that the app uses for network access.

  • TCP—If the app metadata requests that TCP ports be open on the host system, displays the TCP port number or numbers that the app requests be open for its use. If info appears in this field, click info to display a dialog box that provides port mapping information for this network interface.

  • UDP—If the app metadata requests that UDP ports be open on the host system, displays the TCP port number or numbers that the app requests be open for its use. If info appears in this field, click info to display a dialog box that provides port mapping information for this network interface.

  • mac_address—MAC address of the network interface that the app uses for network access.

  • network_name—Name of the network on which the app is activated.

  • ipv4—IPv4 address that is assigned to the internal interface of the app.

  • ipv6—IPv6 address that is assigned to the internal interface of the app.

Device Information area

Sl.No field

Row number in this area number for the corresponding information.

usage field

Description of the USB or serial device that the app uses on the host system.

device-id field

Unique ID used by the host system to identify the USB or serial device that the app uses.

type field

Indicates the type of device (serial or usbport ).

label field

ID used by the app to identify the USB or serial device that the app uses on the host system.

App Health area

App Health field

Description of the health of the app. “Healthy” means that the app has no errors and is operating normally. “Unhealthy” means that the app has errors. Click a description to see more detailed information, if available.

Reconcile Attempted field

If Cisco IOx determined that the app was corrupted and tried to recover the app, this field shows true . Otherwise, this field shows false .

Reconcile Failure field

If Cisco IOx tried to recover the app but was not able to, this field shows true . Otherwise, this field shows false .

If this field shows true , the app must be recovered manually.

Resource Usage area

CPU field

Percentage of total CPU units on the host system that the app is currently consuming.

Memory field

Memory, in KB, that the app is currently consuming on the host system.

Disk field

Disk space, in MB, that the app is currently consuming on the host system.

Network field

Data, in bytes, that the app has received from and transferred to the host system.

Refresh button

Click to update the page with current information.

App-ID > App-Config Page

The App-ID > App-Config page from lets you update the configuration file for an app.

An app configuration file is a text file named package_config.ini, which is stored in the /data directory in the app container for the app. When an app starts, it obtains configuration parameters from this file, if the file exists. The contents and use of this file by its app are defined by the app developer.

To access the App-ID > App-Config page, choose an App-ID tab from the Cisco IOx Local Manager menu bar, and then choose App-Config . The following table describes the fields and options that are available on this page.

Table 9. App-ID > App-Config Page Fields and Options

Item

Description

Text field

Lets you enter configuration information for the app. See the “Updating an App Configuration file” section.

Save button

Click to save the updates that you made in the Text field.

App-ID > App-DataDir Page

The App-ID > App-DataDir page lets you see the contents of the /data directory in an app container, upload files to the /data directory or subdirectory, download files to your local system, and delete files or subdirectories from the /data directory. The files can be configuration files or other files that the app needs when it runs. log files, and other files that are created while app is running.

To access this page, the app must be in the ACTIVATED, RUNNING, or STOPPED state. This page is not available for use when an app is in the DEPLOYED state.

To access the App-ID > App-DataDir page, choose an App-ID tab from the Cisco IOx Local Manager menu bar, and then choose App-DataDir . The following table describes the fields and options that are available on this page.

Table 10. App-ID > App-DataDir Page Fields and Options

Item

Description

Current Location

Location in the app container /data directory of a folder that you clicked in the Name field.

Name field

Displays the files and subdirectories in the app container /data directory. In this field, you can take the following actions:

  • If you are viewing a subdirectory, click ../ to display the contents of the directory that is one level up from the directory that you are viewing.

  • Click the Home button to the contents of the top level of the /data directory.

  • Click a subdirectory name to see its contents.

  • Click a file name to download the file to your local PC. See the Downloading a File from an App Data Directory section.

Type field

Indicates the type of the corresponding item:

  • file —Item is a file in the /data directory or a subdirectory

  • dir —Item is a subdirectory in the /data directory

Size field

Size of a file, in bytes. For directories, the size displays as 0.

Actions field

Provides the delete option for deleting a file or directory. See the Deleting a File or Directory from an App Data Directory section.

Home button

Click to display in the Name field the contents of the top level of the /data directory.

App-ID > Logs Page

The App-ID > Logs page provides information about the app log files that the app creates in the /data/logs directory in the app container for the app, and lets you download these log files.

To access the App-ID > Logs page, choose an App-ID tab from the Cisco IOx Local Manager menu bar, and then choose Logs . The following table describes the fields and options that are available on this page.

Table 11. App-ID > Logs Page Fields and Options

Item

Description

Log name field

Name of the log file.

Timestamp field

Host system date and time that the log file was last updated.

Log Size field

Size of the log file, in bytes.

download button

Lets you download a log file. See the Downloading an App Log File section.