Enterprise Vault™ PowerShell Cmdlets
- Introducing the Enterprise Vault PowerShell cmdlets
- Archiving: Exchange
- Archiving: FSA
- Archiving: Skype for Business
- Archiving: SMTP
- Get-EVSMTPHoldingFolder
- Get-EVSMTPMessageTrackingLogLocation
- Get-EVSMTPPolicy
- Get-EVSMTPServerSettings
- Get-EVSMTPTarget
- New-EVSMTPPolicy
- New-EVSMTPServerSettings
- New-EVSMTPTarget
- Remove-EVSMTPPolicy
- Remove-EVSMTPTarget
- Set-EVSMTPMessageTrackingLogLocation
- Set-EVSMTPPolicy
- Set-EVSMTPServerSettings
- Set-EVSMTPTarget
- Sync-EVSMTPServerSettings
- Backup
- Classification
- Disable-EVClassification
- Get-EVClassificationFCITags
- Get-EVClassificationPolicy
- Get-EVClassificationStatus
- Get-EVClassificationTestMode
- Get-EVClassificationVICTags
- Import-EVClassificationFCIRules
- Initialize-EVClassificationVIC
- New-EVClassificationPolicy
- Publish-EVClassificationFCIRules
- Remove-EVClassificationPolicy
- Set-EVClassificationPolicy
- Set-EVClassificationTestMode
- Databases
- IMAP access
- Indexing
- Records management
- Retention plans
- Roles-based administration
- Sites and servers
- Tasks and services
- Vault stores and archives
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 the snap-in Symantec.EnterpriseVault.PowerShell.AdminAPI.dll.
Get-EVRBARole [[-Name] <String>] -EVDirectoryServer <String> [<CommonParameters>]
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. |
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.
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. |
See Add-EVRBARoleMember.
See Get-EVRBARoleMember.