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.
Cisco ICFPP enables you to perform a number of common administrative tasks via the GUI, such as managing licenses, monitoring tasks, and accessing reports and logs.
Cisco ICFPP enables syslog by default and allows you to specify the severity of messages to be reported. In addition, Cisco ICFPP enables you to forward log messages to a remote server instead of recording them in a local file or displaying them.
If you are using remote syslog servers, obtain the IP addresses of the primary and secondary syslog servers.
Cisco ICFPP enables you to import a Java KeyStore (JKS) file, which is a repository of certification authority (CA) security certificates used in SSL encryption.
Step 1 | In the Cisco ICFPP GUI, choose and click the Certificate Setup tab. |
Step 2 | Click Upload. |
Step 3 | In the Upload Certificate in JKS Format dialog box, in the Keystore File field, browse to and choose the JKS file. |
Step 4 | Click Upload. |
Step 5 | After the file has uploaded, enter the password in the Keystore Password field and click Submit. |
You can use the GUI to install or upgrade an adapter.
Confirm that the adapter file is accessible from Cisco ICFPP.
Step 1 | In the Cisco ICFPP GUI, choose Install. | ||||||||||
Step 2 | In the Adapters pane, click Install. | ||||||||||
Step 3 | In the
Install
Adapter dialog box, provide the information as described in the
following table:
| ||||||||||
Step 4 | Click Upload. The file is uploaded to Cisco ICFPP. | ||||||||||
Step 5 | After the file is uploaded, click Submit. | ||||||||||
Step 6 | Restart services as follows: |
Cisco ICFPP enables you to upgrade standalone appliances and multiple-node clusters for bug fixes and updated adapters. For more information, see the following topics:
Beginning with version 2.3.1, Cisco ICFPP includes a feature that automatically restarts Infra services when you upgrade Cisco ICFPP.
The first time that you upgrade Cisco ICFPP from 2.2.1 or 2.2.1a to 2.3.1 or higher, you must manually restart services. After you restart Infra services, the automatic service restart feature is enabled and you do not need to restart Infra services when you next upgrade Cisco ICFPP.
This procedure enables you to apply Cisco bug fixes and upgrade adapters on a standalone node. To upgrade a multiple-node cluster, see Upgrading a Multiple-Node Cluster.
Step 1 | In the Cisco ICFPP GUI, choose , and click Install. | ||||||||||
Step 2 | In the
Install
Adapter dialog box, provide the information as described in the
following table and then click
Upload:
| ||||||||||
Step 3 | If you are upgrading from Cisco ICFPP 2.2.1 or 2.2.1a to Cisco ICFPP 2.3.1 or higher, complete the following steps: | ||||||||||
Step 4 | If you are upgrading from Cisco ICFPP 2.3.1 to a higher version, a message is displayed stating that the upgrade will start in two minutes. After approximately two minutes, the upgrade is installed, the services automatically restart, and the GUI becomes unresponsive. To finish the upgrade, refresh the browser and log in to the Cisco ICFPP GUI. | ||||||||||
Step 5 | To verify that
the upgrade was successful, click
About in the GUI toolbar and confirm that the
correct version is displayed.
The Product Version field displays the version using the format version-build-patch where:
For example, you might see the version 2.3.1-204-p208. |
Use this procedure to upgrade a multiple-node cluster for bug fixes and updated adapters. To upgrade a standalone Cisco ICFPP virtual appliance, see Upgrading a Standalone Node.
This procedure applies to multiple-node clusters with the following components and configuration:
An HA pair consisting of two Cisco ICFPP virtual appliances that are configured as primary nodes.
The HA pair is configured with one active node and one standby node.
Additional Cisco ICFPP virtual appliances 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.
The following procedure describes how to perform these tasks.
Obtain the Cisco ICFPP upgrade file (icfpp-upgrade-2.3.1.tar.gz) from Cisco.com. For assistance, contact your Cisco representative.
Confirm that HA has been configured on two Cisco ICFPP 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 | Do one of the
following, depending on the
Cisco ICFPP
version:
| ||
Step 6 | Verify that
the HA active node was successfully upgraded as follows:
| ||
Step 7 | Restart the VIP service on the current HA standby node as follows: | ||
Step 8 | Stop the VIP service on the currently active node that was upgraded in Step 4 as follows: | ||
Step 9 | Log in to the ShellAdmin console for the standby node in the HA pair. | ||
Step 10 | In the
ShellAdmin console for the standby node, choose
Display Services Status to monitor the following
events as they occur:
| ||
Step 11 | Upgrade the HA active node as follows: | ||
Step 12 | Restart the VIP service on the HA standby node as follows: | ||
Step 13 | Upgrade each
service node in the cluster as follows:
| ||
Step 14 | Verify that
each service node upgraded successfully as follows:
|
Cisco ICFPP is installed with an evaluation license and support for 20 VMs. The topics in this section describe how to update a license and view license details.
Confirm that the license file is accessible from Cisco ICFPP.
After you install Cisco ICFPP, you can view license details at any time to confirm the term of the license, view the number of VMs supported, and obtain the license identifier.
You can use the Cisco ICFPP GUI to monitor the tasks of the tenants.
In the Cisco ICFPP GUI, choose Tenants and then click the Tasks tab.
The Tasks pane displays the details and status of all tasks for the tenants.You can use Cisco ICFPP logs to debug issues, collect system information, and review detailed information related to HA or cluster environments. For more information, see the following topics:
Cisco ICFPP can provide general or detailed system information, and can assist in troubleshooting issues. This information is also helpful if you need to contact Cisco for technical support.
Step 1 | In the Cisco ICFPP GUI, choose . | ||||||||||||
Step 2 | From the
Support
Information drop-down list, choose the required option as described
in the following table:
|
Cisco ICFPP enables you to download the following logs associated with HA and cluster environments:
Infra Manager log
MySQL log
Apache Catalina log
OpenAPI log
Scalability log
HA log
Install log
Cisco ICFPP syslog messages log
System messages log
If you select a log that is not applicable to your environment (for example, if you choose the HA log but HA is not configured in your environment), Cisco ICFPP generates and downloads all logs except the one that does not apply.
Cisco ICFPP reports are available from the GUI in three formats: Tabular, Historical, and Snapshot. Cisco ICFPP dynamically updates the lists of the reports that are available to you and provides graphic renderings of each type of report. For each context, a different set of reports (each identified by a reportId) is available.
The available reports are:
Tenant report
Cloud instance report
Virtual machine report
Adapters report
Faults report
System tasks report
To generate a report:
Step 1 | In the Cisco ICFPP GUI, navigate to the required object type. For example, to generate a VM report, you would choose , and click the VM tab. |
Step 2 | In the toolbar, click Export Report. |
Step 3 | In the Export Report dialog box, choose the required report format (PDF, CSV, or XLS) and click Generate Report. |
Step 4 | After the report has been generated, click Download. |
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 ICFPP GUI.
You can use the Cisco ICFPP GUI to add, or provision, a cloud instance.
Step 1 | In the Cisco ICFPP GUI, choose Cloud Instances. | ||||||||||||||||
Step 2 | In the Cloud Instances pane, click Add. | ||||||||||||||||
Step 3 | In the Add Cloud
Instance dialog box, provide the following information, and then
click
Add:
|
You can use the Cisco ICFPP GUI to view a cloud instance's details.
You can use the Cisco ICFPP GUI to edit a cloud instance.
Step 1 | In the Cisco ICFPP GUI, choose Cloud Instances. | ||||||||||||||
Step 2 | In the Cloud Instances pane, choose a cloud instance and click Edit. | ||||||||||||||
Step 3 | In the
Edit
Cloud Instance dialog box, update the following information as
needed and click
Save:
|
You can use the Cisco ICFPP GUI to delete a cloud instance.
The following topics describe how to add, edit, delete, and view tenants by using the Cisco ICFPP GUI.
After you create a cloud instance, you can add a tenant on the cloud.
For a CloudStack cloud instance, you must obtain the API Key and Secret Key for the tenant before adding the tenant. After the tenant is created, Cisco ICFPP generates a Pass Key, which is available in the View Tenant dialog box ( ). This Pass Key is required by Cisco Intercloud Fabric Director when configuring a cloud. For more information, see the Cisco Intercloud Fabric User Guide.
Confirm the following:
A cloud has been created to which the tenant can be assigned.
For a VMware vCloud Director cloud instance, you have the name of the organization for the tenant. For more information, see the VMware vCloud Director documentation.
For a CloudStack cloud instance, you have the API Key and Secret Key for the tenant. For more information, see the Apache CloudStack documentation.
Step 1 | In the Cisco ICFPP GUI, choose Tenants and click the Accounts tab. | ||||||||||||||||||||||||||
Step 2 | Click Add. | ||||||||||||||||||||||||||
Step 3 | In the
Add
Tenant dialog box, provide the information as described in the
following table, and then click
Add:
|
You can edit existing tenants by using the Cisco ICFPP GUI.
Step 1 | In the Cisco ICFPP GUI, choose Tenants and click the Accounts tab. | ||||||||||||||||||||||||||
Step 2 | In the Accounts pane, choose a tenant and click Edit. | ||||||||||||||||||||||||||
Step 3 | In the
Edit Tenant dialog box, update the information
as needed and then click
Save:
|
You can use the Cisco ICFPP GUI to delete a tenant.
Step 1 | In the Cisco ICFPP GUI, choose Tenants. |
Step 2 | In the Accounts tab, choose the tenant that you want to delete, and then click Delete. |
Step 3 | In the
Delete
Tenant dialog box:
|
You can use the Cisco ICFPP GUI to view a tenant's details.
You can use the Cisco ICFPP GUI to monitor tenant VMs.
In the Cisco ICFPP GUI, choose Tenants and then click the VM tab.
The VM pane displays the details and status of all tenant VMs.