Parameters for GetAvailabilityGroup.xml
The following table displays all the elements you can use for SQL Availability Group operations.
All elements are mandatory.
Name |
Description |
Parent Element |
---|---|---|
sqlClient |
The SQL AG client information. Set the clientName element to the Availability Group name. <sqlClient clientName=""/> |
App_GetAvailabilityGroupsReq |
instanceEntity |
The SQL AG information Set the following elements: clientName: The SQL AG client. instanceName: The SQL AG instance name. <instanceEntity clientName="" instanceName=""/> |
App_GetAvailabilityGroupsReq |
Parameters for GetReplica.xml
The following table displays all the elements you can use for SQL Availability Group operations.
All elements are mandatory.
Name |
Description |
Parent Element |
---|---|---|
App_GetAvailabilityGroupReplicasReq |
The SQL AG information. Set the availabilityGroup element to the SQL Availability Group name. <App_GetAvailabilityGroupReplicasReq availabilityGroup=""> |
App_GetAvailabilityGroupReplicasReq |
instanceEntity |
The SQL AG instance information Set the following elements: clientName: The SQL Availability Group name. instanceName: The SQL Availability Group instance name. <instanceEntity clientName="" instanceName=""/> |
App_GetAvailabilityGroupsReq |
Parameters for createAGClient.xml
The following table displays all the elements you can use for SQL Availability Group operations.
All elements are mandatory.
Name |
Description |
Parent Element |
---|---|---|
clientInfo |
Specify the SQL AG client information. Set the clientType element to the application type: <clientInfo clientType="MSSQL_AG"> |
App_CreatePseudoClientRequest |
SQLServerInstance |
Specify the SQL AG instance information. Set the clientName element to the host and instance name that are configured in SQL. <SQLServerInstance clientName="" instanceName=""/> |
mssqlagClientProperties |
availabilityGroup |
Specify the SQL AG information. Set the elements to the response values from the GetAvailabilityGroup.xml call. <availabilityGroup backupPreference="" name="" primaryReplicaServerName="" uniqueId=""> |
mssqlagClientProperties |
SQLAvailabilityGroupListenerList |
Specify the SQL AG listener information. Set the elements to the response values from the GetAvailabilityGroup.xml call. <SQLAvailabilityGroupListenerList availabilityGroupListenerName=""/> |
availabilityGroup |
SQLAvailabilityReplicasList |
Specify the replication server list. Create an element for each replication server. Set the elements to the response elements from the GetRelica.xml. <SQLAvailabilityReplicasList availabilityMode="" backupPriority=""connectionState=""failoverMode=""name=""role=""/> |
mssqlagClientProperties |
entity |
The SQL AG client name. Set the clientName element to the Availability Group client name that you want to use in Commvault. <entity clientName=""/> |
App_CreatePseudoClientRequest |