Veritas Enterprise Vault™ PowerShell Cmdlets

Last Published:
Product(s): Enterprise Vault (12.1)
  1. Introducing the Enterprise Vault PowerShell cmdlets
    1.  
      What's new in Enterprise Vault 12.1
    2.  
      About the Enterprise Vault Management Shell
    3.  
      Importing modules
    4.  
      Getting Help for Enterprise Vault PowerShell cmdlets
    5.  
      Rules for PowerShell strings
    6. Where to get more information about Enterprise Vault
      1.  
        Enterprise Vault training modules
  2. Archiving: Exchange
    1.  
      Add-EVPstComputer
    2.  
      Add-EVPstFile
    3.  
      Remove-EVExchangeFolderPolicy
  3. Archiving: FSA
    1.  
      Get-EVFSAFileServer
    2.  
      Get-EVFSAFolder
    3.  
      Get-EVFSAVolume
    4.  
      New-EVFSAFileServer
    5.  
      New-EVFSAFolder
    6.  
      New-EVFSAVolume
    7.  
      Remove-EVFSAFileServer
    8.  
      Remove-EVFSAFolder
    9.  
      Remove-EVFSAVolume
    10.  
      Set-EVFSAFileServer
    11.  
      Set-EVFSAFolder
    12.  
      Set-EVFSAVolume
  4. Archiving: SMTP
    1.  
      Get-EVSMTPHoldingFolder
    2.  
      Get-EVSMTPPolicy
    3.  
      Get-EVSMTPServerSettings
    4.  
      Get-EVSMTPTarget
    5.  
      New-EVSMTPPolicy
    6.  
      New-EVSMTPServerSettings
    7.  
      New-EVSMTPTarget
    8.  
      Remove-EVSMTPPolicy
    9.  
      Remove-EVSMTPTarget
    10.  
      Set-EVSMTPPolicy
    11.  
      Set-EVSMTPServerSettings
    12.  
      Set-EVSMTPTarget
    13.  
      Sync-EVSMTPServerSettings
  5. Backup
    1.  
      Clear-IndexLocationBackupMode
    2.  
      Clear-VaultStoreBackupMode
    3.  
      Get-IndexLocationBackupMode
    4.  
      Get-VaultStoreBackupMode
    5.  
      Set-IndexLocationBackupMode
    6.  
      Set-VaultStoreBackupMode
  6. Classification
    1.  
      Get-EVClassificationPolicy
    2.  
      Get-EVClassificationTags
    3.  
      Get-EVClassificationTestMode
    4.  
      Import-EVClassificationRules
    5.  
      New-EVClassificationPolicy
    6.  
      Publish-EVClassificationRules
    7.  
      Remove-EVClassificationPolicy
    8.  
      Set-EVClassificationPolicy
    9.  
      Set-EVClassificationTestMode
  7. Databases
    1.  
      Get-EVDatabase
    2.  
      Get-EVDatabaseDetail
    3.  
      Get-EVDatabaseFileInfo
    4.  
      Get-EVStorageDatabase
    5.  
      Set-EVDatabaseDetail
    6.  
      Start-EVDatabaseUpgrade
  8. IMAP access
    1.  
      Get-EVIMAPUsers
    2.  
      Get-EVIMAPUserSettings
    3.  
      Set-EVIMAPServerDisabled
    4.  
      Set-EVIMAPServerEnabled
  9. Indexing
    1.  
      Get-EVIndexLocation
    2.  
      Get-EVMDSStatus
    3.  
      Get-IndexServerForIndexLocation
    4.  
      New-EVMDSBuildTask
    5.  
      Set-IndexMetadataSyncLevel
  10. Records management
    1.  
      Export-EVNARAArchive
    2.  
      Get-EVRecordSettings
  11. Retention plans
    1.  
      Get-EVRetentionPlan
    2.  
      New-EVRetentionPlan
    3.  
      Remove-EVRetentionPlan
    4.  
      Set-EVRetentionPlan
  12. Roles-based administration
    1.  
      Add-EVRBARoleMember
    2.  
      Get-EVRBAAzStoreXml
    3.  
      Get-EVRBARole
    4.  
      Get-EVRBARoleMember
    5.  
      Remove-EVRBARoleMember
    6.  
      Set-EVRBAAzStoreXml
  13. Sites and servers
    1.  
      Get-EVComputers
    2.  
      Get-EVFileLocation
    3.  
      Get-EVIISWebsite
    4.  
      Get-EVServer
    5.  
      Get-EVSite
  14. Tasks and services
    1.  
      Get-EVDependencyService
    2.  
      Get-EVDependencyServiceState
    3.  
      Get-EVService
    4.  
      Get-EVServiceState
    5.  
      Get-EVTask
    6.  
      Get-EVTaskState
  15. Vault stores and archives
    1.  
      Export-EVArchive
    2.  
      Get-EVArchive
    3.  
      Get-EVVaultStore
    4.  
      Get-EVVaultStorePartition
    5.  
      Set-EVArchive
    6.  
      Start-PartitionRollover

Remove-EVFSAFileServer

Remove-EVFSAFileServer removes the specified file server from the Enterprise Vault site. You are prompted to confirm the removal of the file server. Make sure that you stop the File System Archiving task that processes the file server volume before you run the cmdlet.

Remove-EVFSAFileServer is provided by Symantec.EnterpriseVault.PowerShell.AdminAPI.dll, which is loaded by the Enterprise Vault Management Shell.

Syntax

Remove-EVFSAFileServer [-SiteId <String>] [-Identifier] <String> [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]

Parameters

Table: Remove-EVFSAFileServer parameters

Parameter

Description

-SiteId (required)

The ID of the Enterprise Vault site in which the file server is configured. If you omit this parameter, Remove-EVFSAFileServer uses the ID of the site of the Enterprise Vault server where the command is running. You can use Get-EVSite to obtain the site ID.

-Identifier (required)

The fully-qualified DNS name, UNC name, or Entry ID of the file server target that is configured in the Enterprise Vault site. The name should be the same as the name that was used when you added the file server, or the name that the Administration Console displays. You can use Get-EVFSAFileServer to obtain the file server name.

Parameter aliases: FileServerDNSName, FileServerName, FileServerId.

-Confirm

Prompts you for confirmation before running the cmdlet. To suppress the confirmation prompt, type -Confirm:$false.

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not actually run.

Examples

  • Remove-EVFSAFileServer -Identifier \\abc

    or

    Remove-EVFSAFileServer -FileServerName \\abc

    Removes the file server with the UNC name '\\abc'.

  • Remove-EVFSAFileServer -SiteId 198...example.com -Identifier abc.example.com

    or

    Remove-EVFSAFileServer -SiteId 198...example.com -FileServerDNSName abc.example.com

    Removes the file server with the fully qualified domain name 'abc.example.com' from the specified Enterprise Vault site.

  • Remove-EVFSAFileServer -Identifier 198...example.com

    or

    Remove-EVFSAFileServer -FileServerId 198...example.com

    Removes the file server with the Entry ID '198...example.com'.

  • "abc.example.com" | Remove-EVFSAFileServer

    Removes the file server with the fully-qualified domain name 'abc.example.com'.

  • Get-EVFSAFileServer | Remove-EVFSAFileServer

    Removes all the file servers that are configured in the Enterprise Vault site in which the local Enterprise Vault server has been configured.

Output

This cmdlet does not return any output.

Related cmdlets