Chat now with support
Chat with Support

Archive Shuttle 11.2 - 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

Add-ASTargetPathNamePolicy?

SYNOPSIS

Add Target Path Name Policy.

SYNTAX

Add-ASTargetPathNamePolicy [-Core] <ConnectCore> [-Name] <string> [-NamingPolicy] <string> [<CommonParameters>]​

DESCRIPTION

The Add-ASTargetPathNamePolicy cmdlet creates a new Target Path Name Policy. 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.

Examples:

​Add-ASTargetPathNamePolicy -Name ARName&ID-NamingPolicy *archivename*_*archiveid*

​/*Add new policy with specific name and tokes*/

Add-ASO365LeaversConfiguration

SYNOPSIS

PowerShell command for adding of Office 365 leavers configuration.

SYNTAX

Add-ASO365LeaversConfiguration [-Core] <ConnectCore> [-LinkId] <Guid?> [-LinkName] <string> [-SettingType] <Office365MailboxProvisioningSettingType> [-NamingScheme] <string> [-UsageLocation] <string> [-EMailSuffix]<string> [[-HideFromAddresslist] <SwitchParameter>] [[-BlockCredential] <SwitchParameter>] -LegalHoldType <Office365LegalHoldType> [-Office365LicenseId <int>] [-MaxRollingLicenses <int?>] [-DLNamingScheme <string>] -GroupMailboxNamingScheme <string> [-DeleteMailboxPermanently <bool?>] [<CommonParameters>]

DESCRIPTION

The Add-ASO365LeaversConfiguration creates leavers setting. Link names or linkIds can be used. The core parameter 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:

​$o365link = Get-ASLink -Type Office365 -LinkName "O365"

$o365license = Get-ASO365License -AccountSkuId "quadrotechlab3:ENTERPRISEPACK"

 

Add-ASO365LeaversConfiguration -LinkId $o365link.LinkId -SettingType Leavers -NamingScheme "LEAVER_MapId_*containermappingID*_*archivename*" -UsageLocation UnitedStates -EMailSuffix "@domain.com" -HideFromAddresslist -BlockCredential -Office365LicenseId $o365license.Office365LicenseId -MaxRollingLicenses 5

​​/* Creates Standard Office 365 Leavers configuration */

/* Post Archive Shuttle 9.5, it is possible to create leavers configuration only with Litigation hold, which is set automatically by default */

Add-ASO365LeaversConfiguration -LinkId $o365link.LinkId -SettingType VirtualJournal -NamingScheme "VJOURNAL_MapId_*containermappingID*_*archivename*" -UsageLocation UnitedStates -EMailSuffix "@domain.com" -HideFromAddresslist -BlockCredential -Office365LicenseId $o365license.Office365LicenseId -MaxRollingLicenses 5

​​​/* Cr​eates Virtual Journal Leavers configuration */

Add-ASO365LeaversConfiguration -LinkId $o365link.LinkId -SettingType VirtualJournal -NamingScheme "MAORVJOURNAL_MapId_*containermappingID*_*archivename*" -UsageLocation UnitedStates -EMailSuffix "@domain.com" -HideFromAddresslist -BlockCredential -Office365LicenseId $o365license.Office365LicenseId -MaxRollingLicenses 5

/* Cr​eates Journal Explosion Leavers configuration */​

Get-ASO365License

SYNOPSIS

Get Archive Shuttle Office 365 license.

SYNTAX

Get-ASO365License [-Core] <ConnectCore> -Office365LicenseId] [<int[]>-AccountSkuId] [<string[]> [<CommonParameters>]

DESCRIPTION

The Get-ASO365License cmdlet gets Office 365 licenses. 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:

Get-ASO365License

​/* Retrieves all Office 365 licenses present within Archive Shuttle Database */

Get-ASO365License -AccountSkuId "quadrotechlab3:ENTERPRISEPACK"

Get-ASO365License -Office365LicenseId 1

​/* Retrieves only license with specified AccountSkuId */

/* Retrieves only license with specified ID (internal Archive Shuttle DB Id) */

Set-ASO365LeaversConfiguration

SYNOPSIS

PowerShell command for setting of Office 365 leavers configuration.

SYNTAX

Set-ASO365LeaversConfiguration [-Core] <ConnectCore> [-LinkId] <Guid?> [-LinkName] <string> [-SettingType] <Office365MailboxProvisioningSettingType> [[-NamingScheme] <string>] [[-UsageLocation] <Location?>] [[-EMailSuffix] <string>] [[-HideFromAddresslist] <bool?>] [[-BlockCredential] <bool?>] [-LegalHoldType <Office365LegalHoldType>] [-Office365LicenseId <int?>] [-MaxRollingLicenses <int?>] [-DLNamingScheme <string>] [-GroupMailboxNamingScheme <string>] [-DeleteMailboxPermanently <bool?>] [<CommonParameters>]

DESCRIPTION

The Set-ASO365LeaversConfiguration sets leavers setting. Link names or linkIds can be used. The core parameter 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-ASO365LeaversConfiguration -LinkName "O365" -SettingType Leavers -UsageLocation Slovakia

​/* Sets UsageLocation of existing leavers configuration */

​Set-ASO365LeaversConfiguration -LinkName "O365" -SettingType VirtualJournal -Office365LicenseId $o365license.Office365LicenseId -MaxRollingLicenses 1

​​/* Sets Rolling license count of existing leavers configuration */

​Set-ASO365LeaversConfiguration -LinkName "O365" -SettingType VirtualJournal -DeleteMailboxPermanently 1

/* Sets Delete mailbox permanently */

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating