지금 지원 담당자와 채팅
지원 담당자와 채팅

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

Start-ASSyncADDomains

SYNOPSIS

Start AD domains synchronization.

SYNTAX

Start-ASSyncADDomains -Core <ConnectCore> [<CommonParameters>]

DESCRIPTION

The Start-ASSyncADDomains starts synchronization of Active Directory domains. 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.

Get-ASExchangeServer

SYNOPSIS

Gets Exchange Servers.

SYNTAX

Get-ASExchangeServer -Core <ConnectCore> [-ADContainerId [<int[]>]] [<CommonParameters>]

DESCRIPTION

The Get-ASExchangeServer returns Exchange servers. 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-ASExchangeServer

​

Get-ASExchangeServer -ADContainerId 2

​/* As of Archive Shuttle 7.7, it is possible to define only the ADContainerId parameter. This is a custom command for ADAM, and in case other parameters are required, it should be logged in TFS */

Get-ASExchangeServer|Format-Table ExchangeServerId,AdContainerId,Name,FullyQualifiedDomainName -AutoSize​

​

​Get-ASExchangeServer | Where-Object {$_.ExchangeServerId -eq "1"}

​

Get-ASExchangeDatabase

SYNOPSIS

Gets Exchange databases.

SYNTAX

Get-ASExchangeDatabase -Core <ConnectCore> [-ExchangeServerId [<int[]>]] [<CommonParameters>]

DESCRIPTION

The Get-ASExchangeDatabase return Exchamge databases. 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-ASExchangeDatabase -ExchangeServerId 1

​/* As of Archive Shuttle 7.7, it is possible to define only ExchangeServerId parameter. This is a custom command for ADAM, and in case other parameters are required, it should be logged in TFS */

​Get-ASExchangeServer | Where-Object {$_.ExchangeServerId -eq "1"} | Get-ASExchangeDatabase | Format-Table ExchangeServerId,Name,DistinguishedName -AutoSize

​

Add-ASEnvironment

SYNOPSIS

Creates a new environment.

SYNTAX

Add-ASEnvironment [-Core] <ConnectCore> [-EnvironmentType] <ContainerTypeEnvironmentEnum> [-ModuleId] <Guid> [-DisplayName] <string> [-SqlServer] <string> [-SqlDatabaseName] <string> [[-SqlTableSchema] <string>] [[-LinkSqlServer] <string>] [[-BasePaths] <string>]

   [-WebServerUrl] <string> [<CommonParameters>]

DESCRIPTION

The Add-ASEnvironment cmdlet creates a new environment. After the command is executed, the environment can be checked in the Archive Shuttle user interface. You can specify core as a parameter, or call Connect-ASCore once and core parameter will be automatically added from session state.

Parameters (M)EnvironmentType, (V)ModuleId, (V)DisplayName, (V)SqlServer, (V)SqlDatabaseName  are common for all containers. Other parameters depends on environment type:

·For type DellArchiveManager: (V)LinkSqlServer.

·For type SourceOne: (V)LinkSqlServer, (V)BasePaths.

·For type EasDynamicParameters: (V)SqlTableSchema, (V)LinkSqlServer, (V)WebServerUrl.

info

NOTE: Some parameters are dynamically added/removed (based on EnvironmentType)

Example:

Add-ASEnvironment -EnvironmentType EnterpriseVault -DisplayName "Enterprise Vault 12" -ModuleId "434b9603-1ab9-e511-80e6-005056b82cc9" -SqlServer "SQLSERVER01\INSTANCE1" -SqlDatabaseName "EnterpriseVaultDirectory"

​

$evcolmodule = Get-ASModule -ModuleType EVCollector | Where-Object {$_.ComputerName -eq "Computer01"}

 

Add-ASEnvironment -EnvironmentType EnterpriseVault -DisplayName "Enterprise Vault 12" -ModuleId $evcolmodule.ModuleId -SqlServer "SQLSERVER01\INSTANCE1" -SqlDatabaseName "EnterpriseVaultDirectory"

​

관련 문서

The document was helpful.

평가 결과 선택

I easily found the information I needed.

평가 결과 선택