Updates a database.
Service | update-db |
Permission | Update DB XML API |
Version | 4.4.9 or later |
Parameter | Definition |
|---|---|
HH$Id | Integer — The ID of the database to update |
HH$Name | Custom display name for the DB |
HH$Description | String |
HH$DbType | One of the database types |
HH$Host | String |
HH$Port | Integer |
HH$Instance | String |
HH$EnableVA | Boolean — Enable or disable VA section There is no default value for this parameter |
HH$Username | String (Optional) |
HH$Password | String |
HH$ConnUrl | Full connection URL (for advanced scenarios) |
HH$Properties | Additional properties (name=value pairs on each line) |
HH$OUs | List of OUs (CSV) |
HH$ExcludeUsers | List of users to exclude |
HH$validateCredentials | Boolean — Enable or disable verify connection (Default = false update db) |
More optional parameters for DAM part only.
Parameter | Definition |
|---|---|
HH$EnableAlternative | Boolean — Enable or disable alternative connection |
HH$AltUsername | String — User name |
HH$AltPassword | String — Password |
HH$AltConnectionString | String — Connection string |
HH$EnableNetMonitor | Boolean — Enable or disable network monitoring |
HH$NetMonitorPorts | String — Monitoring ports separated comma list of ports (numeric) |
HH$EnableMemMonitor | Boolean — Enable or disable memory monitoring |
HH$NetMonitorServiceNames | List (CSV) of service names — Optional and applicable for Oracle DB only |
To update a database with the ID#10000000:
Note
The port number mentioned here varies depending on the Database Security configuration.
https://127.0.0.1:8443/xmlapi.svc?service=update-db&HH$Id=10000000&HH$EnableAlternative=true&HH$AltUsername=sa&HH$AltPassword=somepassword&HH$AltConnectionString=eatal-MOBLIn this particular example, the update-db action is applied only for the database instance 10000000.
https://127.0.0.1:8443/xmlapi.svc?service=update-db&HH$Id=10000000&HH$EnableNetMonitor=true&HH$NetMonitorPorts=1443,2443&HH$EnableMemMonitor=true