Set-VBOOrganizationRetentionExclusion

Short Description

Modifies retention policy settings for contacts and calendars of a specific organization.

Syntax

Set-VBOOrganizationRetentionExclusion -Exclusion <VBOOrganizationRetentionExclusion> [-Calendar <SwitchParameter>] [-Contacts <SwitchParameter>] [<CommonParameters>]

Detailed Description

This cmdlet modifies retention policy settings for contacts and calendars of a specific organization. To modify settings, you need to enter the necessary parameters with new values. The parameters that you omit will remain unchanged.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
Exclusion	Specifies retention policy settings for contacts and calendars of a specific organization. The cmdlet will modify these settings.	Accepts the VBOOrganizationRetentionExclusion object. To get this object, run the Get-VBOOrganizationRetentionExclusion cmdlet.	True	Named	False	False
Calendar	Defines that Veeam Backup for Microsoft 365 will not apply retention policy for calendars of the specified organization. If you do not provide this parameter, Veeam Backup for Microsoft 365 will apply retention policy for calendars.	SwitchParameter	False	Named	False	False
Contacts	Defines that Veeam Backup for Microsoft 365 will not apply retention policy for contacts of the specified organization. If you do not provide this parameter, Veeam Backup for Microsoft 365 will apply retention policy for contacts.	SwitchParameter	False	Named	False	False

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Accept Wildcard Characters

Exclusion

Specifies retention policy settings for contacts and calendars of a specific organization. The cmdlet will modify these settings.

Accepts the VBOOrganizationRetentionExclusion object.

To get this object, run the Get-VBOOrganizationRetentionExclusion cmdlet.

True

Named

False

Calendar

Defines that Veeam Backup for Microsoft 365 will not apply retention policy for calendars of the specified organization.

If you do not provide this parameter, Veeam Backup for Microsoft 365 will apply retention policy for calendars.

SwitchParameter

False

Named

False

Contacts

Defines that Veeam Backup for Microsoft 365 will not apply retention policy for contacts of the specified organization.

If you do not provide this parameter, Veeam Backup for Microsoft 365 will apply retention policy for contacts.

SwitchParameter

False

Named

False

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Output Object

This cmdlet returns the VBOOrganizationRetentionExclusion object that contains settings of organization retention policy for contacts and calendars.

Examples

Set-VBOOrganizationRetentionExclusion Example 1. Enabling Organization Retention Policy for Contacts

This example shows how to enable organization retention policy for contacts.

$org = Get-VBOOrganization -Name "Atlanta"

$policysettings = Get-VBOOrganizationRetentionExclusion -Organization $org

Set-VBOOrganizationRetentionExclusion -Exclusion $policysettings -Contacts:$true

Perform the following steps:

Run the Get-VBOOrganization cmdlet. Set the Name parameter value. Save the result to the $org variable.
Run the Get-VBOOrganizationRetentionExclusion cmdlet. Set the $org variable as the Organization parameter value. Save the result to the $policysettings variable.
Run the Set-VBOOrganizationRetentionExclusion cmdlet. Set the $policysettings variable as the Exclusion parameter value. Set the :$true value for the Contacts parameter.

Set-VBOOrganizationRetentionExclusion Example 2. Enabling Organization Retention Policy for Calendars

This example shows how to enable organization retention policy for calendars.

$org = Get-VBOOrganization -Name "Atlanta"

$policysettings = Get-VBOOrganizationRetentionExclusion -Organization $org

Set-VBOOrganizationRetentionExclusion -Exclusion $policysettings -Calendar:$true

Perform the following steps:

Run the Get-VBOOrganization cmdlet. Set the Name parameter value. Save the result to the $org variable.
Run the Get-VBOOrganizationRetentionExclusion cmdlet. Set the $org variable as the Organization parameter value. Save the result to the $policysettings variable.
Run the Set-VBOOrganizationRetentionExclusion cmdlet. Set the $policysettings variable as the Exclusion parameter value. Set the :$true value for the Calendar parameter.

Set-VBOOrganizationRetentionExclusion Example 3. Disabling Organization Retention Policy for Contacts

This example shows how to disable organization retention policy for contacts.

$org = Get-VBOOrganization -Name "Atlanta"

$policysettings = Get-VBOOrganizationRetentionExclusion -Organization $org

Set-VBOOrganizationRetentionExclusion -Exclusion $policysettings -Contacts:$false

Perform the following steps:

Run the Get-VBOOrganization cmdlet. Set the Name parameter value. Save the result to the $org variable.
Run the Get-VBOOrganizationRetentionExclusion cmdlet. Set the $org variable as the Organization parameter value. Save the result to the $policysettings variable.
Run the Set-VBOOrganizationRetentionExclusion cmdlet. Set the $policysettings variable as the Exclusion parameter value. Set the :$false value for the Contacts parameter.

Set-VBOOrganizationRetentionExclusion Example 4. Disabling Organization Retention Policy for Calendars

This example shows how to disable organization retention policy for calendars.

$org = Get-VBOOrganization -Name "Atlanta"

$policysettings = Get-VBOOrganizationRetentionExclusion -Organization $org

Set-VBOOrganizationRetentionExclusion -Exclusion $policysettings -Calendar:$false

Perform the following steps:

Run the Get-VBOOrganization cmdlet. Set the Name parameter value. Save the result to the $org variable.
Run the Get-VBOOrganizationRetentionExclusion cmdlet. Set the $org variable as the Organization parameter value. Save the result to the $policysettings variable.
Run the Set-VBOOrganizationRetentionExclusion cmdlet. Set the $policysettings variable as the Exclusion parameter value. Set the :$false value for the Calendar parameter.

Related Commands