Enable Basic Authentication for API in vROps 8.1 and later

Products

• VMware Aria Suite

Issue/Introduction

This article details how to enable Basic Authentication for API in vRealize Operations 8.1 and later.

Environment

VMware vRealize Operations 8.2.x
VMware vRealize Operations 8.3.x
VMware vRealize Operations 8.1.x
VMware vRealize Operations 8.4.x

Resolution

Enable Basic Authentication for API in vRealize Operations 8.1 and later

To enable Basic Authentication for API in vRealize Operations 8.1 and later, complete the steps below.

1. Log into the vRealize Operations Primary node as root via SSH or Console
2. Open /usr/lib/vmware-vcops/user/conf/api-conf.properties in a text editor.
3. Change the basicAuthentication.enabled property value to true.

Example: basicAuthentication.enabled=true

4. Save and close the file.
5. Restart the REST API service:

service api restart

6. Repeat steps 1-5 on all other nodes in the vRealize Operations cluster.

See the steps in the Related Information section to disable Basic Authentication for API once it is no longer needed.

Additional Information

To disable Basic Authentication for API in vRealize Operations Manager 67.-8.0.x, see Disable Basic Authentication for API in vRealize Operations Manager 6.7 - 8.0.x.

Disable Basic Authentication for API in vRealize Operations 8.1 and later

To disable Basic Authentication for API in vRealize Operations 8.1 and later, complete the steps below.

1. Log into the vRealize Operations Primary node as root via SSH or Console
2. Open /usr/lib/vmware-vcops/user/conf/api-conf.properties in a text editor.
3. Change the basicAuthentication.enabled property value to false.

Example: basicAuthentication.enabled=false

4. Save and close the file.
5. Restart the REST API service:

service api restart

6. Repeat steps 1-5 on all other nodes in the vRealize Operations cluster.

Impact/Risks:
By default, vRealize Operations 8.1 and later do not allow Basic Authentication for API.
For security purposes, it's best to leave Basic Authentication disabled.