Chat now with support
Chat with Support

Archive Shuttle 11.3 - 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-ASGroup

SYNOPSIS

Set Archive Shuttle group.

SYNTAX

Set-ASGroup [-Core] <ConnectCore> -GroupName] [<string[]>-GroupId] [<int[]> [<CommonParameters>]

DESCRIPTION

The Get-ASGroup cmdlet update Archive Shuttle 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:

Set-ASGroup -GroupName NEWGROUPNAME -GroupId 1

​

Get-ASGroup

SYNOPSIS

Get Archive Shuttle group.

SYNTAX

Get-ASGroup [-Core] <ConnectCore> -GroupName] [<string[]>-GroupId] [<int[]> [<CommonParameters>]

DESCRIPTION

The Get-ASGroup cmdlet gets Archive Shuttle 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:

Get-ASGroup -GroupName GROUP01

​​

Add-ASUserToGroup

SYNOPSIS

Add Archive Shuttle user to group.

SYNTAX

Add-ASUserToGroup [-Core] <ConnectCore> [-UserSid] [<SecurityIdentifier[]>] [-SAMAccountName] [<string[]>] -GroupName] [<string> [<CommonParameters>]

DESCRIPTION

The Add-ASUserToGroup cmdlet adds a user 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:

​Add-ASUserToGroup -SAMAccountName userSAname -GroupName GROUP01​

Add-ASUserToGroup -SAMAccountName domainName\userSAname -GroupName GROUP01

​

CSV Import

CSV file contains multiple rows with data (UserSid, SAMAccountName,GroupName). Because of this, different users can be assigned into different groups. In the case of SAMAccountName, domains can also be used (domainname\samaccountname):

Import-Csv -Path "\\Server01\Folder01\group.csv" | ForEach-Object { Add-ASUserToGroup -UserSid $_.UserSid -GroupName $_.GroupName}

Import-Csv -Path "\\Server01\Folder01\group2.csv" | ForEach-Object { Add-ASUserToGroup -SAMAccountName $_.SAMAccountName -GroupName $_.GroupName}

 

CSV file only contains a list of users (either with UserSID or SAMAccountName). The names of the rows (headers) must be exactly UserSid or SAMAccountName. With this approach, the entire list of users within file can be assigned to one group only:

Import-Csv -Path "\\Server01\Folder01\group3.csv" | Add-ASUserToGroup -GroupName GROUP01​

​

Add-ASTag

SYNOPSIS

Add Archive Shuttle Tag.

SYNTAX

Add-ASTag [-Core] <ConnectCore> [-TagName] [<string[]>] [<CommonParameters>]

DESCRIPTION

The Add-ASTag cmdlet creates 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:

​Add-ASTag -TagName TAG01

Add-ASTag -TagName TAG01,TAG02,TAG03

​

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating