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

Get-ASConfiguration

SYNOPSIS

Gets configuration.

SYNTAX

Get-ASConfiguration [-Core] <ConnectCore> [[-SettingDefinition] <SettingDefinitionEnum>] [[-SettingGroup] <SettingGroupEnum>] [[-UserName] <string>] [[-ModuleId] <Guid[]>] [-SettingScheduleId <int>] [<CommonParameters>]

DESCRIPTION

The Get-ASConfiguration cmdlet gets a list of configurations. 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-ASConfiguration -SettingDefinition EVCollectorParallelism

​/* Gets Enterprise Vault Collector module parallelism global setting */

Get-ASConfiguration -SettingDefinition MyTimezoneOverride -UserName "domain\username" | fl

Get-ASConfiguration -SettingDefinition MyTimezoneOverride

​/* Gets Timezone global setting of specified user */

​/* Gets Timezone global setting of all users */

​Get-ASConfiguration -SettingScheduleId 1

Get-ASConfiguration -SettingDefinition EVCollectorParallelism -SettingScheduleId 1

Get-ASConfiguration -ModuleId 96f342f8-4b7f-e811-838a-005056982247

Get-ASConfiguration -ModuleId c9a0d554-1980-e811-838a-005056982247 -SettingScheduleId 1

​/* Gets all settings related to specified schedule profile */

/* Gets specified setting of schedule profile */

/* Gets settings of GLOBALschedule for specified module */

/* Gets settings of specific schedule for specified module */

Add-ASSettingSchedule

SYNOPSIS

Add Archive Shuttle setting schedule.

SYNTAX

Add-ASSettingSchedule [-Core] <ConnectCore> [-Name] [<string>] [-Schedule] [<string>] [-Color] [<string>] [-ModuleId] <Guid> [<CommonParameters>]

DESCRIPTION

The Add-ASSettingSchedule cmdlet creates new schedule for setting definition. 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-ASSettingSchedule -Name SCHEDULE01 -Color "#FF00FF"

​/* ​Creates custom schedule profile */

Add-ASSettingSchedule -Name SCH01 -Color "#FF00FF" -Schedule "3cf8000ff8000ff8000ff8000ff8000ff8000ff8000f3c" -ModuleId b44e3afe-4b7f-e811-838a-005056982247

 

 

Add-ASSettingSchedule -Name SCH02 -Color "#FF00FF" -Schedule "3cf8000ff8000ff8000ff8000ff8000ff8000ff8000f3c" -ModuleId ((Get-ASModule -ModuleType EVExport -ComputerName Computer01).ModuleId)

/* ​Creates custom schedule profile with schedule assignment for specified module (command accepts only hexa format of schedule assignment) */​

Set-ASSettingSchedule

SYNOPSIS

Set Archive Shuttle setting schedule.

SYNTAX

Set-ASSettingSchedule [-Core] <ConnectCore> [-Id] [<int>] [-Name] [<string>] -Schedule] [<string>-Color] [<string> [<CommonParameters>]

DESCRIPTION

The Set-ASSettingSchedule cmdlet sets schedule name, color or schedule hours. 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-ASSettingSchedule -Id 1 -Color "#FF00FF" -Schedule "3c0200000200000200000200000200000200000200003c"

​​/* ​Sets color and schedule of specified existing schedule */

​Get-ASSettingSchedule -SettingScheduleId 1 | Set-ASSettingSchedule -Name "CHANGEDNAME"

​​​/* ​Gets specified schedule and changes its name */

Get-ASSettingSchedule

SYNOPSIS

Get Archive Shuttle setting schedule.

SYNTAX

Get-ASSettingSchedule [-Core] <ConnectCore> [-SettingScheduleId] [<int[]>] [-Name] [<string[]>] [[-ModuleId] <Guid>] [<CommonParameters>]    

DESCRIPTION

The Get-ASSettingSchedule cmdlet gets schedule for setting definition. 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-ASSettingSchedule | Format-Table -AutoSize

​/* Gets all available custom schedule profiles */

​Get-ASSettingSchedule -Name SCHEDULE01

​/* Gets specified custom schedule based on schedule Name */

​​Get-ASSettingSchedule -ModuleId c9a0d554-1980-e811-838a-005056982247

/* Gets custom schedules of specified module */​

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating