3 minute readApplies to: v3

Collecting Diagnostic Information

SquaredUp provides two scripts and may ask you to run one or both of these:

  1. The SquaredUp Diagnostics Script Get-SquaredUpDiags.ps1 gathers log files and information about the configuration of your SquaredUp instance. The resulting files are added to a zip file. Please contact SquaredUp Support and reply to the automatic response with the output.
  2. The SquaredUp Kerberos Script Debug-SquaredUpKerberos.ps1 queries the Kerberos configuration when using single sign-on with Windows authentication. The results are shown on screen. Please contact SquaredUp Support and reply to the automatic response with the screenshot.

Procedure

  1. On your SquaredUp server download the diagnostic script package.
  2. Extract its contents to a suitable location, for example C:\Scripts or the desktop.
  3. Open Windows PowerShell as an administrator (Start Menu > Windows PowerShell, then right-click and select Run As Administrator).
  4. Change location into the directory where you extracted the script, for example:

    cd C:\Scripts

    or

    cd ~\desktop

  5. For the Diagnostics Script:

    1. Type .\Get-SquaredUpDiags.ps1
    2. Next type a or r when prompted to run the script.
    3. Enter your SquaredUp support ticket ID, and then the SquaredUp v3 application that you need to diagnose.

    Diagnostics sample start of script <>

    1. The script saves a ZIP file(s) to C:\ProgramData\SquaredUpDiags
    2. Please contact SquaredUp Support and reply to the automatic response with the output of the SquaredUp Diagnostics along with any helpful screenshots of the errors or issue you are experiencing.
  6. For the Kerberos Script:

    1. Type .\Debug-SquaredUpKerberos.ps1
    2. Next type a or r when prompted to run the script.
    3. Please contact SquaredUp Support and reply to the automatic response with a screenshot of the Kerberos script output, along with any helpful screenshots of the errors or issue you are experiencing.

How to include your dashboard packs

SquaredUp Support may ask you to include your dashboard packs in the Diagnostics Script for further information.

To include your dashboard packs within the diagnostic zip add -IncludePackages to the end of your script execution, for example:

.\Get-SquaredUpDiags.ps1 -IncludePackages

Diagnostic Script parameters

You can manually specify the PowerShell path to your SquaredUp Virtual Directory if the script doesn't determine it correctly by adding -SquaredUpVirtualDirectory to your script execution and specifying the IIS administration path manually.

For example, if the Virtual Directory was under Default Web Site > SquaredUpv3 in IIS the command would be:

.\Get-SquaredUpDiags.ps1 -SquaredUpVirtualDirectory "IIS:\Sites\Default Web Site\SquaredUpv3"

If you want to specify where the resulting ZIP files(s) are saved to add -OutputZipFile and specify a location, for example:

.\Get-SquaredUpDiags.ps1 -OutputZipFile "C:\Users\User\Documents"

The script collects diagnostic information to a SquaredUpDiags subfolder under the temp directory before it is zipped to OutputZipFile. To change the temp directory add -TempDirectory:

.\Get-SquaredUpDiags.ps1 -TempDirectory "C:\Users\User\Documents\Temp"

Where to find log files

Squared Up Ltd. (c) 2020Report an issue with this article