Cisco Unified Serviceability Administration Guide, Release 9.0(1)
Services setup and viewing services
Downloads: This chapterpdf (PDF - 426.0KB) The complete bookPDF (PDF - 4.6MB) | Feedback

Services setup and viewing services

Services setup and viewing services

Set up services

Perform the following tasks when working with services.
Procedure
    Step 1   Turn on the feature services that you want to run.
    Step 2   Configure the appropriate service parameters.

    All service parameters for the services in Cisco Unified IM and Presence Serviceability display in Cisco Unified CM IM and Presence Administration.

    Step 3   If necessary, troubleshoot problems by using the Cisco Unified IM and Presence Serviceability trace tools.

    Feature services activation and deactivation

    You can turn on (activate) or turn off (deactivate) multiple feature services or select default services to turn on from the Service Activation window in Cisco Unified IM and Presence Serviceability. Cisco Unified IM and Presence Serviceability turns on feature services in automatic mode and checks for service dependencies based on a single-node configuration. When you select to turn on a feature service, Cisco Unified IM and Presence Serviceability prompts you to select all the other services, if any, that depend on that service to run based on a single-node configuration. When you select the Set Default button, Cisco Unified IM and Presence Serviceability selects those services that are required to run IM and Presence based on a single-node configuration. Turning on a service automatically starts the service. You start and stop services from Control Center.

    Recommendations for activation of services in a cluster


    Caution


    Before you turn on any services for a feature, you must complete all the required configuration on IM and Presence for that feature. See the relevant documentation for each IM and Presence feature.


    Before you turn on services in a cluster, review the table below, which provides service recommendations for multi-node configurations.

    Table 1 Service Activation Recommendations

    Service/Servlet

    Recommendations

    Database and Admin Services

    Cisco AXL Web Service

    • Turn on this service on the first node only.
    • Failing to turn on this service causes the inability to update IM and Presence from client-based applications that use AXL.

    Cisco Bulk Provisioning Service

    • You turn on the Cisco Bulk Provisioning Service only on the first node.
    • If you use the Bulk Administration Tool (BAT) to administer users, you must turn on this service.

    Performance and Monitoring Services

    Cisco Serviceability Reporter

    Turn on this service on the publisher node only.
    Note   

    The service only generates reports on the publisher node even if you turn on the service on other nodes.

    IM and Presence Services

    Cisco SIP Proxy

    Turn on this service on all nodes in the cluster.

    Cisco Presence Engine

    Turn on this service on all nodes in the cluster.

    Cisco Sync Agent

    Turn on this service on all nodes in the cluster.

    Cisco XCP Text Conference Manager

    • Turn on this service if you deploy the Chat feature on IM and Presence.
    • Turn on this service on each node that runs the Chat feature.
    Note   

    The permanent chat feature requires an external database. If you enable the permanent chat feature, you must also configure an external database before starting the Text Conference Manager service. The Text Conference Manager service will not start if the permanent chat feature is enabled and an external database is not configured. See the Database Setup Guide for IM and Presence on Cisco Unified Communications Manager.

    Cisco XCP Web Connection Manager

    • Turn on this service if you integrate web clients with IM and Presence.
    • Turn on this service on all nodes in the cluster.

    Cisco XCP Connection Manager

    • Turn on this service if you integrate XMPP clients with IM and Presence.
    • Turn on this service on all nodes in the cluster.

    Cisco XCP SIP Federation Connection Manager

    Turn on this service if you deploy any of the following configurations:
    • Interdomain federation over the SIP protocol on IM and Presence. Turn on this service on each node that runs SIP federation.
    • Intercluster deployment between a IM and Presence Release 9.0 cluster and a Cisco Unified Presence Release 8.6 cluster. Turn on this service on all nodes in the Release 9.0 cluster.

    Cisco XCP XMPP Federation Connection Manager

    • Turn on this service only if you deploy interdomain federation over the XMPP protocol on IM and Presence.
    • Turn on this service on each node that runs XMPP federation.
    Note   

    Before you turn on the XMPP Federation Connection Manager service on a node, you must turn on XMPP Federation in Cisco Unified CM IM and Presence Administration on that node. See Interdomain Federation for IM and Presence on Cisco Unified Communications Manager .

    Cisco XCP Message Archiver

    • Turn on this service if you deploy the Compliance feature on IM and Presence.
    • Turn on this service on any node that runs the IM Compliance feature.
    Note   

    If you turn on the Message Archiver before you configure an external database, the service will not start. Also, if the external database is not reachable, the service will not start. See the Database Setup Guide for IM and Presence on Cisco Unified Communications Manager.

    Cisco XCP Directory Service

    • Turn on this service if you integrate XMPP clients on IM and Presence with an LDAP directory.
    • Turn on this service on all nodes in the cluster.
    Note   

    If you turn on the Directory Service before you configure the LDAP contact search settings for third-party XMPP clients, the service will start, and then stop again. See the Deployment Guide for IM and Presence on Cisco Unified Communications Manager.

    Cisco XCP Authentication Service

    • Turn on this service if you integrate XMPP clients with IM and Presence.
    • Turn on this service on all nodes in the cluster.

    Activate and deactivate feature services

    You can turn on and turn off feature services in Cisco Unified IM and Presence Serviceability. Some feature services depend on other services, and you always turn on the non-dependent services first.


    Note


    Cisco Unified IM and Presence Serviceability allows you to turn on and turn off only features services (not network services).


    Before You Begin

    The service names for the server that you select and the status of the services are displayed in the Service Activation window. Services do not start until you turn them on.

    Procedure
      Step 1   Select Tools > Service Activation.
      Step 2   Select the server from the Server list box, and then select Go.
      Step 3   Perform one of the following actions to turn on or turn off services:
      1. To turn on the default services required to run on a single server, select Set to Default
        Note   

        This option selects default services based on the configuration of a single server, and checks for service dependencies.

      2. To turn on all services, check Check All Services.
      3. To turn on a specific service, check the service that you want to turn on
      4. To turn off a service, uncheck the services that you want to turn off.
      Step 4   Select Save after you finish making the appropriate changes.
      Tip   

      To obtain the latest status of services, select Refresh.


      Start, stop, and restart services in Control Center or CLI

      To perform these tasks, Cisco Unified IM and Presence Serviceability provides two Control Center windows. To start, stop, and restart network services, access the Control Center—Network Services window. To start, stop, and restart feature services, access the Control Center—Feature Services window.


      Tip


      Use the Related Links list box and the Go button to navigate to Control Center and Service Activation windows.


      Start, stop, restart, and refresh services status in Control Center

      Control Center in Cisco Unified IM and Presence Serviceability allows you to:

      • view status
      • refresh status
      • start, stop, and restart IM and Presence services for a particular server in a cluster

      You can only start, stop or restart feature services that you have turned on.

      If you are upgrading IM and Presence, those services that were already started on your system will start after the upgrade.

      Procedure
        Step 1   Depending on the service type that you want to start, stop, restart or refresh, perform one of the following actions:
        1. Select Tools > Control Center - Feature Services.
        2. Select Tools > Control Center - Network Services.
        Step 2   Select the server from the Server list box, and then select Go.
        Step 3   Perform one of the following actions:.
        1. To start a service, select the radio button next to the service that you want to start, and then select Start.

          The Status changes to reflect the updated status.

        2. To restart a service, do the following:
          1. Select the radio button next to the service that you want to restart, and then select Restart.
          2. Select OK when a message indicates that restarting may take a while.
        3. To stop a service, select the radio button next to the service that you want to stop, and then select Stop.

          The Status changes to reflect the updated status.

        4. To get the latest status of the services, select Refresh.
        5. To go to the Service Activation window or to the other Control Center window, select the option from the Related Links list box, and select Go.

        Start, stop, and restart services with Command Line Interface

        You can start and stop the following services by issuing a command in the command line interface (CLI). You must start and stop all other services from Control Center in Cisco Unified IM and Presence Serviceability.

        Procedure
          Step 1   To start a service, enter utils service start <service name>, where <service name> equals the entire name of the service.
          Step 2   To stop a service, enter utils service stop <service name>, where <service name> equals the entire name of the service.
          Step 3   To restart a service, enter utils service restart <service name>, where <service name> equals the entire name of the service.