Process to view the List of Services Registered with Single Sign-On for VMware vCenter Server

Products

• VMware vCenter Server

Issue/Introduction

This article outlines the procedures for listing services registered with the Lookup Service in vCenter Single Sign-On (SSO). The Lookup Service serves as a central repository where VMware services and external solutions publish their functionalities as endpoints. This information is critical for troubleshooting service registration, certificate issues, and environment cleanups. Sample service registration is available in Related Information of this KB.

Environment

• VMware vCenter Server 7.0
• VMware vCenter Server 6.0

Resolution

1. vSphere 7.x , 8.x
   

   • Open an SSH session to the vCenter Server Appliance (VCSA) 7.0 with an embedded Platform Services Controller.

     /usr/lib/vmware-lookupsvc/tools/lstool.py list --url http://localhost:7090/lookupservice/sdk
     
     
2. vSphere 6.x 
   
   • Appliance:
     • Open an SSH session to the Platform Services Controller Appliance 6.x or vCenter Server Appliance with embedded Platform Services Controller and run:

python /usr/lib/vmidentity/tools/scripts/lstool.py list --url http://localhost:7080/lookupservice/sdk
       
       Note:
       • lstool.py script is only available on PSC or Embedded vCenter, this script will not work on Management Node (vCenter Server with an External Platform Services Controller)
       • lstool.py script is located on path /usr/lib/vmware-lookupsvc/tools/ on VMC releases
         
         
   • Windows:
     
     1. Log into the Windows Platform Services Controller 6.x or vCenter Server with embedded Platform Services Controller
     2. Open a command prompt window
     3. Run the below command to list the services registered with the Platform Services Controller and save the output to c:\psc_services.txt
     "%VMWARE_PYTHON_BIN%" "%VMWARE_CIS_HOME%\VMware Identity Services\lstool\scripts\lstool.py" list --url http://localhost:7080/lookupservice/sdk > c:\psc_services.txt
     4. Open the c:\psc_services.txt output in Notepad:
      

Additional Information

Following is an example of Service Registration (from 6.x or 7.x): 

Name: cs.keyvalue.servicenameresource
Description: cs.keyvalue.servicedescriptionresource
Service Product: com.vmware.cis
Service Type: cs.keyvalue
Service ID: ########-####-####-####-########5cf1_kv
Site ID: default-site
Node ID: ########-####-####-####-########8d13
Owner ID: vpxd-extension-########-####-####-####-########[email protected]
Version: 1.0
Endpoints:
        Type: com.vmware.cis.kv.client
        Protocol: http
        URL: https://vCenterServer_FQDN_or_PNID:443/invsvc
        SSL trust: MIIEoDCCpROaVQHMbwECFmFlubr/f3R7qau3UU.......................s7XJJkS1ZW/q4lfpqSzZDfH8kT2yxonbQm9aJr0IWNY/R/J8KZa1a0jslE/wLfdDkNl


• Service Type and Service Product - These are string values to uniquely identify the Type of Service, Example: vCenter Server Service or Inventory Service
• Site ID - This shows the Site Name where Services are registered for a particular vCenter Server
• Node ID - This is the unique identifier of each vCenter Server deployment, this ID can be obtained by executing command "/usr/lib/vmware-vmafd/bin/vmafd-cli get-ldu --server-name localhost"
• Owner ID - Solution user associated with the Service
• Endpoints - Each Service will have one or more endpoints with a specified functionality ( Example - one endpoint for SDK queries, another one for Health etc..)
• Type: String value in Endpoint Type is used to uniquely identify the Type of endpoints which can be filtered by other Services
• Protocol - Type of Protocol used to communicate with the Endpoint URL
• URL - Services connects to the URL specified in Endpoint URL for communicating each other, each Endpoint URL has a specific functionality
• SSL Trust - Base 64 encoded Certificate which is configured for the Service, when two services communicate each other using the endpoints, it uses value of SSL Trust to confirm the authenticity of the connection

Opening a command or shell prompt
"ERROR certificate-manager 'lstool get' failed: 1" during Certificate Replacement on vCenter Server 6.x
"ERROR certificate-manager 'lstool get-site-id' failed: 1", Certificate Replacement with Custom Certificate Fails on vCenter Server 6.x