Octopus.Script exported 2019-10-13 by vasant-horapeti belongs to ‘SQL Server’ category.
Checks for SQL Node currently being serving as primary on high availability group and sets Octopus variable : SQLIsOnSecondary to true if secondary is active in High Availability Group
Parameters
When steps based on the template are included in a project’s deployment process, the parameters below can be set.
Enter server name
HAGroupSQLServer =
SQL Server name used in connection string from website code
Enter primary node
HAGroupPrimaryNode =
Enter primary SQL server name which serves traffic
Script body
Steps based on this template will execute the following PowerShell script.
function CheckSQLServerInAOAG($SqlServer, $PrimaryNode)
{
$serverConn = new-object ('Microsoft.SqlServer.Management.Common.ServerConnection') $SqlServer
try{
$serverConn.Connect();
$server = new-object ('Microsoft.SqlServer.Management.Smo.Server') $serverConn
if (!$server.IsHadrEnabled)
{
Write-Host "The SQL Server [$SqlServer] is not configured with High Availability Group."
}
else
{
# Get SQL Availability Group
$SQLAvailabilityGroup = $server.AvailabilityGroups[0]
Write-Host "Getting High Availability Group properties."
# Get SQL Availability Groups Properties
$SQLAvailabilityGroupName = $SQLAvailabilityGroup.Name;
$SQLAvailabilityGroupID = $SQLAvailabilityGroup.Id;
$SQLAvailabilityGroupGuid = $SQLAvailabilityGroup.UniqueId;
$SQLLocalReplicaRole = $SQLAvailabilityGroup.LocalReplicaRole;
$SQLPrimaryReplicaServerName = $SQLAvailabilityGroup.PrimaryReplicaServerName;
Write-Host "SQLAvailabilityGroupName : $SQLAvailabilityGroupName"
Write-Host "SQLAvailabilityGroupID : $SQLAvailabilityGroupID"
Write-Host "SQLAvailabilityGroupGuid : $SQLAvailabilityGroupGuid"
Write-Host "SQLLocalReplicaRole : $SQLLocalReplicaRole"
Write-Host "SQLPrimaryReplicaServerName : $SQLPrimaryReplicaServerName"
if ($SQLPrimaryReplicaServerName -eq $PrimaryNode)
{
Write-Host "Setting Octopus variable SQLIsOnSecondary false"
Set-OctopusVariable -name "SQLIsOnSecondary" -value "false"
}
else
{
Write-Host "Setting Octopus variable SQLIsOnSecondary true"
Set-OctopusVariable -name "SQLIsOnSecondary" -value "true"
}
}
}
catch
{
throw "Could not connect to server $SqlServer. Exception is:`r`n$($_ | fl -force | out-string)"
}
finally
{
$serverConn.Disconnect();
}
}
[System.Reflection.Assembly]::LoadWithPartialName("Microsoft.SqlServer.SMO") | out-null
[System.Reflection.Assembly]::LoadWithPartialName("Microsoft.SqlServer.ConnectionInfo") | out-null
CheckSQLServerInAOAG $HAGroupSQLServer $HAGroupPrimaryNode
Provided under the Apache License version 2.0.
To use this template in Octopus Deploy, copy the JSON below and paste it into the Library → Step templates → Import dialog.
{
"Id": "735d2f76-fdbb-4232-9f36-07020cad120d",
"Name": "Check SQL Server in High Availability Group",
"Description": "Checks for SQL Node currently being serving as primary on high availability group and sets Octopus variable : SQLIsOnSecondary to true if secondary is active in High Availability Group",
"Version": 1,
"ExportedAt": "2019-10-13T08:11:56.532Z",
"ActionType": "Octopus.Script",
"Author": "vasant-horapeti",
"Parameters": [
{
"Id": "afe518f5-5778-45b4-86c7-3715fa55b4d9",
"Name": "HAGroupSQLServer",
"Label": "Enter server name",
"HelpText": "SQL Server name used in connection string from website code",
"DefaultValue": "",
"DisplaySettings": {
"Octopus.ControlType": "SingleLineText"
},
"Links": {}
},
{
"Id": "c3c49b74-9982-400d-bc8f-b292ea7b2488",
"Name": "HAGroupPrimaryNode",
"Label": "Enter primary node",
"HelpText": "Enter primary SQL server name which serves traffic",
"DefaultValue": "",
"DisplaySettings": {
"Octopus.ControlType": "SingleLineText"
},
"Links": {}
}
],
"Properties": {
"Octopus.Action.Script.Syntax": "PowerShell",
"Octopus.Action.Script.ScriptSource": "Inline",
"Octopus.Action.RunOnServer": "false",
"Octopus.Action.Script.ScriptBody": "function CheckSQLServerInAOAG($SqlServer, $PrimaryNode)\n{\n $serverConn = new-object ('Microsoft.SqlServer.Management.Common.ServerConnection') $SqlServer\n \n try{\n $serverConn.Connect();\n $server = new-object ('Microsoft.SqlServer.Management.Smo.Server') $serverConn \n if (!$server.IsHadrEnabled)\n {\n \t Write-Host \"The SQL Server [$SqlServer] is not configured with High Availability Group.\"\n }\n else\n {\n # Get SQL Availability Group\n $SQLAvailabilityGroup = $server.AvailabilityGroups[0]\n \n Write-Host \"Getting High Availability Group properties.\"\n \n # Get SQL Availability Groups Properties\n\t $SQLAvailabilityGroupName = $SQLAvailabilityGroup.Name;\n\t $SQLAvailabilityGroupID = $SQLAvailabilityGroup.Id;\n\t $SQLAvailabilityGroupGuid = $SQLAvailabilityGroup.UniqueId;\n\t $SQLLocalReplicaRole = $SQLAvailabilityGroup.LocalReplicaRole;\n\t $SQLPrimaryReplicaServerName = $SQLAvailabilityGroup.PrimaryReplicaServerName;\n\t \n\t Write-Host\t\"SQLAvailabilityGroupName : $SQLAvailabilityGroupName\"\n Write-Host\t\"SQLAvailabilityGroupID : $SQLAvailabilityGroupID\"\n Write-Host\t\"SQLAvailabilityGroupGuid : $SQLAvailabilityGroupGuid\"\n Write-Host\t\"SQLLocalReplicaRole : $SQLLocalReplicaRole\"\n Write-Host\t\"SQLPrimaryReplicaServerName : $SQLPrimaryReplicaServerName\" \n \n if ($SQLPrimaryReplicaServerName -eq $PrimaryNode)\n {\n \t Write-Host \"Setting Octopus variable SQLIsOnSecondary false\"\n Set-OctopusVariable -name \"SQLIsOnSecondary\" -value \"false\" \n }\n else \n {\n \t Write-Host \"Setting Octopus variable SQLIsOnSecondary true\"\n \t Set-OctopusVariable -name \"SQLIsOnSecondary\" -value \"true\"\n }\n }\n }\n catch\n {\n throw \"Could not connect to server $SqlServer. Exception is:`r`n$($_ | fl -force | out-string)\"\n }\n finally\n {\n $serverConn.Disconnect();\n }\n}\n\n[System.Reflection.Assembly]::LoadWithPartialName(\"Microsoft.SqlServer.SMO\") | out-null\n[System.Reflection.Assembly]::LoadWithPartialName(\"Microsoft.SqlServer.ConnectionInfo\") | out-null\nCheckSQLServerInAOAG $HAGroupSQLServer $HAGroupPrimaryNode",
"Octopus.Action.Script.ScriptFileName": null,
"Octopus.Action.Package.FeedId": null,
"Octopus.Action.Package.PackageId": null
},
"Category": "SQL Server",
"HistoryUrl": "https://github.com/OctopusDeploy/Library/commits/master/step-templates//opt/buildagent/work/75443764cd38076d/step-templates/sqlserver-high-availability-group.json",
"Website": "/step-templates/735d2f76-fdbb-4232-9f36-07020cad120d",
"Logo": "iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAMAAACahl6sAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAD9QTFRFlZ+r3DAr6p+dy8/V4G9t////5efp9M7NrLS+wCYm8/T1vcPK1tnd10xK+fn6/PLyUU5O+eXk3+Hk7O3u7/DxS2XoPwAADb9JREFUeNrsnYl6nbgOgMEYDHghGN7/Wa8k70B6s3AOZD5o2umcSaf+0S4bUbX/kat6QB6QB+QBeUAekAfkAXlAHpAH5AF5QB6QB+QBeUAekAckXMv4XwBZVCPVnwcZlZSNXRrzp0HGTkqplrY1zfKHQboGMZwoGvVXQUbVy152QaPUu3XrJJCl6Xsp1/SBfbdunQJiZd/3zVqqmfprIEb1iLHRpLF5s279FsQ0iCH3etQ03R8CQYyq74/MwTbN3wGxQFGRRJTaJiVL815z/wXIIiviQEunq2lsNyZhvdfcfw6iCMPavl9H20jkgV8gP1F2NRRJmvEvgIA4gAS0B8xkpexEYWB3F0ijAyOxfwAkcsBvHQk53QWW71HwGm8PIhJHazIS98HYdUqBar1TJD8EYQOABGNe+w0J0dj3iuSHIOMw6PRHOyDpdhggE2XvDmLYAChsDh4MSPI1g92DWkGaosbbey0kARbOyFCaTCYgDemioQWp3D+O9EO4NGNCRpIFMKQzjlG9TyS/iOwoE64jjeaVwICOzjeoGfgue38QshPRMV57lhpVjbNemZTMK7X+gaQRSRgQzaz2JDX9CjRiDvWV+gMgRniSltWMMV0TSo1fcIEjEAKUa7k/CDiomkjaeeAU8JEmoRAOuoLp/hWidTJp9RBiipkF07our9fj/Lpmn51MeM2TnAx5gnp/cRZj6P2aD6BdWoBu1QUeiESwWoCu8a10OBfzHUFaATIxoFssfjIxUKbZiJobkg/ibFSNny2aM/pa4Lt0y4eoWwJkQP9S11NQNoOmw18Ic0qDDsIIg59TiC517aTDa5a7OBDPLDjRBMemmbgTCIhjEINbNVpHLXzozzxAhI4mg9ETv7i4DwhYiHa6JfA2T9F6dPltaDwgBQifwgG5ZOAMlpNAZlrShEpW8ykG/mgkCaMmX40LXwX3uUBR21wLgoYxoMOtc22agpJlGBM5AYF5pcFUwOkXXr8Ty2n7IxrWgze4sIo6WrvD4LNx6pc8QDtzHVA0uwGIcJ6otO4IQhahfZLCtqYjYiUwsOlqEMMp8S31w4MIHrUKv1PvnZlhsUJjF4NAWHQ5PCRUIoGA5XutEpMJsquPFjvzX6GcB2I0Ybg45wWDpi/Iz7K07QPiOfZQEwtls7gShCL6kGe6U4tBg8Bmk7syfSjRpF0glOVCEDT3Mp0KQZyV+cxeswKEjur1baGcuc8O66bQsM10C0Wa6jy4oG2E7gXkXeAxdOdhmLkMBPxWSLJyFj5vBKJLURAGJ58m0NKNcuLh01UgLLvXU87CWSEQVlDUSOHu/gQp2xgaTSAidRFISICjl83UiyVYl3/NIdHiKQZy73pNEIq4BqTNzZht2w8sCISjXWjnqYtcEZtLwTBM9c2Qci5I+ouDYs2sQMGPZxH+Y5kGiFIE6nskp4LwEPcmTpaBd99MqZTiLHPK2wwRDAQq5sxVjeS+enMBSGhAzMRhQsTIUOK1Lz9w2cWHZqy+YSevkMiknWvSMRfZoGg2mX1ecBA6yHupCyRCEqDkasaqMYsYc/LGRwWUmdHd7j4dG/x4ukIiE3HQ382KVDF546NAN9XHSmQsWo65wkbmuFSdxcdCtQ7yKP2ZgzLdx9dc19kSEbFqF0mzdsYuDgydf/I/RW8m324jPGUgPPgsoTPz0Af5MNn0p5ZgZpDJ9F6QfI2ztxQf/TT3DS+2J8Hm8b/sYAJxmXeCzJukikdnpcUUG5BeKKzQnfpf0UJUX4gmpyaNdVoQJlWzYSGGG9I5Fz0mXtoJGEh9sPc70ZZErBrN+0AMyyTCkkEwr1BJe1hOwnfysEiQyl5dMWneqlp8iGGCstyI4YLIVKT4gwfDJmvMTHDrIUP44FWz4JbEe93vnIUJXlSHyUDi92rnps1c+/LcgBiG7OIghqu6KHHXYxZlMsLLfpAzlAGTfjB0ICzlgLq0jqO5rGbnIAudtU+KqpAfKiI25XghCM3cuYlvn34+D2Qil5rqKDZlWRY/BA97CkM4aWRb89Pz2+eBsIHMedab1smks62fogs0+JMSDmL+3RH080B8a9qDCJMVvXrehgiu6yiP+pRN0epEgQi3SeUkkgeXXUOuDmdWBn7Wbuh5Gz2U67JtgsvqomUdtw4RQnNx3hMNJ269QS2iXRN7DrmUmXXGIYr+48knBqoTLUR4xztTXzRU73OgSPvSmov27OscELCEQWBgQM1hrjqc2tR+EPx1ojgVZMJTc+hzQzXl2sCc0pVMFkDRLa85iHbWyQe0Xoau1rkrg0AMk5VU5pJCmeXOILR9CMGCJ7cL5TuDJCVReDe7Aoi5K8hUUwKYc4A0MoXCLRy/+vHOIKBYPnXnbVk7BY1KS78zCKPNJShmY/9pjo0ToJjW/PErtJHxniCCjjtAxMBds9LXcrYCIZjFau4PAqURxwg+bDvvuJ/WdeiiEGW8PYge9GSEL7yjMNxOlLGd87XjGi3jriC4k4tHY8H5Gn94GUtc56QiCBn5eGcQMHRB9epEe2yDE0boe4y2i0f8jUcBkPV2IHg2nmHDkwk+uAqD573Q1dps0WAqYPTLi0L7r0CAAXs4NR3vxy8mi+fDAKRQI0AZ7wgyD7j8AQ/O0bMjrDFL8cjeYu0m+KEDux2IyLo4qFM0Q6R4GKnbgbQ3BDE6UdRsXpxWdblIrN00p0fiuBfIpCMGbtIafHwS8UAkYaHG2uLpRHBcKzqvW4GM6Skxhs62a6R7fh0fPgyZripARnK8NwOJ8gh9UXz00K0fn5p2v1uUXXZp771AhN6cc8PZLt4ejFJ+3INV8fm3cQkl7nqngOj9le7jJ8ARAwgqF0HFhxDHDq775Vp0SgGb/308XEEjg5KLbUgmo1Kdx8hSlRuBOHlU2bPfBp8GzSIGPn1o246e3BvBB9usKLwPCHPHqPAx42C1thAIkTQKn80fF6tsNtHiTiB0imelAQlBIluBOJmAVPBRXWXL6QM3ATGYslPhKpNEmq1AnJ04kI2vvQnIxAftXWofQRYUyGZxOJMDOXZjd+4BYnU6mZdApOw3AulwcAWR2O2ib9EOEoNOSSCqFi1f4ViXbL2Lokki3ka2MrkDiKryg5IIgqePRpxRozYUjmQxi9o+Pb1e3/tVVTG1yaJuGZz2IHt/nGoEN9zQbBe1di53NOCEi3p3vbwbX8oD7n1PkzfwH5RljX7iDs7fMDQ5yHrrtrmpLFeDyKraqDbpFk6pkRKsO04NckYBJW8a5bZCpWh9s7HrXpMzfhVEVdX2RtLENhpJJSWNcUKMkBqqppgTBmKBPGVEVeu68UIQ4NjPLwtjtUg08KOx2dCK3eQ2SOQtSAMkciHIUlX9/tMmkRQUXiB7JwtlbpbPXwBiqqra3cZVxUlnSaPCHwCLPzo/jYp1JUi/U6yuwZltNH6uPxh8YuXRHKcRdMsCSHsViK0KjzUqWSWMvt8bj5EHY3LR3MfWdt1yGUiVCQRFUdGXBNWqjklU6KhkOmUpD4Yqq1uvAmkAZHVdBZrXBhQ0CXcBDmcm2y4c+uHCnGxIVJZNlfVWkIpcVgf330HY0e19UIqyODMpyUGzlkwYWb4FkfFFtv7/QSwtP0CYTFCUxq877VpzgWASmWXAdtN7fCdIUKcyUEBo6StSKU9i8s6Q7Lyboiw4a9JhfL8KpE/j/3Lr7WMzyJHEiqTzAjEuoy+cs/Nc14CYqjoK62AxMnnbPqTAVC+iQHBQOUbFctnYUjFXSYQU6yD36vNAntTL0sCzhvL57d03arfP8GaJVJu/fu03xUnn1KtznSGXCO/vPVYmS3uljWx1q/eRJQ/mfr6sT+ibIy+LFZZpr/VayyZE7lPCzk2XpQmznwxffulova/FkUIk3VFxAiWIT+jlZwOL15eOcftSZK+KpR94MaNkVmF9MggQQ7y5EERVpXKBoZfeyNhYmXjVOjYRTFXaC0G8SIKb2lbvnYzlFU2PX7y977TotZr1FZDFk7ipnoWhLzJUJqBO1BmiXpYfxVyuGzdNzKUglMgHmWQRfWloSDmkYW6BaZwppryeJenYi8eBfqn50ESZNMFARuUyYhnbV2qbBVuXpjQuczdF+nhVO6j3JIszENO4MCkzmx59C3VbpvuWtrUvHr/+9QZdcMPGyUJu2gtyN4U5erV1wZHlLx7H/NWWaRNAKK3fh2572IaIFkNiMXcACb4LKI5KCih8q+PH7QxVV0v36pHlX99WMLLaBfmi8D2I5ytOlZYY6ZtXv2rhOztWNghlp1gdvpxgr1ApnR9f/qaFb+0hRqFsh6tjMNmJIo+J9uWvI/nm9vQaUfIb3JQG0imXz2fRsHn5C2K+e2DArH1QsNhvGKuUR462OWhsr/Llbyf4yaEaGR2Yu83gsVaftLgMUtqN4b/hFR4/O69lk1iUsVTTG+VFofbbz+YN73776VFAH99dG1Iu7l09Uh1bdCdf/wqlXxyXHRML5sD/GBD/jpfx/fJsvOttu589vnXv2KhAIBgYQQNfNg//hBdyQcio+vCjxxpks1gLApmqj+rjox0/5G1BgteVfbaPhTjR6Okwl/kAFtl/9PcGyWqpPutEYFW1dM5CAARkcneJlDwLlVP+dVDhMNdHW8mP45TzriBZ7k+Xi4W9kbMS0v5JkDdeD8gD8oA8IA/IA/KAPCAPyAPygDwgD8gD8oA8IA/IA/IXr/8JMAAhf0RDrOWy2QAAAABJRU5ErkJggg==",
"$Meta": {
"Type": "ActionTemplate"
}
}
Page updated on Sunday, October 13, 2019