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.
This chapter provides detailed reference information about the pages and options that are available in Cisco IOx Local Manager.
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:
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:
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. Table 2-1 describes the fields and options that are available on this page.
|
|
---|---|
Each app that has been uploaded to the host system displays in an area that includes the following items: |
|
|
|
Resources profile that is assigned to the app (default, c1.tiny, c1.small, c1.medium, c1.large, c1.xlarge, or Custom) |
|
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. |
|
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. |
|
Appears for an app that has a status of ACTIVATED or STOPPED. Click to start the app. See the “Starting an App” section. |
|
Appears for an app that has a status of RUNNING. Click to stop the app. See the “Stopping an App” section. |
|
Appears for an app that has a status of DEPLOYED. Click to activate the app. See the “Activating an App” section. |
|
Appears for an app that has a status of ACTIVATED or STOPPED. Click to deactivate the app See the “Deactivating an App” section. |
|
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. |
|
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. |
|
Appears for an app that has a status of DEPLOYED. Click to upgrade the app. See the “Upgrading an App” section. |
|
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. |
|
The first app that has does not include information for an installed app displays the following buttons: |
|
Uploads the app to the host system and puts the app in DEPLOYED state. See the “Adding/Deploying an App” section. |
|
The Cartridges 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.
Cartridges are used by PAAS 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.
Cartridges are not used by KVM, LXC, or Docker apps.
To access the Cartridges page, choose Cartridges from the Cisco IOx Local Manager menu bar. Table 2-2 describes the fields and options that are available on this page.
|
|
---|---|
Provides options that you can click to execute operations for the cartridge:
|
|
Installs the cartridge on the host system. See the “Installing a Cartridge” section. |
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. It also provides options for managing and obtaining host system log files and related information for troubleshooting. The information that this page displays is not specific to any particular app.
The Logs area and TechSupport Information area on the System Info page provide options that are useful for troubleshooting the Cisco IOx framework. For related information, see the “Host System Log File Workflows” section, the “Tech Support Information Workflows” section, and the “Core Dump File Workflows” section. (For information about app-specific log files, see the “Downloading an App Log File” section.)
To access the System Info page, choose System Info from the Cisco IOx Local Manager menu bar. Table 2-3 describes the fields and options that are available on this page.
|
|
---|---|
Provides information about CPU and processes that are used on the host system. |
|
Click to display a pop-up window that provide additional information about processes that are running on the host system. |
|
Provides information about storage devices that host system is using. |
|
Click a link in the Source_Linux_Bridge column to display a pop-up window that provides additional information about the corresponding network. |
|
Provides information about serial interface devices that are available on the host system. |
|
Provides information about general interfaces that host system is using. |
|
Provides IP v4 routing information that relates to the host system. |
|
Provides domain information for any DNS and NTP servers that the host system is using. |
|
Click to configure the type and level of information that the host system captures in its host system log files. See the “Configuring Host System Log Files” section. |
|
Host system date and time that the host system log file was last updated. |
|
Click to download the corresponding host system log file. See the “Downloading Host System Log Files” section. |
|
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 “Generating a Snapshot File” section. |
|
Click download to download the corresponding snapshot file to the location of your choice. See the “Downloading a Snapshot File” section. |
|
Click the Delete icon to delete the corresponding snapshot file from the host system. See the “Deleting a Snapshot File” section. |
|
Click to generate a snapshot file. See the “Generating a Snapshot File” section. |
|
Click to update the list of snapshot files with current information. |
|
Lists the name of core dump files that the system generated. |
|
Click download to download the corresponding core dump file to the location of your choice. See the Downloading a Core Dump File. |
|
Click the Delete icon to delete the corresponding core dump file from the host system. See the Deleting a Core Dump File. |
|
Click to update the list of core dump files with current information. |
The System Setting page provides options for managing internal Cisco IOx networks for apps and managing 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. Table 2-4 describes the fields and options that are available on this page.
|
|
---|---|
Click to add an internal network on host systems that support adding internal networks. See the “Adding an Internal Network” section. |
|
Name of the internal Cisco IOx bridge that provides connectivity for this internal network. |
|
Physical interface that the internal network uses for connectivity. |
|
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. |
|
Identifier of the VLAN on which this internal network operates, if applicable. |
|
IP mode of the internal Cisco IOx bridge that provides connectivity for this internal network (dhcp, static, or no_ip_address). |
|
IP address and subnet mask of the internal Cisco IOx bridge that provides connectivity for this internal network. |
|
|
|
Expand this area to display the following options:
See the “App Validation Workflow” section. |
|
Appears if the host system supports managing trust anchors. Expand this area to display the following options:
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.
|
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. Table 2-5 describes the fields and options that are available on this page.
|
|
---|---|
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:
|
|
Indicates whether a license is required for the Cisco Data in Motion service to operate on the host system. |
|
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.
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 .
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. Table 2-6 describes the fields and options that are available on this page.
|
|
---|---|
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.
See the “Activating an App” section for more information. |
|
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. |
|
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. |
|
Amount of disk space, 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. |
|
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. |
|
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. |
|
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. |
|
Appears only for VM-based apps. Number of virtual CPUs that are available on the host system. |
|
Designates the network from which the app obtains its IP address or addresses: |
|
Click to configure mapping of external ports to internal ports for an app. See Step 8 in 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. |
|
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. |
|
Click to activate or deactivate an app. See the “Activating an App” section and the “Deactivating an App” section. |
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. Table 2-7 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.
|
|
---|---|
For PAAS applications, the name of each cartridge that the app requires. See the “Cartridge Management Workflows” section. |
|
Author of the app (for example, the company that provided the app). |
|
Link to an external page for the author (for example, the website of the author). |
|
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. |
|
Number of CPU units that the app consumes on the host system. |
|
Resource profile that you assigned to the app. See the “Activating an App” section. |
|
Disk space, in MB, that the app consumes on the host system. |
|
Number of virtual CPUs that are available on the host system for a VM-based app. |
|
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:
|
|
Row number in this area number for the corresponding information. |
|
Description of the USB or serial device that the app uses on the host system. |
|
Unique ID used by the host system to identify the USB or serial device that the app uses. |
|
ID used by the app to identify the USB or serial device that the app uses on the host system. |
|
Percentage of total CPU units on the host system that the app is currently consuming. |
|
Memory, in KB, that the app is currently consuming on the host system. |
|
Disk space, in MB, that the app is currently consuming on the host system. |
|
Data, in bytes, that the app has received from and transferred to the host system. |
|
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. Table 2-9 describes the fields and options that are available on this page.
|
|
---|---|
Lets you enter configuration information for the app. See the “Updating an App Configuration file” section. |
|
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. Table 2-9 describes the fields and options that are available on this page.
|
|
---|---|
Location in the app container /data directory of a folder that you clicked in the Name field. |
|
Displays the files and subdirectories in the app container /data directory. In this field, you can take the following actions:
|
|
Size of a file, in bytes. For directories, the size displays as 0. |
|
Provides the delete option for deleting a file or directory. See the “Deleting a File or Directory from an App Data Directory” section. |
|
Click to display in the Name field the contents of the top level of the /data directory. |
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. Table 2-10 describes the fields and options that are available on this page.
|
|
---|---|
Host system date and time that the log file was last updated. |
|
Lets you download a log file. See the “Downloading an App Log File” section. |