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

Get-ASArchive

SYNOPSIS

Get archive.

SYNTAX

Get-ASArchive [-Core] <ConnectCore> [-ContainerType] <ContainerTypeEnum> [[-ContainerId] <Guid[]>] [<CommonParameters>]​

DESCRIPTION

The Get-ASArchive will return existing archive(s) based on defined parameters. 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-ASArchive -ContainerType EnterpriseVault​

​ ​/* Retrieves all Enterprise Vault archives */

​Get-ASArchive -ContainerType DellArchiveManager​ -ContainerId "ContainerId"

​ ​/* Retrieves information about specific archive */

Get-ASUser

SYNOPSIS

Gets Active Directory user.

SYNTAX

Get-ASUser -Core <ConnectCore> [[-UserSid] <SecurityIdentifier[]>] [[-SAMAccountName] <string[]>] [[-UserPrincipalName] <string[]>] [[-Email] <string[]>] [[-PrimarySMTPAddress] <string[]>] [[-DomainADContainerId] <int[]>] [[-All] <SwitchParameter>] [[-Skip] <uint64>] [[-First] <uint64>]

   [<CommonParameters>]

DESCRIPTION

The Get-ASUser returns Active Directory user. 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-ASUser

​

​Get-ASUser -All -IncludeTotalCount | Select-Object UserSid,SAMAccountName

​

Get-ASUser -First 1 -Skip 1000

​

​Get-ASUser -DomainADContainerId 1 -SAMAccountName "SAName"

​

 

Get-ASContainers

SYNOPSIS

Displays data regarding container(s).

SYNTAX

Get-ASContainers [[-Core] <ConnectCore>] [[-ContainerId] <Guid>] [[-LegacyExchangeDN] <string>] [[-ContainerType] <ContainerTypeEnum>] [[-Name] <String>] [-SAMAccountName] [<string[]>] [-TagName] <string[]> [-Skip <uint64>] [-First <uint64>] [<CommonParameters>]

DESCRIPTION

The Get-ASContainers cmdlet gets data regarding a specified container or containers. The result contains: Container Id, Name, Link Id, Item Count, Item Size, and Enterprise Vault Environment Name. By default all containers details are displayed after the command executes. 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:

Get-ASContainers -First 10| Select-Object Name,ItemCount|Sort-Object Name

​

Get-ASContainers |Sort-Object Name|Select-Object Name -Last 5

​

​Get-ASContainers -All -IncludeTotalCount |Sort-Object Name|Select-Object -Property Name -First 6

​

​Get-ASContainers -IncludeTotalCount -All -Skip 1000

​

Get-ASContainers -TagName TAG01

/* ​Gets list of containers assigned to specific Tag */

Get-AdamContainer

SYNOPSIS

Gets Adam container.

SYNTAX

Get-AdamContainer [[-Core] <ConnectCore>] [-ContainerType] <GetContainerTypeEnum> [-EWSId] <string[]> [-GroupName] <string[]> [-PrimarySMTPAddress] <string[]> [<CommonParameters>]

DESCRIPTION

The Get-ASContainer gets adam container. Parameter (M)ContainerType is mandatory for all containers. Other parameters depends on container type:

·For types PublicFolder, ModernPublicFolder, ModernPublicFolderOnline: (M)EWSId.

·For types Office365GroupsMail and Office365GroupsSharepoint: (M)GroupName.

·For types SharedMailbox, SharedMailboxOnline: (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:

​Get-AdamContainer -ContainerType ModernPublicFolder -All -IncludeTotalCount

​/* Retrieves all modern public folder containers and shows total count of these containers*/

​Get-AdamContainer -ContainerType PublicFolder -EWSId

​/* Retrieves specified public folder container based on EWSId*/

​​Get-AdamContainer -ContainerType Office365GroupsMail -GroupName GROUPNAME01

​/* Retrieves specified Office 365 Group container based on group name*/

​​Get-AdamContainer -ContainerType SharedMailbox -PrimarySMTPAddress user1@domain1.onmicrosoft.com

​/* Retrieves specified shared mailbox container based on email address*/

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating