Chat now with support
Chat with Support

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

Set-ASPstTargetPath

SYNOPSIS

Sets PST output path for target link.

SYNTAX

Set-ASPstTargetPath [-Core] <ConnectCore> [-LinkId] <Guid[]> [-Path] <string> [<CommonParameters>]

DESCRIPTION

The Set-ASPstTargetPath cmdlet sets PST output path of target link. After the command is executed, the result can be checked in the Archive Shuttle user interface. All parameters in the cmdlet are 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-ASPstTargetPath -LinkId "D9B5F4A9-263C-E611-813B-005056B84ED8" -Path "\\UNCPath"

​

​Get-ASLink -Type PST -LinkName "PST as TARGET QA" | Set-ASPstTargetPath -Path"\\UNCPath"

​

Set-ASPstTemporaryPath

SYNOPSIS

Sets PST temporary path for target link.

SYNTAX

Set-ASPstTemporaryPath [-Core] <ConnectCore> [-LinkId] <Guid[]>] [-Path] <string>] [-SetAsDefault] [<SwitchParameter>] [-ClearPath] [<SwitchParameter>[-ClearPath]  [<SwitchParameter>] [<CommonParameters>]

DESCRIPTION

The Set-ASPstTemporaryPath cmdlet sets PST temporary path of target link. After the command is executed, the result can be checked in the Archive Shuttle user interface. Not all parameters in the cmdlet are 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-ASPstTemporaryPath -Link​Id "D9B5F4A9-263C-E611-813B-005056B84ED8" ​

​​/*Sets PST temporary path for specific linkId */

​Get-ASLink -Type PST -LinkName "PST as TARGET QA" | Set-ASSPstTemporaryPath -Path"\\UNCPath"

​​/*Supports piping feature*/

​Set-ASPstTemporaryPath -Path "\\UNCPath" -SetAsDefault

​/*Set defined UNC Path as default for all PST type links*/

​Set-ASPstTemporaryPath -LinkId "D9B5F4A9-263C-E611-813B-005056B84ED8" -ClearPath

​/*Removes set UNC temporary path from PST link*/

Add-ASContainer

SYNOPSIS

Creates a new container.

SYNTAX

Add-ASContainer -Core] <ConnectCore>] [-ContainerType] <AddContainerTypeEnum> [-LinkId] <Guid> [-EWSId] <string> [-PublicFolderName] <string> [-FolderPath] <string> [-PrimarySMTPAddress] [<string>] [[-DistinguishedName] [<string>-GroupName] [<string>-UserSid] [<SecurityIdentifier> [-SharepointUrl] <string> [-SAMAccountName] <string> [-UserPrincipalName] <string> [-UserName] <string> [-TargetName] <string> [<CommonParameters>]

DESCRIPTION

The Add-ASContainer cmdlet creates a new container. Parameters (M)ContainerType and (M)LinkId are mandatory for all containers. Other parameters depends on container type.

·For types PublicFolder, ModernPublicFolder, ModernPublicFolderOnline: (M)EWSId, (M)PublicFolderName, (M)FolderPath, (V) PrimarySMTPAddress, (V) DistinguishedName, (V) TargetName.

·For types Office365GroupsMail: (M)GroupName, (M)PrimarySMTPAddress, (V) UserSid.

·For types Office365GroupsSharepoint: (M)GroupName, (M)PrimarySMTPAddress, (V)UserSid, (M)SharepointUrl.

·For types Office365, SharedMailbox, SharedMailboxOnline: (M)SAMAccountName, (V) DistinguishedName, (M)UserPrincipalName, (M)UserName, (M)PrimarySMTPAddress.

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-ASContainer -ContainerType PublicFolder -EWSId "AAEuAAAAAAAaRHOQqmYRzZvIAKoAL8RaAwCes/4PRwIuRLqwkpDBpA9uAAAHoLkMAAA=" -PublicFolderName "PublicFolderName1" -FolderPath "\IPM_SUBTREE" -LinkId 963f8ef9-c6aa-42a0-8d32-45c5bc84d153

 

$pflink = Get-ASLink -Type PublicFolder | Where-Object {$_.LinkName -like "*adam*"}

Add-ASContainer -ContainerType PublicFolder -EWSId "AAEuAAAAAAAaRHOQqmYRzZvIAKoAL8RaAwCes/4PRwIuRLqwkpDBpA9uAAAHoLkMAAA=" -PublicFolderName "PublicFolderName1" -FolderPath "\IPM_SUBTREE" -LinkId $pflink.LinkId

​/* Creates public folder container in Archive Shuttle Directory database with specified parameters and links to specified Archive Shuttle link*/

 

/* Gets specified Archive Shuttle link first and then creates public folder container in Archive Shuttle Directory database with specified parameters and link to subjected Archive Shuttle link*/

​$o365link = Get-ASLink -Type Office365 | Where-Object {$_.LinkName -like "*O365*"}  

Add-ASContainer -ContainerType Office365GroupsMail -GroupName O365GROUP1 -LinkId $o365link.LinkId

​/* Gets specified Office 365 Archive Shuttle link first and then creates Office365 Group container in Archive Shuttle Directory database with specified parameters and link to subjected Office 365 Archive Shuttle link*/

​$o365link = Get-ASLink -Type Office365 | Where-Object {$_.LinkName -like "*O365*"}  

Add-ASContainer -ContainerType Office365GroupsSharepoint -GroupName O365GROUP2 -SharepointUrl "https://sharepoint.com/sites/O365GROUP2" -LinkId $o365link.LinkId

​/* Gets specified Office 365 Archive Shuttle link first and then creates Office365 Groups Sharepoint container in Archive Shuttle Directory database with specified parameters and link to subjected Office 365 Archive Shuttle link*/

Add-ASContainerToUser

SYNOPSIS

Adds container to user.      

SYNTAX

Add-ASContainerToUser [-Core] <ConnectCore> [-ContainerId] <Guid> [-UserSID] <string>

   [<CommonParameters>]

DESCRIPTION

The Add-ASContainerToUser will assign user to the container. You can specify core as a parameter, or call Connect-ASCore once and core parameter will be automatically added from session state.

Example:

Add-ASContainerToUser -ContainerId 'c26089cc-a81f-48ad-aa95-00783e2fe408' -UserSID 'S-1-5-21-2153452352-2279314742-1272584938-3645'

/* Assigns container with specified ContainerId to User with specified UserSID */

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating