Adds a VA database.
Service | add-db |
Permission | Add DB XML API |
Version | 4.4.9 or later |
Note
Depending on the database type, you must provide either an instance name or a port number. For advanced scenarios, it is possible to provide a full connection URL.
Note
In MSSQL, you are not allowed to provide both parameter, instance and port number.
Parameter | Definition |
|---|---|
HH$Name | Custom display name for the DB |
HH$Description | String |
HH$DbType | One of these database types:
|
HH$Host | String |
HH$Port | Integer |
HH$Instance | String |
HH$EnableVA | Boolean Enable or disable VA section. The default value is true |
HH$Username | String (mandatory) |
HH$Password | String |
HH$ConnUrl | Full connection URL (for advanced scenarios) |
HH$Properties | Additional properties (name=value pairs on each line) |
HH$OUs | Comma-separated list of OUs |
HH$ExcludeUsers | A list of users to exclude |
HH$validateCredentials | Boolean Enable or disable verify connection. The default value is true for add db |
If support for OS scanning is required, use these parameters.
Parameter | Definition |
|---|---|
HH$OSType | One of DCOM and SSH |
HH$OSUsername | String |
HH$OSPassword | String |
HH$OSCert | String |
HH$OSCertPassword | String |
HH$OSPort | Integer (SSH port) |
If SSH tunneling is required, use these parameters.
Parameter | Definition |
|---|---|
HH$OSTunnelUsername | String |
HH$OSTunnelPassword | String |
HH$OSTunnelCertificate | String |
HH$OSTunnelCertificatePassword | String |
HH$OSTunnelHost | String |
HH$OSTunnelPort | Integer |
For example, to add a new MSSQL database name SQL_DB, issue the request:
https://127.0.0.1:8443/xmlapi.svc?service=add-db&HH$Name=SQL_DB&HH$DbType=MSSQL&HH$Host=127.0.0.1&HH$Instance=SQL2005&HH$Username=uname&HH$Password=pword