{"id":353741,"date":"2024-08-26T10:07:52","date_gmt":"2024-08-26T10:07:52","guid":{"rendered":"https:\/\/www.ninjaone.com\/script-hub\/documentare-le-istanze-di-sql-server\/"},"modified":"2024-10-13T19:09:57","modified_gmt":"2024-10-13T19:09:57","slug":"documentare-le-istanze-di-sql-server","status":"publish","type":"script_hub","link":"https:\/\/www.ninjaone.com\/it\/script-hub\/documentare-le-istanze-di-sql-server\/","title":{"rendered":"Come utilizzare PowerShell per scoprire e documentare le istanze di SQL Server"},"content":{"rendered":"

Vuoi imparare a r<\/strong>ecuperare e documentare le istanze di SQL server con PowerShell<\/strong>? <\/span>Nel mondo IT, la gestione e la manutenzione delle istanze di SQL Server<\/a> \u00e8 un compito fondamentale per i professionisti IT e i Managed Service Provider (MSP)<\/a>. Sapere come raccogliere in modo efficiente le informazioni sulle istanze di SQL Server pu\u00f2 migliorare notevolmente le attivit\u00e0 amministrative e snellire i processi. In questo articolo analizzeremo un potente script PowerShell progettato per ottenere un elenco di istanze del server MSSQL, e forniremo informazioni dettagliate sullo script e sue applicazioni pratiche.<\/p>\n

Background<\/h2>\n

Le istanze di SQL Server sono la spina dorsale di molte applicazioni aziendali, in quanto memorizzano e gestiscono grandi quantit\u00e0 di dati. I professionisti IT devono spesso identificare e gestire queste istanze per garantire prestazioni e sicurezza ottimali. Lo script PowerShell fornito \u00e8 uno strumento prezioso per recuperare rapidamente le informazioni sulle istanze di SQL Server su un sistema. Questa capacit\u00e0 \u00e8 fondamentale per attivit\u00e0 quali audit, risoluzione dei problemi e monitoraggio del sistema.<\/p>\n

Lo script per documentare le istanze di SQL Server:<\/h2>\n
#Requires -Version 5.1\r\n\r\n<#\r\n.SYNOPSIS\r\n    Gets a list of MSSQL server instances and optionally save the results to a custom field.\r\n.DESCRIPTION\r\n    Gets a list of MSSQL server instances and optionally save the results to a custom field.\r\n    The custom field can be either\/both a multi-line or WYSIWYG custom field.\r\n\r\n    SQL Server, SQL Server Developer and SQL Express are supported.\r\n\r\n    SQL \"Local\" that are built into an application are not supported as they aren't an SQL Server instance.\r\n\r\n    SQL service name that don't start with \"MSSQL$\" will not get detected.\r\n\r\n    PS > Get-Service -Name \"MSSQL`$*\"\r\n    Status   Name               DisplayName\r\n    ------   ----               -----------\r\n    Running  MSSQL$DB           SQL Server (DB)\r\n    Running  MSSQL$DB01         SQL Server (DB01)\r\n    Running  MSSQL$DB02         SQL Server (DB02)\r\n\r\n.EXAMPLE\r\n    (No Parameters)\r\n    ## EXAMPLE OUTPUT WITHOUT PARAMS ##\r\n     Status Name              Instance Path\r\n     ------ ----              -------- ----\r\n    Running SQL Server (DB01) DB01     C:\\Program Files\\Microsoft SQL Server\\MSSQL16.DB01\\MSSQL\r\n    Running SQL Server (DB02) DB02     C:\\Program Files\\Microsoft SQL Server\\MSSQL16.DB02\\MSSQL\r\n\r\nPARAMETER: -CustomFieldName \"ReplaceMeWithAnyMultilineCustomField\"\r\n    Saves an text table to a multi-line Custom Field with a list of SQL instances.\r\n.EXAMPLE\r\n    -CustomFieldName \"ReplaceMeWithAnyMultilineCustomField\"\r\n    ## EXAMPLE OUTPUT WITH CustomFieldName ##\r\n     Status Name              Instance Path\r\n     ------ ----              -------- ----\r\n    Running SQL Server (DB01) DB01     C:\\Program Files\\Microsoft SQL Server\\MSSQL16.DB01\\MSSQL\r\n    Running SQL Server (DB02) DB02     C:\\Program Files\\Microsoft SQL Server\\MSSQL16.DB02\\MSSQL\r\n\r\nPARAMETER: -CustomFieldParam \"ReplaceMeWithAnyWysiwygCustomField\"\r\n    Saves an html table to a Wysiwyg Custom Field with a list of SQL instances.\r\n.EXAMPLE\r\n    -WysiwygCustomFieldName \"ReplaceMeWithAnyWysiwygCustomField\"\r\n    ## EXAMPLE OUTPUT WITH WysiwygCustomFieldName ##\r\n     Status Name              Instance Path\r\n     ------ ----              -------- ----\r\n    Running SQL Server (DB01) DB01     C:\\Program Files\\Microsoft SQL Server\\MSSQL16.DB01\\MSSQL\r\n    Running SQL Server (DB02) DB02     C:\\Program Files\\Microsoft SQL Server\\MSSQL16.DB02\\MSSQL\r\n.OUTPUTS\r\n    None\r\n.NOTES\r\n    Release Notes: Initial Release\r\nBy using this script, you indicate your acceptance of the following legal terms as well as our Terms of Use at https:\/\/www.ninjaone.com\/terms-of-use.\r\n    Ownership Rights: NinjaOne owns and will continue to own all right, title, and interest in and to the script (including the copyright). NinjaOne is giving you a limited license to use the script in accordance with these legal terms. \r\n    Use Limitation: You may only use the script for your legitimate personal or internal business purposes, and you may not share the script with another party. \r\n    Republication Prohibition: Under no circumstances are you permitted to re-publish the script in any script library or website belonging to or under the control of any other software provider. \r\n    Warranty Disclaimer: The script is provided \u201cas is\u201d and \u201cas available\u201d, without warranty of any kind. NinjaOne makes no promise or guarantee that the script will be free from defects or that it will meet your specific needs or expectations. \r\n    Assumption of Risk: Your use of the script is at your own risk. You acknowledge that there are certain inherent risks in using the script, and you understand and assume each of those risks. \r\n    Waiver and Release: You will not hold NinjaOne responsible for any adverse or unintended consequences resulting from your use of the script, and you waive any legal or equitable rights or remedies you may have against NinjaOne relating to your use of the script. \r\n    EULA: If you are a NinjaOne customer, your use of the script is subject to the End User License Agreement applicable to you (EULA).\r\n#>\r\n\r\n[CmdletBinding()]\r\nparam (\r\n    [String]$CustomFieldName,\r\n    [String]$WysiwygCustomFieldName\r\n)\r\n\r\nbegin {\r\n    function Test-IsElevated {\r\n        $id = [System.Security.Principal.WindowsIdentity]::GetCurrent()\r\n        $p = New-Object System.Security.Principal.WindowsPrincipal($id)\r\n        $p.IsInRole([System.Security.Principal.WindowsBuiltInRole]::Administrator)\r\n    }\r\n    function Set-NinjaProperty {\r\n        [CmdletBinding()]\r\n        Param(\r\n            [Parameter(Mandatory = $True)]\r\n            [String]$Name,\r\n            [Parameter()]\r\n            [String]$Type,\r\n            [Parameter(Mandatory = $True, ValueFromPipeline = $True)]\r\n            $Value,\r\n            [Parameter()]\r\n            [String]$DocumentName\r\n        )\r\n    \r\n        $Characters = $Value | Measure-Object -Character | Select-Object -ExpandProperty Characters\r\n        if ($Characters -ge 10000) {\r\n            throw [System.ArgumentOutOfRangeException]::New(\"Character limit exceeded, value is greater than 10,000 characters.\")\r\n        }\r\n        \r\n        # If we're requested to set the field value for a Ninja document we'll specify it here.\r\n        $DocumentationParams = @{}\r\n        if ($DocumentName) { $DocumentationParams[\"DocumentName\"] = $DocumentName }\r\n        \r\n        # This is a list of valid fields that can be set. If no type is given, it will be assumed that the input doesn't need to be changed.\r\n        $ValidFields = \"Attachment\", \"Checkbox\", \"Date\", \"Date or Date Time\", \"Decimal\", \"Dropdown\", \"Email\", \"Integer\", \"IP Address\", \"MultiLine\", \"MultiSelect\", \"Phone\", \"Secure\", \"Text\", \"Time\", \"URL\", \"WYSIWYG\"\r\n        if ($Type -and $ValidFields -notcontains $Type) { Write-Warning \"$Type is an invalid type! Please check here for valid types. https:\/\/ninjarmm.zendesk.com\/hc\/en-us\/articles\/16973443979789-Command-Line-Interface-CLI-Supported-Fields-and-Functionality\" }\r\n        \r\n        # The field below requires additional information to be set\r\n        $NeedsOptions = \"Dropdown\"\r\n        if ($DocumentName) {\r\n            if ($NeedsOptions -contains $Type) {\r\n                # We'll redirect the error output to the success stream to make it easier to error out if nothing was found or something else went wrong.\r\n                $NinjaPropertyOptions = Ninja-Property-Docs-Options -AttributeName $Name @DocumentationParams 2>&1\r\n            }\r\n        }\r\n        else {\r\n            if ($NeedsOptions -contains $Type) {\r\n                $NinjaPropertyOptions = Ninja-Property-Options -Name $Name 2>&1\r\n            }\r\n        }\r\n        \r\n        # If an error is received it will have an exception property, the function will exit with that error information.\r\n        if ($NinjaPropertyOptions.Exception) { throw $NinjaPropertyOptions }\r\n        \r\n        # The below type's require values not typically given in order to be set. The below code will convert whatever we're given into a format ninjarmm-cli supports.\r\n        switch ($Type) {\r\n            \"Checkbox\" {\r\n                # While it's highly likely we were given a value like \"True\" or a boolean datatype it's better to be safe than sorry.\r\n                $NinjaValue = [System.Convert]::ToBoolean($Value)\r\n            }\r\n            \"Date or Date Time\" {\r\n                # Ninjarmm-cli expects the GUID of the option to be selected. Therefore, the given value will be matched with a GUID.\r\n                $Date = (Get-Date $Value).ToUniversalTime()\r\n                $TimeSpan = New-TimeSpan (Get-Date \"1970-01-01 00:00:00\") $Date\r\n                $NinjaValue = $TimeSpan.TotalSeconds\r\n            }\r\n            \"Dropdown\" {\r\n                # Ninjarmm-cli is expecting the guid of the option we're trying to select. So we'll match up the value we were given with a guid.\r\n                $Options = $NinjaPropertyOptions -replace '=', ',' | ConvertFrom-Csv -Header \"GUID\", \"Name\"\r\n                $Selection = $Options | Where-Object { $_.Name -eq $Value } | Select-Object -ExpandProperty GUID\r\n        \r\n                if (-not $Selection) {\r\n                    throw [System.ArgumentOutOfRangeException]::New(\"Value is not present in dropdown\")\r\n                }\r\n        \r\n                $NinjaValue = $Selection\r\n            }\r\n            default {\r\n                # All the other types shouldn't require additional work on the input.\r\n                $NinjaValue = $Value\r\n            }\r\n        }\r\n        \r\n        # We'll need to set the field differently depending on if its a field in a Ninja Document or not.\r\n        if ($DocumentName) {\r\n            $CustomField = Ninja-Property-Docs-Set -AttributeName $Name -AttributeValue $NinjaValue @DocumentationParams 2>&1\r\n        }\r\n        else {\r\n            $CustomField = Ninja-Property-Set -Name $Name -Value $NinjaValue 2>&1\r\n        }\r\n        \r\n        if ($CustomField.Exception) {\r\n            throw $CustomField\r\n        }\r\n    }\r\n    if ($env:multilineCustomFieldName -and $env:multilineCustomFieldName -notlike \"null\") {\r\n        $CustomFieldName = $env:multilineCustomFieldName\r\n    }\r\n    if ($env:WysiwygCustomFieldName -and $env:WysiwygCustomFieldName -notlike \"null\") {\r\n        $WysiwygCustomFieldName = $env:WysiwygCustomFieldName\r\n    }\r\n}\r\nprocess {\r\n    if (-not (Test-IsElevated)) {\r\n        Write-Error -Message \"Access Denied. Please run with Administrator privileges.\"\r\n        exit 1\r\n    }\r\n\r\n    try {\r\n        $InstanceNames = $(Get-ItemProperty -Path \"HKLM:\\SOFTWARE\\Microsoft\\Microsoft SQL Server\\\" -ErrorAction Stop).InstalledInstances\r\n        $SqlInstances = $InstanceNames | ForEach-Object {\r\n            $SqlPath = $(Get-ItemProperty -Path \"HKLM:\\SOFTWARE\\Microsoft\\Microsoft SQL Server\\$_\\Setup\" -ErrorAction Stop).SQLPath\r\n            $SqlServices = Get-Service -Name \"MSSQL`$$_\" -ErrorAction Stop\r\n            $SqlService = $SqlServices | Where-Object { $_.Name -notlike $SqlServices.DependentServices.Name -and $_.Name -notlike \"SQLTelemetry*\" }\r\n            [PSCustomObject]@{\r\n                Status   = $SqlService.Status\r\n                Service  = $SqlService.DisplayName\r\n                Instance = $_\r\n                Path     = $SqlPath\r\n            }\r\n        }\r\n    }\r\n    catch {\r\n        Write-Host \"[Error] $($_.Message)\"\r\n        Write-Host \"[Info] Likely no MSSQL instance found.\"\r\n        exit 1\r\n    }\r\n\r\n    $SqlInstances | Out-String | Write-Host\r\n\r\n    if ($CustomFieldName) {\r\n        Write-Host \"Attempting to set Custom Field '$CustomFieldName'.\"\r\n        Set-NinjaProperty -Name $CustomFieldName -Value ($SqlInstances | Out-String)\r\n        Write-Host \"Successfully set Custom Field '$CustomFieldName'!\"\r\n    }\r\n\r\n    if ($WysiwygCustomFieldName) {\r\n        try {\r\n            Write-Host \"Attempting to set Custom Field '$WysiwygCustomFieldName'.\"\r\n            $htmlReport = New-Object System.Collections.Generic.List[String]\r\n            $htmlReport.Add(\"<h1>SQL Server Instances<\/h1>\")\r\n            $htmlTable = $SqlInstances | ConvertTo-Html -Fragment \r\n            $htmlTable = $htmlTable -replace \"<tr><td>Running<\/td>\", '<tr class=\"success\"><td>Running<\/td>'\r\n            $htmlTable = $htmlTable -replace \"<tr><td>StartPending<\/td>\", '<tr class=\"other\"><td>StartPending<\/td>'\r\n            $htmlTable = $htmlTable -replace \"<tr><td>ContinuePending<\/td>\", '<tr class=\"other\"><td>ContinuePending<\/td>'\r\n            $htmlTable = $htmlTable -replace \"<tr><td>Paused<\/td>\", '<tr class=\"other\"><td>Paused<\/td>'\r\n            $htmlTable = $htmlTable -replace \"<tr><td>PausePending<\/td>\", '<tr class=\"other\"><td>PausePending<\/td>'\r\n            $htmlTable = $htmlTable -replace \"<tr><td>Stopped<\/td>\", '<tr class=\"danger\"><td>Stopped<\/td>'\r\n            $htmlTable = $htmlTable -replace \"<tr><td>StopPending<\/td>\", '<tr class=\"danger\"><td>StopPending<\/td>'\r\n            $htmlTable | ForEach-Object { $htmlReport.Add($_) }\r\n            Set-NinjaProperty -Name $WysiwygCustomFieldName -Value ($htmlReport | Out-String)\r\n            Write-Host \"Successfully set Custom Field '$WysiwygCustomFieldName'!\"\r\n        }\r\n        catch {\r\n            Write-Error $_\r\n            Write-Host \"[Error] $($_.Message)\"\r\n            exit 1\r\n        }\r\n    }\r\n    exit 0\r\n}\r\nend {\r\n    \r\n    \r\n    \r\n}<\/pre>\n
 <\/p>\n\n
<\/h2>
<\/p><\/div>
<\/a><\/div><\/div>\n
Analisi dettagliata<\/h2>\n
Lo script per documentare le istanze di SQL Server inizia controllando se viene eseguito con i privilegi di amministratore, necessari per accedere ad alcune propriet\u00e0 del sistema. Definisce una funzione, Test-IsElevated, per verificarlo. Se lo script non \u00e8 eseguito come amministratore, esce con un errore.<\/p>\n
Successivamente, lo script tenta di recuperare le istanze di SQL Server installate dal Registro di Windows<\/a>. Lo fa con il cmdlet Get-ItemProperty, che accede al percorso di registro pertinente. Lo script esegue quindi l’iterazione di ogni istanza, recuperando dettagli come il nome dell’istanza, lo stato del servizio e il percorso di installazione.<\/p>\n
Le informazioni raccolte vengono strutturate in un oggetto personalizzato e visualizzate. Se specificato, i risultati possono anche essere salvati in campi personalizzati, come plain text o HTML, utilizzando la funzione Set-NinjaProperty. Questa funzione gestisce vari tipi di dati e garantisce che i valori siano conformi ai limiti di caratteri e ad altri vincoli.<\/p>\n
Casi d’uso potenziali<\/h2>\n
Immagina un professionista IT che gestisce pi\u00f9 server in un’organizzazione. Utilizzando questo script per documentare le istanze di SQL Server, pu\u00f2 raccogliere e documentare rapidamente tutte le istanze di SQL Server in esecuzione su ciascun server. Queste informazioni sono fondamentali per attivit\u00e0 quali l’aggiornamento del software, l’esecuzione di audit di sicurezza e la pianificazione delle capacit\u00e0. Per esempio, durante un ciclo di aggiornamento, conoscere tutte le istanze attive aiuta a pianificare e a ridurre al minimo i tempi di inattivit\u00e0.<\/p>\n
Confronti<\/h2>\n
Questo script PowerShell offre un metodo semplificato e automatizzato, rispetto ai metodi manuali, per raccogliere informazioni e per documentare le istanze di SQL Server. Altri metodi con cui gli amministratori possono farlo sono l\u2019utilizzo di SQL Server Management Studio (SSMS) o il controllo manualmente dei servizi tramite la console dei servizi di Windows. Pur essendo efficaci, questi metodi richiedono molto tempo e sono soggetti a errori umani<\/a>. Lo script qui analizzato invece fornisce un processo coerente e ripetibile che pu\u00f2 essere facilmente integrato in flussi di lavoro pi\u00f9 ampi di gestione IT.<\/p>\n
Domande frequenti<\/h2>\n
D: Questo script per documentare le istanze di SQL Server pu\u00f2 rilevare le istanze di SQL Server installate come parte di un’applicazione?<\/h3>\n
R: No, lo script \u00e8 progettato per rilevare le istanze SQL Server standard. Le istanze incorporate nelle applicazioni non sono supportate.<\/p>\n
D: Cosa succede se il nome di un campo personalizzato supera il limite di caratteri?<\/h3>\n
R: Lo script per documentare le istanze di SQL Server include un controllo per garantire che i valori non superino i 10.000 caratteri. Se questo limite viene superato, viene lanciato un errore.<\/p>\n
D: Questo script per documentare le istanze di SQL Server pu\u00f2 essere eseguito su qualsiasi versione di PowerShell?<\/h3>\n
R: Lo script per documentare le istanze di SQL Server richiede PowerShell versione 5.1 o successive.<\/p>\n
Implicazioni<\/h2>\n
L’esecuzione di questo script fornisce ai professionisti IT informazioni dettagliate sulle implementazioni di SQL Server nella loro infrastruttura. Queste informazioni sono fondamentali per garantire la conformit\u00e0, ottimizzare le prestazioni e migliorare la sicurezza. Sapendo esattamente dove sono in esecuzione le istanze di SQL Server, gli amministratori possono proteggere meglio i dati sensibili e garantire che i sistemi siano configurati e manutenuti correttamente.<\/p>\n
Raccomandazioni<\/h2>\n