Master Password Lookup with VMware VCF 5.1 SDDC API: A Step-by-Step Guide

Managing passwords in VMware Cloud Foundation (VCF) is essential for maintaining the security and integrity of your infrastructure. The SDDC Manager API in VCF 5.1 provides a powerful tool to look up and manage the VCF passwords efficiently. In this blog, we’ll walk you through the steps to use the API for this purpose.

Prerequisites

Before you begin, ensure you have:

• Access to the VMware Cloud Foundation environment.
• Appropriate permissions to use the SDDC Manager API.
• Basic understanding of API usage and authentication.
• For API reference, access the API reference guide at
• https://vdc-download.vmware.com/vmwb-repository/dcr-public/60ff5385-d6ee-41d3-9ccf-b719a59f7971/b8ba0641-d8ae-4243-acf2-3639ca248783/index.html

Step-by-Step Guide

1. Access the API Explorer
   • Log in to the SDDC Manager UI.
   • Navigate to Developer Center and select API Explorer.
2. Expand Credentials
   • In the API Explorer, look for the section Credentials.
   • Expand the relevant API endpoints to see the available operations.
3. Look Up Passwords
   • Expand /v1/credentials endpoint to retrieve a list of stored credentials (1).
   • Scroll down to the section Try it now(
   • You can filter the results based on specific criteria, such as resourceName or resourceType. Additionally, you can refine your search further by applying these filters to narrow down the results more effectively.
4. Example Request
   • For the resourceType Value, Type NSXT_MANAGER (2).
   • Scroll to the bottom and hit EXECUTE
   • Under Response, click PageOfCredential to expand (3).
   • To view the User and Service account information, click on the Credential (GUID) lines. Since the order of user and service credentials may vary, make sure to open both.
5. Handling the Response
   • The response will include details of the credentials, such as the username, service type, and the encrypted password.
   • Ensure you handle this information securely and do not expose sensitive data.
6. Updating Passwords
   • If you need to update a password, use the PUT /v1/credentials/{id} endpoint.
   • Provide the new password in the request body and ensure it meets the security policies of your organization.

1

2

3

Best Practices

• Regularly Rotate Passwords: To enhance security, rotate passwords periodically.
• Monitor API Usage: Keep track of API usage and access logs to detect any unauthorized attempts.
• Secure Storage: Store your API tokens and credentials securely to prevent unauthorized access.

Conclusion

Using the SDDC Manager API in VCF 5.1 to look up and manage passwords is a straightforward process that enhances your ability to maintain a secure environment. By following the steps outlined above, you can efficiently manage your credentials and ensure your VMware Cloud Foundation setup remains secure.

Feel free to reach out if you have any questions or need further assistance!