Return
-
Title
Contents of Input CSV File in SQL Server cartridge documentation refers to Oracle CLI file fields -
Description
The fields listed in the "Contents of the Input CSV File" section of the SQL Server cartridge documentation related to the agent Command Line Installer is for Oracle rather than SQL Server -
Cause
Documentation error beginning with the 5.9.5.10 SQL Server cartridge.
-
Resolution
WORKAROUND
Refer to the following table with content that is included in the README file instructions for the SQL Server CLI (Command Line Installer). This table is accurate as of version 6.1.0.10 of the SQL Server cartridge.
The CSV file will contain data regarding a list of instances to monitor.For each instance the following fields should be filled (like in the "silent_installer_input_template.csv" file):
Table 1. Input CSV File
Name Description DB Agent name (Optional): The required DB agent name. If no value is entered in this field, it will be filled automatically by the template, as follows: "DBSS-" + hostName + "-" + instanceName;
For example: for the host name[MyHost] and the instance Name [MyInstance] the agent will be created with the name "DBSS-MyHost-MyInstance".Host name The SQL Server host name. Instance name The SQL Server instance name. DB port (Optional) The SQL Server instance port.
If no value is inserted in this field, the port number should match the instance name.DB credentials Type (Optional) DB authentication type. The DB authentication type can be one of the following: Windows_Default_Account, Windows_Custom_Account, SQL_Server_Authentication or AAD_Password.
If this field is left empty, the Windows_Default_Account option is used.DB user name (Optional) The user name required for connecting to the database, if the Windows_Default_Account authentication type was selected. DB password (Optional) The password of the database user name that was selected if the Windows_Default_Account authentication type was selected. DB power user credentials Type (Optional) The database authentication type of a user that can grant privileges to the regular database user. This possible options for this authentication type are as follows: Windows_Default_Account, Windows_Custom_Account, SQL_Server_Authentication, AAD_Password.
If this field is left empty, the grant privileges script will not run.DB power user name (Optional)The user name of a user that can grant privileges to the regular database user. DB power password (Optional) The password of the database power user name mentioned above; required only if the regular user does not have sufficient privileges. Should monitor OS Specifies whether to create an IC agent for the given host name; the possible values are "True" or "False". OS credentials Type (Optional) OS authentication type. This field can have one of the following values: Windows_Default_Account, Windows_Custom_Account, UX_Login_Password, Windows_Local_User.
If this field is left empty, the Windows_Default_Account value is used by default.OS user name (Optional) The user name required for connecting to the OS if the Windows_Default_Account option was selected. The user name should be compatible with the selected authentication type.
If the Windows_Default_Account value was selected, this field can be left empty.OS password (optional) The password of the OS user specified above; if the Windows_Default_Account option was selected, this field can be left empty. Enable VMware Collection (Optional) Specifies whether to monitored VMware metrics; the possible values are "True" or "False". VMware Host (Optional) The VMware host name. VMware Port (Optional) The VMware port.
If no value is inserted in this field, the port number will used the default port number 443.VMware User Name (Optional) The user name required for connecting to the VMware. VMware Password (Optional) The password of the VMware user specified above. Enable PI collection (Optional) Specifies whether to enable PI collection; the possible values are "True" or "False".
a PI repository must be already installed.Use SSL (Optional) Specifies whether an SSL connection should be used; the possible values are "True" or "False".
If no value is inserted in this field, it will used the default value "False".Group Names (Optional) The database group names you want to add the monitored instance to; Multiple group name should separate with ";".
For example: groupA;groupB;groupC
When the group already exists, then the monitored instance will be attached to the existing group. When the group does not exist, then new group will be created under the default group "Database Groups".STATUS
This documentation error has been logged as defect FOG-4270 and has been updated in the 7.1.5 release of the SQL Server cartridge.
-
Defect ID
FOG-4270