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

Archive Shuttle 11.4 - 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

Available commands

 

Connect-ASCore

Create core via Connect-ASCore command.

SYNOPSIS

Connects to Archive Shuttle core.

SYNTAX

Connect-ASCore [-ComputerName] <string> [-Credential] <PSCredential> -UseHttps [[-Port] <int>] [<CommonParameters>]

Connect-ASCore [-RemoteAddress] <string> [-Credential] <PSCredential> [-AuthenticationType <AuthenticationType>] [[-SendTimeout] <string>] [<CommonParameters>]

DESCRIPTION

Connects to Archive Shuttle core and creates PowerShellModule service instance which allows all commands to communicate with Archive Shuttle core. This command is used as an input parameter for all other Archive Shuttle PowerShell commands.

Credentials (mandatory) - insert the domain with the username, and after command is executed, the user will be prompted to add a password.

RemoteAddress - Uses specified remote service address. Full URL is required.

ComputerName - Connects to specified computer name.

UseHttps - Uses HTTPS protocol instead of HTTP.

Port - Specifies communication port number. By default, port 80 is used for HTTP and port 443 is used for HTTPS.

Examples of Connect-ASCore usage:

$core = Connect-ASCore -ComputerName "COMPUTER01" -Credential "domain\username"

​/* This will connect to PowerShell service on server COMPUTER01 */

$core = Connect-ASCore -ComputerName "COMPUTER01" –Port 567 -Credential "domain\username"

​/* This  will  connect  to  PowerShell  service  on  server  COMPUTER01  with  port  567  */

$core = Connect-ASCore -Credential "domain\username"

​/* This will connect to default server selected during modules configuration */

 

$password = convertto-securestring -String "EnterPasswordHere" -AsPlainText -Force

$UserCredential = New-object -typename System.Management.Automation.PSCredential -argumentlist "Domain\User",$password

Connect-ASCore -ComputerName "EnterComputerName" -Credential $UserCredential

Connect to core in AS.Cloud?

In the case that core is installed in the cloud, it is possible to connect from a machine where Archive Shuttle modules (PowerShell module) is installed:

$UserCredential = Get-Credential -Message Credentials -UserName user@quadrotech-it.com

Connect-ASCore -ComputerName cloud.archiveshuttle.com -AuthenticationType Basic -UseHttps -Credential $UserCredential

Core is a mandatory parameter for each command as it is used to get data from core.

You can specify core as a parameter, or call Connect-ASCore once and the core parameter will be automatically added from the session state. call Connect-ASCore once and core parameter will be automatically added from session state and other commands can be used without core from this point.

Sometimes command may time-out. Default time is seconds. This can be increased:​​ $core = Connect-ASCore $computerName -Credential $credentials -SendTimeout 120

Set-ASConfiguration

SYNOPSIS

Sets configuration setting.

SYNTAX

Set-ASConfiguration [-Core] <ConnectCore> [-SettingDefinition] <SettingDefinitionEnum> [-Value] <object> [[-ModuleId] <Guid[]>] [[-SettingScheduleId] <int>] [[-ContainerMappingTemplateId] <int>] [<CommonParameters>]

DESCRIPTION

The Set-ASConfiguration cmdlet sets configuration setting. After the command is executed, the result 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.

Example:​

Set-ASConfiguration  -SettingDefinition​  EVCollectorParallelism  -Value​  5

​/* Sets Enterprise Vault Collector module parallelism to 5 for global configuration */

​Set-ASConfiguration -SettingDefinition MyTimezoneOverride -Value "(UTC) Coordinated Universal Time" -UserName "domain\user01"

​​/* Sets TimeZoneOverride setting for specified user in global configuration */

Set-ASConfiguration -SettingDefinition PstExportFileParallelism -Value 8 -ModuleId c9a0d554-1980-e811-838a-005056982247

Set-ASConfiguration -SettingDefinition PstExportFileParallelism -Value 8 -ModuleId c9a0d554-1980-e811-838a-005056982247 -SettingScheduleId 1

​/* Sets PST Export paralelism of GLOBAL schedule for specified module */

/* Sets PST Export paralelism of specified custom schedule for specified module */

Set-ASConfiguration -SettingDefinition AutoRecreateLeavers 0 -ContainerMappingTemplateId 1

Set-ASConfiguration -SettingDefinition Office365VirtualJournalItemCountLimit 10 -ContainerMappingTemplateId 1

Set-ASConfiguration -SettingDefinition Office365VirtualJournalItemSizeByteLimit 1024000 -ContainerMappingTemplateId 1

/* Mapping template configuration details are defined through Set-ASConfiguration command. It works the same way as when defining general system configuration but with a special parameter -ContainerMappingTemplateId is specified  */​

Documents connexes

The document was helpful.

Sélectionner une évaluation

I easily found the information I needed.

Sélectionner une évaluation