PowerShell script for monitoring Citrix license utilization and sending email alerts when the usage exceeds a specified threshold.
This PowerShell script retrieves license usage information from a Citrix License Server using WMI and sends email alerts if license usage exceeds a specified threshold.
- PowerShell 2.0 or later
- Citrix Licensing Service running on a Citrix License Server
- Windows Firewall configured to allow remote WMI access
To use the script, run the Monitor-CitrixLicenseUtilization.ps1 script file with the following parameters:
CitrixLicenseServer: The name of the Citrix License Server to retrieve license usage information.Threshold: The license usage threshold (in percentage) to send email alerts.OutputFile: The path to the CSV file to save license usage information.EmailFrom: The email address to send email alerts from.EmailTo: An array of email addresses to send email alerts to.EmailServer: The SMTP server to send email alerts.EmailPort: The SMTP server port to send email alerts (default is 25).LogFile: The path to the log file to save script execution information.
For example:
.\Monitor-CitrixLicenseUtilization.ps1 -CitrixLicenseServer 'Server01' -Threshold 90 -OutputFile 'C:\LicenseUsage.csv' -EmailFrom '[email protected]' -EmailTo '[email protected]', '[email protected]' -EmailServer 'smtpserver' -LogFile 'C:\Monitor-CitrixUtilization.log'The output file will contain detailed license usage information for all license types. Each row represents a license type and includes the following columns: License Type, Total Licenses, Licenses In Use, and License Usage Percentage.
Here's an example of what the output file might look like:
License Type,Total Licenses,Licenses In Use,License Usage Percentage
XenApp Enterprise,100,80,80%
XenDesktop Platinum,50,30,60%
NetScaler Gateway Universal,200,150,75%
In this example, the script has retrieved license usage information for three license types: XenApp Enterprise, XenDesktop Platinum, and NetScaler Gateway Universal. The script calculates the license usage percentage for each license type and outputs the results to the specified output file.
To troubleshoot issues when running the Citrix License Usage Monitoring Script, you can follow these steps:
-
Refer to the script output and log files for more information about the error. The script outputs detailed information about license usage and any errors during script execution. The log file also contains information about when the script was executed and where the license usage information was saved.
-
Consult the Citrix License Server documentation for more information about how to configure and troubleshoot the Citrix Licensing Service. The Citrix documentation provides detailed information about how to configure the Citrix Licensing Service to use WMI and how to allow remote WMI access.
-
Seek assistance from Citrix support if you cannot resolve the issue using the script output, log files, or Citrix documentation. Citrix support can provide additional assistance with troubleshooting and resolving issues related to the Citrix Licensing Service and Citrix License Server.
Following these steps, you should be able to troubleshoot and resolve most issues when running the Citrix License Usage Monitoring Script.
To configure the Citrix Licensing Service to use WMI and allow remote WMI access, you can follow these steps:
-
Open the Citrix Licensing Manager on the Citrix License Server.
-
Click on the "Configuration" tab.
-
Under "Service Options", select "Use WMI for Remote Administration".
-
Click on the "Security" tab.
-
Under "WMI Security", select "Enable Remote WMI".
-
Click on the "Apply" button to save the changes.
-
Open the Windows Firewall on the Citrix License Server.
-
Click on "Advanced Settings".
-
Click on "Inbound Rules".
-
Click on "New Rule".
-
Select "WMI" from the list of predefined rules.
-
Click on "Next".
-
Select "Allow the connection".
-
Click on "Next".
-
Select the network types for which the rule should apply.
-
Click on "Next".
-
Give the rule a name and click on "Finish".
Following these steps, you can configure the Citrix Licensing Service to use WMI and allow remote WMI access, allowing the Citrix License Usage Monitoring Script to retrieve license usage information from the Citrix License Server using WMI.
To configure the script to run at regular intervals using Windows Task Scheduler, you can follow these steps:
-
Open Task Scheduler by typing "Task Scheduler" in the Start menu search bar and selecting the "Task Scheduler" app.
-
Click "Create Task" in the "Actions" pane on the right-hand side of the Task Scheduler window.
-
In the "General" tab, give the task a name and description.
-
In the "Triggers" tab, click "New" to create a new trigger.
-
In the "New Trigger" window, specify the schedule for the task. For example, you can set it to run daily at a specific time.
-
In the "Actions" tab, click "New" to create a new action.
-
In the "New Action" window, select "Start a program" as the action type.
-
In the "Program/script" field, specify the path to the PowerShell executable (usually
C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe). -
In the "Add arguments" field, specify the path to the script file and any required parameters. For example:
-ExecutionPolicy Bypass -File "C:\Scripts\Monitor-CitrixLicenseUtilization.ps1" -CitrixLicenseServer 'Server01' -Threshold 90 -OutputFile 'C:\LicenseUsage.csv' -EmailFrom '[email protected]' -EmailTo '[email protected]', '[email protected]' -EmailServer 'smtpserver' -LogFile 'C:\Monitor-CitrixUtilization.log'
You may need to adjust the paths and parameters to match your environment.
-
Click "OK" to save the new task.
The script will now run automatically at the specified intervals. You can view the task status in the "Task Scheduler Library" pane of the Task Scheduler window.
You can also modify the task settings by right-clicking on the task in the "Task Scheduler Library" pane and selecting "Properties". From here, you can adjust the task schedule, action, and other settings as needed.
This script is licensed under the MIT License. See the LICENSE file for more information.