Lifecycle Services Cmdlets

PowerShell CmdLets have been deprecated in 6.0. These articles are provided for informational purposes only.

Records Management supports the post-installation configuration of Lifeycle Services by using a PowerShell Module installed to the following location:

POWERSHELL

%Install Path%\PowerShell\RecordLion.RecordsManager.PowerShell.dll

When Records Management Services are installed, the following Cmdlets are pre-registered with PowerShell and should be immediately available. However, if the Cmdlets are not available, simply execute the following command from a PowerShell Script to make the Cmdlets available.

POWERSHELL

Import-Module “%Install Path%\PowerShell\RecordLion.RecordsManager.PowerShell.dll”

%Install Path% should be replaced with the absolute path to where installation was specified.

Cmdlets

Get-RetentionServiceStatus

POWERSHELL

Get-RetentionServiceStatus
[-SQLTimeout <int>]

Remove-RetentionServicePermission

POWERSHELL

Remove-RetentionServicePermission
[-ServiceIdentity <pscredential>]
[-Stop]
[-Start]
[-ChangeLogon]
[-GrantPermissionToServiceIdentity]

Set-IndexRebuildInterval

POWERSHELL

Set-IndexRebuildInterval
-Interval <IndexRebuildInterval> {None | Hourly | Daily | Weekly}
[-RebuildStartHour <int>]
[-SQLTimeout <int>]

Set-RetentionService

POWERSHELL

Set-RetentionService
[-ConnectionString <string>]
[-ServiceIntervalInMS <int>]
[-AuditLifespanInDays <int>]
[-LoggingLevel <string>]
[-ServiceIdentity <pscredential>]
[-Stop]
[-Start]
[-ChangeLogon]
[-GrantPermissionToServiceIdentity]