Tchater maintenant avec le support
Tchattez avec un ingénieur du support

Quadrotech Archive Shuttle 10.3 - Administration Guide

Index Fragmentation

Archive Shuttle has a reliance on a performant SQL Server in order to achieve high throughput of items during migration. If SQL is struggling to handle the load, performance will drop. The Index Fragmentation page shows some key metrics about the SQL Indices associated with each link database. These can get fragmented over time during the Enterprise Vault Collection and export/import processes. The information on the index fragmentation page is updated hourly.

The screen highlights tables/indices that are of particular concern according to this:

Row Highlighting

Reason

No highlighting

Fragmentation is not significant, or the number of pages in the index is not over 1000.

Yellow

Fragmentation is between 10 and 30 % and the page count in the index is more than 1000.

Red

Fragmentation is over 30 % and the page count in the index is more than 1000. Accessing data associated with this table/index will not be performant.

 

The recommended actions to take are as follows:

Row Highlighting

Action

No highlighting

No action required

Yellow

Perform an “Index Reorganization”

Red

Perform an “Index Rebuild”

 

More information specific to SQL Server and management of the Archive Shuttle databases can be found in the Quadrotech Archive Shuttle SQL Best Practices Guide.

License Information

The License page in the Admin Interface gives an overview of the usage to-date of Archive Shuttle against the purchased amount of licenses and license volume. It also shows key information about when the license will expire.

If required, a license can be extended and then added to the system. See Adding a New License.

Data on this page is refreshed hourly and shows exported data quantities at that time. User licenses are used when a user enters Stage 2.

A new license can be uploaded, if required.

License expiry notifications may be seen from time to time as the migration progresses. The notifications will appear as follows:

Notification

Description

Date

When there is 7 days left before the license expires

Volume

When there is 3% left of the volume license

Users

When there is 5% of the user license count remaining

PowerShell Guide

The PowerShell module allows you to manage Archive Shuttle migrations using a command line interface approach. Using PowerShell means that much of the administration work can be configured to be executed remotely, and it can be part of other scripted solutions (such as AD user migration, or Exchange Mailbox migration).

PowerShell Module Requirements

Before installing the PowerShell Module the following requirements need to be met:

·.Net Framework 4.0

·PowerShell 3.0

 

Connecting to Archive Shuttle Core

To issue any commands via PowerShell, the first step is to connect to the Archive Shuttle Core. This can be done as follows:

$Core = Connect-ASCore –ComputerName “Name of Server” –Credential “some domain\user”

 

You will then be prompted for the password for the account.

The $Core variable can then be used for additional commands, as shown in the example in the next section.

To connect to a Cloud Core, use:

$Core = Connect-ASCore –ComputerName cloudtenantname.archiveshuttle.com -AuthenticationType Basic -UseHTTPS –Credential “cloud account”

 

info

NOTE: PowerShell should be launched as an administrator.

 

Performing a Command

Once a connection has been made to the Archive Shuttle Core, commands can be executed. For example, a list of current mappings can be shown as follows:

Get-ASMappings –Core $Core

 

 

PowerShell Paging Functionality

The standard PowerShell paging functionality commands can be used with the Archive Shuttle cmdlets. For example:

Get-ASContainers -Core $core -first 10 -skip 0

 

 

List of Commands and Descriptions

A list of available commands can be obtained by running the following PowerShell command:

Get-Command –Module ArchiveShuttle.PowerShell

 

The commands currently available are covered in the next section.

Name

Description

Command Example

Add-ASArchiveNamePolicy

Creates a new archive name policy

Add-ASArchiveNamePolicy [-Core] <ConnectCore> [-Name] <string> [-NamingPolicy] <string> [<CommonParameters>]

Add-ASContainer

Adds a container of a given type.

Add-ASContainer –Core $Core –ContainerType None | EnterpriseVault | Exchange | PST | Mimecast | Office365 | Sharepa | EAS | Proofpoint | SourceOne | DellArchiveManager | EVCloud | PublicFolder | ModernPublicFolder | Office365GroupsMail | Office365GroupsSharepoint | OneDrive | SharedMailbox -LinkdId <guid>

Add-ASContainerMapping

Creates a container mapping for a given source container ID. It will apply a given Workflow and Filter based on the ID’s passed to the command.

Add-ASContainerMapping –Core $Core –SourceContainerID (guid) -WorkflowPolicyID (int) -FilterPolicyID (int) -MigrationEnabled (switchParameter) -ItemGatheringEnabled (switchParameter) -OwnerlessWorkflowPolicyID (int) -Priority (int)

Add-ASContainerToTag

Adds a container to a particular tag.

 

Add-ASContainerToTag –Core $Core –ContainerID (guid) -SAMAccountName (string) -UserSid (sid) -TagName (string) -TagID (int) -GroupName (string)

Add-ASEnvironment

Creates a new environment.

Add-ASEnvironment –Core $Core -EnvironmentType (EnvironmentType) -ModuleID (guid) -DisplayName (string) -SQLServer (string) -SQLDatabaseName (string) -SQLTableShema (string) -CreateItemDatabase (switchParameter) -EmableArchiveCollection (switchParameter) -LinkSQLServer (string) -BasePaths (string)

Add-ASEVRetentionCategoryMapping

Creates a new retention category mapping for Enterprise Vault to Enterprise Vault migrations.

Add-ASEVRetentionCategoryMapping [-Core] <ConnectCore> [-Intrasite] <SwitchParameter> [-SourceSiteName] <string> [-SourceRetentionCategoryName] <string> [-TartgetSiteName] <string> [-TartgetRetentionCategoryName] <string> [<CommonParameters>]

Add-ASFileNamePolicy

Adds a new file name policy.

Add-ASFileNamePolicy [-Core] <ConnectCore> [-Name] <string> [[-NamingPolicy] <string>] [<CommonParameters>]

Add-ASFilterCondition

Adds a condition to an existing filter.


Add-ASFilterPolicy

This can be used as input for the Add-ASContainerMapping command

Add-ASFilterPolicy [[-Core] <ConnectCore>] [[-Name] <string[]>] [<CommonParameters>]

Add-ASGroup

Creates a new group.

Add-ASGroup –Core $Core –GroupName (string)

 

Add-ASItemDatabase

Creates an Item Database for a given LinkID (or Link Name).

Add-ASItemDatabase –Core $Core -SQLServerName (string) -LinkID (string) -LinkName (string)

 

Add-ASLink

Creates a new link.

Add-ASLink –Core $Core –EnvironmentType (ContainerTypeLink) -LinkName (string) -LinkPath (string) -CustomerName (string) -NumberOfWorkers (int) -BatchSizeMb (int) -Format (MailNativeFormatEnum) -DefaultRolloverBytes (long) -OutputPath (string)

Add-ASMappingConfigurationTemplate

Adds a new mapping configuration template.

Add-ASMappingConfigurationTemplate [-Name] <string> [[-Description] <string>] [-Core <ConnectCore>] [<CommonParameters>]

Add-ASO365LeaversConfiguration

This command creates leavers settings.

Add-ASO365LeaversConfiguration [-Core] <ConnectCore> [-LinkId] <Guid?> [-LinkName] <string> [-SettingType] <Office365MailboxProvisioningSettingType> [-NamingScheme] <string> [-UsageLocation] <string> [-EMailSuffix] <string> [[-HideFromAddresslist] <SwitchParameter>] [[-BlockCredential] <SwitchParameter>] [-SetLegalHold <SwitchParameter>] [-LegalHoldType <Office365LegalHoldType>] [-InPlaceHoldIdentity <string>] [-Office365LicenseId <int>] [-MaxRollingLicenses <int?>] [-DLNamingScheme <string>] -GroupMailboxNamingScheme <string> [<CommonParameters>]

Add-ASPstSourcePath

Adds PST sources for a PST link.

Add-ASPstSourcePath –Core $Core -LinkID (guid) -ModuleID (guid) -Path (string)

Add-ASSettingSchedule

Add a Schedule to be used for Settings.

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

Add-ASTag

Creates a new tag.

Add-ASTag –Core $Core -TagName (string)

Add-ASUserToGroup

Adds a user (or users) to a group.

Add-ASUserToGroup –Core $Core -UserSid (string) -SAMAccountName (string) –GroupName (string)

Note: It’s possible to use this command to add people from a CSV file to a group, as follows:

Import-CSV -path “to a CSV file.csv” | Add-ASUserToGroup –GroupName “The Group”

Add-ASWorkflowPolicy

This command creates new workflow policy.

Add-ASWorkflowPolicy [-Core] <ConnectCore> [-WorkflowPolicyName] <string> [-Description] <string> [-ToContainerTypes] <WorkflowPolicyContainerTypeEnum[]> [[-IsSystem] <SwitchParameter>] [[-Enabled] <bool>] [<CommonParameters>]

Add-ASWorkflowPolicyStep

This command adds a step to a given workflow policy.

 

Connect-ASCore

Connects to an Archive Shuttle Core using the name given. If no credentials are supplied, then you will be prompted to input them.

Connecting to a specific Core:

$Core = Connect-ASCore –ComputerName SomeASServerName -Credential (PSCredential) -UseHTTPS -Port (int) -AuthenticationType (AuthenticationType) -SendTimeOut (string)

 

You will then be prompted for credentials.

Connecting to the Core running on the same machine as the PowerShell command:

$Core = Connect-ASCore

 

You will then be prompted for credentials.

Disable-ASActiveDirectorySync

Disables Active Directory synchronization for a particular domain.

Disable-ASActiveDirectorySync –Core $Core –DistinguishedName (string)

Disable-ASArchiveGathering

Disables archive gathering.

Disable-ASArchiveGathering –Core $Core –EnvironmentType (ContainerTypeEnum) -LinkID (guid) -VaultStoreID (string)

Disable-ASCollection

Disables Item Gathering for the specified Container Mapping ID.

Disable-ASCollection –Core $Core –ContainerMappingID 10

Disable-ASMigration

Disables Migration for the specified Container Mapping ID.

Disable-ASMigration –Core $Core –ContainerMappingID 10

Disable-ASModule

Disables a module in Archive Shuttle.

Disable-ASModule –Core $Core –ModuleID (guid)

Enable-ASActiveDirectorySync

Enables Active Directory synhronization for a particular domain.

Enable-ASActiveDirectorySync –Core $Core –DistinguishedName (string)

Enable-ASArchiveGathering

Enables archive gathering.

Enable-ASArchiveGathering –Core $Core –EnvironmentType (ContainerTypeEnum) -LinkID (guid) -VaultStoreID (string)

Enable-ASCollection

Enables Item Gathering for the specified Container Mapping ID.

Enable-ASCollection –Core $Core –ContainerMappingID 10

Enable-ASModule

Enables a module in Archive Shuttle.

Enable-ASModule –Core $Core –ModuleID (guid)

Enable-ASMigration

Enables Migration for the specified Container Mapping ID.

Enable-ASMigration –Core $Core –ContainerMappingID 12

Enable-ASStage2

Enables Stage 2 for the specified Container Mapping ID.

Enable-ASStage2 –Core $Core –ContainerMappingID 12

Get-ASArchiveNamePolicy

Gets information about a particular policy.

Get-ASArchiveNamePolicy [-Core] <ConnectCore> [[-ArchiveNamePolicyId] <int>] [[-Name] <string>] [<CommonParameters>]

Get-ASADDomain

Returns a list of Active Directory domains.

Get-ASADDomain –Core $Core

Get-ASADGroup

Returns Active Directory groups.

Get-ASADGroup –Core $Core -DomainADContainerID (int) -GroupSid (sid) -SAMAccountName (string) -IsEnabled (bool) -All (switchParameter)

Get-ASADGroupMember

Returns the members of a specific AD Group.

Get-ASAdGroupMember –Core $Core -DomainADContainerID (int) -GroupSID (sid) -MemberSid (sid) -MemberType (groupmembertype) -All (switchParameter)

Get-ASArchive

Returns information about archives collected by Archive Shuttle.

Get-ASArchive –Core $Core [-ContainerType] <ContainerTypeEnum> [[-ContainerId] <Guid[]>] [<CommonParameters>]​

 

Examples of usage:

Get-ASArchive -ContainerType EnterpriseVault​ /* Retrieves all Enterprise Vault archives */

 
​Get-ASArchive -ContainerType DellArchiveManager​ -ContainerId “ContainerId” /* Retrieves information about specific archive */

Get-ASCommandQueueStatus

Retrieves an entry from the CommandQueue table.

Get-ASCommandQueueStatus –Core $Core -CommandID (int) -ModuleID (guid)

Get-ASConfiguration

Retrieves information about a particular entry in the SettingDefinition table.

Get-ASConfiguration –Core $Core -SettingDefinition (SettingDefinitionEnum) -SettingGroup (SettingGroupEnum)

Get-ASContainers

Retrieves a list of Containers from Archive Shuttle.

Get-ASContainers –Core $Core -ContainerID (guid) -LegacyExchangeDN (string) -ContainerType (name) -Name (string) -SAMACcountName (string) -TagName (string) -Skip (int) -First (int)

 

Example: Return all currently discovered containers

Get-ASContainers –Core $Core

 

Example: Return all containers belonging to the user with the Legacy DN specified.

Get-ASContainers –Core $Core -LegacyExchangeDN “full legacy DN” -ContainerType Exchange

Get-ASCoreVersion

Displays version information for Archive Shuttle.

 

Get-ASEnvironment

Display information about a specific environment which has been added to Archive Shuttle.

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

Get-ASEVRetentionCategoryMapping

Gets information about a retention category mapping.

Get-ASEVRetentionCategoryMapping [-Core] <ConnectCore> [[-SourceSiteName] <string>] [[-SourceSiteId] <string>] [[-SourceRetentionCategoryName] <string>] [[-SourceRetentionCategoryId] <string>] [[-TartgetSiteName] <string>] [[-TartgetSiteId] <string>] [[-TartgetRetentionCategoryName] <string>] [[-TartgetRetentionCategoryId] <string>] [<CommonParameters>]

Get-ASExchangeDatabase

Retrieves a list of Exchange Databases.

Get-ASExchangeDatabase –Core $Core –ExchangeServerID (int)

Get-ASExchangeServer

Retrieves a list of Exchange Servers in a particular Active Directory Domain.

Get-ASExchangeServer –Core $Core -ADContainerID (int)

Get-ASFailedItemThreshold

Fetches the failed item threshold.

Get-ASFailedItemThreshold –Core $Core –LinkId (guid) -ContainerMappingID (int) -GetAll (SetFailedItemThresholdTable)

Get-ASFileNamePolicy

Gets information about a file name policy.

 

Get-ASFilterPolicy

Get a list of Filter Policies, or a specific policy.

Get-ASFilterPolicy –Core $Core -Name (string) -Skip (int) -First (int)

 

Example: Get a list of all filters

Get-ASFilterPolicy –Core $Core

Get-ASFolderNamePolicy

Retrieves information about a folder name policy.

 

Get-ASGroup

Retrieves a list of groups. It is also possible to retrieve a particular group by name (in order to get the ID) or by ID (in order to get the name).

Get-ASGroup –Core $Core -GroupName (string) -GroupID (int)

 
Get-ASGroup –Core $Core

Get-ASLicense

Returns information about licenses.

Get-ASLicense –Core $Core

Get-ASLink

Returns information about a specific link.

Get-ASLink –Core $Core -LinkID (guid) -LinkName (string) -ComputerName (string) -Type (ContainerTypeEnum) -HasLinkDatabase (bool) -IsArchiveGatheringEnabled (bool)

Get-ASLinkHealth

Returns information about links.

Get-ASLinkHealth –Core $Core

Get-ASLinkModule

Returns information about modules assigned to a link.

Get-ASLinkModule –Core $Core -LinkdID (guid)

Get-ASMailbox

Returns information about mailboxes.

Example: Get information about all mailboxes.

Get-ASMailbox –Core $Core -All

 

Example: Get information about a certain range of mailboxes.

Get-ASMailbox –Core $Core -First (int) -Skip (int)

 

Example: Get information about certain mailboxes.

Get-ASMailbox –Core $Core -UserSid “UserPrincipalName”

 

Example: Get information about mailboxes of a certain type.

Get-ASMailbox –Core $Core -MailboxType “ExchangeMailboxTypeEnum”

Get-ASMappingConfigurationTemplate

Retrieves information about a mapping configuration template.

Example: Get all existing mapping templates.

Get-ASMappingConfigurationTemplate

 

Example: Get details (configuration properties) for all existing mapping templates.

Get-ASMappingConfigurationTemplate -ShowTemplateSettingDefinitions

 

Example: Get details (configuration properties) for a specific container mapping.

Get-ASMappingConfigurationTemplate -ContainerMappingTemplateId (int) -ShowTemplateSettingDefinitions

Get-ASMappings

Retrieves a list of container mappings that have already been made in Archive Shuttle.

Example: Get a list of all current mappings.

Get-ASMappings –Core $Core

 

Example: Retrieve mappings by mapping ID.

Get-ASMappings –ContainerMappingId (int)

 

Example: Get a list of all mappings of in a certain container type.

Get-ASMappings –Core $Core -ContainerMappingType “Container Mapping Type”

 

Example: Return a specific mapping.

Get-ASMappings –Core $Core –ContainerMappingID (int)

 

Example: Return a specific container.

Get-ASMappings –Core $Core –ContainerID “ContainerID GUID”

 

Example: Return a range of mappings.

Get-ASMappings –Core $Core –Skip (int) –First (int)

Get-ASModule

Returns a list of modules.

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

Get-ASModulePerformance

Gets some statistics relating to module performance.

Get-ASModulePerformance –Core $Core -module ‘Guid’ -latestrecord

Get-ASO365LeaversConfiguration

Gets information about a leavers configuration.

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

Get-ASO365License

Gets information about licenses collected from Office 365.

Get-ASO365License [-Core] <ConnectCore> [-Office365LicenseId] <int[]> [-AccountSkuId] <string[]> [<CommonParameters>]

Get-ASProgressStatistics

Gets information about the overall progress and statistics relating to a migration, as shown on the Progress & Performance screen in the user interface.

Get-ASProgressStatistics [-Core] <ConnectCore> [-StatisticsType] <string[]> [-LinkID] <guid[]> [<CommonParameters>]

 

StatisticsType can be either BasicStatistics or OverallPerformance

Optionally a LinkID can be specified to get information about a specific link.

Get-ASRetentionCategory

Gets a retention category.

Get-ASRetentionCategory –Core $Core -Name <name> -EVRetentionCategoryID <id> -EVSiteID <id>

Get-ASScheduedTask

Gets information about all scheduled tasks, or a specific task based on name or ID.

Get-ASScheduledTask –Core $Core -ScheduledTask <name> -ScheduledTaskID <id>

Get-ASSettingSchedule

Get a Schedule to be used for Settings.

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

Get-ASStage1Statistics

Retrieves Stage 1 statistics for a specified container mapping ID.

Example: Get Stage 1 statistics for all mappings.

Get-ASStage1Statistics –Core $Core -All

 

Example: Get Stage 1 statistics for a certain range of mappings.

Get-ASStage1Statistics –Core $Core -Skip (int) -First (int)

 

Example: Get Stage 1 statistics for a specified container mapping ID.

Get-ASStage1Statistics –Core $Core –ContainerMappingID (int)

Get-ASStage2Status

Retrieves Stage 2 status information for a specified container mapping ID.

Example: Get Stage 2 status for all mappings.

Get-ASStage2Status –Core $Core -All

 

Example: Get Stage 2 status for a certain range of mappings.

Get-ASStage2Status –Core $Core -Skip (int) -First (int)

 

Example: Get Stage 2 status for a specified container mapping ID.

Get-ASStage2Status –Core $Core –ContainerMappingID (int)

Get-ASTag

Returns information relating to a Tag.

Get-ASTag –Core $Core -TagName (string) -TagID (int)

Get-ASUser

Retrieves details about a specific user from within Archive Shuttle.

Get-ASUser -Core <ConnectCore> [[-UserSid] <SecurityIdentifier[]>] [[-SAMAccountName] <string[]>] [[-DomainADContainerId] <int[]>] [[-All] <SwitchParameter>] [[-Skip] <uint64>] [[-First] <uint64>] [<CommonParameters>]

Get-ASUserSyncStatus

Returns information about when a user object was last synchronized.

Get-ASUserSyncStatus –Core $Core -SamAccountName (string) -UPN (string)

Get-ASVaultStore

Retrieves a list of Vault Stores.

Get-ASVaultStore –Core $Core -LinkdID (guid) -VaultStoreID (string)

Get-ASWatermark

Retrieves the high and low watermark for a link or for all links (if a LinkID is not specified).

Get-ASWatermark –Core $Core -LinkId (guid)

Get-ASWorkflowPolicy

Get a list of Workflow Policies, or a specific policy.

Get-ASWorkflowPolicy –Core $Core -Name (string) -Skip (int) -First (int)

 

Example: Get a list of all current policies

Get-ASWorkflowPolicy –Core $Core

Get-ASWorkflowPolicyStep

Gets information about a step in a workflow policy.

Get-ASWorkflowPolicyStep [-Core] <ConnectCore> [-WorkflowSequenceId] <int> [-WorkflowPolicyId] <int> [-CommandId] <CommandEnum> [<CommonParameters>]

Remove-ASContainerMapping

Removes an existing mapping from Archive Shuttle.

Remove-ASContainerMapping [-Core] <ConnectCore> [-ContainerMapping] <int[]> [[-IncludeItemData] <SwitchParameter>]

 

A list of container mapping can be obtained using the Get-ASMappings command.

Remove-ASLinkDatabase

Removes a specific link database.

Remove-ASLinkDatabase –Core $Core -LinkID (string) -LinkName (string) -DeleteAll (boolean)

Remove-ASMappingConfigurationTemplate

Removes a mapping configuration template.

Remove-ASMappingConfigurationTemplate [-ContainerMappingTemplateId] <int[]> [-Core <ConnectCore>] [<CommonParameters>]

Remove-ASPstSourcePath

Removes a specific PST Source Path.

Remove-ASPstSourcePath –Core $Core -LinkID (string) -PSTDirectoryID (int)

Restart-ASModule

Issues a command to restart a specified Archive Shuttle module.

Restart-ASModule -Core $Core -ModuleID (Guid)

 

A list of modules can be obtained using the Get-ASModule command.

Set-ASArchiveNamePolicy

Updates an archive name policy.

Set-ASArchiveNamePolicy [-Core] <ConnectCore> [-ArchiveNamePolicyId] <int> [[-Name] <string>] [[-NamingPolicy] <string>] [<CommonParameters>]

Set-ASCommandIntervalLastExecutedDate

Sets the last executed date on an entry in the CommandIntervalExecutionStatus table.

Set-ASCommandIntervalLastExecutedDate –Core $Core –All (switchparameter) -CommandID (int) -Date (datetime)

Set-ASConfiguration

Updates a configuration option in the SettingDefinition table.

Set-ASConfiguration –Core $Core –SettingDefinition (SettingDefinitionEnum) -ValueType (SettingDefinitionValueEnum) -StringValue (object)

Set-ASContainerMapping

This command sets various values of a container mapping, After the command is executed the mapping can be checked in the Archive Shuttle user interface. All parameters in the cmdlet are mandatory except FilterPolicyId.

Set-ASContainerMapping [-Core] <ConnectCore> [-ContainerMappingId] <int[]> [[-WorkflowPolicyId] <int>] [[-FilterPolicyId] <int>] [[-MigrationEnabled] <bool>] [[-ItemGatheringEnabled] <bool>] [[-Priority] <byte>] [[-ItemGatheringScheduleDateTime] <DateTime>] [[-MigrationScheduleDateTime] <DateTime>] [<CommonParameters>]

Set-ASEnvironment

Defines an Environment.

Set-ASEnvironment –Core $Core –EnvironmentType (ContainerTypeEnvironmentEnum) -ModuleID (guid) -DisplayName (string) -SQLServer (string) -SQLDatabaseName (string) -SQLTableSchema (string) -CreateItemDatabase (switchParameter) -EnableArchiveCollection (switchParameter) -LinkSQLServer (string) -EnvironmentID (int) -BasePaths (string)

Set-ASFailedItemThreshold

Sets the failed item threshold.

Set-ASFailedItemThreshold –Core $Core -LinkID (guid) -ContainerMappingID (int) -SetAll (SetFailedItemThresholdTable) -FailedItemThreshold (int)

Set-ASFileNamePolicy

Updates a file name policy.

 

Set-ASFolderNamePolicy

Updates a folder name policy.

 

Set-ASGroup

Modifies the name of an existing group.

Set-ASGroup –Core $Core –GroupName (string) -GroupId (int)

Set-ASLinkModule

Assigns a module to a link.

Set-ASLinkModule –Core $Core –LinkId (guid) -ModuleType (ModuleTypeEnum) -ModuleId (guid)

Set-ASMappingConfigurationTemplate

Updates a mapping configuration template.

Set-ASMappingConfigurationTemplate [-ContainerMappingTemplateId] <int> [[-Name] <string>] [[-Description] <string>] [-Core <ConnectCore>] [<CommonParameters>]

Set-ASModule

Sets a module.

Set-ASModule –Core $Core -ModuleID (guid)

Set-ASModuleLogLevel

Sets the logging level of a particular module.

Set-ASModuleLogLevel –Core $Core -ModuleID (guid) -CoreLogLevel (LogLevelEnum) -ModuleLogLevel (LogLevelEnum)

Set-ASO365LeaversConfiguration

Updates parameters in an Office 365 leavers configuration.

 

Set-ASPstSourcePath

Adds a PST Source path for a PST link.

Set-ASPstSourcePath –Core $Core -PSTDirectoryID (int) -Path (string)

Set-ASPstTargetPath

Sets the PST Output Path for a PST link.

Set-ASPstTargetPath –Core $Core -LinkdID (guid) -Path (string)

Set-ASPstTemporaryPath

Sets the temporary path to be used when creating PSTs.

Set-ASPstTemporaryPath [-Core] <ConnectCore> [[-LinkId] <Guid[]>] [[-Path] <string>] [[-SetAsDefault] [<SwitchParameter>]] [[-ClearPath] [<SwitchParameter>]] [<CommonParameters>]

 

LinkId – is mandatory parameter and defines for which PST target link the cmdlet will apply.

Path – paramter which defines PST temp directory (UNC format)

SetAsDefault – parameter switch replace deffined PST temp path as default for all PST links

ClearPath – clear existing UNC PST temporary path

Set-ASScheduledTask

Modify a scheduled task

Set-ASScheduledTask [-Core] <ConnectCore> -ScheduledTask] <ScheduledTaskEnum[]>] [[-ScheduledTaskId] <int[]>] [[-IsEnabled] [<bool> -RunNow] <SwitchParameter>] [[-RepeatEvery] [<int> [<CommonParameters>]

 

Examples of usage:

Set-ASScheduledTask -ScheduledTask AutoEnableJournalTransformationUsers -RepeatEvery 10 -IsEnabled $true -RunNow /* Sets particular task base on name*/

 
Set-ASScheduledTask -ScheduledTaskid 33 -RepeatEvery 10 -IsEnabled $true -RunNow /* Sets particular task base on TaskId */

Set-ASSettingSchedule

Modify a Schedule to be used for Settings.

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

Set-ASStage2Status

Changes values for a mapping in Stage 2.

Set-ASStage2Status [-Core] <ConnectCore> -[ContainerMappingID] <int> [-Action] <string>

 

For example:

Set-ASStage2Status -ContainerMappingID 12 -Action ChangePolicy -WorkflowPolicyName NewPol1

 
Set-ASStage2Status -ContainerMappingID 15 -Action Pause

 

If a Workflow Policy is being specific it can be done so with -WorkflowPolicyName or -WorkflowPolicyID.

Other actions: Pause, Resume, Retry, Skip.

Set-ASStagingAreaPath

Sets a staging are for a particular link.

Set-ASStagingAreaPath –Core $Core -Path (string) -Default (switchparameter) -LinkID (guid)

Set-ASTag

Updates a specific tag name.

Set-ASTag –Core $Core -TagName (string) -TagID (int)

Set-ASWatermark

Sets the high and low watermark for a particular link.

Set-ASWatermark –Core $Core -LinkID (guid) -LowWatermark (long) -HighWaterMark (long)

Set-ASWorkflowPolicy

This command updates a workflow policy.

Set-ASWorkflowPolicy [-Core] <ConnectCore> [-WorkflowPolicyId] <int> [[-WorkflowPolicyName] <string>] [-Description] <string> [-ToContainerTypes] <WorkflowPolicyContainerTypeEnum[]> [[-IsSystem] <bool>] [[-IsEnabled] <bool>] [<CommonParameters>]

Set-ASWorkflowPolicyStep

Updates a given step in a workflow policy.

 

Set-ASStage2Status

Sets the status for container mapping in Stage 2.

Set-ASStage2Status [-Core] <ConnectCore> [-ContainerMappingId] <int[]> [-Action] <Stage2Action> [[-WorkflowPolicyId] <int>] [[-WorkflowPolicyName] <string>] [<CommonParameters>]

Start-ASAdSyncSingleUser

Starts synchronization of a specific user from Active Directory.

Start-ASAdSyncSingleUser –Core $Core -SAMAccountName (string) -UPN (string)

Start-ASArchiveGathering

Starts archive gathering.

Start-ASArchiveGathering –Core $Core -EnvironmentType (ContainerTypeEnum) -LinkID (guid) -VaultStoreID (string)

Start-ASCommand

Starts a specific command.

Start-ASCommand –Core $Core –CommandID (int)

Start-ASModule

Starts a specified module.

Start-ASModule –Core $Core -ModuleID (guid)

Start-ASO365SyncMailboxes

Starts the procedure to synchronize all mailbox metadata from Office 365 into Archive Shuttle.

Start-ASO365SyncMailboxes –Core $Core –LinkdID (guid)

Start-ASO365SyncSingleUser

Starts the procedure to synchronize a single users’ metadata from Office 365 into Archive Shuttle.

Start-ASO365SyncSingleUser –Core $Core –SAMAccountName (string) -UPN (string)

Start-ASRetryFailedItems

This command retries failed (retryable, permanent) or hanging items for a specified container mapping. This actions can be defined for export, import or both. In case there it is not specified what should be retried, then everything available is retried for the whole container mapping.

Start-ASRetryFailedItems [-Core] <ConnectCore> [-ContainerMappingId] <int[]> [[-Type] <ImportExportTypeEnum>] [[-RetryableFailed] <SwitchParameter>] [[-PermanentlyFailed] <SwitchParameter>] [[-Hanging] <SwitchParameter>]
[<CommonParameters>]

Start-ASStagingAreaCleanup

Starts the clean-up process for the staging area.

Start-ASStagingAreaCleanup -ContainerMappingID

 

or

Start-ASStagingAreaCleanup -LinkID

 

Optional parameters include:

-ItemAge  (with enum ‘All’ or ‘OlderThanConfiguredHours’)

-IncludeDeletedMappingItems

Start-ASSyncADDomains

Starts synchronization of metadata about AD Domains.

Start-ASSyncADDomains –Core $Core

Start-ASSyncADUsers

Starts synchronization of metadata from a particular Active Directory domain.

Start-ASSyncADUsers –Core $Core -DistinguishedName (string)

Stop-ASModule

Stops a specified module.

Stop-ASModule –Core $Core -ModuleID (guid)

 

Examples

In the following examples, the Connect-ASCore command has already been run, using this syntax:

$Core = Connect-ASCore –ComputerName “Name of Server” –Credential “some domain\user”

 

List containers which are less than 90% imported

Get-ASStage1Statistics -Core $Core | Where-Object {$_.ImportStatistics.Percentage -le 90

 

PS1

 

List people in stage 1 who have not started stage 2

Get-ASStage1Statistics -Core $Core | Where-Object {$_.Stage2Enabled -eq $false}

 

PS2

 

List all the mappings with the tag ‘Batch1’ which are not yet mapped

Get-ASContainers -Core $Core -TagName ‘Batch1’ | Where-Object {$_.IsMapped -eq $false}

 

PS3

 

Output Results to file

It might be required to output the results of PowerShell commands to a file, an example of how to output to a file is shown below:

Get-ASContainers -core $core |Out-File C:\Temp\ContainersList.txt

 

Get Command-Level Help

Additional help on the syntax of the commands can be obtained from the PowerShell help, for example:

Help Get-ASContainers

Running PowerShell with Archive Shuttle

It is possible to add customized steps into a Stage 2 workflow and to execute PowerShell scripts. These can perform customer or environment specific actions. There are essentially two steps which need to be performed:

Addition of scripts

Customization of the Workflow

Addition of Scripts

This section of the user interface allows an administrator to add PowerShell scripts to perform various tasks.

Scripts can be added, edited and deleted. When adding a script it should be given a friendly name, and description. The script itself can be added directly, or it can be uploaded from a file that you already have.

Customization of Workflow

PowerShell scripts can be added to an existing workflow. It is also possible to add multiple scripts, if required. To add a script edit the desired workflow, and from the right hand side of the screen click on the PowerShellScriptExecutionRunScript command. This will add that command to the bottom of the workflow.

The command can the be moved to the appropriate position in the workflow.

The command in the workflow needs to be edited so that you can provide the name of the script that you want to execute.

Documents connexes

The document was helpful.

Sélectionner une évaluation

I easily found the information I needed.

Sélectionner une évaluation