Merge pull request #15 from umn-microsoft-automation/1.0.12

Add configurable timeout for Get-UsersIDM

README.md

@@ -1,5 +1,8 @@
 # UMN-Common
 
+## 1.0.12 - 6/18/2020
+Make Timeout for Get-UsersIDM configurable
+
 ## 1.0.11 - 12/10/2019
 Fixed bug in Send-SplunkHEC when eventData was a PSCustomObject.
 Changed code to make copy of metadata hashtable rather than modifying in place

UMN-Common.psd1

@@ -28,7 +28,7 @@
 RootModule = 'UMN-Common.psm1'
 
 # Version number of this module.
-ModuleVersion = '1.0.11'
+ModuleVersion = '1.0.12'
 
 # ID used to uniquely identify this module
 GUID = '4a7ba823-deb0-4b4d-9f81-396b20c8784b'
@@ -122,9 +122,7 @@ PrivateData = @{
 
         # ReleaseNotes of this module
         ReleaseNotes = @"
-Fixed bug in Send-SplunkHEC when eventData was a PSCustomObject.
-Changed code to make copy of metadata hashtable rather than modifying in place
-Renamed Host parameter in Send-SplunkHEC to EventHost (and added alias for backwards compatiblity)
+Make Timeout for Get-UsersIDM configurable
 "@
 
     } # End of PSData hashtable

UMN-Common.psm1

@@ -330,8 +330,16 @@ function Get-RandomString {
 				Fetch list of users from IDM
 			.DESCRIPTION
 				Fetch list of users from IDM
+			.PARAMETER ldapServer
+				Name of LDAP server to connect to
+			.PARAMETER ldapSearchString
+				LDAP query to execute
+			.PARAMETER searchDN
+				DN to execute search against
+			.PARAMETER TimeoutMinutes
+				Timeout for the query, in minutes, defaults to 30. If the query exceeds this time it will throw an exception
 			.EXAMPLE
-				$users = Get-UsersIDM -ldapCredential $ldapCredential -ldapServer $ldapServer -ldapSearchString "(Role=*.cur*)"
+				$users = Get-UsersIDM -ldapCredential $ldapCredential -ldapServer $ldapServer -ldapSearchString "(Role=*.cur*)" -TimeoutMinutes 60
 			.EXAMPLE
 				$users = Get-UsersIDM -ldapCredential $ldapCredential -ldapServer $ldapServer -ldapSearchString "(&(Role=*.staff.*)(cn=mrEd))"
 		#>
@@ -347,7 +355,9 @@ function Get-RandomString {
 			[Parameter(Mandatory)]
 			[string]$ldapSearchString,
 
-			[string]$searchDN
+			[string]$searchDN,
+
+			[int]$TimeoutMinutes = 30
 		)
 		#Load the assemblies needed for ldap lookups
 		$null = [System.Reflection.Assembly]::LoadWithPartialName("System.DirectoryServices.Protocols")
@@ -369,8 +379,8 @@ function Get-RandomString {
 		$ldapSearch.Scope = "Subtree"
 		$ldapSearch.DistinguishedName = $searchDN
 
-		#execute query for Students...30 minute timeout...generally takes about 12 minutes
-		$ldapResponse = $ldapConnection.SendRequest($ldapSearch, (New-Object System.TimeSpan(0,30,0))) -as [System.DirectoryServices.Protocols.SearchResponse]
+		#execute query for Students...default 30 minute timeout...generally takes about 12 minutes
+		$ldapResponse = $ldapConnection.SendRequest($ldapSearch, (New-Object System.TimeSpan(0,$TimeoutMinutes,0))) -as [System.DirectoryServices.Protocols.SearchResponse]
 		$null = $ldapConnection.Dispose()
 		return ($ldapResponse)
 	}