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

Set-ASMappingConfigurationTemplate???

SYNOPSIS

Sets​ mapping configuration template.

SYNTAX

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

DESCRIPTION

The Set-ASMappingConfigurationTemplate cmdlet updates the Container Mapping Configuration Template attributes and returns it. 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:

Set-ASMappingConfigurationTemplate -ContainerMappingTemplateId 1 -Name NAME01NEW -Description DESC01NEW

​/* Sets new name and description of specified mapping template */

Set configuration properties of mapping template: SEE COMMAND SET-ASCONFIGURATION

Get-ASMappingConfigurationTemplate???

SYNOPSIS

Get mapping configuration template.

SYNTAX

Get-ASMappingConfigurationTemplate [-Core] <ConnectCore> [[-ContainerMappingTemplateId] <int[]>] [[-Name] <string>] [[-Description] <string>] [[-ShowTemplateSettingDefinitions] <bool>] [<CommonParameters>]    

DESCRIPTION

The Get-ASMappingConfigurationTemplate cmdlet gets Container Mapping Configuration Template by its ContainerMappingTemplateId or Name. If the parameter is not set, it returns all configuration templates. If ShowTemplateSettingDefinitions is presen,t then the cmdlet returns all setting definitions. 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-ASMappingConfigurationTemplate

​/* Gets all existing mapping templates */

​​Get-ASMappingConfigurationTemplate -ShowTemplateSettingDefinitions | Format-Table

Get-ASMappingConfigurationTemplate -ContainerMappingTemplateId 1 -ShowTemplateSettingDefinitions

/* Gets details (configuration properties) of all existing mapping templates */

/* Gets mapping template details (configuration properties) of specified container mapping */​

Remove-ASMappingConfigurationTemplate???

SYNOPSIS

Remove mapping configuration template.

SYNTAX

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

DESCRIPTION

The Remove-ASMappingConfigurationTemplate cmdlet removes Container Mapping Configuration Template. 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:

Remove-ASMappingConfigurationTemplate -ContainerMappingTemplateId 1

Remove-ASMappingConfigurationTemplate -ContainerMappingTemplateId 2,3

​/* Removes specified mapping template */

/* Removes specified mapping templates */

Get-ASMappingConfigurationTemplate | Remove-ASMappingConfigurationTemplate

/* Gets all mapping templates, then removes all */

Add-ASJEUserGroup?

SYNOPSIS

Add Archive Shuttle Journal Explosion user group.

SYNTAX

Add-ASJEUserGroup [-Core] <ConnectCore> [-GroupName] [<string[]>] [<CommonParameters>]

DESCRIPTION

The Add-ASJEUserGroup cmdlet creates new Archive Shuttle Journal Explosion User groups. 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:

Add-ASJEUserGroup -Name JEGROUP01

​

Add-ASJEUserGroup -Name JEGROUP01,JEGROUP02,JEGROUP03,JEGROUP04​

​

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating