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.
Beginning with release 3.1.1, Cisco ICFP introduces a new graphical user interface (GUI).
The following icons are used throughout the Cisco ICFP GUI.
Icon |
Description |
---|---|
Edit the selected item. |
|
Refresh the screen. |
|
Search for an item. |
|
View details for the selected item. |
The following icons are used for working with cloud instances.
Icon |
Description |
---|---|
Add a cloud instance. |
|
Delete a cloud instance. |
The following icons are used for working with tenant accounts.
The following icons are used to install JKS certificate files, update licenses, or update software or adapters.
Icon |
Description |
---|---|
Install a JKS certificate. |
|
Update the Cisco ICFP license. |
|
Update an adapter or Cisco ICFP software. |
The following icons are used to configure syslog and download logs.
Cisco ICFP enables you to perform the following common administrative tasks via the GUI:
Configure admin account options
Configure syslog servers
Import JKS certificates
Install adapters
Upgrade Cisco ICFP
Manage licenses
Check system health
Monitor tasks
Specify debug levels
Download logs
You can reset the admin account password, specify how the Cisco ICFP menu should look when opening the GUI, and configure the amount of time that a session can remain inactive before it times out. For more information, see the following topics:
Use this procedure to change the password for the Cisco ICFP admin account for standalone and multiple-node clusters as follows:
To change the password for a standalone node, log in to the Cisco ICFP GUI for that node.
To change the password for a multiple-node cluster, log in to the Cisco ICFP GUI for the active primary node in the cluster.
Step 1 | In the Cisco ICFP toolbar, choose Admin. |
Step 2 | In the Admin Log In dialog box, enter the current credentials for logging in to the Cisco ICFP admin account and click Login. |
Step 3 | In the Admin Panel dialog box, click the Password tab. |
Step 4 | Enter the new password in the New Password and Confirm New Password fields, and click Apply. A success message indicates that the password has been successfully updated. |
Step 5 | Click Close. |
Step 6 | Log out of the Cisco ICFP GUI and log in again with the new password. |
Cisco ICFP enables you to set the following options for the Cisco ICFP GUI:
Whether the left menu is expanded or collapsed by default.
The number of minutes that a session can remain inactive before it times out.
Step 1 | In the Cisco ICFP toolbar, choose Admin. |
Step 2 | In the Admin Log In dialog box, enter the credentials for logging in to the Cisco ICFP admin account and click Login. |
Step 3 | In the Admin Panel dialog box, click the Settings tab. |
Step 4 | In the Menu state on startup field, indicate whether the left menu should be expanded or collapsed when you log in to the GUI. |
Step 5 | In the Session timeout in minutes field, enter the number of minutes that a session can remain inactive before the session times out. |
Step 6 | Click Save. A success message indicates that the settings have been successfully updated. |
Step 7 | Click Close. |
Step 8 | Log out of the Cisco ICFP GUI and log in again for the new settings to take effect. |
Cisco ICFP enables syslog by default and allows you to specify the severity of messages to be reported. In addition, Cisco ICFP enables you to forward log messages to a remote server instead of recording them in a local file or displaying them.
If you use remote syslog servers, obtain the IP addresses of the primary and secondary syslog servers.
Cisco ICFP enables you to import a Java KeyStore (JKS) file, which is a repository of certification authority (CA) security certificates used in SSL encryption.
You can use the Cisco ICFP GUI to install or upgrade an adapter.
Confirm that the adapter file is accessible from Cisco ICFP.
Step 1 | In the Cisco ICFP GUI, choose Upgrade Software and click the Upgrade Adapter icon. | ||||||||||||
Step 2 | In the Upgrade Adapter dialog box, provide the following information:
| ||||||||||||
Step 3 | Click Upload. | ||||||||||||
Step 4 | When prompted, click Yes to upload the adapter. | ||||||||||||
Step 5 | Restart services as follows:
For information about the ShellAdmin console, see Using Cisco ICFP ShellAdmin Commands. |
Cisco ICFP enables you to upgrade standalone appliances and multiple-node clusters for bug fixes and updated adapters. For more information, see the following topics:
Cisco ICFP 3.1.1 supports the following upgrade paths:
This procedure enables you to upgrade Cisco ICFP to a newer version and apply Cisco bug fixes on a standalone node. To upgrade a multiple-node cluster, see Upgrading a Multiple-Node Cluster.
Upgrading from Cisco ICFP version 2.3.1 to 3.1.1 automatically resets the admin account password to changeme. For information on changing the admin account password to another password, see Changing the Admin Account Password.
Obtain the Cisco ICFP upgrade file (icfp-upgrade-3.1.1.tar.gz) from Cisco.com. For assistance, contact your Cisco representative.
Confirm that the upgrade file is accessible from the Cisco ICFP virtual appliance.
Step 1 | In the Cisco ICFP GUI, choose Upgrade Software, and click the Upgrade Adapter icon. | ||||||||||||
Step 2 | In the Upgrade Adapter dialog box, provide the following information:
| ||||||||||||
Step 3 | When prompted, click Yes to confirm the upload. When upgrading from Cisco ICFP 2.3.1 to 3.1.1 or higher, a message is displayed stating that the upgrade will start in 2 minutes. After approximately 2 minutes, the upgrade is installed, the services automatically restart, and the GUI becomes unresponsive. | ||||||||||||
Step 4 | Finish the upgrade by refreshing the browser and logging in to the Cisco ICFP GUI. | ||||||||||||
Step 5 | To verify that
the upgrade was successful, click
About in the GUI toolbar and confirm that the
correct version is displayed.
Cisco ICFP displays the version, build number, build date, the last modification date, and the version hash value. |
If required, change the admin account password as described in Changing the Admin Account Password.
Use this procedure to upgrade a multiple-node cluster for bug fixes and updated adapters. To upgrade a standalone Cisco ICFP virtual appliance, see Upgrading a Standalone Node.
Upgrading from Cisco ICFP version 2.3.1 to 3.1.1 automatically resets the admin account password to changeme. For information on changing the admin account password to another password, see Changing the Admin Account Password.
This procedure applies to multiple-node clusters with the following components and configuration:
An HA pair that:
Consists of two Cisco ICFP virtual appliances configured with the Primary Node role.
Is configured with one active node and one standby node.
Additional Cisco ICFP virtual appliances that are configured as service nodes.
The workflow for upgrading a cluster includes the following high-level tasks:
Stop the virtual IP (VIP) service on the HA active node.
Monitor status while services fail over to the HA standby node.
Upgrade the current HA active node (originally the standby node).
Start the VIP service on the current HA standby node (originally the active node).
Stop the VIP service on the upgraded HA active node.
Monitor status while services fail over to the current HA standby node, making it the active node again.
Upgrade the current HA active node.
Start the VIP service on the current HA standby node.
Upgrade each service node.
If required, change the admin account password.
The following procedure describes how to perform these tasks.
Obtain the Cisco ICFP upgrade file (icfp-upgrade-3.1.1.tar.gz) from Cisco.com. For assistance, contact your Cisco representative.
Confirm that the upgrade file is accessible from the Cisco ICFP virtual appliance.
Confirm that HA has been configured on two Cisco ICFP virtual appliances that are configured with the Primary Node role.
Step 1 | Stop the VIP service on the HA active node as follows: | ||
Step 2 | Log in to the ShellAdmin console for the HA standby node. | ||
Step 3 | In the
ShellAdmin console for the standby node, choose
Display
Services Status to monitor the following events as they occur:
| ||
Step 4 | Upgrade the
currently active node of the HA pair as follows:
| ||
Step 5 | Verify that the HA active node was successfully upgraded as follows: | ||
Step 6 | Restart the VIP service on the current HA standby node as follows: | ||
Step 7 | Stop the VIP service on the currently active node that was upgraded in Step 4 as follows: | ||
Step 8 | Log in to the ShellAdmin console for the standby node in the HA pair. | ||
Step 9 | In the
ShellAdmin console for the standby node, choose
Display Services Status to monitor the following
events as they occur:
| ||
Step 10 | Upgrade the HA active node as follows: | ||
Step 11 | Restart the VIP service on the HA standby node as follows: | ||
Step 12 | Upgrade each
service node in the cluster as follows:
| ||
Step 13 | Verify that each service node upgraded successfully as follows: | ||
Step 14 | (Optional)If required, change the admin account password as described in Changing the Admin Account Password. |
Cisco ICFP is automatically installed with a 60-day evaluation license that supports 20 hybrid cloud units (HCUs). The topics in this section describe how to obtain a permanent license by using a Product Authorization Key (PAK), install a license file, update a license, and view license details.
A Cisco ICFP license is based on hybrid cloud units (HCUs). One or more HCUs are used for each VM running in the public cloud. A powered-off VM does not use any HCUs.
For Amazon Web Services and Microsoft Azure, two HCUs are used for each VM. For example, if the HCU count is ten, five VMs can run in the public cloud. For Cisco-powered providers, one HCU is used for each VM. For example, if the HCU count is ten, ten VMs can run in the public cloud.
Cisco ICFP includes the following types of licenses:
Evaluation License (ICFP-EVAL-EBD)—Cisco ICFP includes a 60-day, 20-HCU evaluation license that lets you try the software before you purchase permanent licenses. The evaluation period begins when you install the software and expires within 60 days of installation.
Permanent License (ICFP-CPC)—Permanent licenses have an expiration date. The license file specifies the number of licenses that you purchased. Contact your Cisco representative to purchase permanent licenses.
Partner License (ICFP-NFR-EBDS)—Partner (not for resale) licenses are available only to Cisco partners for demonstration and lab purposes. Partner licenses have an expiration date. The license file specifies the number of licenses that you purchased. Contact your Cisco representative to purchase partner licenses.
This workflow applies to all Cisco ICFP licenses except for the Cisco ICFP evaluation license. This workflow is not required for the 60-day evaluation license that is included with Cisco ICFP.
Before installing Cisco ICFP, locate your Cisco ICFP license and Product Authorization Key (PAK).
To purchase a license, contact your Cisco representative.
Register the PAK on the Cisco software license site.
For more information, see Generating a License Using a PAK.
Install Cisco ICFP.
For more information, see the Cisco Intercloud Fabric for Provider Installation Guide.
Upload the license in Cisco ICFP.
For more information, see Uploading a License.
Check license status.
For more information, see Viewing License Details.
Update the license.
To update an existing license, use the procedure for uploading a license.
This procedure describes how to generate a Cisco ICFP license by using a PAK.
Obtain the Cisco ICFP PAK.
Step 1 | In a browser, go to the Cisco Product License Registration page. This page offers training on assigning PAKs or tokens, and a link to the Cisco Product License Registration tool. |
Step 2 | Click Continue to Product License Registration. |
Step 3 | In the Product License Registration screen, enter the PAK number in the Get New Licenses field, and click Fulfill. |
Step 4 | In the Get New Licenses dialog box, provide the required information and click Submit. The status of your request is displayed, and a digital license agreement and a zipped license file are sent to the email address that you specified. |
Upload the license file in Cisco ICFP. For more information, see Uploading a License.
Use this procedure to upload a new license in Cisco ICFP or to update an existing license. To ensure continuous operation, be sure to update the license before the current license expires.
Obtain the Cisco ICFP license file. For more information, see Generating a License Using a PAK.
If you received a zipped license file by email, extract and save the .lic file to your local machine.
Step 1 | In the Cisco ICFP GUI, choose License and click the Upload License icon. |
Step 2 | In the dialog box, select the Cisco ICFP .lic file and click Upload. |
Step 3 | When prompted, click Yes to confirm the upload. After the license file is successfully processed, a success message is displayed. |
To view license details in the Cisco ICFP GUI, choose License.
The license details are displayed, including the license type, the license status, the number of HCUs supported, and the term of the license.
Cisco ICFP enables you to monitor the system health of standalone, primary, and service nodes as described in the following topics:
This procedure enables you to view the following information for Cisco ICFP nodes:
Node information, including the node type (such as standalone, primary, or service), status (active or inactive), name, IP address, and length of uptime.
Cisco ICFP version, build number, and build date.
JVM name and version.
Database status.
System memory capacity, amount used, and amount free.
System disk capacity, amount used, and amount free.
CPU load, number of CPUs, architecture, and operating system version.
Applications and their status.
The scope of the information that is displayed depends on the node that you use to check status:
If you log in to a standalone node, you can view system status for the standalone node only.
If you log in to a primary node in a multiple-node cluster, you can view system status for the primary node and each service node in the cluster.
If you log in to a service node in a multiple-node cluster, you can view the system status for that service node only.
Step 1 | In the Cisco ICFP GUI, choose System Health. |
Step 2 | Click Node Info for the required node.
The information that is displayed depends on the node you choose:
|
Step 3 | (Optional)Click Refresh to view updated information. |
You can use the Cisco ICFP GUI to monitor the tasks of each tenant.
Step 1 | In the Cisco ICFP GUI, choose Tenants Accounts. |
Step 2 | In the Tenant Accounts table, click the Accounts icon for the required tenant. |
Step 3 | In the User Statistics area, click the Tasks icon. All tasks for the tenant account are listed. |
In addition to specifying the level for syslog reporting (see Configuring Syslog Servers), you can specify the level of messages to be reported in Tomcat and Infra Manager logs.
Step 1 | In the Cisco ICFP GUI, choose . |
Step 2 | Click the Configure icon. |
Step 3 | In the Debug Configuration dialog box, choose the level of messages to be reported in Tomcat and Infra Manager logs:
|
Step 4 | Click Apply. |
Cisco ICFP enables you download the following logs:
CAPI Controller Log
CAPI Tomcat Log
Catalina Log
Database Log
HA Log
Install Log
MultiNode Log
Syslog Messsages Log
System Messages Log
If you choose a log that does not apply to your environment (for example, if you choose the HA Log but HA is not configured in your environment), Cisco ICFP generates and downloads all logs except the log that does not apply.
Step 1 | In the Cisco ICFP GUI, choose . |
Step 2 | Click the Add icon for each log that you want to download and click Download. A zipped file containing all requested logs that apply to your environment is downloaded to your system. |
A cloud instance has a unique identifier that binds the back-end cloud URI to a southbound adapter that is installed by the service provider. Multiple back-end URIs can have multiple cloud instances. A tenant is a part of a single cloud instance. The following topics describe how to manage cloud instances by using the Cisco ICFP GUI.
You can use the Cisco ICFP GUI to add, or provision, a cloud instance.
Step 1 | In the Cisco ICFP GUI, choose Cloud Instances and click the Add Cloud Instance icon. | ||||||||||||||||||||||||
Step 2 | In the New Cloud Instance dialog box, provide the following information and click Create:
|
You can use the Cisco ICFP GUI to view cloud instance details.
Step 1 | In the Cisco ICFP GUI, choose Cloud Instances. Cisco ICFP displays the cloud instance name, type, module, and endpoint URI for each cloud instance. |
Step 2 | To view parameter details, click Edit for the required cloud instance.
The Edit Cloud Instance dialog box is displayed with the configured parameters. |
You can use the Cisco ICFP GUI to edit the cloud instance endpoint URI and parameters. The cloud instance name, type, and module cannot be changed.
Step 1 | In the Cisco ICFP GUI, choose Cloud Instances. | ||||||||||||||||||||||||
Step 2 | Choose the required cloud instance and click Edit. | ||||||||||||||||||||||||
Step 3 | In the Edit Cloud Instance dialog box, update the following information as needed and click Update:
|
You can use the Cisco ICFP GUI to delete a cloud instance.
The following topics describe how to add, edit, and delete tenant accounts, and view tenant account details by using the Cisco ICFP GUI.
After you create a cloud instance, you can create a tenant account on the cloud.
For a CloudStack cloud instance, you must obtain the API Key and Secret Key for the tenant account before adding the account. After the tenant account is created, Cisco ICFP generates a Pass Key, which is available in the tenant Account Information screen ( ). This Pass Key is required by Cisco Intercloud Fabric when configuring a cloud. For more information, see the Cisco Intercloud Fabric documentation on Cisco.com.
For an OpenStack cloud instance, you need additional information depending on the support enabled in the cloud:
Confirm that the required cloud instance has been created.
Depending on the type of cloud instance, obtain the following information:
Cloud Instance Type |
Requirement |
---|---|
CloudStack |
The API Key and Secret Key for the tenant. For more information, see the Apache CloudStack documentation. |
OpenStack |
For more information, see the OpenStack documentation. |
VMware vCloud Director |
The name of the organization for the tenant. For more information, see the VMware vCloud Director documentation. |
Step 1 | In the Cisco ICFP GUI, choose Tenant Accounts and click the Add Tenant Account icon. | ||||||||||||||||||||||||||
Step 2 | In the New Tenant Account dialog box, provide the following information and then click Create:
|
You can edit an existing tenant account by using the Cisco ICFP GUI.
You can edit the maximum number of servers, the tenant account email address, and parameters. For tenants using a CloudStack cloud, you can also edit the API Key and Secret Key. The other fields are display-only.Step 1 | In the Cisco ICFP GUI, choose Tenants Accounts. | ||||||||||||||||||||||||||
Step 2 | Choose the required tenant and click Edit. | ||||||||||||||||||||||||||
Step 3 | In the Edit Tenant Account dialog box, update the information as needed and then click Update:
|
You can use the Cisco ICFP GUI to delete or purge a tenant account:
If you delete a tenant account:
The tenant account remains in the GUI with the state Deleted.
The tenant account resources remain in the Cisco ICFP database.
If you purge a tenant account:
The tenant account is removed from the GUI.
All tenant account resources are removed from the Cisco ICFP database.
Step 1 | In the Cisco ICFP GUI, choose Tenant Accounts. |
Step 2 | Choose the tenant account that you want to delete or purge, and then do one of the following:
|
You can use the Cisco ICFP GUI to view tenant account details.
Step 1 | In the Cisco ICFP GUI, choose Tenants Accounts. |
Step 2 | Choose the required tenant and click Accounts. The following information is displayed:
|
You can use the Cisco ICFP GUI to monitor tenant accounts.
Step 1 | In the Cisco ICFP GUI, choose Tenant Accounts. |
Step 2 | Click the Accounts icon for the required tenant account. The row expands to display information about the account, VMs, and user statistics. |
Step 3 | Under User Statistics, click VMs, Tasks, or Faults to view detailed information about each of these items. |