└── XA-and-XD-HealthCheck_Parameters.xml


/XA-and-XD-HealthCheck_Parameters.xml:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="utf-8"?>
  2 | <settings>
  3 | 	<Variables>
  4 | 		<Variable>
  5 | 			<!-- Define a EnvironmentName e.g. Integration/Production etc. - this will be used in HTML & Email Subject -->
  6 | 			<Name>EnvironmentName</Name>
  7 | 			<Value>Citrix Health Status</Value>
  8 | 			<Type>[string]</Type>
  9 | 			<Scope>Script</Scope>
 10 | 		</Variable>
 11 | 		<Variable>
 12 | 			<!-- Define an Output log file e.g CTXXDHealthCheck.log -->
 13 | 			<Name>OutputLog</Name>
 14 | 			<Value>CTXXDHealthCheck.log</Value>
 15 | 			<Type>[string]</Type>
 16 | 			<Scope>Script</Scope>
 17 | 		</Variable>
 18 | 		<Variable>
 19 | 			<!-- Define an Output HTML file e.g CTXXDHealthCheck.html -->
 20 | 			<Name>OutputHTML</Name>
 21 | 			<Value>CTXXDHealthCheck.htm</Value>
 22 | 			<Type>[string]</Type>
 23 | 			<Scope>Script</Scope>
 24 | 		</Variable>
 25 | 		<Variable>
 26 | 			<!-- Is the HealthCheck used in a Citrix Cloud enviornment and running on a CloudConnector -->
 27 | 			<Name>CitrixCloudCheck</Name>
 28 | 			<Value>0</Value> <!-- 1 or 0 -->
 29 | 			<Type>[int]</Type>
 30 | 			<Scope>Script</Scope> <!-- global ? -->
 31 | 		</Variable>
 32 | 		<Variable>
 33 | 			<!-- Cloud API for Enviornments in Citrix Cloud e.g. https://eu.cloud.com/identity/api-access/secure-clients -->
 34 | 			<Name>CustomerID</Name>
 35 | 			<Value>a12345b78cde</Value> <!-- this is the short ID like a12345b78cde -->
 36 | 			<Type>[string]</Type>
 37 | 			<Scope>Script</Scope> <!-- global ? -->
 38 | 		</Variable>
 39 | 		<Variable>
 40 | 			<!-- Cloud API for Enviornments in Citrix Cloud https://eu.cloud.com/identity/api-access/secure-clients -->
 41 | 			<Name>SecureClientFile</Name>
 42 | 			<Value>C:\Company\myCredentialfiles\secureclient.csv</Value> <!--  you need to download the CSV file and locate it on the server running this script, e.g the CloudConnector --> 
 43 | 			<Type>[string]</Type>
 44 | 			<Scope>Script</Scope> <!-- global ? -->
 45 | 		</Variable>
 46 | 		<Variable>
 47 | 			<!-- Cloud API for Enviornments in Citrix Cloud e.g. https://eu.cloud.com/identity/api-access/secure-clients -->
 48 | 			<Name>APIKey</Name>
 49 | 			<Value>20f97466-76ff-4cfc-ac2a-52790387540a</Value> <!-- this is the GUID ID like 20f97466-76ff-4cfc-ac2a-52790387540a . Only needed when the SecureClientFile is not present -->
 50 | 			<Type>[string]</Type>
 51 | 			<Scope>Script</Scope> <!-- global ? -->
 52 | 		</Variable>
 53 | 		<Variable>
 54 | 			<!-- Cloud API for Enviornments in Citrix Cloud e.g. https://eu.cloud.com/identity/api-access/secure-clients -->
 55 | 			<Name>SecretKey</Name>
 56 | 			<Value>eoFfKREqbx620gTrJH0JFA==</Value> <!-- this is the secret like eoFfKREqbx620gTrJH0JFA== . Only needed when the SecureClientFile is not present -->
 57 | 			<Type>[string]</Type>
 58 | 			<Scope>Script</Scope> <!-- global ? -->
 59 | 		</Variable>
 60 | 		<Variable>
 61 | 			<!-- Set the correct Citrix Cloud API Region for Enviornments that use Citrix Cloud.
 62 | 			  - US region: api-us.cloud.com
 63 | 			  - EU region: api-eu.cloud.com
 64 | 			  - AP-S region: api-ap-s.cloud.com
 65 | 			  - Japan region: api.citrixcloud.jp
 66 | 			 Important:
 67 | 			 - You must use the region where your Citrix Cloud account is set to.
 68 | 			 - If you use the incorrect region, you will get the error: "The remote server returned an error: (404) Not Found."
 69 | 			 I feel that Citrix could use more intelligence here to automatically proxy/redirect a request to the correct region. -->
 70 | 			<Name>CCRegion</Name>
 71 | 			<Value>api-ap-s.cloud.com</Value>
 72 | 			<Type>[string]</Type>
 73 | 			<Scope>Script</Scope>
 74 | 		</Variable>
 75 | 		<Variable>
 76 | 			<!-- Set to true to append the SiteId GUID to the Citrix Cloud Site Name or "cloudxdsite". This allows for uniqueness when running checks against multiple Citrix Cloud sites. -->
 77 | 			<Name>AppendCCSiteIdToName</Name>
 78 | 			<Value>true</Value>
 79 | 			<Type>[bool]</Type>
 80 | 			<Scope>Script</Scope>
 81 | 		</Variable>
 82 | 		<Variable>
 83 | 			<!-- Set to true to bypass the default system proxy when using the Invoke-RestMethod and Invoke-WebRequest cmdlets.
 84 | 			This is important for on-prem connectivity to avoid getting "The remote server returned an error: (503) Server Unavailable." error. -->
 85 | 			<Name>NoProxy</Name>
 86 | 			<Value>true</Value>
 87 | 			<Type>[bool]</Type>
 88 | 			<Scope>Script</Scope>
 89 | 		</Variable>
 90 | 		<Variable>
 91 | 			<!-- Set to true to bypass certificate validation. Not recommended for production platforms. -->
 92 | 			<Name>SkipCertificateCheck</Name>
 93 | 			<Value>false</Value>
 94 | 			<Type>[bool]</Type>
 95 | 			<Scope>Script</Scope>
 96 | 		</Variable>
 97 | 		<Variable>
 98 | 			<!-- Define the hostnames of delivery controllers, you can use localhost if you run this script localy
 99 | 			     Example: CXDC01.domain.tld,CXDC02.domain.tld -->
100 | 			<Name>DeliveryControllers</Name>
101 | 			<Value>localhost</Value> <!-- Add Server separated by comma -->
102 | 			<Type>[array]</Type>
103 | 			<Scope>Script</Scope>
104 | 		</Variable>
105 | 		<Variable>
106 | 			<!-- Information about the disk you want to check. -->
107 | 			<Name>diskLettersControllers</Name>
108 | 			<Value>C,D</Value>
109 | 			<Type>[array]</Type>
110 | 			<Scope>Script</Scope>
111 | 		</Variable>
112 | 		<Variable>
113 | 			<!-- Raise alert if delivery controllers have been rebooted in less than this number of days -->
114 | 			<Name>minUpTimeDaysDDC</Name>
115 | 			<Value>1</Value>
116 | 			<Type>[int]</Type>
117 | 			<Scope>Script</Scope>
118 | 		</Variable>
119 | 		<Variable>
120 | 			<!-- # Set to 1 if you want to Check a Environment with Cloud Connectors -->
121 | 			<Name>ShowCloudConnectorTable</Name>
122 | 			<Value>0</Value>
123 | 			<Type>[int]</Type>
124 | 			<Scope>Script</Scope>
125 | 		</Variable>
126 | 		<Variable>
127 | 			<!-- Define the hostnames of Cloud Connector Servers
128 | 			     Example: CCS01.domain.tld,CCS02.domain.tld -->
129 | 			<Name>CloudConnectorServers</Name>
130 | 			<Value></Value> <!-- Add Server separated by comma -->
131 | 			<Type>[array]</Type>
132 | 			<Scope>Script</Scope>
133 | 		</Variable>
134 | 		<Variable>
135 | 			<!-- # Set to 1 if you want to Check a Environment with Storefront -->
136 | 			<Name>ShowStorefrontTable</Name>
137 | 			<Value>0</Value>
138 | 			<Type>[int]</Type>
139 | 			<Scope>Script</Scope>
140 | 		</Variable>
141 | 		<Variable>
142 | 			<!-- Define the hostnames of Storefront Servers
143 | 			     Example: CXS01.domain.tld,CXS02.domain.tld -->
144 | 			<Name>StoreFrontServers</Name>
145 | 			<Value></Value> <!-- Add Server separated by comma -->
146 | 			<Type>[array]</Type>
147 | 			<Scope>Script</Scope>
148 | 		</Variable>
149 | 		<Variable>
150 | 			<!-- Maximum uptime of a virtual Desktop or a XenApp
151 | 				 Example: 7 -->
152 | 			<Name>maxUpTimeDays</Name>
153 | 			<Value>7</Value>
154 | 			<Type>[int]</Type>
155 | 			<Scope>Script</Scope>
156 | 		</Variable>
157 | 		<Variable>
158 | 			<!-- Exclude Catalogs, e.g Testing or Poc-Catalogs
159 | 				 Example: Windows 7,Windows 8 Test
160 | 				 Supports wildcards -->
161 | 			<Name>ExcludedCatalogs</Name>
162 | 			<Value></Value>
163 | 			<Type>[array]</Type>
164 | 			<Scope>Script</Scope>
165 | 		</Variable>
166 | 		<Variable>
167 | 			<!-- Exclude Delivery Groups, e.g Testing or Poc-DGs
168 | 				 Example: Windows 7,Windows 8 Test
169 | 				 Supports wildcards -->
170 | 			<Name>ExcludedDeliveryGroups</Name>
171 | 			<Value></Value>
172 | 			<Type>[array]</Type>
173 | 			<Scope>Script</Scope>
174 | 		</Variable>
175 | 		<Variable>
176 | 			<!-- Exclude Tags, e.g excludeFromReport, UAT, etc
177 | 				 Supports wildcards -->
178 | 			<Name>ExcludedTags</Name>
179 | 			<Value>excludeFromReport</Value>
180 | 			<Type>[array]</Type>
181 | 			<Scope>Script</Scope>
182 | 		</Variable>
183 | 		<Variable>
184 | 			<!-- define the maximum of counted machines (default is only 250) -->
185 | 			<Name>maxmachines</Name>
186 | 			<Value>5000</Value>
187 | 			<Type>[int]</Type>
188 | 			<Scope>Script</Scope>
189 | 		</Variable>
190 | 		<Variable>
191 | 			<!-- Time (In Days) that it will look back for maintenance mode actions
192 | 				 Example: 30
193 | 				 This is handy data to have in the reports so you can see who placed the
194 | 				 machines, Delivery Groups and Hypervisor Connections into maintenance mode -->
195 | 			<Name>MaintenanceModeActionsFromPastinDays</Name>
196 | 			<Value>30</Value>
197 | 			<Type>[int]</Type>
198 | 			<Scope>Script</Scope>
199 | 		</Variable>
200 | 		<Variable>
201 | 			<!-- Set to 1 if you want to Check for Broker Connection Failures -->
202 | 			<Name>ShowBrokerConnectionFailuresTable</Name>
203 | 			<Value>0</Value>
204 | 			<Type>[int]</Type>
205 | 			<Scope>Script</Scope>
206 | 		</Variable>
207 | 		<Variable>
208 | 			<!-- Time (In Hours) of that it will look back for Broker Connection Failures
209 | 				ShowBrokerConnectionFailuresTable must be set to 1 for this to be used.
210 | 				 Example: 12
211 | 				 If the report is run first thing in the morning, this will help see any
212 | 				 brokering issues that occurred overnight -->
213 | 			<Name>BrokerConnectionFailuresinHours</Name>
214 | 			<Value>12</Value>
215 | 			<Type>[int]</Type>
216 | 			<Scope>Script</Scope>
217 | 		</Variable>
218 | 		<Variable>
219 | 			<!-- Set a list of supported VDA versions. Any versions that do not match will be marked
220 | 				  as a warning. Leave blank to ignore this.
221 | 				  Supports wildcards -->
222 | 			<Name>SupportedVDAVersions</Name>
223 | 			<Value>2203.*,2402.*,2507.*</Value>
224 | 			<Type>[array]</Type>
225 | 			<Scope>Script</Scope>
226 | 		</Variable>
227 | 		<Variable>
228 | 			<!-- # Set to 1 if you want to Show and Check the CrowdStrike Tests in all tables -->
229 | 			<Name>ShowCrowdStrikeTests</Name>
230 | 			<Value>1</Value>
231 | 			<Type>[int]</Type>
232 | 			<Scope>Script</Scope>
233 | 		</Variable>
234 | 		<Variable>
235 | 			<!-- Mark failed Spooler and CitrixPrint services as warning only.
236 | 				 It reduces the red (errors) in the reports in environments where these services are
237 | 				 not required for normal operation -->
238 | 			<Name>MarkSpoolerAsWarningOnly</Name>
239 | 			<Value>0</Value>
240 | 			<Type>[int]</Type>
241 | 			<Scope>Script</Scope>
242 | 		</Variable>
243 | <!-- XenDesktop Options -->
244 | 		<Variable>
245 | 			<!-- # Set to 1 if you want to Check a Environment with XenDesktop (V 5.x and higher) -->
246 | 			<Name>ShowDesktopTable</Name>
247 | 			<Value>1</Value>
248 | 			<Type>[int]</Type>
249 | 			<Scope>Script</Scope>
250 | 		</Variable>
251 | 		<Variable>
252 | 			<!-- Set to the header name you would like to use to sort the table in ascending order.
253 | 				 Example: DeliveryGroup
254 | 				 This will sort by Delivery Group in ascending order, instead of hostname, which can
255 | 				 to identify config differences within that Delivery Group  where hostnames are not
256 | 				 contiguous or naming standards have changed over time.
257 | 				 Leave blank for default sort, which is hostname in ascending order. -->
258 | 			<Name>SortDesktopTableByHeaderName</Name>
259 | 			<Value></Value>
260 | 			<Type>[string]</Type>
261 | 			<Scope>Script</Scope>
262 | 		</Variable>
263 | 		<Variable>
264 | 			<!-- Define if you ONLY want to see bad DESKTOPS (Unregistered, to high Uptime)
265 | 				 I propose to set this value to 1 in not small environments >50 Desktops -->
266 | 			<Name>ShowOnlyErrorVDI</Name>
267 | 			<Value>0</Value>
268 | 			<Type>[int]</Type>
269 | 			<Scope>Script</Scope>
270 | 		</Variable>
271 | 		<Variable>
272 | 			<!-- Define if you want to see the used graphic mode)
273 | 				  -->
274 | 			<Name>ShowGraphicsMode</Name>
275 | 			<Value>1</Value>
276 | 			<Type>[int]</Type>
277 | 			<Scope>Script</Scope>
278 | 		</Variable>
279 | <!-- XenApp Options -->
280 | 		<Variable>
281 | 			<!-- Set to 1 if you want to Check a Environment with XenApp (V 7.x and higher) - if you need a Script for versions below visit http://deptive.co.nz/xenapp-farm-health-check-v2/ -->
282 | 			<Name>ShowXenAppTable</Name>
283 | 			<Value>1</Value>
284 | 			<Type>[int]</Type>
285 | 			<Scope>Script</Scope>
286 | 		</Variable>
287 | 		<Variable>
288 | 			<!-- Set to the header name you would like to use to sort the table in ascending order.
289 | 				 Example: DeliveryGroup
290 | 				 This will sort by Delivery Group in ascending order, instead of hostname, which can
291 | 				 to identify config differences within that Delivery Group  where hostnames are not
292 | 				 contiguous or naming standards have changed over time.
293 | 				 Leave blank for default sort, which is hostname in ascending order. -->
294 | 			<Name>SortXenAppTableByHeaderName</Name>
295 | 			<Value></Value>
296 | 			<Type>[string]</Type>
297 | 			<Scope>Script</Scope>
298 | 		</Variable>
299 | 		<Variable>
300 | 			<!-- Define if you ONLY want to see bad XENAPP (Unregistered, to high Uptime)
301 | 				 I propose to set this value to 1 in not small environments >50 Desktops -->
302 | 			<Name>ShowOnlyErrorXA</Name>
303 | 			<Value>0</Value>
304 | 			<Type>[int]</Type>
305 | 			<Scope>Script</Scope>
306 | 		</Variable>
307 | 		<Variable>
308 | 			<!-- Information about the disk you want to check. -->
309 | 			<Name>diskLettersWorkers</Name>
310 | 			<Value>C,D</Value>
311 | 			<Type>[array]</Type>
312 | 			<Scope>Script</Scope>
313 | 		</Variable>
314 | 		<Variable>
315 | 			<!-- Set to 1 if you want to see connected XenApp Users -->
316 | 			<Name>ShowConnectedXenAppUsers</Name>
317 | 			<Value>1</Value>
318 | 			<Type>[int]</Type>
319 | 			<Scope>Script</Scope>
320 | 		</Variable>
321 | 		<Variable>
322 | 			<!-- Set value for a load of a XenApp server that is be fine, but is needed to escalate -->
323 | 			<Name>loadIndexWarning</Name>
324 | 			<Value>6000</Value>
325 | 			<Type>[int]</Type>
326 | 			<Scope>Script</Scope>
327 | 		</Variable>
328 | 		<Variable>
329 | 			<!-- Set value for a load of a XenApp server that is be critical -->
330 | 			<Name>loadIndexError</Name>
331 | 			<Value>8500</Value>
332 | 			<Type>[int]</Type>
333 | 			<Scope>Script</Scope>
334 | 		</Variable>
335 | 		<Variable>
336 | <!-- License Options -->
337 | 			<!-- # Set to 1 if you want to Check a Citrix license usage -->
338 | 			<Name>ShowCTXLicense</Name>
339 | 			<Value>1</Value>
340 | 			<Type>[int]</Type>
341 | 			<Scope>Script</Scope>
342 | 		</Variable>
343 | 		<Variable>
344 | 			<!-- # Select types of licenses to report, eg: XDT_PLT_UD, PVSD_STD_CCS -->
345 | 			<Name>CTXLicenseMode</Name>
346 | 			<Value>XDT_PLT_CCS,XDT_PLT_UD,PVSD_STD_CCS</Value>
347 | 			<Type>[array]</Type>
348 | 			<Scope>Script</Scope>
349 | 		</Variable>
350 | <!-- Stuck Sessions Options -->
351 | 		<Variable>
352 | 			<!-- Set to 1 if you want to process and display the Stuck Sessions Table -->
353 | 			<Name>ShowStuckSessionsTable</Name>
354 | 			<Value>1</Value>
355 | 			<Type>[int]</Type>
356 | 			<Scope>Script</Scope>
357 | 		</Variable>
358 | 		<Variable>
359 | 			<!-- Maximum Disconnect Time (In Hours) of a virtual Desktop or a XenApp host
360 | 				 Example: 8
361 | 				 This will help to evaluate stuck or stale sessions -->
362 | 			<Name>MaxDisconnectTimeInHours</Name>
363 | 			<Value>8</Value>
364 | 			<Type>[int]</Type>
365 | 			<Scope>Script</Scope>
366 | 		</Variable>
367 | 		<Variable>
368 | 			<!-- Exclude user accounts from being flagged as a Stuck Session
369 | 			      Example: kiosk
370 | 				  Supports wildcards -->
371 | 			<Name>ExcludedStuckSessionUserAccounts</Name>
372 | 			<Value></Value>
373 | 			<Type>[array]</Type>
374 | 			<Scope>Script</Scope>
375 | 		</Variable>
376 | <!-- MCS/PVS-Section: If you are using WriteCache to HD -->
377 | 		<Variable>
378 | 			<!-- Drive to MCSIO vDisk write cache file -->
379 | 			<Name>MCSIOWriteCacheDrive</Name>
380 | 			<Value>D</Value>
381 | 			<Type>[string]</Type>
382 | 			<Scope>Script</Scope>
383 | 		</Variable>
384 | 		<Variable>
385 | 			<!-- Drive to PVS vDisk write cache file -->
386 | 			<Name>PvsWriteCacheDrive</Name>
387 | 			<Value>D</Value>
388 | 			<Type>[string]</Type>
389 | 			<Scope>Script</Scope>
390 | 		</Variable>
391 | 		<Variable>
392 | 			<!-- Maximum size of the local PVS (vdiskdif.vhdx) and MCSIO (mcsdif.vhdx) write cache file -->
393 | 			<Name>WriteCacheMaxSizeInGB</Name>
394 | 			<Value>15</Value> <!-- size in GB -->
395 | 			<Type>[long]</Type>
396 | 			<Scope>Script</Scope>
397 | 		</Variable>
398 | <!-- Logon Duration and Failed Connections Params -->
399 | 		<Variable>
400 | 			<!-- Define a EnvironmentName for the LogonDuration e.g. Integration/Production etc. - this will be used in HTML & Email Subject -->
401 | 			<Name>EnvironmentNameLogonDuration</Name>
402 | 			<Value>Citrix Logon Duration</Value>
403 | 			<Type>[string]</Type>
404 | 			<Scope>Script</Scope>
405 | 		</Variable>
406 | 		<Variable>
407 | 			<!-- Define a EnvironmentName for the FailedConnections e.g. Integration/Production etc. - this will be used in HTML & Email Subject -->
408 | 			<Name>EnvironmentNameFailedConnections</Name>
409 | 			<Value>Citrix Failed Connections</Value>
410 | 			<Type>[string]</Type>
411 | 			<Scope>Script</Scope>
412 | 		</Variable>
413 | 		<Variable>
414 | 			<!-- Define an Output log file for Citrix Logon Durations e.g CTXLogonDurations.log -->
415 | 			<Name>OutputLogLogonDurations</Name>
416 | 			<Value>CTXLogonDurations.log</Value>
417 | 			<Type>[string]</Type>
418 | 			<Scope>Script</Scope>
419 | 		</Variable>
420 | 		<Variable>
421 | 			<!-- Define an Output log file for Citrix Failed Connections e.g CTXFailedConnections.log -->
422 | 			<Name>OutputLogFailedConnections</Name>
423 | 			<Value>CTXFailedConnections.log</Value>
424 | 			<Type>[string]</Type>
425 | 			<Scope>Script</Scope>
426 | 		</Variable>
427 | 		<Variable>
428 | 			<!-- Set this to how many hours in time you want to look back into the logs from script runtime. -->
429 | 			<Name>HoursToLookBack</Name>
430 | 			<Value>24</Value>
431 | 			<Type>[int]</Type>
432 | 			<Scope>Script</Scope>
433 | 		</Variable>
434 | <!-- Logon Duration ONLY Params -->
435 | 		<Variable>
436 | 			<!-- The script will get the sessions that have a LogonDuration greater than the number of seconds you set here.
437 | 			Your aim should always be 30, but that may not always be practical. -->
438 | 			<Name>LogonDurationInSeconds</Name>
439 | 			<Value>30</Value>
440 | 			<Type>[int]</Type>
441 | 			<Scope>Script</Scope>
442 | 		</Variable>
443 | 		<Variable>
444 | 			<!-- Set this to the number of records you want to output. The script sorts all records collected in descending
445 | 			order and and then returns the top x records. Setting this to 0 will output all records -->
446 | 			<Name>NumberOfRecordsToOutput</Name>
447 | 			<Value>0</Value>
448 | 			<Type>[int]</Type>
449 | 			<Scope>Script</Scope>
450 | 		</Variable>
451 | 		<Variable>
452 | 			<!-- Only set this to True if your on-prem version supports of the LogonMetrics entity values for
453 | 			AppxAssociationStartDate,AppxAssociationEndDate,AppxLoadPackageStartDate and AppxLoadPackageEndDate.
454 | 			This is for future versions as this is yet to be ported to on-prem versions. -->
455 | 			<Name>OnPremAppxSupport</Name>
456 | 			<Value>false</Value>
457 | 			<Type>[bool]</Type>
458 | 			<Scope>Script</Scope>
459 | 		</Variable>
460 | <!-- Syslog Configuration -->
461 | 		<Variable>
462 | 			<!-- Set to true if you want to send to Syslog -->
463 | 			<Name>CheckOutputSyslog</Name>
464 | 			<Value>true</Value>
465 | 			<Type>[bool]</Type>
466 | 			<Scope>Script</Scope>
467 | 		</Variable>
468 | 		<Variable>
469 | 			<!-- Define an Output Syslog file for the Citrix Health Check e.g CTXXDHealthCheckSyslog.log -->
470 | 			<Name>OutputSyslog</Name>
471 | 			<Value>CTXXDHealthCheckSyslog.log</Value>
472 | 			<Type>[string]</Type>
473 | 			<Scope>Script</Scope>
474 | 		</Variable>
475 | 		<Variable>
476 | 			<!-- Define an Output Syslog file for Citrix Logon Durations e.g CTXLogonDurationsSyslog.log -->
477 | 			<Name>OutputSyslogLogonDurations</Name>
478 | 			<Value>CTXLogonDurationsSyslog.log</Value>
479 | 			<Type>[string]</Type>
480 | 			<Scope>Script</Scope>
481 | 		</Variable>
482 | 		<Variable>
483 | 			<!-- Define an Output Syslog file for Citrix Failed Connections e.g CTXFailedConnectionsSyslog.log -->
484 | 			<Name>OutputSyslogFailedConnections</Name>
485 | 			<Value>CTXFailedConnectionsSyslog.log</Value>
486 | 			<Type>[string]</Type>
487 | 			<Scope>Script</Scope>
488 | 		</Variable>
489 | 		<!--
490 | 		The STRUCTURED-DATA part of an RFC 5424 syslog message is enclosed in square brackets ([]). Within these brackets, each SD-ELEMENT begins
491 | 		with its unique SD-ID, followed by its associated parameters.
492 | 		- The prefix for the Structured Data ID, which is the bit that comes before the @ symbol. This is a constant within the script and does not
493 | 		need to be in this params file.
494 | 		- The Private Enterprise Number (PEN) comes after the @ symbol to make up the Structured Data ID (SD-ID). This is set here.
495 | 		The MSGID field provides a unique identifier for the type of message being sent. This field helps in categorizing and filtering log messages.
496 | 		- The MSGID (Message Identifier) is also a constant within the script and does not need to be in this params file.
497 | 		-->
498 | 		<Variable>
499 | 			<!-- Private Enterprise Number (PEN). For these reports we are using the Private Enterprise Number (PEN) registered to Citrix of 3845.
500 | 			- Registered Private Enterprise Numbers (PENs) can be found here:
501 | 			  - https://www.iana.org/assignments/enterprise-numbers/
502 | 			- If you don't have a Private Enterprise Number (PEN), and you do not want to use the one registered to Citrix, you can request
503 | 			a new assignment for free here:
504 | 			  - https://www.iana.org/assignments/enterprise-numbers/assignment/apply/ -->
505 | 			<Name>PrivateEnterpriseNumber</Name>
506 | 			<Value>3845</Value>
507 | 			<Type>[string]</Type>
508 | 			<Scope>Script</Scope>
509 | 		</Variable>
510 | 		<Variable>
511 | 			<!-- Set to true to output to file only or false to also send to the Syslog server. -->
512 | 			<Name>SyslogFileOnly</Name>
513 | 			<Value>true</Value>
514 | 			<Type>[bool]</Type>
515 | 			<Scope>Script</Scope>
516 | 		</Variable>
517 | 		<Variable>
518 | 			<!-- Address of the Syslog Server. It will use UDP 514 as the port -->
519 | 			<Name>SyslogServer</Name>
520 | 			<Value>192.168.1.15</Value>
521 | 			<Type>[string]</Type>
522 | 			<Scope>Script</Scope>
523 | 		</Variable>
524 | <!-- E-Mail Configuration -->
525 | 		<Variable>
526 | 			<!-- Set to 1 if you want to send E-mail -->
527 | 			<Name>CheckSendMail</Name>
528 | 			<Value>1</Value>
529 | 			<Type>[int]</Type>
530 | 			<Scope>Script</Scope>
531 | 		</Variable>
532 | 		<Variable>
533 | 			<!-- Address of the sender -->
534 | 			<Name>emailFrom</Name>
535 | 			<Value>citrix@mycompany.ch</Value>
536 | 			<Type>[string]</Type>
537 | 			<Scope>Script</Scope>
538 | 		</Variable>
539 | 		<Variable>
540 | 			<!-- Address of the recipient -->
541 | 			<Name>emailTo</Name>
542 | 			<Value>citrix@mycompany.ch</Value>
543 | 			<Type>[string]</Type>
544 | 			<Scope>Script</Scope>
545 | 		</Variable>
546 | 		<Variable>
547 | 			<!-- Address of the recipient for CC -->
548 | 			<Name>emailCC</Name>
549 | 			<Value></Value>
550 | 			<Type>[string]</Type>
551 | 			<Scope>Script</Scope>
552 | 		</Variable>
553 | 		<Variable>
554 | 			<!-- IP or name of SMTP server  -->
555 | 			<Name>smtpServer</Name>
556 | 			<Value>mailrelay.mycompany.ch</Value>
557 | 			<Type>[string]</Type>
558 | 			<Scope>Script</Scope>
559 | 		</Variable>
560 | 		<Variable>
561 | 			<!-- Port of SMTP server -->
562 | 			<Name>smtpServerPort</Name>
563 | 			<Value>25</Value>
564 | 			<Type>[string]</Type>
565 | 			<Scope>Script</Scope>
566 | 		</Variable>
567 | 		<Variable>
568 | 			<!-- Use ssl for SMTP or not -->
569 | 			<Name>smtpEnableSSL</Name>
570 | 			<Value>False</Value> <!-- False or True -->
571 | 			<Type>[bool]</Type>
572 | 			<Scope>Script</Scope>
573 | 		</Variable>
574 | 		<Variable>
575 | 			<!-- Priority of email -->
576 | 			<Name>emailPrio</Name>
577 | 			<Value>Low</Value>
578 | 			<Type>[string]</Type>
579 | 			<Scope>Script</Scope>
580 | 		</Variable>
581 | 		<Variable>
582 | 			<!-- Username -->
583 | 			<Name>smtpUser</Name>
584 | 			<Value></Value>
585 | 			<Type>[string]</Type>
586 | 			<Scope>Script</Scope>
587 | 		</Variable>
588 | 		<Variable>
589 | 			<!-- Key for password encryption -->
590 | 			<Name>smtpKey</Name>
591 | 			<Value>7,13,25,32,42,64,72,88,91,55,88,55,77,59,22,82,200,0,3,88,10,55,93,244</Value>
592 | 			<Type>[array]</Type>
593 | 			<Scope>Script</Scope>
594 | 		</Variable>
595 | 		<Variable>
596 | 			<!-- Password
597 | 				 Create password with follow two lines
598 | 				 $Credential = Get-Credential
599 | 				 $credential.Password | ConvertFrom-SecureString -Key $smtpKey -->
600 | 			<Name>smtpPW</Name>
601 | 			<Value></Value>
602 | 			<Type>[string]</Type>
603 | 			<Scope>Script</Scope>
604 | 		</Variable>
605 | 	</Variables>
606 | </settings>
607 | 


--------------------------------------------------------------------------------