Lync Server Admin Guide: Managing Archiving

  • Article

This article is part of the Microsoft Lync Server 2010 Administration Guide: PowerShell Supplement.

 

 

Configuring Support for Archiving of Internal and External Communications

 

Change the Global Policy for Archiving of Internal and External Communications

 

  • To change the global policy for archiving

 

To modify the global archiving policy, use the Set-CsArchivingPolicy cmdlet and set the Identity to global:

 

Set-CsArchivingPolicy -Identity global -ArchiveInternal $True –ArchiveExternal $True

 

Alternatively, you can leave off the Identity parameter. If you do not specify an Identity, Set-CsArchivingPolicy will automatically modify the global policy:

 

Set-CsArchivingPolicy -ArchiveInternal $True –ArchiveExternal $True

 

 

Create a Site Policy for Archiving

 

  • To create an archiving policy for a site

 

To create a new archiving policy at the site scope, use the New-CsArchivingPolicy cmdlet:

 

New-CsArchivingPolicy -Identity "site:Redmond" -ArchiveInternal $True –ArchiveExternal $True

 

 

Enable or Disable Archiving for a Site

 

  • To change a site policy

 

To modify an archiving policy configured at the site scope, use the Set-CsArchivingPolicy cmdlet:

 

Set-CsArchivingPolicy -Identity "site:Redmond" -ArchiveInternal $False –ArchiveExternal $False

 

 

Create a User Policy for Archiving

 

  • To create a user policy for archiving

 

To create a new per-user archiving policy, use the New-CsArchivingPolicy cmdlet:

 

New-CsArchivingPolicy -Identity "RedmondArchivingPolicy" -ArchiveInternal $True –ArchiveExternal $True

 

 

Enable or Disable Archiving for Users

 

  • To change a user policy for archiving

 

To modify a per-user archiving policy, use the Set-CsArchivingPolicy cmdlet:

 

Set-CsArchivingPolicy -Identity "RedmondArchivingPolicy" -ArchiveInternal $False

 

 

Delete an Archiving Policy

 

  • To delete a user or site policy for archiving

 

To delete a per-user or per-site archiving policy use the Remove-CsArchivingPolicy cmdlet:

 

Remove-CsArchivingPolicy -Identity "RedmondArchivingPolicy"

 

This command removes all the archiving policies configured at the site scope:

 

Get-CsArchivingPolicy –Filter "site:*" | Remove-CsArchivingPolicy

 

And this one removes all the archiving policies configured at the per-user scope:

 

Get-CsArchivingPolicy –Filter "tag:*" | Remove-CsArchivingPolicy

 

 

Apply an Archiving Policy to a User or User Group

 

  • To apply an archiving user policy to a user account

 

To assign a per-user archiving policy to a user, use the Grant-CsArchivingPolicy cmdlet:

 

Grant-CsArchivingPolicy –Identity "Ken Myer" –PolicyName "RedmondArchiving"

 

To unassign a per-user archiving policy, use the Grant-CsArchivingPolicy cmdlet and set the value of the PolicyName property to null:

 

Grant-CsArchivingPolicy –Identity "Ken Myer" –PolicyName $Null

 

 

For more information

 

 

 

 

 

Enable or Disable Archiving

 

  • To enable or disable archiving for a policy

 

To disable archiving, use the Set-CsArchivingConfiguration cmdlet and set the EnableArchiving property to None:

 

Set-CsArchivingConfiguration –Identity global –EnableArchiving None

 

 

For more information

 

 

 

 

 

Specify the Types of Communications to Be Archived

 

  • To specify the communications to be archived

 

To archive only instant message sessions, use the Set-CsArchivingConfiguration cmdlet and set the EnableArchiving property to ImOnly:

 

Set-CsArchivingConfiguration –Identity global –EnableArchiving ImOnly

 

To archive both instant message sessions and conferences, set EnableArchiving to ImAndWebConf:

 

Set-CsArchivingConfiguration –Identity global –EnableArchiving ImAndWebConf

 

To disable archiving altogether, set EnableArchiving to None:

 

Set-CsArchivingConfiguration –Identity global –EnableArchiving None

 

 

For more information

 

 

 

 

 

Enable or Disable Purging for Archiving

 

  • To enable or disable purging for archiving

 

To enable the purging of old records from the archiving database, use the Set-CsArchivingConfiguration cmdlet to set the EnablePurging property to True:

 

Set-CsArchivingConfiguration –Identity global –EnablePurging $True –KeepArchivingDataForDays 30

 

As shown above, you can also use the KeepArchivingDataForDays parameter to specify the number of days that records should be kept in the database.

 

To disable purging, set the EnablePurging property to False:

 

Set-CsArchivingConfiguration –Identity global –EnablePurging $False

 

 

For more information

 

 

 

 

 

Block or Allow IM and Web Conferencing Sessions If Archiving Fails

 

  • To enable or disable blocking of IM and web conferencing sessions if archiving fails

 

To disable instant message sessions and conferences if archiving fails, use the Set-CsArchivingConfiguration cmdlet and set the BlockOnArchiveFailure property to True:

 

Set-CsArchivingConfiguration –Identity global –BlockOnArchiveFailure $True

 

To allow instant message sessions and conferences if archiving fails set the BlockOnArchiveFailure property to False:

 

Set-CsArchivingConfiguration –Identity global –BlockOnArchiveFailure $False

 

 

For more information

 

 

 

 

 

Enable or Disable Sending an Archiving Disclaimer to Federated Partners

 

  • To enable or disable sending an archiving disclaimer to federated partners

 

To display an archiving disclaimer to federated partners at the beginning of an instant messaging session, use the Set-CsAccessEdgeConfiguration cmdlet and set the EnableArchivingDisclaimer property to True:

 

Set-CsAccessEdgeConfiguration –Identity global -EnableArchivingDisclaimer $True

 

To prevent the display of the archiving disclaimer, set the EnableArchivingDisclaimer property to False:

 

Set-CsAccessEdgeConfiguration –Identity global -EnableArchivingDisclaimer $False

 

 

For more information