How to Deploy CYRISMA Agents via GPO
This guide outlines the steps for deploying the CYRISMA agent across all domain-managed machines in your environment using Group Policy Objects (GPO). By leveraging domain GPO, you can automate and streamline the installation process.
- User Manual
- Agents
- The Cyber Risk Assessment Process
- API Documents
- General Questions and Troubleshooting
- The Cyber Risk Assessment Process (Video Tutorials)
- Sales and Prospecting Articles
- CYRISMA Partner Portal Access
- Glossary
- CYRISMA Change Log
- Support Ticket SLA
- Onboarding Framework
- PSA Integrations
- Billing Questions
- Self Onboarding Guide
Table of Contents
Step-by-Step Deployment Guide
1. Prepare the Netlogon Folder
- On a Domain Controller, navigate to the Netlogon folder.
- Create a folder named CYRISMA.
- Ensure this folder replicates across all domain controllers in the network.
2. Add the CYRISMA Installer
- Download
CYRISMA_Setup.exe
from the CYRISMA portal. - Place the downloaded file in the
CYRISMA
folder under Netlogon.
3. Create the Installation Script
- In the
CYRISMA
folder, create a batch file namedcyrisma_install.cmd
. - Use one of the following script templates depending on your provisioning preference.
Batch script without auto provisioning (manual provisioning required)
:: Check if CYRISMA Agent is already installed
sc query state= all | findstr /C:"SERVICE_NAME: Cyrisma_Agent"
if %ERRORLEVEL% gtr 0 (
copy \\[dcServerName]\netlogon\CYRISMA\CYRISMA_Setup.exe %temp%
%temp%\CYRISMA_Setup.exe /verysilent /key=XXXX-XXXX-XXXX /url=https://ccXXXXX.cyrisma.com
)
Batch script with auto provisioning (optional)
This version automatically provisions the agent, skipping the manual provisioning step.
:: Check if CYRISMA Agent is already installed
sc query state= all | findstr /C:"SERVICE_NAME: Cyrisma_Agent"
if %ERRORLEVEL% gtr 0 (
copy \\[dcServerName]\netlogon\CYRISMA\CYRISMA_Setup.exe %temp%
%temp%\CYRISMA_Setup.exe /verysilent /key=XXXX-XXXX-XXXX /url=https://ccXXXXX.cyrisma.com /autoprovision=yes
)
Replace the placeholders in the script:
-
[dcServerName]
with the name of your domain controller. -
XXXX-XXXX-XXXX
with your CYRISMA license key. -
https://ccXXXXX.cyrisma.com
with your CYRISMA portal URL.
4. Create a Group Policy Object (GPO)
- Log in to the Domain Controller.
- Open Group Policy Management.
- Create a new GPO named CYRISMA Deployment at the root of the domain.
5. Configure GPO Permissions
Assign Read and Execute rights to Authenticated Users or a designated group for the new GPO.
6. Add the Batch File to the GPO
- Open the newly created GPO for editing.
- Navigate to Computer Configuration > Policies > Windows Settings > Scripts (Startup/Shutdown).
- In the right pane, double-click Startup.
- In the Startup Properties window, click Add.
- Browse to the location of the batch file created in step 3:
\\[dcServerName]\Netlogon\CYRISMA\cyrisma_install.cmd
- Select the batch file, click Open, then OK.
- Click Apply and OK to save the configuration.
Verification Steps
Replicate GPO Across Domain Controllers
To ensure the new GPO is applied, run the following command:
gpupdate /force
Test Installation
- Log in to a domain-managed machine.
- Check if the CYRISMA agent is installed and running.
- Open Services Manager (
services.msc
) and verify the CYRISMA service is running.
Monitor Logs
- Review system logs to confirm successful installation.
- Check for errors and troubleshoot as needed.
Key Notes
- Ensure the
CYRISMA
folder replicates properly across all domain controllers. - Verify that authenticated users or deployment groups have the correct permissions.
- Update the batch file if the installer location, license key, or URL changes.
- If using auto provisioning, the agent will automatically pair with the instance without manual intervention.
- Be cautious with auto provisioning in environments with multiple instances to prevent unintended installations.
- Keep the license key and URL updated to avoid disruptions.
Deployment Guide
For detailed instructions on deploying CYRISMA Agents via GPO, refer to the comprehensive guide linked below.