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

Get-EVRBARole

Get-EVRBARole gets all the Enterprise Vault RBA roles from the Enterprise Vault Directory. You can also get specific RBA roles by providing a full or partial role name using the -Name parameter.

You can specify the Enterprise Vault Directory using the -EVDirectoryServer parameter. If you do not specify the -EVDirectoryServer parameter, and Get-EVRBARole cannot determine the directory, you are prompted to enter a value for -EVDirectoryServer.

Permission to execute this cmdlet is restricted to the Vault Service account.

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

Syntax

Get-EVRBARole [[-Name] <string>] -EVDirectoryServer <string> [<CommonParameters>]

Parameters

Table: Get-EVRBARole parameters

Parameter

Description

-Name

Identifies all or part of the name of an Enterprise Vault RBA role.

-EVDirectoryServer (required)

Specifies the host name, fully qualified domain name, or DNS alias of an Enterprise Vault Directory server. Note that, although this parameter is required, the cmdlet determines it automatically if it can.

Examples
  • Get-EVRBARole

    Gets all the Enterprise Vault RBA roles from the current Enterprise Vault Directory.

  • Get-EVRBARole -Name "File Server Administrator"

    Gets the Enterprise Vault RBA role called "File Server Administrator" from the current Enterprise Vault Directory.

  • Get-EVRBARole ex*

    Performs a wildcard search and gets the Enterprise Vault RBA role objects whose names begin with "ex". For example:

    • Exchange Administrator

    • Extension Content Provider Administrator

    • Extension Content Provider Application

    Note that the parameter -Name is a positioned parameter (at position 0), so this example works without it being specified.

  • In the preceding examples, you can also use the -EVDirectoryServer parameter to connect to a specified Enterprise Vault Directory.

    • Get-EVRBARole -EVDirectoryServer evs2.example.com

      Gets all the Enterprise Vault RBA roles from the Enterprise Vault Directory identified by the -EVDirectoryServer parameter.

    • Get-EVRBARole ex* -EVDirectoryServer evs2.example.com

      Gets the Enterprise Vault RBA role objects whose names begin with "ex" in the Enterprise Vault Directory identified by the -EVDirectoryServer parameter.

  • String piping example:

    "ex*", "file server administrator" | Get-EVRBARole

    Gets the matching Enterprise Vault RBA role objects.

Output

Get-EVRBARole returns objects of the type Symantec.EnterpriseVault.Admin.EVRbaRole, which has the following properties.

Table: Symantec.EnterpriseVault.Admin.EVRbaRole properties

Name

Type

Description

Name

String

The name of the Enterprise Vault RBA role.

RoleGuid

String

The GUID of the Enterprise Vault RBA role.

TaskLinkDescription

String

The description of the associated TaskLink.

TaskLinkGuid

String

The GUID of the associated TaskLink.

Related cmdlets