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

Set-ASTag

SYNOPSIS

Set Archive Shuttle tag.

SYNTAX

Set-ASTag [-Core] <ConnectCore> -TagName] [<string[]>-TagId] [<int[]> [<CommonParameters>]

DESCRIPTION

The Get-ASTag cmdlet update Archive Shuttle tags. 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-ASTag -TagName NEWTAGNAME -TagId 1

​

 

Get-ASTag

SYNOPSIS

Get Archive Shuttle tag.

SYNTAX

Get-ASTag [-Core] <ConnectCore> -TagName] [<string[]>-TagId] [<int[]> [<CommonParameters>]

DESCRIPTION

The Get-ASTag cmdlet gets Archive Shuttle tags. 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-ASTag -TagName TAG01

​

Add-ASContainerToTag

SYNOPSIS

Add Archive Shuttle container to tag.

SYNTAX

Add-ASContainerToTag [-Core] <ConnectCore> [[-ContainerId] <Guid[]>] [[-SAMAccountName] <string[]>] [[-UserSid] <SecurityIdentifier[]>] [-TagName] <string[]> [[-TagId] <int[]>] [[-GroupName] <string[]>] [<CommonParameters>]

DESCRIPTION

The Add-ASContainerToTag cmdlet adds a container to a group. 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:

Assign 2 containers to specific Tag:

Add-ASContainerToTag -ContainerId ID01,ID02 -TagName TAG01

 

Assign container to multiple Tags

Add-ASContainerToTag -ContainerId ID01 -TagName TAG01,TAG02

 

Assign all users from specified Group into defined Tag:

Add-ASContainerToTag -GroupName GROUP01 -TagName TAG01

 

Assign specified containers + all users from specified Group to defined Tag        

Add-ASContainerToTag -ContainerId ID01 -TagName TAG01 -GroupName GROUP01

 

CSV Import

CSV file contains multiple rows with data (Containerid, TagName). Because of this, different users can be assigned into different groups:

Import-Csv -Path "\\Server01\Folder01\tag.csv" | ForEach-Object { Add-ASContainerToTag -Containerid $_.Containerid -TagName $_.TagName}

(CSV should contain SAMAccountName or UserSid in first column, the rest of the columns are considered as Tag names)

To get a list of all containers assigned to specific Tag, see Get-ASContainers command.

 

Special parameters

·Each one command also supports the PowerShell paging functionality. Get-ASContainers -core $core -first 10 -skip 0

oBy default, paging is set to 1000 results (to override this, some of the commands have the -All parameter available)

·If you want to add output to file then use this command: Get-ASContainers -core $core |Out-File C:\ContainersList.txt​

·PowerShell's help for each command is supportedworks.

·Syntax: help-ASpowershell command (other example): Get-Help "Set-ASModuleLogLevel"

·All parameters ignore paging and throws all results (available for specific commands only)

·IncludeTotalCount parameter also returns total count of results regardless of the applied filter; the total count is always thrown

Recreate-ASMapiProfile

SYNOPSIS

Re-creates MAPI profile for the provided module.

SYNTAX

Recreate-ASMapiProfile [-Core] <ConnectCore> [-ModuleId] <Guid> [<CommonParameters>]

DESCRIPTION

The Recreate-ASMapiProfile cmdlet re-creates MAPI profile for the provided module. You need to run the PowerShell session as an administrator to have rights to access and do changes in registry. 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:

Recreate-ASMapiProfile -ModuleId 'A39E0B88-DB8D-EA11-81A5-005056B84ED8'

/* Recreate MAPI profile is sent to NativeFormatImport module, which will delete all profiles and recreate MAPI profile. */​

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating