Chat now with support
Chat mit 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-ASO365LeaversConfiguration

SYNOPSIS

Get Archive Shuttle Office 365 leavers configuration.

SYNTAX

Get-ASO365LeaversConfiguration [-Core] <ConnectCore> [[-LinkId] <Guid>] [[-LinkName] <string>] [[-SettingType] <Office365MailboxProvisioningSettingType>] [<CommonParameters>]

DESCRIPTION

The Get-ASO365LeaversConfiguration cmdlet gets the Office 365 leavers configuration. 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-ASO365LeaversConfiguration

​/* Retrieves all available Leavers configuration settings for all O365 links */

Get-ASO365LeaversConfiguration -LinkName "O365"

Get-ASO365LeaversConfiguration -SettingType Leavers

​/* Gets leavers configuration of specific O365 link */

​/* Gets all "Standard Leavers" configurations */

Get-ASModule

SYNOPSIS

Gets list of available modules.

SYNTAX

Get-ASModule [-Core] <ConnectCore> [[-ModuleId] <Guid>] [[-ModuleType] <ModuleTypeEnum>] [[-ComputerName] <string>] [[-Is64bit] <bool>] [[-CustomSchedule] <bool>] [[-IsActive] <bool>] [[-TimeToNextSchedule] <bool>] [<CommonParameters>]    

DESCRIPTION

The Get-ASModule cmdlet gets a list of available Modules. 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-ASModule -ModuleId "47d0ccbe-7638-e611-813a-005056b84ed8"


Get-ASModule -ModuleType EVExport| Format-List ModuleId,ComputerName,ServiceName

​/* Retrieves all Enterprise Vault Export modules with filtered list of three columns */

Get-ASModule-ModuleTypeADCollector| Where-Object {$_.DomainName -eq "domain1"}

​​/* Retrieves all Active Directory Collector modules for domain1 */ (new result property added in 7.7)

​Get-ASModule -CustomSchedule 1 -IsActive 1

/* Retrieves only modules with custom schedule which are currently active */​

​Get-ASModule | Where-Object {($_.isStopped -eq 'True') -and ($_.LastStoppedDateUTC -like '*2020*')}|  Start-ASModule ​

​/*Retrieves only stopped modules from specific year and start these modules */

Set-ASModule

SYNOPSIS

Set module.

SYNTAX

Set-ASModule [-Core] <ConnectCore> [-ModuleId] <Guid[]> [[-IsPerformanceStatisticsEnabled] <bool>] [[-DoUpdateModule] <SwitchParameter>] [<CommonParameters>]

DESCRIPTION

The Set-ASModule cmdlet set module. After the command is executed, the module version 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-ASModule -ModuleId ffed0c15-69e9-e811-8392-005056982247 -DoUpdateModule Set-ASModule -ModuleId ffed0c15-69e9-e811-8392-005056982247,aaed0c15-69e9-e811-8392-005056982247 -DoUpdateModule

/* Sets column DoUpdate = TRUE in dbo.Module table */

/* Sets column DoUpdate = TRUE in dbo.Module table for array of modules */

Set-ASModule -ModuleId ffed0c15-69e9-e811-8392-005056982247 -IsPerformanceStatisticsEnabled 1

/* Enables performance statistics collection for specified module */​

Get-ASModule | Set-ASModule -DoUpdateModule

Get-ASModule | Set-ASModule -IsPerformanceStatisticsEnabled 1

/* Sets column DoUpdate = TRUE in dbo.Module table for all retrieved modules */​

/* Enables performance statistics collection for all retrieved modules */​​

Set-ASModuleLogLevel

SYNOPSIS

Sets module log level.

SYNTAX

Set-ASModuleLogLevel [-Core] <ConnectCore> [-ModuleId] <Guid[]> [-CoreLogLevel] <LogLevelEnum> [-ModuleLogLevel] <LogLevelEnum> [<CommonParameters>]

DESCRIPTION

The Set-ASModuleLogLevel cmdlet sets module log level. After the command is executed, the module log level 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-ASModuleLogLevel -ModuleId​ "434b9603-1ab9-e511-80e6-005056b82cc9" -CoreLogLevel Trace -ModuleLogLevel Trace

/* Sets TRACE level for specified module logs */

Get-ASModule -ModuleType Office365Import | Set-ASModuleLogLevel -CoreLogLevel Trace -ModuleLogLevel Trace

​/* Sets TRACE level for all Office365 modules logs */

Get-ASModule | Set-ASModuleLogLevel -CoreLogLevel Trace -ModuleLogLevel Trace

​​/* Sets TRACE level for all existing modules logs */

Verwandte Dokumente

The document was helpful.

Bewertung auswählen

I easily found the information I needed.

Bewertung auswählen