Explore Cisco
How to Buy

Have an account?

  •   Personalized content
  •   Your products and support

Need an account?

Create an account

Cisco Prime Service Catalog 11.1.1 Virtual Appliance Quick Start Guide

Available Languages

Download Options

  • PDF     (1.3 MB)
    View with Adobe Reader on a variety of devices
Updated:February 29, 2016

Bias-Free Language

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.

IntroductionBefore You BeginPreparing the Virtual Appliance for Deployment Installing Prime Service Catalog Virtual Appliance Performing Post Installation TasksConfiguring Prime Service Catalog Virtual Appliance With Cisco ONE Enterprise Cloud SuiteUpgrading the Cisco Prime Service Catalog Virtual ApplianceUninstalling Prime Service CatalogLimitations

Cisco Prime Service Catalog 11.1.1 Virtual Appliance Quick Start Guide

Contents

Introduction

Overview

Cisco Prime Service Catalog software is a self-service portal to order and manage any type of IT services from the data center to desktop. You can also order Infrastructure as a Service (IaaS) such as virtual machines, fenced containers, and VACS (if integrated with UCSD), and use Prime Service Catalog for lifecycle management of these entities.

Cisco Prime Service Catalog Virtual Appliance (OVF) package enables you to deploy Cisco Prime Service Catalog product as a Virtual Machine.

The Virtual Appliance comes with the following pre-installed and pre-configured software:

  • Red Hat Enterprise Linux Operating System, version 7.1

  • Red Hat OpenJDK , version 1.7.0_79

  • Apache HTTP Server , version 2.4.6

  • WildFly Application Server , version 8.2.0. Final

  • Oracle 12c Database Enterprise Edition , version 12.1.0.2

  • Puppet Master , version 3.8.1

  • Rabbit MQ, version 3.3.5

  • Prime Service Catalog (with Orchestration Service, and contents for applications), version 11.1.1

The Cisco Prime Service Catalog Quick Start Guide provides information on deploying and configuring Prime Service Catalog Virtual Appliance. For more information about using Prime Service Catalog, see the Cisco Prime Service Catalog 11.1.1 User Guide.

Contents

Before You Begin

System Requirements

  • The OVF file for Prime Service Catalog 11.1.1 Virtual Appliance can be deployed only in VMware vSphere version 5.x. To deploy the Prime Service Catalog OVF file, you need to open a vSphere Client and connect it to your VMware vCenter Server 5.x.

  • Make sure that your VMware vCenter Server has enough resources to accommodate the Virtual Appliance: 4 CPU, 8 GB of memory, 100 GB of disk space.


    Note

    If you plan to deploy the Cisco Prime Service Catalog Virtual Appliance in Complete mode (all components in a single VM), we recommend increasing the VM's CPU count to 8, and memory to 16 GB.

  • An SMTP server is highly desirable but not required. After deploying the OVF, you can enter the SMTP server setting via the Shell Menu, as described in the Installation Instructions. The SMTP server that you use must listen to port 25, and should not require authentication.

Licensing

Prime Service Catalog is part of the Cisco ONE Enterprise Cloud Suite. Cisco ONE Enterprise Cloud Suite is licensed on a per server basis.

Prime Service Catalog is also licensed to manage desktop, communications, bring your own devices, and other end-user service requests through a catalog of workplace services for employees. When licensed for workplace services, the Prime Service Catalog is licensed on a per user basis.

These use cases are licensed separately. The licenses are determined as follows:

  • Prime Service Catalog per server edition license is based on the number of servers managed by the product and Cisco ONE Enterprise Cloud Suite includes per server license.

  • Prime Service Catalog per user edition license is based on the number of users who are given permission to access the product.

If you choose to use Prime Service Catalog to manage both data center and workplace use cases you need to license both the per user and per server options. You may also discuss the Enterprise License Agreement (ELA) with your account manager.

Prime Service Catalog is also an integral part of Cisco Intelligent Automation for Cloud.

For more information about licensing contact your account manager.

Contents

Preparing the Virtual Appliance for Deployment

Procedure

    Step 1   Download the following zip files from cisco.com web site:

    • CPSC-virtual_appliance_v11.1.1_Part1.zip

    • CPSC-virtual_appliance_v11.1.1_Part2.zip

    • CPSC-virtual_appliance_v11.1.1_Part3.zip

    Step 2   Create a temporary directory that will contain the contents of the three zip files, for example, "C:\Temp\CPSC_11.1.1_VA".
    Step 3   Extract each of the three zip files into the directory created in the previous step, so that the contents of all three zip files are located in the same directory.
    Step 4   From vSphere Client, deploy the OVF file by navigating to the directory containing the extracted files, and select the file "cpsc-virtualappliance-11.1.1.53.ovf".
    Step 5   After the OVF is deployed as a VM in your VMware vCenter Server, power up the VM.

    Contents

    Installing Prime Service Catalog Virtual Appliance

    Using Cisco Prime Service Catalog 11.1.1 Virtual Appliance (OVF) package, you can deploy Cisco Prime Service Catalog in two modes:
    • Complete (All in One): This type of OVF installation performs a streamlined installation using default settings. All the Virtual Appliance components- Prime Service Catalog application, Prime Service Catalog Database, Puppet Master, and the Orchestration components are installed on a single appliance. For installation steps, see Installing Prime Service Catalog Virtual Appliance for a Complete (All-in-One) Setup.
    • Distributed: This type of OVF 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. For installation steps, see Installing Prime Service Catalog Virtual Appliance for a Distributed Setup.

    Installing Prime Service Catalog Virtual Appliance for a Complete (All-in-One) Setup

    Before You Begin

    • Prepare the Virtual Appliance for deployment. For more information, see Preparing the Virtual Appliance for Deployment.
    • After deploying the VA in your vCenter Server, make sure that you edit the VM and the change the specifications as:

      • Change the memory from 8 GB to 16 GB.

      • Change the CPU to "2 sockets, 4 core per socket" (total 8 CPU).

    Procedure
      Step 1   Open the VM's Console in your vSphere Client. VM console will display the following prompts:
      1. Do you want to configure DHCP or Static IP? Enter either the value dhcp or static.

        If you select DHCP address, make sure that your VM is using a VMware network portgroup that is connected to a DHCP sever.

        If you select Static IP address, you are prompted to enter the values for Static IP Address, Subnet Mask, Default Gateway, Primary DNS Address, and (optionally) Secondary DNS Address.

        You are prompted to confirm the values that you have entered before continuing.

      2. Appliance Hostname: Enter the hostname for your VM. You can enter a Fully Qualified Domain Name such as psc.mydomain.com, or a short hostname, such as psc. Hostname value must begin with an alphabetic character, and must contain only alphabetic characters, digits, hyphen, and period.
      3. Appliance Node Type: Choose option 1 - Complete to install Prime Service Catalog application, Prime Service Catalog Database, Puppet Master, and the Orchestration components on a single appliance.
      4. Password for System Components: Enter a common password that will be used for the following user(s):

        • Shelladmin user

        • Oracle system and sys users

        • Prime Service Catalog Database user

        • Prime Service Catalog Site Administrator

        • Prime Service Catalog service Orchestration user

        A valid password must conform to the following rule:

        • Is between 8 to 16 character long

        • Begins with an alphabetic character

        • Contains at least one upper-case character

        • Contains at least one lower-case character

        • Contains at least one digit

        • Contains at least one special character from the following list: ! ^ * - _

      5. Proxy for Accessing External Internet: Enter y or n depending on whether your virtual machine is using proxy for external internet access.

        After the value for the last prompt is entered, the VM will perform a series of tasks to boot up the Red Hat Enterprise Linux operating system,and configure the Prime Service Catalog services. This process may take up to 10 minutes to complete. Wait until you see the message on the screen, which says that the Cisco Prime Service Catalog Virtual Appliance initialization completed successfully. The message will also contain the URL for Cisco Prime Service Catalog, similar to the one shown below:

        The system will also show the details such as Host IP address, DB Port, DB Service Name and User Name for connecting to Prime Service Catalog Database, Puppet Master, and Orchestration components.

      Step 2   Open a supported web browser and connect to the Prime Service Catalog URL. You should see the Login screen.
      Step 3   To login as the Site Administrator user of Prime Service Catalog, type admin in the User Name field, type the password value that you provided in Step 1d in the Password field, and then click the Log In button. Once logged in, you should see the Service Catalog home page.

      The installation of the Prime Service Catalog Virtual Appliance is completed.

      After the installation is complete, the following configurations are performed automatically:
      • Puppet Master information is configured in the Administration module.

      • AMQP host will point to the Orchestration node.

      • AMQP port type for communicating with Rabbit MQ server will be set as SSL.

      These configurations can be verified in Administration > Settings > AMQP.

      What to Do Next

      Proceed to the 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.

      Installing Prime Service Catalog Virtual Appliance for a Distributed Setup

      In the Distributed setup of OVF installation, all the Virtual Appliance components are installed on different nodes. The nodes should be deployed in the same order as mentioned below. You can also add additional Prime Service Catalog nodes to set up a cluster for failover.

      Installing the Database Node

      Before You Begin

      Prepare the Virtual Appliance for deployment. For more information, see Preparing the Virtual Appliance for Deployment.

      Procedure
      Open the VM's Console in your vSphere Client. The VM console will display the following prompts:
      1. Do you want to configure DHCP or Static IP? Enter either the value dhcp or static.

        If you select DHCP address, make sure that your VM is using a VMware network portgroup that is connected to a DHCP sever.

        If you select Static IP address, you are prompted to enter the values for Static IP Address, Subnet Mask, Default Gateway, Primary DNS Address, and (optionally) Secondary DNS Address.

        You are prompted to confirm the values that you have entered before continuing.

      2. Appliance Hostname: Enter the hostname for your VM. You can enter a Fully Qualified Domain Name such as pscdb.mydomain.com, or a short hostname such as pscdb. Hostname value must begin with an alphabetic character, and must contain only alphabetic characters, digits, hyphen, and period.
      3. Appliance Node Type: Choose option 2 - Distributed to install Prime Service Catalog application, Prime Service Catalog Database, Prime Service Catalog Cluster Node, Puppet Master, and the Orchestration components on different appliances.
      4. Distributed Node Type: Choose option 1- Database Node to install Prime Service Catalog Database on a VM.
      5. Password for System Components: Enter a common password that will be used for the following user(s):

        • Shelladmin user

        • Oracle system and sys users

        A valid password must conform to the following rule:

        • Is between 8 to 16 character long

        • Begins with an alphabetic character

        • Contains at least one upper-case character

        • Contains at least one lower-case character

        • Contains at least one digit

        • Contains at least one special character from the following list: ! ^ * - _

        After the value for the last prompt is entered, the VM will perform a series of tasks to install and configure the Oracle database server. This process will take a few minutes to complete. Wait until you see the message on the screen, which says that the Database Node has been successfully initialized. The message will contain the details to access Prime Service Catalog database.

        The system will also show the details such as Host IP address, DB Port, DB Service Name, and User Name for connecting to Prime Service Catalog Database.


      What to Do Next

      Proceed to the Installing the Prime Service Catalog Node.

      Installing the Prime Service Catalog Node

      Before You Begin

      Procedure
        Step 1   Open the VM's Console in your vSphere Client. The VM console will display the following prompts:
        1. Do you want to configure DHCP or Static IP? Enter either the value dhcp or static.

          If you select DHCP address, make sure that your VM is using a VMware network portgroup that is connected to a DHCP sever.

          If you select Static IP address, you are prompted to enter the values for Static IP Address, Subnet Mask, Default Gateway, Primary DNS Address, and (optionally) Secondary DNS Address.

          You are prompted to confirm the values that you have entered before continuing.

        2. Appliance Hostname: Enter the hostname for your VM. You can enter a Fully Qualified Domain Name such as psc.mydomain.com, or a short hostname such as psc. Hostname value must begin with an alphabetic character, and must contain only alphabetic characters, digits, hyphen, and period.
        3. Appliance Node Type: Choose option 2 - Distributed to install Prime Service Catalog application, Prime Service Catalog Database, Prime Service Catalog Cluster Node, Puppet Master, and the Orchestration components on different appliances.
        4. Distributed Node Type: Choose option 2 - Prime Service Catalog Node to install Prime Service Catalog using an external database on a VM.
        5. Password for System Components: Enter a common password that will be used for the following user(s):

          • Shelladmin user

          • Prime Service Catalog Site Administrator user

          • JMS users

          A valid password must conform to the following rule:

          • Is between 8 to 16 character long

          • Begins with an alphabetic character

          • Contains at least one upper-case character

          • Contains at least one lower-case character

          • Contains at least one digit

          • Contains at least one special character from the following list: ! ^ * - _

          Note   

          Keep this password handy as this is the password for the Prime Service Catalog admin user and will be used while deploying the Orchestration node.

        6. Multicast IP Address: Enter a unique multicast IP address in your network environment, for use by Prime Service Catalog server.
        7. Multicast Port number: Enter a unique multicast port number in your network environment, for use by the Prime Service Catalog server.

          Note    If you plan to deploy multiple Prime Service Catalog nodes in a clustered configuration, ensure that you use the same Multicast Address and Port number for all the nodes.

        8. Database Hostname or IP address: Enter the IP address of the machine where database node was installed.
        9. Enter other database details such as the database port, Oracle service name, and the Oracle system user password.

          After the value for the last prompt is entered, the VM will perform a series of tasks to boot up the Red Hat Enterprise Linux operating system, and configure the Prime Service Catalog services. This process may take up to 10 minutes to complete. Wait until you see the message on the screen, which says that the Cisco Prime Service Catalog Virtual Appliance initialization completed successfully. The message will also contain the URL for Cisco Prime Service Catalog.

        Step 2   Open a supported web browser and connect to the Prime Service Catalog URL. You should see the Login screen.
        Step 3   To login as the Site Administrator user of Prime Service Catalog, type admin in the User Name field, type the password value that you provided in Step 1e in the Password field, and then click the Log In button. Once logged in, you should see the Service Catalog home page.
        What to Do Next

        Proceed to the Installing the Puppet Node.

        Installing the Puppet Node

        Before You Begin

        Procedure
        Open the VM's Console in your vSphere Client. The VM console will display the following prompts:
        1. Do you want to configure DHCP or Static IP? Enter either the value dhcp or static.

          If you select DHCP address, make sure that your VM is using a VMware network portgroup that is connected to a DHCP sever.

          If you select Static IP address, you are prompted to enter the values for Static IP Address, Subnet Mask, Default Gateway, Primary DNS Address, and (optionally) Secondary DNS Address.

          You are prompted to confirm the values that you have entered before continuing.

        2. Appliance Hostname: Enter the hostname for your VM. You can enter a Fully Qualified Domain Name such as puppet.mydomain.com, or a short hostname such as puppet. Hostname value must begin with an alphabetic character, and must contain only alphabetic characters, digits, hyphen, and period.
        3. Appliance Node Type: Choose option 2 - Distributed to install Prime Service Catalog application, Prime Service Catalog Database, Prime Service Catalog Cluster Node, Puppet Master, and the Orchestration components on different appliances.
        4. Distributed Node Type: Choose option 3 - Puppet Master to install Puppet Master on a VM.
        5. Password for System Components: Enter a common password that will be used for the following user(s):

          • Shelladmin user

          A valid password must conform to the following rule:

          • Is between 8 to 16 character long

          • Begins with an alphabetic character

          • Contains at least one upper-case character

          • Contains at least one lower-case character

          • Contains at least one digit

          • Contains at least one special character from the following list: ! ^ * - _

          After the value for the last prompt is entered, the VM will perform a series of tasks to install the Puppet Master files. This process may take few minutes to complete. Wait until you see the message on the screen, which says that the Puppet Node has been successfully initialized.


        What to Do Next

        Proceed to the Installing the Orchestration Node.

        Installing the Orchestration Node

        Before You Begin

        • Prepare the Virtual Appliance for deployment. For more information, see Preparing the Virtual Appliance for Deployment .

        • Make sure that the database, Prime Service Catalog, and the Puppet Master nodes are up and running.


          Note
          Make sure that the root user is enabled on both the Prime Service Catalog and the Puppet Master nodes. To enable root user, use the Shell Menu called Manage Users on each Node. For information on Shell Menu, see Launching Shell Menu.

        Procedure
        Open the VM's Console in your vSphere Client. The VM console will display the following prompts:
        1. Do you want to configure DHCP or Static IP? Enter either the value dhcp or static.

          If you select DHCP address, make sure that your VM is using a VMware network portgroup that is connected to a DHCP sever.

          If you select Static IP address, you are prompted to enter the values for Static IP Address, Subnet Mask, Default Gateway, Primary DNS Address, and (optionally) Secondary DNS Address.

          You are prompted to confirm the values that you have entered before continuing.

        2. Appliance Hostname: Enter the hostname for your VM. You can enter a Fully Qualified Domain Name, such as orchestration.mydomain.com, or a short hostname, such as orchestration. Hostname value must begin with an alphabetic character, and must contain only alphabetic characters, digits, hyphen, and period.
        3. Appliance Node Type: Choose option 2 - Distributed to install Prime Service Catalog application, Prime Service Catalog Database, Prime Service Catalog Cluster Node, Puppet Master, and the Orchestration components on different appliances.
        4. Distributed Node Type: Choose option 4 - Orchestration Node to install the Orchestration component on a VM.
        5. Password for System Components: Enter a common password that will be used for the following user(s):

          • Shelladmin user

          • Prime Service Catalog Service Orchestration user

          • RabbitMQ user

          A valid password must conform to the following rule:

          • Is between 8 to 16 character long

          • Begins with an alphabetic character

          • Contains at least one upper-case character

          • Contains at least one lower-case character

          • Contains at least one digit

          • Contains at least one special character from the following list: ! ^ * - _

        6. Enter the following details for other nodes as shown below:

          • Database Host or IP address

          • Database Port

          • Oracle Service Name

          • Prime Service Catalog Database Username and Password

          • Prime Service Catalog Hostname or IP address

          • Prime Service Catalog host root password

          • Prime Service Catalog Site Administrator password

          • Puppet Master hostname or IP address

          • Puppet Master host root password

          After the value for the last prompt is entered, the VM will perform a series of tasks to initialize the Orchestration node, and start the orchestration services. This process may take a few minutes to complete. Wait until you see the message on the screen, which says that the Orchestration node has been successfully initialized. The message will contain the details to access Orchestration node.


        What to Do Next

        Proceed to the Installing Prime Service Catalog Cluster Node section if you want to configure a clustered environment for Prime Service Catalog .

        Installing Prime Service Catalog Cluster Node

        Use the procedure detailed here only if you want to configure a clustered environment for Prime Service Catalog. In this section, you will deploy the OVF file for a second Prime Service Catalog Node, that will act as a secondary cluster node. The first Prime Service Catalog Node that you already have will act as the primary cluster node.
        Before You Begin

        • 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.

        Procedure
          Step 1   Open the VM's Console in your vSphere Client. The VM console will display the following prompts:
          1. Do you want to configure DHCP or Static IP? Enter either the value dhcp or static.

            If you select DHCP address, make sure that your VM is using a VMware network portgroup that is connected to a DHCP sever.

            If you select Static IP address, you are prompted to enter the values for Static IP Address, Subnet Mask, Default Gateway, Primary DNS Address, and (optionally) Secondary DNS Address.

            You are prompted to confirm the values that you have entered before continuing.

          2. Appliance Hostname: Enter the hostname for your VM. You can enter a Fully Qualified Domain Name such as psc.mydomain.com, or a short hostname such as psc. Hostname value must begin with an alphabetic character, and must contain only alphabetic characters, digits, hyphen, and period.
          3. Appliance Node Type: Choose option 2 - Distributed to install Prime Service Catalog application, Prime Service Catalog Database, Prime Service Catalog Cluster Node, Puppet Master, and the Orchestration components on different appliances.
          4. Distributed Node Type: Choose option 5 - Service Catalog Cluster Node to install the additional Prime Service Catalog Cluster Node on a VM.
          5. Prime Service Catalog Cluster Node:Choose option 1 - PSC Cluster Node 2 to set up a two node cluster. If you want to set up a three node cluster, then execute the option 2 - PSC Cluster Node 3.
          6. Domain Controller Hostname or IP address: Enter the IP address of the machine where domain controller is installed.
          7. Domain Controller Password: Enter the password to access the domain controller node.
          8. Enter the root password for Prime Service Catalog Domain Controller node.
          9. Multicast IP Address: Enter the same multicast IP address used by the Prime Service Catalog primary node.
          10. Multicast Port number: Enter the same multicast port number used by the Prime Service Catalog primary node.
            Note    Make sure that you enter the same Multicast IP Address and Port number as those entered for the Prime Service Catalog primary node.
          Step 2   The Prime Service Catalog Node that you just deployed is the secondary cluster node. You must go back to the primary cluster node, and add the information of the second Prime Service Catalog Node to the load balancer. To do this, log in as shelladmin user on the first Prime Service Catalog Node, and choose the Manage Cluster shell menu. For more information on how to use the shell menu, see Launching Shell Menu.
          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 .

          Contents

          Performing Post Installation Tasks

          This section consists of the following sub-sections:

          Launching Shell Menu

          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 1d of the Installing Prime Service Catalog 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.

          Complete (All-in-One) Installation Shell Menu Options
          • Manage Users
          • Display Service Status
          • Stop Services
          • Start Services
          • Manage Databases
          • Manage Firewall
          • Manage Puppet Master
          • View/Configure Network Interface
          • View/Configure SMTP
          • View Logs
          • Show Version
          • Install Applications and Patch
          • Login as Root
          • Shutdown Appliance
          • Reboot Appliance
          • Quit
          Database Node Shell Menu Options
          • Manage Users
          • Display Service Status
          • Stop Services
          • Start Services
          • Manage Databases
          • View/Configure Network Interface
          • View Logs
          • Show Version
          • Apply Patch
          • Login as Root
          • Shutdown Appliance
          • Reboot Appliance
          • Quit
          Prime Service Catalog Node Shell Menu Options
          • Manage Users
          • Display Service Status
          • Stop Services
          • Start Services
          • Manage Firewall
          • View/Configure Network Interface
          • View/Configure SMTP
          • View Logs
          • Show Version
          • Apply Patch
          • Login as Root
          • Shutdown Appliance
          • Reboot Appliance
          • Quit
          Puppet Node Shell Menu Options
          • Manage Users
          • Display Service Status
          • Stop Services
          • Start Services
          • Manage Puppet Master
          • View/Configure Network Interface
          • View Logs
          • Show Version
          • Apply Patch
          • Login as Root
          • Shutdown Appliance
          • Reboot Appliance
          • Quit
          Orchestration Node Shell Menu Options
          • Manage Users
          • Display Service Status
          • Stop Services
          • Start Services
          • View/Configure Network Interface
          • Manage Data Source
          • View Logs
          • Show Version
          • Apply Patch
          • Login as Root
          • Shutdown Appliance
          • Reboot Appliance
          • Quit

          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 Linux, and to set the password for the root user. It also allows you to change the System Passwords for the Virtual Appliance.

          Display 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, Prime Service Catalog Services, Orchestration Services, Prime Service Catalog, Prime Service Link, and so on.

          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.

          Manage Firewall

          This menu option allows you to open or close the TCP port numbers for certain services.

          Manage Puppet Master

          This menu option allows you to view the Puppet Master certificate.

          View/Configure 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.

          View/Configure SMTP

          This menu option allows you to configure the SMTP server setting.

          View Logs

          This menu option allows you to view the runtime logs of various services on the VM.

          Show Version

          This menu option displays the version information for the Prime Service Catalog product and its related components.

          Apply Patch

          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.

          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.

          Configuring SMTP

          The Prime Service Catalog service needs to connect to an SMTP server for all outbound emails. To configure the SMTP server:

          Procedure
            Step 1   From the Shell Menu, select option View/Configure SMTP.
            Step 2   Select the sub-menu option Configure SMTP. You will be prompted to enter the Fully Qualified Domain Name (or the IP address) of the SMTP server, and a valid Support Email Address. Press Enter to continue to configure the SMTP.

            Configuring Proxy Server Settings

            If your VM must go through a proxy server to connect to the internet, do the following on the Shell Menu:

            Procedure
              Step 1   Select the option View/Configure Network Interface.
              Step 2   Select the sub-menu option Configure Proxy Settings. You will be prompted with several questions regarding your proxy server. The system will reconfigure the appliance to use the proxy settings that you have entered.
              Step 3   To verify the proxy settings, select the sub-menu option View Proxy Settings. Otherwise, select the sub-menu option Return to Previous Menu to get back to the main Shell Menu screen.

              Contents

              Configuring Prime Service Catalog Virtual Appliance With Cisco ONE Enterprise Cloud Suite

              Procedure
                Step 1   Log in to Prime Service Catalog as Site Administrator.
                Step 2   Go to the Service Link module and ensure that the UCSD Agent is up and running.
                Step 3   Go to Service Designer > Services.
                Step 4   Expand the Reserved Services folder, and then click the UCSD Application Template Service template.
                Step 5   Choose Plan, and then click the Publish HeatTemplate task. The task details appear in the lower pane.
                Step 6   In the General tab, choose the workflow type, and then click the … button. A dialog box appears.
                Step 7   Choose a public key, and then click Save.
                Step 8   Go to Administration > Settings.
                Step 9   Enable the UCSD Scheduler option, and then click Update.

                Contents

                Upgrading the Cisco Prime Service Catalog Virtual Appliance

                You can upgrade from 11.0 to 11.1.1 and 11.1 to 11.1.1. Only these two upgrade paths are supported.

                To upgrade to Cisco Prime Service Catalog Virtual Appliance 11.1.1, you must perform a migration process rather than an in-place upgrade. This is because many third-party components have changed in version 11.1.1, such as the Operating System, OpenStack, RabbitMQ, Orchestration, and so on. Therefore, you must deploy a new 11.1.1 virtual appliance prior to migrating the existing 11.0 or 11.1 virtual appliance. For instructions to deploy Cisco Prime Service Catalog Virtual Appliance 11.1.1, see Installing Prime Service Catalog Virtual Appliance.

                At a high level, the upgrade procedures are as follows:

                Table 1 High-Level Upgrade Procedures

                Step 1

                Disable the UCS Director automatic polling flag. This setting should be disabled on the Prime Service Catalog 11.0 or 11.1 virtual appliance set up .

                Go to Administration > Settings and disable the UCSD Scheduler option.

                Step 2

                Back up the database on 11.0 or 11.1 virtual appliance.

                See Backing Up the Database on 11.0 or 11.1 Virtual Appliance

                Step 3

                Installing a new 11.1.1 Virtual Appliance.

                See Installing Prime Service Catalog Virtual Appliance

                Step 4

                Upgrade the database from 11.0 or 11.1 virtual appliance to 11.1.1 virtual appliance. You can either manually copy the database from the backup in Step 2 or you can let the system copy it from the remote location using the shell menu option.

                See Upgrading to the latest Virtual Appliance Database

                Step 5

                Perform the post upgrade steps to complete the upgrade/migration process.

                See Performing the Post-upgrade Tasks

                Backing up the Database on Cisco Prime Service Catalog Virtual Appliance 11.0 or 11.1

                Procedure
                  Step 1   Login to the Virtual Appliance as the shelladmin user and the password that you had provided while Installing Prime Service Catalog Virtual Appliance 11.1. Once logged in, you will see the Shell Menu.
                  Step 2   Back up database. Select Manage Databases > Backup Prime Service Catalog Database. While taking the backup of the database, you will be prompted for the following values:
                  1. Do you want to proceed:Enter y to proceed with the database backup.
                  2. Prime Service Catalog Database Administration Password: Enter the database administration password, which is the Oracle System user.

                  After the value for the last prompt is entered, the VM will perform a series of tasks to backup the Oracle database. This process will take a few minutes to complete. Wait until you see the message on the screen, which says that the Backup performed successfully. After the backup is done, the system will ask you whether you want to start all Prime Service Catalog services and Orchestration service. You can start the services on 11.0 virtual appliance.

                  Step 3   Ensure database backup was successful.
                  Step 4   Obtain the IP address of this machine where the 11.1 VA is installed. From the Shell Menu, select View/Configure Network Interface > View Network Details.
                  Step 5   Enable the root user. From the Shell Menu, select Manage Users > Enable Root Access.
                  Step 6   Login as the root user. From the Shell Menu, select Login as Root.
                  Step 7   Rename the backup file.
                  1. Access the Oracle Backup Directory by executing the following command: cd /opt/cisco/.backups/oracle/cpscuser
                  2. Rename the backup file by executing the following command: mv CPSCUSER_backup_<timestamp>.dmp CPSCUSER_11.1_backup.dmp
                  What to Do Next

                  Install the 11.1.1 virtual appliance. For more information, see Installing Prime Service Catalog Virtual Appliance for 11.1.

                  Exporting Prime Service Catalog Schema and Importing to the External Oracle Database

                  Procedure
                    Step 1   Back up the database. For detailed procedure, see section Backing up the Database on Cisco Prime Service Catalog Virtual Appliance 11.0 or 11.1.
                    Step 2   Login as the root user on the Prime Service Catalog Virtual Appliance.
                    Step 3   Go to the Oracle Backup Directory by executing the following command: 
                    cd /opt/cisco/.backups/oracle/cpscuser
                    Step 4   Execute the following command to copy the backup files from previous Virtual Appliance to the external Oracle database: 
                    scp CPSCUSER_backup_<timestamp>.dmp root@{IP_of_external oracle database}:/<external oracle directory>
                    Step 5   Enter the password of the external oracle database.
                    Step 6   Execute the following command on the external oracle to create the directory in the external oracle database by logging in as system user: 
                    SQL> create or replace directory CPSC_BACKUPS as ‘opt/cisco/.backups/oracle/cpscuser’
                    Step 7   Execute the following command on the external oracle to verify the location of the dump file in the specified directory: 
                    SQL> select directory_name,directory_path from dba_directories
                    Step 8   Execute the following command on the external oracle to import the backup files: 
                    impdp <systemuser>_schemas=cpscuser directory=CPSC_BACKUPS	 dumpfile=CPSCUSER_backup_<timestamp>.dmp

                    Upgrading to the Latest Virtual Appliance Database

                    Before You Begin

                    • Make sure the root user is enabled on the database node. From the Shell Menu, select Manage Users > Enable Root Access.

                    • Make sure the old database files are backed up. For more information on backing the old database, see Backing Up the Database on 11.0 Virtual Appliance.


                      Note

                      In case of distributed set up, these instructions should be executed only on the Database Node.

                    Procedure
                      Step 1   Login to the Virtual Appliance as the shelladmin user and the password that you had provided while Installing Prime Service Catalog Virtual Appliance 11.1.1. Once logged in, you will see the Shell Menu.
                      Step 2   Select Manage Databases > Upgrade Previous Version of Prime Service Catalog Database. You will be prompted for the following values:
                      1. Do you want to proceed:Enter y to proceed with the database upgrade.
                      2. Select the location from where the database file should be retrieved: You can either manually copy the database from the backup or you can let the system copy it from the remote location using the shell menu option. Choose remote if you want system to copy the database files from a remote machine. Choose local if you want to manually copy the database from some location to your local folder . To manually copy, do the following on the 11.1.1 Virtual Appliance prior to proceeding with this "Upgrade Previous Version of Prime Service Catalog Database" shell menu:

                        1. Login as the root user on the 11.1.1 Virtual Appliance.

                        2. Go to the Oracle Backup Directory by executing the following command:

                          cd /opt/cisco/.backups/oracle/cpscuser

                        3. Execute the following command to copy the backup files from previous Virtual Appliance to the new 11.1.1 Virtual Appliance :

                          scp root@{IP_of_11.1_VA}:/opt/cisco/.backups/oracle/cpscuser/CPSC_11.1_backup.dmp .

                        4. Change the backup file ownership and permissions:

                          chown oracle.oracle CPSCUSER_11.0_backup.dmp

                          chmod a+r CPSCUSER_11.0_backup.dmp

                        If you have selected remote option, the following options are displayed:

                        1. Enter the IP address of the Virtual Appliance node where the database backup files can be retrieved:

                        2. Enter the root password of the Virtual Appliance node:

                        3. Select the database backup file from the list of backup files:

                      Step 3   Ensure database upgrade was successful.
                      What to Do Next

                      Perform the post upgrade steps to complete the upgrade/migration process. For more information, see Performing the Post-upgrade Tasks.

                      Performing Post-upgrade Tasks for the Virtual Appliance

                      Procedure
                        Step 1   Log in to the Service Catalog application as a Site Administrator user.
                        Step 2   Navigate to the Administration module > Manage Connections > Puppet and add a new or modify the existing puppet master connection:

                        • Name = "PuppetMaster"

                        • Host name = host name of your puppet master server for the 11.1.1 virtual appliance

                        • Protocol =http

                        • Port =4433

                        • Username = pmadmin

                        • Password

                        • End Point API= /classifier-api/v1

                        Step 3   Update UCSD users, groups, infrastructure templates, containers.
                        1. Navigate to the Administration module > Manage Connections > UCS Director.
                        2. Select the UCSD server and import data into Prime Service Catalog using Connect and Import option.
                        Step 4   Update the public key value for the new 11.1 virtual appliance:
                        1. Go to Administration > Settings > AMQP page.
                        2. For a distributed setup, change AMQP Host to IP address of the Orchestration node.
                        3. If the AMQP port type is not SSL, change the AMQP Port Type to SSL and add the SSL certificate. To add the SSL certificate, do the following:

                          1. Login to Orchestration node as a root user.

                          2. Open the file /etc/rabbitmq/certs/cacert.pem and copy the entire value.

                          3. In the Administration > Settings > AMQP, click on Add/Edit Certificate. Enter the value copied in the previous step for the root CA certificate.

                        4. From the AMQP Public Key drop down option, choose an existing public key, and modify the existing key with the new modulus and exponent value. To get the new values, do the following:

                          1. Login to the Orchestration node as a root user, and open the file /etc/psc/lock/publickey.xml

                          2. Copy the text between <modulus> </modulus> and enter this value in the Modulus field.

                            Note   

                            Before entering the Modulus value, remove the spaces between the copied text.

                          3. Copy text between <exponent> </exponent> and enter this value in the Exponent field.

                          4. Click Save.

                          5. Copy the value of GUID.

                          6. In the AMQP Public Key field, choose the key you have been modifying in the above steps and click Update.

                          7. Click on Test AMQP Connection to verify connection was successful.

                        5. Update the Orchestration node with the GUID value. To update, do the following:

                          1. Login to the Orchestration node as a root user.

                          2. Edit file /etc/heat/server.json file.

                          3. Replace the UUID with the GUID copied in step d5.

                        Step 5   Re-start the Orchestration services. To start the services, do the following:

                        1. Login to the Orchestration node 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 orchestration VM.

                        2. On the Login Prompt, type shelladmin for the user name, and type the password value.

                        3. From the Orchestration node Shell Menu options, select option 3 to stop the services first, then select option 4.

                        Step 6   Login to the Orchestration node as a root user and verify that the Orchestration node is connected to AMQP. To verify, do the following:
                        1. On the orchestration node, access the file /etc/psc/orchestration/orchestration_log_config.json.
                        2. In the log file, modify the parameter value "level":"DEBUG".
                        Step 7   Rebuild all application services from 11.0.
                        1. Login to Prime Service Catalog as a Site Administrator user.
                        2. Access the Stack Designer module.
                        3. Select an application template and click Edit Service.
                        4. Build the service and save.
                        Repeat these steps for all the application templates that were upgraded from 11.0.
                        Step 8   (Optional) This step is applicable only if the Docker app was used in 11.0. After the upgrade, select an application template with Docker software, click on the software and do the following:

                        1. Change the Docker version from 1.4.1 to the latest.

                        2. Set the Docker registry to private registry or a public docker hub (for example: https://hub.docker.com/login/).

                        3. Enter the values for RegistryUsername, RegistryPassword, and RegistryUserEmail .

                        4. Click Save after updating the Docker configuration.

                        5. Rebuild the Docker application service.

                        Contents

                        Uninstalling Prime Service Catalog

                        Removing Virtual Appliance

                        Procedure
                          Step 1   Login to vSphere Client and connect to your VMware vCenter Server.
                          Step 2   Right-click the Prime Service Catalog Virtual Appliance, go to Power > Shut Down Guest (or choose Power Off).
                          Step 3   Right-click the Prime Service Catalog Virtual Appliance, select Delete from Disk option to remove the VM. The Prime Service Catalog Virtual Appliance is removed.

                          Contents

                          Limitations

                          Additional Configuration for Firefox ESR 31.x Browser

                          If you use the Firefox ESR 31.x browser and have problem connecting to the Prime Service Catalog URL, you may need to perform the configuration settings for your Firefox as described in this section.
                          Procedure
                            Step 1   Launch Firefox.
                            Step 2   On the Address field, type about:config
                            Step 3   Click I'll be careful, I promise! to continue.
                            Step 4   Enter tls in the Search box.
                            Step 5   Change the following config parameters if necessary:

                            security.tls.version.max = 3

                            security.tls.version.min = 1

                            services.sync.prefs.sync.security.tls.version.max = true

                            services.sync.prefs.sync.security.tls.version.min = true

                            Step 6   Select Tools > Options menu (or Firefox > Preferences menu, if you are on Mac Operating System).
                            Step 7   Click Advanced.
                            Step 8   Select the Certificates tab.
                            Step 9   Click View Certificates.
                            Step 10   Select Authorities tab.
                            Step 11   Scroll down until you see a section called Cisco or Cisco Systems, Inc..
                            Step 12   Select all certificates under Cisco or Cisco Systems, Inc. section, and click Delete.
                            Step 13   Click OK at confirmation prompt.
                            Step 14   Click OK to close the Certificate Manager popup.
                            Step 15   Click OK to close the Options popup. You can now access the Prime Service Catalog HTTPS URL using Firefox ESR 31.x.

                            HTTP Server Configuration

                            The mod_evasive module of the HTTP server in the Virtual Appliance is disabled by default, to prevent overly aggressive DDOS protection that causes the 403 Forbidden error in real sessions. Users who want to turn it back on should research and understand how to tune this module for the HTTP server.

                            Copyright © 2016, Cisco Systems, Inc. All rights reserved.

                            Was this Document Helpful?

                            FeedbackFeedback

                            Contact Cisco