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.
The OVA installation will install all the Virtual Appliance components on different nodes. The nodes should be deployed in the same order as shown in the Virtual Appliance prompt. You can also add additional Prime Service Catalog nodes to set up a cluster for failover.
Open the VM's Console in your vSphere Client. The VM console will display the following prompts:
Prepare the Virtual Appliance for deployment. For more information, see Preparing the Virtual Appliance for Deployment..
Use this procedure to set up a Prime Service Catalog node.
Prepare the
Virtual Appliance for deployment. For more information, see
Preparing
the Virtual Appliance for Deployment..
Set up the
database node and ensure that it is up and running. For information on setting
up a database node, see
Installing
Prime Service Catalog Database Node..
The installation of the Prime Service Catalog Virtual Appliance is completed.
After the installation is complete, RabbitMQ Cluster connection is added automatically. This configuration can be verified in Integrations > Internal > RabbitMQ Server. For more information on RabbitMQ server see section Accessing RabbitMQ Server.
What to Do Next
Proceed to the Installing Prime Service Catalog Cluster Node.
Prepare the
Virtual Appliance for deployment. For more information, see
Preparing
the Virtual Appliance for Deployment.
Set up the
database node and ensure that it is up and running. For information on setting
up a database node, see
Installing
Prime Service Catalog Database Node.
Install the
Prime service Catalog node and ensure that it is up and running. For more on
installing a Prime Service Catalog node, see
Installing Prime Service Catalog Node.
Make sure that
root login is enabled on the Prime Service Catalog Primary node. You can enable
the root login through shell admin menu. For more information, see
Launching
Shell Menu.
Make sure that
all the Firewall ports for services such as Service Link, Domain Controller,
and Prime Service Catalog Application Management Port are open. You can enable
these ports through shell admin menu. For more information on Shell Menu, see
Launching
Shell Menu.
The installation of the Prime Service Catalog Virtual Appliance Cluster is completed.
What to Do Next
Proceed to the Installing the Guacamole Node.
This is an optional node in case you want to integrate Guacamole server with Prime Service Catalog. For detailed information see section Integrating Guacamole Server with Prime Service Catalog in Cisco Prime Service Catalog Administration and Operation Guide.
The installation of the Guacamole server is completed.
After the installation is complete, Guacamole server connection is added automatically. This configuration can be verified in Integrations > Internal > Guacamole Server.
What to Do Next
Proceed to Post Installation Tasks section to perform the additional configuration tasks, which are required if you plan to use more advanced features of Prime Service Catalog .
This section consists of the following sub-sections:
The Shell Menu allows you to perform various administrative tasks for the Virtual Appliance such as configuring SMTP setting, configuring Proxy server, changing passwords, starting and stopping services on the Linux operating system, etc.
Login to the Virtual Appliance as the shelladmin user. You can do this via the VM Console in your vSphere Client, or via an SSH connection to the IP address of the VM. On the Login Prompt, type shelladmin for the user name, and type the password value that you provided in Step 2 e of the Installing the Prime Service Catalog Node section. Once logged in, you will see the Shell Menu depending upon the type of installation. Following is the list of commands that appears in a Shell Menu for different types of installation. For details on these prompts, see the table below.
The following table contains the descriptions of all the menu items available on the Shell Menu:
Note | For some of the menu items, you may be presented with a list of choices to select. If you don’t see any choices that you want and you want to get back to the previous menu, press Control-C (Ctrl+C). |
Menu |
Description |
---|---|
Manage Users |
This menu option allows you to enable or disable root access to CentOS, and to set the password for the root user. It also allows you to change the System Passwords for the Virtual Appliance, shelladmin, Cisco Prime Service Catalog Admin and RabbitMQ User. |
View Services Status |
This menu option displays the status (running or stopped) of all services on the VM that are related to the Prime Service Catalog. |
Stop Services |
This menu option allows you stop individual services on the VM, such as, Service Catalog, Service Link, Httpd, RabbitMQ, and Docker. |
Start Services |
This menu option allows you to start individual services on the VM. |
Manage Databases |
This menu option allows you to perform database backup, restore, upgrade previous version of Prime Service Catalog database, execute custom SQL on database, and update the data source. It also allows you change Oracle system password and Cisco Prime Service Catalog database user password. |
Manage Firewall |
This menu option allows you to open or close the TCP port numbers for certain services. |
Manage Network Interface |
This menu option allows you to view the existing network information and to configure the proxy server settings. Note: The Virtual Appliance is not required to have Internet access. If you want to have Internet access for the Virtual Appliance, and your network requires your VM to go through a proxy server to connect to the internet, use this menu to configure the proxy settings on your VM. |
Manage SMTP |
This menu option allows you to configure the SMTP server setting. |
Manage Cluster |
This menu option allows you to configure the Prime Service Catalog Cluster settings. |
View Logs |
This menu option allows you to view the runtime logs of various services on the VM. |
System Information & Cisco Support |
This menu option allows you to view the system information and send system information to Cisco Support by selecting appropriate sub-menu options: |
Manage Packages and Patches |
This menu option allows you to install a patch for the appliance, should there be a patch released by Cisco in the future for this version of the Virtual Appliance. |
Manage Docker Applications |
This menu application allows you to view Guacamole containers status and start/stop Guacamole containers. |
Login as Root |
This menu option allows you to login to Linux as the root user. You must first enable the root access via Shell Menu Manage Users option. |
Shutdown Appliance |
This menu option shuts down the Linux operating system and power off the VM. |
Reboot Appliance |
This menu option reboots the Linux operating system. |
Quit |
This menu option logs you out of Linux and returns you to the Linux Login Prompt. |
The Prime Service Catalog service needs to connect to an SMTP server for all outbound emails. To configure the SMTP server:
If your VM must go through a proxy server to connect to the internet, do the following on the Shell Menu:
Manage Packages and Patches has the following sub-menu options:
To be able to download the Cisco VA patch files from cisco.com you would need to request access to the repository. The sub menu Send Request for Repository Access sends an email requesting access for the required user.
If your Prime Service catalog VA must be updated with patches, you must enable the cisco repository that contains the latest packages.
You must have
valid Cisco account.
You must have
access to package repository. For more information on requesting access, see
section
Requesting
Access to Repository.
You must
configure proxy server settings.
To configure
proxy settings, select Manage Network Interface from the main menu and select
the Configure Proxy Settings option.
Step 1 | Select the option Manage Packages and Patches. |
Step 2 | Select the sub-menu option Enable/Update Cisco Package Repository. |
Step 3 | Enter the SSO Username and paste the API Key information from the clipboard. For information on Generating API Key, see Generate API Key Using SSO Login. |
Step 4 | Your repository is now enabled. |
To generate the API Key using the SSO login, perform the following:
Once you have access to the repository and downloaded the packages, you can update the System Packages or Prime Service Catalog Patches from the shell menu.
Ensure the database files are backed up. For more information on backing the old database, see Backing up the Database on Cisco Prime Service Catalog Virtual Appliance 11.0, 11.1, or 11.1.1.
This is an optional procedure, perform these steps only if you wish to replace the Self-Signed certificate with a new one.
The rabbitmq-management plugin is installed on each Prime Service Catalog (RabbitMQ) node during installation. This provides an HTTP-based API for management and monitoring of your RabbitMQ server, along with a browser-based UI and a command line tool, rabbitmqadmin.
The RabbitMQ web UI can be accessed using the URL: http://<serveIPaddress>:15672. Enter CPSCUSER in the User Name field, type the password value that you provided in Step 2e of section Installing the Prime Service Catalog Node.
The port 15672 is closed by default . You must manually open the port using the shelladmin menu: Manage Firewall > Open/Close RabbitMQ Management Port.