Install SnapCenter Plug-in for SQL Server and add database hosts
You should install the SnapCenter Plug-in for SQL Server on each of the SQL database hosts, add the database hosts, discover the database instances, and configure the credentials for the database instances.
Install the SnapCenter Plug-in for SQL Server
You should download plug-in snapcenter_service_windows_host_plugin.exe and then run the silent installer command to install the plug-in on the database host.
-
You should ensure that the following prerequisites are met.
-
.Net 4.7.2 is installed
-
PowerShell 4.0 is installed
-
Minimum disk space of 5 GB is available
-
Minimum RAM size of 4 GB is available
-
-
You should run the API to complete the customer on-boarding. For more infromation, refer to: https://snapcenter.cloudmanager.cloud.netapp.com/api-doc/#/Tenant%20Registration/createTenant
-
Download the plug-in by running the API from the Connector host.
docker exec -it cloudmanager_scs_cloud curl 'http://127.0.0.1/api/v2/pluginpackage/windows'
The location of the file is /var/lib/docker/volumes/service-manager-2_cloudmanager_scs_cloud_volume/_data/<agent_version>/sc-windows-host-plugin/snapcenter_service_windows_host_plugin.exe.
-
Copy snapcenter_service_windows_host_plugin.exe from the connector to each of the MSSQL Server database hosts either using scp or other alternate methods.
-
Install the plug-in.
'"C://<install_folder>/snapcenter_service_windows_host_plugin.exe"/silent/debuglog "C://<install_folder>/HA_Suite_Silent_Install_SCSQL_FRESH.log" /log"C://install_folder/" BI_SNAPCENTER_PORT=8145 ISFeatureInstall=SCSQL' -
Copy the self signed certificate from /var/lib/docker/volumes/service-manager-2_cloudmanager_scs_cloud_volume/_data/client/certificate/certificate.pem to the MSSQL Server database hosts.
You can also generate a self signed certificate or a CA signed certificate if you do not use the default one.
-
Convert the certificate from .pem to .crt format in the Connector host.
'openssl x509 -outform der -in certificate.pem -out certificate.crt' -
Double-click the certificate to add it to the Personal and Trusted Root Certification Authorities store.
Add the SQL Server database host
You should add the MSSQL database host using the host FQDN.
'POST snapcenter.cloudmanager.cloud.netapp.com/api/v1/hosts'
For more information, refer to: https://snapcenter.cloudmanager.cloud.netapp.com/api-doc/#/Host%20Management/AddHosts
This API creates a job that can be tracked from the Job Monitor tab in the BlueXP UI.
Parameters
Name | Type | Required |
---|---|---|
addr |
string |
True |
connector_id |
string |
True |
plugin_type |
string |
True |
install_method |
string |
True |
plugin_port |
number |
True |
username |
string |
True |
Response
If the API is executed successfully, response code 202 is displayed.
Example:
{ "job": { "_links": { "self": { "href": "/api/resourcelink" } }, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } }
View the added SQL Server database hosts
You can run this API to view all the added SQL Server database hosts.
'GET snapcenter.cloudmanager.cloud.netapp.com/api/v1/hosts'
For more information, refer to: https://snapcenter.cloudmanager.cloud.netapp.com/api-doc/#/Host%20Management/GetHosts
Response
If the API is executed successfully, response code 200 is displayed.
Example:
{ "num_records": 1, "total_records": 1, "records": [ { "id": "85bd4603-08f7-45f4-ba8e-a0b1e2a0f4d0", "addr": "scspa2722211001.rtp.openenglab.netapp.com", "status": "Running", "connector_id": "fBf8Iwbp4BscBfD02qBwWm6I03gGAesRclients", "plugin_port": 8145, "plugins": [ { "type": "mssql" } ], "os_type": "windows", "platform": "onprem", "username": "administrator", "operating_mode": "production" } ], "_links": { "next": {} } }
Discover the database instances
You can run this API and enter the host ID to discover all the MSSQL instances.
'POST snapcenter.cloudmanager.cloud.netapp.com/api/mssql/instances/discovery'
For more information, refer to: https://snapcenter.cloudmanager.cloud.netapp.com/api-doc/#/MSSQL%20Instances/MSSQLInstancesDiscoveryRequest
This API creates a job that can be tracked from the Job Monitor tab in the BlueXP UI.
Parameter
Name | Type | Required |
---|---|---|
host_id |
string |
True |
Response
If the API is executed successfully, response code 202 is displayed.
Example:
{ "job": { "_links": { "self": { "href": "/api/resourcelink" } }, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } }
View the discovered database instances
You can run this API to view all the discovered database instances.
'GET snapcenter.cloudmanager.cloud.netapp.com/api/mssql/instances'
For more information, refer to: https://snapcenter.cloudmanager.cloud.netapp.com/api-doc/#/MSSQL%20Instances/GetMSSQLInstancesRequest
Response
If the API is executed successfully, response code 200 is displayed.
Example:
{ "num_records": 2, "total_records": 2, "records": [ { "id": "953e66de-10d9-4fd9-bdf2-bf4b0eaabfd7", "name": "scspa2722211001\\NAMEDINSTANCE1", "host_id": "85bd4603-08f7-45f4-ba8e-a0b1e2a0f4d0", "status": "Running", "auth_mode": 0, "version": "", "is_clustered": false, "is_credentials_configured": false, "protection_mode": "" }, { "id": "18e1b586-4c89-45bd-99c8-26268def787c", "name": "scspa2722211001", "host_id": "85bd4603-08f7-45f4-ba8e-a0b1e2a0f4d0", "status": "Stopped", "auth_mode": 0, "version": "", "is_clustered": false, "is_credentials_configured": false, "protection_mode": "" } ], "_links": { "next": {} } }
Configure the database instance credentials
You can run this API to validate and set credentials for the database instances.
'POST snapcenter.cloudmanager.cloud.netapp.com/api/mssql//api/mssql/credentials-configuration'
For more information, refer to: https://snapcenter.cloudmanager.cloud.netapp.com/api-doc/#/MSSQL%20Instances/ConfigureCredentialRequest
This API creates a job that can be tracked from the Job Monitor tab in the BlueXP UI.
Parameter
Name | Type | Required |
---|---|---|
host_id |
string |
True |
instance_ids |
string |
True |
username |
string |
True |
password |
string |
True |
auth_mode |
string |
True |
Response
If the API is executed successfully, response code 202 is displayed.
Example:
{ "job": { "_links": { "self": { "href": "/api/resourcelink" } }, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } }