ES1_IndexUtils.psm1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
<#    
 .NOTES
 ===========================================================================
  
 Copyright � 2018 Dell Inc. or its subsidiaries. All Rights Reserved.

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at
        http://www.apache.org/licenses/LICENSE-2.0
 ===========================================================================
 THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
 WHETHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED
 WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
 IF THIS CODE AND INFORMATION IS MODIFIED, THE ENTIRE RISK OF USE OR RESULTS IN
 CONNECTION WITH THE USE OF THIS CODE AND INFORMATION REMAINS WITH THE USER.

 .DESCRIPTION
  Functions and objects for managing Indexes in a folder


#>



<#
.SYNOPSIS
   Issue a "Rebuild" request for the Indexes specified
.DESCRIPTION
  Issue a "Rebuild" request for the Indexes specified
  The process of rebuilding an index is handled by index servers on a scheduled basis. The completion of the rebuild
  operation could take some time.

.PARAMETER ArchiveName
 The name of the archive connection

.PARAMETER ArchiveFolder
 The archive folder containig the indexes.

.PARAMETER YearMonth
 The year and month folder which the indexes are part of

.PARAMETER IndexNumList
 A integer array of the index numbers to be rebuilt.

.OUTPUTS
 List of Indexes submitted for rebuild

.EXAMPLE

#>

function Rebuild-ES1Index{
[CmdletBinding(SupportsShouldProcess=$true,
               ConfirmImpact=�High�)]
     PARAM (
     [Parameter(Mandatory=$true)]
        [Alias('archive')]
        [string] $ArchiveName,        
        [Parameter(Mandatory=$true)]
        [Alias('arfolder')]
        [string] $ArchiveFolder,
        [Parameter(Mandatory=$true)]
        [Alias('month')]
        [string] $YearMonth,
        [Parameter(Mandatory=$true)]
        [Alias('idxnums')]
        [int []] $IndexNumList

        )

BEGIN
    {
     
        $MyDebug = $false
        # Do both these checks to take advantage of internal parsing of syntaxes like -Debug:$false
        if ($PSCmdlet.MyInvocation.BoundParameters.ContainsKey("Debug") -and $PSCmdlet.MyInvocation.BoundParameters["Debug"].IsPresent)
        {
            $DebugPreference = "Continue"
            Write-Debug "Debug Output activated"
            # for convenience
            $MyDebug = $true
        }

    try {
         [bool] $loaded = Add-ES1Types #-ErrorAction SilentlyContinue

        if (-not $loaded )
        {
            Write-Error 'Error loading SourceOne Objects and Types'
            break
        }
    }
    catch
    {
        Write-Error $_ 
        break
    }

}
    
PROCESS {

 try {
        $asmgr = new-object -ComObject ExAsAdminAPI.CoExASAdminAPI
        $asmgr.SetTraceInfo($Global:S1LogFile)
        $asmgr.Initialize()
        $RetIndexList=@()

        # Get the index flag enumeration strings/names
        $idxFlags=[enum]::GetNames([EMC.Interop.ExAsBaseAPI.exASIndexFlags])

        # Get the specific repo.
        $repo = $asmgr.GetRepository($ArchiveName)
        $repo.SetTraceInfo($Global:S1LogFile)

        # Need the folderplan object to issue the "Rebuild" on
        $folderplan=$repo.GetFolderPlan()

        # Get the archive folder we need
        $folder = Get-Es1ArchiveFolder -ArchiveName $ArchiveName -FolderName $ArchiveFolder 
        
        if ($folder -ne $null)
        {
            $folder.SetTraceInfo($Global:S1LogFile)
            $containerfolders=$folder.EnumerateContainerFolders()
        
            # dummy filter object because need to pass something to EnumerateIndexes but its not actually used (I looked at the underlying code)
            $idxFilter = $repo.CreateNewObject([EMC.Interop.ExAsAdminAPI.exASObjectType]::exASObjectType_ArchiveFolder)
            [bool] $FoundYM = $false
            foreach ($cf in $containerfolders)
            {
                if ($cf.Name -eq $YearMonth)
                {
                    $FoundYM = $true
                    $cf.SetTraceInfo($Global:S1LogFile)
                    Write-Verbose "Year Month name: $($cf.Name)"

                    $indexes=$cf.EnumerateIndexes($idxFilter)
                         
                    foreach ($index in $indexes)
                    {                   
                        Foreach($inum in $IndexNumList)
                        {
                                if ([int] $inum -eq [int] $index.IndexNum)
                                {                   
                                         # Make sure its not alreading ReIndexing or Refreshing
                                        if ( (-not ($index.IndexState -band [EMC.Interop.ExAsBaseAPI.exASIndexFlags]::exASIndexFlagRefreshing)) -and `
                                             (-not ($index.IndexState -band [EMC.Interop.ExAsBaseAPI.exASIndexFlags]::exASIndexFlagReindexing)) )
                                        {
                                            if ($pscmdlet.ShouldProcess("Folder: $($cf.Name) Index: $($index.IndexNum) ?")) 
                                            {
                                                # issue rebuild
                                                Write-Verbose "Issueing rebuild for $($cf.Name), $($index.IndexNum)"
                                    
                                                $folderplan.ReIndex($index.FolderID, $index.IndexNum)
                                                $RetIndexList += $index
                                            }
                                        }
                                }
                        }
                
                    }

                    # stop cause we processed what was specified.
                    break
                }
            } 
            if ( -not $FoundYM )
            {
                throw "Error: No matching Year or month folder found for $($YearMonth)"
            }  
        }
        else
        {
            throw "Error: Archive $($ArchiveName) or Folder $($ArchiveFolder) not found"
        }
    }
    catch {
        Write-Error $_
    }
    finally
    {
        # These might not be 100% necessary..
        [System.Runtime.Interopservices.Marshal]::ReleaseComObject($folderplan) > $null
        [System.Runtime.Interopservices.Marshal]::ReleaseComObject($repo) > $null
    }
    
    $RetIndexList
 }
 END {}
}

<#
.SYNOPSIS
   Get a list of indexes in the state(s) requested
.DESCRIPTION
  Get a list of indexes in the state(s) requested

.PARAMETER ArchiveName
 The name of the archive connection

.PARAMETER ArchiveFolder
 The archive folder containig the indexes.

.PARAMETER YearMonth
 The year and month folder which the indexes are part of. Can only be used in conjuction with the ArchiveFolder
 parameter

.PARAMETER States
 List of states. The States correlate to some common combinations of the [EMC.Interop.ExAsBaseAPI.exASIndexFlags]
 enum of the volume flag bits.

 REPAIRING will return Indexes with ReIndexing or Refreshing bits sets
 CORRUPT will return Indexes with the Corrupt bit set
 INCOMPLETE will return Indexes with the any of the InconsistentAncillaryDB,MissingMsgs, Missing,
                  MissingACE, MissingBCC, MissingOwner, or MissingRecpts bit set
 UNPERFORMEDTRANS will return Indexes with the UnperformedTrans bit set


.OUTPUTS
 List of Indexes in the requested state(s)

.EXAMPLE

#>

Function Get-ES1IndexByState {
[CmdletBinding()]
PARAM( [Parameter(Mandatory=$true)]
        [Alias('archive')]
        [string] $ArchiveName,        
        [Parameter(Mandatory=$false)]
        [Alias('name')]
        [string] $ArchiveFolder,
        [Parameter(Mandatory=$false)]
        [Alias('month')]
        [string] $YearMonth,
        [Parameter(Mandatory=$true)]                      
        [ValidateSet ("REPAIRING","CORRUPT","INCOMPLETE","UNPERFORMEDTRANS")]
        [string[]] $States
        )


BEGIN{
        
        $MyDebug = $false

        # The YearMonth parameter only make sense when an ArchiveFolder is specified. Otherwise you might get some meaningless results
        if ($PSCmdlet.MyInvocation.BoundParameters.ContainsKey("YearMonth") -and(-not $PSCmdlet.MyInvocation.BoundParameters.ContainsKey("ArchiveFolder")))
        {
            Write-Error "Argument Error: YearMonth can only be specified with an ArchiveFolder"
            break
        }

        # Do both these checks to take advantage of internal parsing of syntaxes like -Debug:$false
        if ($PSCmdlet.MyInvocation.BoundParameters.ContainsKey("Debug") -and $PSCmdlet.MyInvocation.BoundParameters["Debug"].IsPresent)
        {
            $DebugPreference = "Continue"
            Write-Debug "Debug Output activated"
            # for convenience
            $MyDebug = $true
        }

    try {
         [bool] $loaded = Add-ES1Types #-ErrorAction SilentlyContinue

        if (-not $loaded )
        {
            Write-Error 'Error loading SourceOne Objects and Types'
            break
        }
    }
    catch
    {
        Write-Error $_ 
        break
    }
}
PROCESS{

try {
        $asmgr = new-object -ComObject ExAsAdminAPI.CoExASAdminAPI
        $asmgr.SetTraceInfo($Global:S1LogFile)
        $asmgr.Initialize()
        $RetIndexList=@()

        # Get the index flag enumeration strings/names
        $idxFlags=[enum]::GetNames([EMC.Interop.ExAsBaseAPI.exASIndexFlags])

        # Get the specific repo.
        $repo = $asmgr.GetRepository($ArchiveName)
        $repo.SetTraceInfo($Global:S1LogFile)

        $folderplan=$repo.GetFolderPlan()
        $folders = @($folderplan.EnumerateArchiveFolders())

        # If an archive folder was specified only process that one...
        if ($ArchiveFolder )
        {
            foreach ($folder in $folders)
            {
             if (($folder.Name -eq $ArchiveFolder) )
                {
                    $folders = @($folder)
                    break;
                }
            }
        }

        # dummy object because need to pass something but its not actually used
        $idxFilter = $repo.CreateNewObject([EMC.Interop.ExAsAdminAPI.exASObjectType]::exASObjectType_ArchiveFolder)

        foreach ($folder in $folders)
        {
            $containerfolders=$folder.EnumerateContainerFolders()
            
            foreach ($cf in $containerfolders)
            {
                #
                # Process only the YMFolder if specified.
                #
                if ($YearMonth -and ($YearMonth -ne $cf.Name) )
                {
                    continue
                }
                
                $cf.SetTraceInfo($Global:S1LogFile)

                $indexes=$cf.EnumerateIndexes($idxFilter)
                Write-Verbose "Archive Folder: $($ArchiveFolder) YearMonth : $($cf.Name) Index Count $($indexes.Count)"
                             
                foreach ($index in $indexes)
                {  
                    $roles = @()
                       for ($i = 0 ; $i -lt ($idxFlags.Length); $i++)
                    {
                        [int] $bits = [EMC.Interop.ExAsBaseAPI.exASIndexFlags]$idxFlags[$i]
                        
                        # there are some inconsistent names in the EMC.Interop.ExAsBaseAPI.exASIndexFlags so making the string
                        # readable friendly takes a little extra work
                        if ($index.IndexState -band $bits)
                        {
                            if (([EMC.Interop.ExAsBaseAPI.exASIndexFlags]$idxFlags[$i]).ToString().Contains('exASIndexMissing') -or `
                            ([EMC.Interop.ExAsBaseAPI.exASIndexFlags]$idxFlags[$i]).ToString().Contains('exASIndex4xMBCSIndex') -or `
                            ([EMC.Interop.ExAsBaseAPI.exASIndexFlags]$idxFlags[$i]).ToString().Contains('exASIndexESIndex') 
                            )
                            {
                                $roles += ([EMC.Interop.ExAsBaseAPI.exASIndexFlags]$idxFlags[$i]).ToString().Substring(9)
                            }
                            elseif (([EMC.Interop.ExAsBaseAPI.exASIndexFlags]$idxFlags[$i]).ToString().Contains('exAsInconsistent'))
                            {
                                $roles += ([EMC.Interop.ExAsBaseAPI.exASIndexFlags]$idxFlags[$i]).ToString().Substring(4)
                            }
                            else
                            {
                                $roles += ([EMC.Interop.ExAsBaseAPI.exASIndexFlags]$idxFlags[$i]).ToString().Substring(13)
                            }
                        }

                    }

                    # add a user readable string representation of the flags
                    $index | Add-Member NoteProperty -Name "ArchiveFolder" -Value $folder.Name
                    $index | Add-Member NoteProperty -Name "FolderName" -Value $cf.Name
                    $index | Add-Member NoteProperty -Name "IndexStatus" -Value $roles
                

                    foreach ($state in $States)
                    {
                        if ( ($state -eq 'REPAIRING') -and `
                            (($index.IndexState -band [EMC.Interop.ExAsBaseAPI.exASIndexFlags]::exASIndexFlagRefreshing) -or `
                             ($index.IndexState -band [EMC.Interop.ExAsBaseAPI.exASIndexFlags]::exASIndexFlagReindexing) ))
                        {
                            $RetIndexList += $index
                            break
                        }

                        if ( ($state -eq 'CORRUPT') -and `
                            (($index.IndexState -band [EMC.Interop.ExAsBaseAPI.exASIndexFlags]::exASIndexFlagCorrupt) ))
                        {
                            $RetIndexList += $index
                            break
                        }
                        if ( ($state -eq 'UNPERFORMEDTRANS') -and `
                            (($index.IndexState -band [EMC.Interop.ExAsBaseAPI.exASIndexFlags]::exASIndexFlagUnperformedTrans) ))
                        {
                            $RetIndexList += $index
                            break
                        }
                        if ( ($state -eq 'INCOMPLETE') -and `
                            (($index.IndexState -band [EMC.Interop.ExAsBaseAPI.exASIndexFlags]::exAsInconsistentAncillaryDB) -or `
                             ($index.IndexState -band [EMC.Interop.ExAsBaseAPI.exASIndexFlags]::exASIndexMissingMsgs) -or `
                             ($index.IndexState -band [EMC.Interop.ExAsBaseAPI.exASIndexFlags]::exASIndexMissing)  -or `
                             ($index.IndexState -band [EMC.Interop.ExAsBaseAPI.exASIndexFlags]::exASIndexMissingBusinessFolder)  -or `
                             ($index.IndexState -band [EMC.Interop.ExAsBaseAPI.exASIndexFlags]::exASIndexMissingACE)  -or `
                             ($index.IndexState -band [EMC.Interop.ExAsBaseAPI.exASIndexFlags]::exASIndexMissingBCC)  -or `
                             ($index.IndexState -band [EMC.Interop.ExAsBaseAPI.exASIndexFlags]::exASIndexMissingOwner)  -or `
                             ($index.IndexState -band [EMC.Interop.ExAsBaseAPI.exASIndexFlags]::exASIndexMissingRecpts)  )
                             )
                        {
                            $RetIndexList += $index
                            break
                        }

                    }

                }
            }

        }
    }
    catch {
        Write-Error $_
    }
    finally
    {
        # These might not be 100% necessary..
        [System.Runtime.Interopservices.Marshal]::ReleaseComObject($folderplan) > $null
        [System.Runtime.Interopservices.Marshal]::ReleaseComObject($repo) > $null
    }
    
    $RetIndexList

}

END{}

}



Export-ModuleMember -Function * -Alias *