- Introduction to IOx
- IOx Edge Compute Devices
- IC3000-series
- IR 800-series
- IR 1100 Series
- IE 4000-series
- IE3x00 Series
- IE93xx Series
- CGR 1000 Compute Module
- ISR 800-series
- Catalyst 9000-series
- ISR 4000/ASR 1000-series
- Comparison of IOx Devices
- IOx Resource Downloads
- IOx Local Manager
- IOx Development Tools
- ioxclient Reference
- What is ioxclient?
- Profiles
- App management
- App file management
- App console
- Service management
- Platform management
- Getting CAF Metrics
- Manage devices
- Managing logical networks
- Manage platform log files
- Manage package signature validation
- Debuggability and Diagnostics
- Platform Certificates
- Smart License Management
- Cartridge management
- Messaging service
- Docker commands
- Docker Layers
- Docker Toolchain Setup
- ioxclient Reference
- IOx App Tutorials
- Docker Applications
- Overview
- Tutorial: Deploy Dockerhub Image
- Tutorial: Create Custom Package Descriptor for Docker Apps
- Tutorial: Build Sample Docker Type IOx app Using Docker Toolchain
- Tutorial: Build Sample Docker Type Python Simple App
- Tutorial: Build Sample Docker Type C Based Simple App
- Tutorial: Build Sample Docker Type Python with C App
- Tutorial:Build Sample Docker Type C++ Based Simple App
- Tutorial: Build Sample Docker Type nodejs Based HTTP Server Using Alpine Base Image
- Tutorial: Build Sample Docker Type IOx App That Consumes GPS Service
- VM Applications
- Legacy Styles
- Docker Applications
- IOx App Concepts
- Advanced Features
- Application Groups
- Remote Docker workflow
- OVA to IOx VM App Package Deployment
- Debuggability and Diagnostics
- USB Storage and Serial Device
- IOx Services
- Key Value Datastore
- Cisco Local Manager Based App Console Access
- Fog Director API Documentation
- IOx Smart Licensing
- Access GPS data from an IOx App via serial interface on IR1101
- Troubleshooting Guide
- Developer Resources
- Community and Support
Cisco IOx Local Manager Workflows
Cisco IOx Local Manager is a platform-specific application that is installed on a host system as part of the installation of the Cisco IOx framework on that device. It provides a web-based user interface that you can use to manage, administer, monitor, and troubleshoot apps on the host system, and to perform various related activities.
The following sections provide overviews of common workflows that you can perform with Cisco IOx Local Manager. For more detailed information, see Cisco IOx Local Manager Reference Guide.
• Starting Cisco IOX Local Manager • Adding/Deploying an App • Activating an App • Starting an App • Managing an App • Viewing Host System Log Files
Starting Cisco IOX Local Manager
You can access Cisco IOx Local Manager from any supported computer that has IP connectivity to the host system on which it is installed. To do so, see Figure 1 and the steps that follow.
Figure 1
- Start a supported browser and perform either of these actions:
On Cisco IR1101 routers and Cisco IE3x00 switches, enter the following address in the address field: https://ip_address/iox/login where
ip_address is the IP address of the host system on which Cisco IOx Local Manager is installed.
On other Cisco IoT supported devices, enter the following address in the Address field: https://ip_address:port where:
ip_address is the IP address of the host system on which Cisco IOx Local Manager is installed.
port is the port number for access to Cisco IOx Local Manager. The default number is 8443.
The Log In page displays.
In the Username field, enter the user name that you use to log in to Cisco IOS on the host system that you identified in Step 1.
In the Password field, enter the password that you use to log in to Cisco IOS on the host system that you identified in Step 1.
Click Log In.
Adding/Deploying an App
Adding and deploying an app uploads a Cisco IOx app file to the host system.
To add and deploy an app, see Figure 2 and the steps that follow.
Figure 2
Choose Applications from the Cisco IOx Local Manager menu bar.
Click the Add New button on the Applications page.
In the Deploy application dialog box Application ID field, enter a unique identifier to be assigned to the app.
The identifier can contain up to 64 letters, numbers, and underscores (_), in any combination.
- In the Deploy application dialog box, click the Browse button and select the app OVA or tarball file.
OVA files are supported only on the Cisco IC3000 Industrial Compute Gateway. If you choose an OVA file, perform these actions in the Deploy OVA dialog box that displays:
If the OVA file includes a QEMU guest agent package, check the OVA includes qemu-guest-agent check box.
From the OS Type drop-down list, choose the operating system in which you will run the app (Linux or Windows).
Click the OK button.
In the Deploy application dialog box, click the OK button.
The app file uploads to the host system. This process can take some time. When the Successfully Deployed dialog box displays, click the OK button.
Activating an App
Activating an app reserves host system resources that the app requires to run, designates the network from which the app obtains its IP address, and assigns host system serial ports for use by the app, if requested.
You can activate an app that has a status of DEPLOYED. To do so, see Figure 3 and the steps that follow.
Figure 3
In the Applications page, the click the Activate button for the app.
Select the Resources tab in the page that displays.
In the Resource Profile area, configure host system CPU, memory, and disk resources that the app requires when it runs.
In the Advanced Settings area, which appears for Docker type apps if the host system supports Native Docker, configure Docker options for the app.
In the Network Configuration area, configure options to designate the logical network from which the app obtains its IP address.
In the Peripheral Configuration area, configure options to define peripheral devices that are attached to the host system and that the app controls.
Click the Activate App button.
Starting an App
Starting an app starts the app container for the app on the host system. CPU and memory (RAM) resources that were reserved for the app become in use.
You can start an app that has a status of ACTIVATED or STOPPED.
To start an app, in the Applications page, the click the Start button for the app. See Figure 4.
Figure 4
Managing an App
You can perform various management tasks for an app that has a status of RUNNING. To do so, see Figure 5 and the steps that follow.
Figure 5
In the Applications page, the click the Manage button for the app that you want to activate.
Select a tab to manage the app:
Resource—Use this tab to view resource profile, Docker options, network configuration, and peripheral configuration information for an app.
App-Info—Use this tab to view general, resource, network, and health information for an app, and to access an app via a console.
App-Config—Use this tab to update the app configuration file, package_config.ini, for an app.
App-DataDir—Use this tab to view the contents of the app container directory that is defined by the ${CAF_APP_APPDATA_DIR} environment variable, upload files to the directory or subdirectory, download files to your local system, and delete files or subdirectories from the directory. Typically, this directory is /data.
Log—Use this tab to download a log file for the app. For log files to be visible, your app must write log files to the directory that the ${CAF_APP_LOG_DIR} environment variable defines.
Downloading Host System Log Files
Host system log files contain information from the host system that relates to Cisco IOx Local Manager operations . You can configure the categories for which the host system logs information and the level at which it logs information. For information about configuring log levels, see the “Configuring Log Files” section in Cisco IOx Local Manager Reference Guide
To download log files, see Figure 5 and the steps that follow.
Figure 5
Choose System Troubleshoot from the Cisco IOx Local Manager menu bar.
(Optional) From the Select Log Type drop-down list in the Logs area, choose the type of log files that you want to appear in the Log File list.
In the Log File list, click download in the View field for the log file that you want to download, and follow the on-screen prompts to save the file in the location of your choice.