Chat now with support
Chat with Support

Archive Shuttle 11.4 - PowerShell Guide

Archive Shuttle and PowerShell Get Archive Shuttle commands Public commands table Available commands sorted to groups Available commands
Connect-ASCore Connect to core in AS.Cloud? Set-ASConfiguration Get-ASConfiguration Add-ASSettingSchedule Set-ASSettingSchedule Get-ASSettingSchedule Add-ASSettingDefinitionToSchedule Get-ASFailedItemThreshold Set-ASFailedItemThreshold Get-ASWatermark Set-ASWatermark Get-ASRetentionCategory Get-ASEVRetentionCategoryMapping Add-ASEVRetentionCategoryMapping Add-ASWorkflowPolicy Set-ASWorkflowPolicy Get-ASWorkflowPolicyStep Add-ASWorkflowPolicyStep Set-ASWorkflowPolicyStep Add-ASFilterPolicy Add-ASFilterCondition Get-ASFileNamePolicy Set-ASFileNamePolicy Add-ASFileNamePolicy? Get-ASTargetPathNamePolicy? Set-ASTargetPathNamePolicy? Add-ASTargetPathNamePolicy? Add-ASO365LeaversConfiguration Get-ASO365License Set-ASO365LeaversConfiguration Get-ASO365LeaversConfiguration Get-ASModule Set-ASModule Set-ASModuleLogLevel Get-ASModulePerformance Enable-ASModule Disable-ASModule Start-ASModule Stop-ASModule Restart-ASModule Start-ASCommand Get-ASCommandQueueStatus Set-ASCommandIntervalLastExecutedDate Get-ASScheduledTask Set-ASScheduledTask Enable-ASActiveDirectorySync Disable-ASActiveDirectorySync Get-ASADGroup Get-ASADGroupMember Get-ASADDomain Start-ASSyncADDomains Get-ASExchangeServer Get-ASExchangeDatabase Add-ASEnvironment Set-ASEnvironment Get-ASEnvironment Get-ASVaultStore Enable-ASArchiveGathering Disable-ASArchiveGathering Start-ASArchiveGathering Get-ASLicense Add-ASLink Get-ASLink Get-ASLinkHealth Get-ASLinkModule Set-ASLinkModule Remove-ASLinkDatabase Add-ASItemDatabase Set-ASStagingAreaPath Start-ASStagingAreaCleanup Get-ASProgressStatistics Add-ASPstSourcePath Remove-ASPstSourcePath Set-ASPstSourcePath Set-ASPstTargetPath Set-ASPstTemporaryPath Add-ASContainer Add-ASContainerToUser Get-ASArchive Get-ASUser Get-ASContainers Get-AdamContainer Get-ASMailbox Get-ASUserSyncStatus Set-ASContainer Start-ASSyncADUsers Start-ASO365SyncMailboxes Start-ASADSyncSingleUser Start-ASO365SyncSingleUser Add-ASContainerMapping Set-ASContainerMapping Get-ASBulkMappingWizardTemplate Get-ASMappings Get-ASPremigrationStatus Get-ASStage1Statistics Get-ASStage2Status Get-ASWorkflowPolicy Get-ASFilterPolicy? Enable-ASCollection Enable-ASMigration Disable-ASCollection Disable-ASMigration Enable-ASStage2 Start-ASRetryFailedItems Remove-ASContainerMapping Add-ASMappingConfigurationTemplate??? Set-ASMappingConfigurationTemplate??? Get-ASMappingConfigurationTemplate??? Remove-ASMappingConfigurationTemplate??? Add-ASJEUserGroup? Get-ASJEUserGroup Set-ASJEUserGroup Add-ASFolderNamePolicy Get-ASFolderNamePolicy Set-ASFolderNamePolicy? Get-ASJESenderRecipient Add-ASJEUserMapping Get-ASJEUserMapping Set-ASJEUserMapping Remove-ASJEUserMapping Add-ASJELeaverMapping Get-ASJELeaverMapping Set-ASJELeaverMapping Remove-ASJELeaverMapping Get-ASJEStage1Statistics Add-ASJEEmailAddressRule Get-ASJEEmailAddressRule Set-ASJEEmailAddressRule Remove-ASJEEmailAddressRule Add-ASJEADUserRule Get-ASJEADUserRule Remove-ASJEADUserRule Add-ASJEDistributionListRule Get-ASJEDistributionListRule Remove-ASJEDistributionListRule Set-ASJEDistributionListRule Copy-ASJEAutoCreationRules (Copy-ASJECreationRules) Get-ASMailboxQuotaStatus?? Update-ASMailboxSizeAndQuota?? Get-ASJELeaversStatus Set-ASJELeaversStatus Add-ASGroup Set-ASGroup Get-ASGroup Add-ASUserToGroup Add-ASTag Set-ASTag Get-ASTag Add-ASContainerToTag Recreate-ASMapiProfile Set-ASStage2Status Set-ASPremigrationAction Get-ASHealthStatus Get-ASModuleCredential Set-ASModuleCredential

Update-ASMailboxSizeAndQuota??

SYNOPSIS

Forces mailbox size and quota check.

SYNTAX

Update-ASMailboxSizeAndQuota [-Core] <ConnectCore> [[-UserSid] <string[]>] [[-PrimarySmtpAddress] <string[]>] [[-JournalTransformation]<SwitchParameter>] [<CommonParameters>]

DESCRIPTION

The Update-ASMailboxSizeAndQuota cmdlet forces mailbox size and quota check. Add Core parameter in the cmdlet is mandatory. You can specify core as a parameter, or call Connect-ASCore once and the core parameter will be automatically added from the session state.

Example:

Update-ASMailboxSizeAndQuota -UserSid "S-1-5-21-1234567890-100000000-100000000-1000"

Update-ASMailboxSizeAndQuota -PrimarySmtpAddress "email@email.com"

Update-ASMailboxSizeAndQuota -PrimarySmtpAddress "email@email.com" -JournalTransformation

/* Sends update command for specified mailbox based on UserSid*/

/* Sends update command for specified mailbox based on email address */

/* Sends update command for specified mailbox based on email address  and JT switch*/

Get-ASMailboxQuotaStatus -All | Update-ASMailboxSizeAndQuota -UserSid $_.UserSid

/* First retrieves all mailboxes with quota records, then sends update command for all of them*/​

 

Get-ASJELeaversStatus

SYNOPSIS

Get list of Journal Explosion leavers enabled for finalization according to specified parameters.

SYNTAX

Get-ASJELeaversStatus [[-UserSids] <string[]>] [[-PrimarySmtpAddress] <string[]>] [[-All] <SwitchParameter>] [<CommonParameters>]​

DESCRIPTION

The Get-ASJELeaversStatus cmdlet gets a list of Journal Explosion leavers enabled for finalization. Core parameter in the cmdlet is mandatory. You can specify core as a parameter, or call Connect-ASCore once and the core parameter will be automatically added from the session state. Cmdlet has two optional parameters; LinkId and ContainerMappingId, but it is mandatory to use at least one of them.

Example:

Get-ASJELeaversStatus -All -IncludeTotalCount

Get-ASJELeaversStatus -UserSids S-1-5-21-1234567890-100000000-100000000-1059

Get-ASJELeaversStatus -PrimarySmtpAddresses youruser@yourdomain.com

/* Retrieves all available Journal Explosion leavers enabled for finalization and adds also total count of result*/

/* Retrieves specific Journal Explosion leaver based on UserSid */

/* Retrieves specific Journal Explosion leaver based on PrimarySMTP address */

​

Get-ASJELeaversStatus -UserSids S-1-5-21-1234567890-100000000-100000000-1059,S-1-5-21-1234567890-100000000-100000000-1058

Get-ASJELeaversStatus -PrimarySmtpAddresses youruser1@yourdomain1.com,youruser2@yourdomain2.com

/* Retrieves specific Journal Explosion leaver based on UserSid list */

/* Retrieves specific Journal Explosion leaver based on PrimarySMTP address list */​

Set-ASJELeaversStatus

SYNOPSIS

Sets the Journal Explosion Leaver Status parameters. Runs specific functionality for Journal Explosion Leaver Status.

SYNTAX

Set-ASJELeaversStatus [-Core] <ConnectCore> [-UserSid] [<string[]>] -PrimarySmtpAddress] [<string[]> [-Action] <LeaverStatusAction> [<CommonParameters>]​

DESCRIPTION

The Set-ASJELeaversStatus cmdlet sets the Journal Explosion Leaver Status parameters. Runs specific functionality for Journal Explosion Leaver Status. Add Core parameter in the cmdlet is mandatory. You can specify core as a parameter, or call Connect-ASCore once and the core parameter will be automatically added from the session state.

Example:

Set-ASJELeaversStatus -PrimarySmtpAddresses "youruser@yourdomain.com" -Action ConvertToUserMailbox

Set-ASJELeaversStatus -UserSids S-1-5-21-1234567​890-100000000-10​​0000000-1046 -Action RetryFailedStep

Set-ASJELeaversStatus -UserSids S-1-5-21-1234567890-100000000-100000000-1046 -Action Finalize

/* Converts single shared mailbox into normal mailbox based on email address */

/* Retries failed finalization step for single user based on UserSid */

/* Starts finalization process of specified Journal Explosion user */​

Set-ASJELeaversStatus -UserSids (Get-ASJELeaversStatus).UserSid -RetryFailedStep

/* Retries failed steps of multiple Journal Explosion leavers */

Get-ASJELeaversStatus | ForEach-Object -Begin { $ids = @()} -Process { $ids += $_.UserSid} -End { Set-ASJELeaversStatus -UserSids $ids -Action RetryFailedStep}

Get-ASJELeaversStatus | ForEach-Object {Set-ASJELeaversStatus -UserSids $_.UserSid -Action RetryFailedStep}

Get-ASJELeaversStatus | ForEach-Object {Set-ASJELeaversStatus -UserSids $_.UserSid -Action ConvertToUserMailbox}

Get-ASJELeaversStatus | ForEach-Object -Begin { $ids = @()} -Process { $ids += $_.UserSid} -End { Set-ASJELeaversStatus -UserSids $ids -Action ConvertToUserMailbox}​​

/* Examples of how to use actions via pipes: */​

Add-ASGroup

SYNOPSIS

Add Archive Shuttle group.

SYNTAX

Add-ASGroup [-Core] <ConnectCore> [-GroupName] [<string[]>] [<CommonParameters>]

DESCRIPTION

The Add-ASGroup cmdlet gets Archive Shuttle user groups. Core parameter in the cmdlet is mandatory. You can specify core as a parameter, or call Connect-ASCore once and the core parameter will be automatically added from the session state.

Example:

Add-ASGroup -Name GROUP01

​

​Add-ASGroup -Name GROUP01,GROUP02,GROUP03

​

 

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating