Privilege Cloud - How to run the PSMCheckPrerequisites script

cancel
Showing results for 
Show  only  | Search instead for 
Did you mean: 
PAM SaaS Articles
9 min read
L0 Member
No ratings
This article will help outline and guide customers when running the PSMCheckPrerequisities script, provided by Idira in the Marketplace found linked here:
https://cyberark-customers.force.com/mplace/s/#a352J000000GWAZQA4-a392J000002tNgLQAU
 

Steps

What's needed.

The script will perform a number of checks to ensure the designated servers are meeting the minimum requirements needed to complete the installation.   Additionally as part of the checks, connectivity tests to Idira backend services are performed, these checks will ensure that Idira has whitelisted customer IP addresses and the required firewall configuration is in place.


In order to perform the connectivity tests, the following is required.  If these are not known, please reach out to your Idira representative.
 

  • Public IP has been whitelisted in Idira backend services.

  • Customer ID

  • Vault Address - Example - vault-SUBDOMAIN.privilegecloud.cyberark.cloud

  • Connector Address - Example - connector-SUBDOMAIN.privilegecloud.cyberark.cloud

  • There will be an option to perform a CPM Test after the initial test has completed,  we strongly encourage this is completed to ensure communications to your hosted Idira Vault are reaching us correctly from just one IP address for the duration of the TCP session, this can be ran at anytime also via  .\PSMCheckPrerequisites.ps1 -CPMConnectionTest.

  • Please ensure you have your credentials available , please refer to the following URL for guidance  https://cyberark-customers.force.com/s/article/Privilege-Cloud-How-to-locate-and-update-the-Installe...


Script Zip File Contents

  • Readme.txt file.

  • VaultOperationsTester folder containing files needed to perform CPM Connectivity test.

Example Commands

Please choose and execute one of the following commands in an Admin instance of Powershell. During execution, it will also generate a file called "PSMCheckPrerequisites_PrivilegeCloud.ini" that will store the parameters provided during runtime. If you had made a mistake and want to rerun the script, we recommend you edit this file with the proper details or delete it.

Recommended run of the script
.\PSMCheckPrerequisites.ps1
 ka32J00000053smQAA__eid=ka32J00000053sm&feoid=00N2J000009R3kv&refid=0EM2J000003MFgA.png
Run checks if the machine is out of the domain:
.\PSMCheckPrerequisites.ps1 -OutOfDomain
 
Troubleshoot certain components:
.\PSMCheckPrerequisites.ps1 -Troubleshooting
 
Run in POC mode:
.\PSMCheckPrerequisites.ps1 -POC
 
Run CPM Connection Test:
.\PSMCheckPrerequisites.ps1 -CPMConnectionTest
ka32J00000053smQAA__eid=ka32J00000053sm&feoid=00N2J000009R3kv&refid=0EM2J000003MFeJ.png
ka32J00000053smQAA__eid=ka32J00000053sm&feoid=00N2J000009R3kv&refid=0EM2J000003MFvZ.png
Files generated during the execution:
  • <ScriptDir>\DCInfo.txt - (this isn't generated by default, only if you need to, from -troubleshooting section).
  • <ScriptDir>\Machine PublicIP - will try to query machine public IP by reaching https://ipinfo.io
  • <ScriptDir>\_PSMCheckPrerequisuites.log - General log for the script itself.
  • <ScriptDir>\_PSMCheckPrerequisites_PrivilegeCloud.ini - generated file on initial run and will contain useful info to save time on reruns.
  • <ScriptDir>\VaultOperationsTester\Log\*.logs

Troubleshooting

Tenant Password Contains Invalid Characters

ka32J00000053smQAA__eid=ka32J00000053sm&feoid=00N2J000009R3kv&refid=0EM2J000003MHnm.png
This can happen if your password contains the characters \/<>{}'&"$*@`  and fails the logon test. 

To update the password please see https://cyberark-customers.force.com/s/article/Privilege-Cloud-How-to-locate-and-update-the-Installe...

Vault/Connector Connection Failure

ka32J00000053smQAA__eid=ka32J00000053sm&feoid=00N2J000009R3kv&refid=0EM2J000003MFw8.png
This issue is likely a whitelist issue on either the external firewall or the Idira AWS firewall. Work with your firewall team to confirm the required IPs and Ports are allowed through the firewall. Also, provide your <Server> PublicIP.txt file to your Idira Rep to verify the AWS side.

If you have a PaloAlto Firewall, please read on in this article for some troubleshooting steps: https://cyberark-customers.force.com/s/article/Vault-Connectivity-fails-when-components-separated-by-Palo-Alto-Firewall
 

Console HTTP Connection Failure

ka32J00000053smQAA__eid=ka32J00000053sm&feoid=00N2J000009R3kv&refid=0EM2J000003MFwc.png
Start by verifying the CustomerID you have provided to the script and then run the test again. If issues persist, please reach out to Idira for your next steps.

If you have a PaloAlto Firewall, please read on in this article for some troubleshooting steps:
https://cyberark-customers.force.com/s/article/Vault-Connectivity-fails-when-components-separated-by-Palo-Alto-Firewall

 

Unable to retrieve public IP

ka32J00000053smQAA__eid=ka32J00000053sm&feoid=00N2J000009R3kv&refid=0EM2J000003MFwm.png
Please reach out to your Firewall team to get the public IP of this machine. This issue can be caused by a block at the firewall level if you are whitelisting only specific addresses or hosts. The script attempts to reach https://ipinfo.io in order to find the public IP of the server.

 

GPO Failures

ka32J00000053smQAA__eid=ka32J00000053sm&feoid=00N2J000009R3kv&refid=0EM2J000003MFyO.pngPlease update the GPO that is being pushed to the machine to turn off any cited issue GPOs from the script. In this above example the team would adjust the "Allow users to connect remotely by using Remote Desktop" policy, to "Not Configured" . As part of the prereqs Idira asks that we disable all GPOs.
 

Hostname too Long

ka32J00000053smQAA__eid=ka32J00000053sm&feoid=00N2J000009R3kv&refid=0EM2J000003Me49.png
With some machines, we have noticed that RDS will fail to install when the computer hostname is over 15 characters. Recommended action would be to change the hostname of the server to something shorter.

 

General Troubleshooting Guide
ka32J00000053smQAA__eid=ka32J00000053sm&feoid=00N2J000009R3kv&refid=0EM2J000003MFkM.png
You can run the script with the -Troubleshooting flag to perform various helpful commands:

  • Test LDAPS Bind Account - similar to what ldp.exe does, can check bind user authentication to LDAPS server.
  • Enable TLS 1.0 (Only for POC) - Enable TLS 1.0, this should NOT be used on the final production environment, it is only meant for POCs. During production installation, the machine will be hardened with TLS 1.2.
  • Retrieve DC Info - Will retrieve a list of all available DCs of the currently joined domain and check port availability (389,636,3268,3269) and save it to a local file "DCInfo.txt" for reference
  • Disable IPv6 - Disables the IPv6 protocol both in the network card and registry, restart is required to apply changes.
  • Enable WinRM HTTPS Listener - Generates a new self-signed cert and configures WinRM listener with HTTPs mode and opens local firewall port 5986.
  • Config WinRMListener Permissions - Checks the local cert file has the correct file permissions typically located under C:\ProgramData\Microsoft\Crypto\Keys or C:\ProgramData\Microsoft\Crypto\RSA\MachineKeys\
  • Enable SecondaryLogon Service - Enables services and makes sure it's set to StartType Automatic, this is required for PSM functionality, it is also enabled during installation, but can fail if service is disabled, that's why we have this step in prereq.
  • Run CPM Install Connection Test - Simulates a real CPM install without leaving any leftovers in the vault, requires good connectivity to vault and admin user/pw.

The checks that will be performed

  • VaultConnectivity - Run command Test-NetConnection to provide Vault public IP with Port 1858.
  • TunnelConnectivity - Run command Test-NetConnection to provide Tunnel public IP with Port 443.
  • CustomerPortalConnectivity - Run Test-NetConnection to https://<CustomerDomain>.privilegecloud.cyberark.com with port 443
  • ConsoleNETConnectivity - Run command Test-NetConnection to console.privilegecloud.cyberark.com with Port 443.
  • ConsoleHTTPConnectivity - Run command invoke-restmethod against console.privilegecloud.cyberark.com and retrieve tenant details.
  • SecureTunnelLocalPort - Check if port 50000/50001 is not used by other app since secure tunnel uses this as default.
  • CRLConnectivity - Run invoke-webrequest command to http://ocsp.digicert.com on port 80 (if status 200 then success).
  • OSVersion - Check Windows Server is 2016, 2019 as required.
  • Processors - Check a Minimum of 8 Cores.
  • Memory - Check a Minimum of 8 RAM.
  • SQLServerPermissions - Administrators group are in the mandatory local security groups for a successful SQL instance installation.
  • InterActiveLoginSmartCardIsDisabled - Checks Smart Card Is not enabled to logon to the machine, otherwise this will cause CredSSP error during install
  • UsersLoggedOn - Verify only one user is logged on.
  • IPV6 - Verify IPv6 is disabled.
  • SecondaryLogon - Check service is running, it is required for PSM webapps/apps to function (invoked by PSMShadowUsers).
  • KUsrInitDELL - Check for KUsrInit.exe file, this exists if the machine has DELL agent deployed and replaces the default userInit.exe, meaning the PSM Applocker whitelist needs to be adapted.
  • NetworkAdapter - Check that all NICs are up, this is required by the connector installer, and can be disabled afterward.
  • DotNet - Check if .NET 4.8 or higher is installed, this is mandatory from version 12.1+ of CPM/PSM.
  • PSRemoting - Verify PS Remoting is enabled by running command → Invoke-Command -ComputerName $env:COMPUTERNAME -ScriptBlock { ; }
  • WinRM - Check if WinRM service is running and isn't blocked by any GPO.
  • WinRMListener - Check if WinRM is listening on HTTPS protocol and also has a valid cert
  • NoPSCustomProfile - Check Powershell profile is not custom (this would yield CredSSP error during install)
  • CheckNoRDS - Verify no RDS roles are installed on the machine before Idira deployment, if PSM is already installed this will always return green result.
  • PendingRestart - Verify no machine restarts are pending, typically due to windows updates or server role installs.
  • DomainUser - Check if logged in user is a domain user  (If you are installing on non domain joined machine run the script with -OutofDomain flag since this check is irrelevant)
  • PrimaryDNSSuffix - Check if logged in user and machine are from the same domain, if not will link to an KB article on how to workaround the issue. (If you are installing on non domain joined machine run the script with -OutofDomain flag since this check is irrelevant)
  • GPO - Verify the following rules are set:
    • Nothing under RDS → Computer Configuration → Administrative Templates → Windows Components → Remote Desktop Services. (Idira will provide special hardened GPO that will apply to RDS).
    • "Allow CredSSP authentication" - Expected='Not Configured'
    • "Allow remote server management through WinRM" - Expected='Not Configured'
    • "Prevent running First Run wizard" - Expected='Not Configured'
    • "Allow Remote Shell Access" - Expected='Not Configured'
  • CPMConnectionTest - This step will be performed on initial run of the script, afterwards you can invoke it by running with -CPMConnectionTest or -Troubleshooting flag.
    • The idea behind this check is to simulate a CPM component install before the real installation attempt, to detect early FW issues, to verify the username/password credentials are valid and any edge case.
    • While the check is called CPM, it will also help detect PSM problems as well since both components are using the same communication protocol.
    • Communication to the Vault over 1858/TCP is required to utilize sticky session and maintain the same source IP for the duration of the session.
    • You must have your PVWA admin username/password ready for this (typically <subdomain>_admin).
    • The script requires Redis C++ x86 2013 to run, it comes with the script and the script will install it automatically, don't delete it since CPM requires it to function anyway and applies it during real install.
    • The check will generate several logs under "<ScriptDir>\VaultOperationsTester\Log".
    • In some cases this might return false positive, we are constantly working to improve this tool, keep in mind it only checks connectivity behavior,
    • For example, it will not detect an issue related to Anti Virus software on the machine, while the test will pass, the real install might still fail if AV intervenes.
  • MachineNameCharLimit - Checks if machine hostname is over 15 char limit.
Rate this article:
  • 21807 Views
  • 0 comments
  • 0 Likes
Article Dashboard
Version history
Last Updated:
‎11-05-2026 11:43 AM
Updated by: