立即与支持人员聊天
与支持团队交流

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

Set-ASEnvironment

SYNOPSIS

Sets an existing environment.

SYNTAX

Set-ASEnvironment [-Core] <ConnectCore> [-EnvironmentType] <ContainerTypeEnvironmentEnum> [-ModuleId] <Guid> [-DisplayName] <string> [-SqlServer] <string> [-SqlDatabaseName] <string> [[-SqlTableSchema] <string>] [[-LinkSqlServer] <string>] [[-BasePaths] <string>] [-EnvironmentId] <int> [<CommonParameters>]

DESCRIPTION

The Set-ASEnvironment cmdlet sets an existing 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 the core parameter will be automatically added from the session state.

Parameters (M)EnvironmentId, (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:

Set-ASEnvironment -EnvironmentId 1 -EnvironmentType EnterpriseVault -ModuleId "C0484EE5-CB39-E611-813B-005056B84ED8" -DisplayName "EV10 QA" -SqlServer "172.16.7.8\INSTANCE1" -SqlDatabaseName "EnterpriseVaultDirectory"

​

Get-ASEnvironment

SYNOPSIS

Displays data regarding the environment.

SYNTAX

Get-ASEnvironment [[-Core] <ConnectCore>] [[-EnvironmentType] <ContainerTypeEnvironmentEnum[]>] [[-DisplayName] <string[]>] [[-SqlServerName] <string[]>] [[-SqlDatabaseName] <string[]>] [<CommonParameters>]

DESCRIPTION

The Get-ASEnvironment cmdlet gets data regarding a specified environment. 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-ASEnvironment                  

/* Returns all existing environments */

Get-ASEnvironment -EnvironmentType EnterpriseVault

/* Returns only Enterprise Vault environments*/

Get-ASEnvironment -DisplayName "EV10 QA" -SqlServerName "172.16.7.8\INSTANCE1"

​/* Returns only specific Enterprise Vault environment */

Get-ASVaultStore

SYNOPSIS

Gets list of Vault stores.

SYNTAX

Get-ASVaultStore [-Core] <ConnectCore> [[-LinkId] <Guid[]>] [[-VaultStoreId] <string[]>] [[-Skip] <uint64>] [[-First] <uint64>] [<CommonParameters>]

DESCRIPTION

The Get-ASVaultStore cmdlet gets a list of available Vault Stores. 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-ASLink -LinkName​ "VS1" | Get-ASVaultStore

​​/* Enterprise Vault Vault Store received through link name */

​Get-ASLink -Type EnterpriseVault | Where-Object {$_.LinkName -like "*VS1*"} | Get-ASVaultStore

​​​/* Enterprise Vault Vault Store received through link type and specific name */

Enable-ASArchiveGathering

SYNOPSIS

Enables archive gathering.

SYNTAX

Enable-ASArchiveGathering [-Core] <ConnectCore> [[-LinkId] <Guid[]>] [[-VaultStoreId] <string[]>] [<CommonParameters>]

DESCRIPTION

The Enable-ASArchiveGathering cmdlet enables archive gathering. After the command is executed, the result 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:

Get-ASLink -LinkName​ "VS1" | Get-ASVaultStore | Enable-ASArchiveGathering

​/* Enables archive gathering for specified Enterprise Vault Vault Store through link name */

Enable-ASArchiveGathering -LinkId​ "434b9603-1ab9-e511-80e6-005056b82cc9"

Enable-ASArchiveGathering -VaulStoreId​ "13851C140C2F8184F993AF0C26BDA3C6C1210000ev10-site"

​

$evlink = Get-ASLink -Type EnterpriseVault |Where-Object {$_.LinkName -like "*VS1*"} | Get-ASVaultStore

Enable-ASArchiveGathering -VaultStoreId $evlink.VaultStoreId

​/* First Enterprise Vault Vault Store is searched through Link name then archive gathering enabled

info

NOTE: Currently, only Enterprise Vault is supported (7.7).

相关文档

The document was helpful.

选择评级

I easily found the information I needed.

选择评级