Veritas 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-EVRBARoleMember
Get-EVRBARoleMember gets the members of an Enterprise Vault RBA role from the Enterprise Vault Directory. Members can be Active Directory users, groups, or built-in security principals.
The -Identity parameter specifies the Enterprise Vault RBA role to access. You can identify an RBA role by its name, or GUID. You can also specify the role by passing a role object through the pipeline. For example, you can use Get-EVRBARole to retrieve a role object and then pass the object through the pipeline to Get-EVRBARoleMember. If you do not specify the -Identity or the -InputObject parameter, you are prompted to enter the value for -Identity.
You can specify the Enterprise Vault Directory using the -EVDirectoryServer parameter. If you do not specify the -EVDirectoryServer parameter, and Get-EVRBARoleMember cannot determine the directory, you are prompted to enter a value for -EVDirectoryServer.
If you execute Get-EVRBARoleMember from a server other than an Enterprise Vault server, it prompts for the -EVDirectoryServer parameter, unless -EVDirectoryServer is already specified as a parameter.
Permission to execute this cmdlet is restricted to the Vault Service Account.
Get-EVRBARoleMember is provided by Symantec.EnterpriseVault.PowerShell.AdminAPI.dll, which is loaded automatically by the Enterprise Vault Management Shell.
Get-EVRBARoleMember [-Identity] <String> -EVDirectoryServer <String> [<CommonParameters>]
Get-EVRBARoleMember [-InputObject] <Symantec.EnterpriseVault.Admin.EVRbaRole> -EVDirectoryServer <String> [<CommonParameters>]
Table: Get-EVRBARoleMember parameters
Parameter | Description |
|---|---|
-Identity (required) | Specifies an Enterprise Vault RBA role by its name or GUID. |
-InputObject (required) | Specifies an Enterprise Vault RBA role object. This parameter can get this object through the pipeline or you can set this parameter to an object instance. |
-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-EVRBARoleMember -Identity "File Server Administrator"
Gets the members of the Enterprise Vault RBA role called "File Server Administrator" from the current Enterprise Vault Directory.
Get-EVRBARoleMember "File Server Administrator"
Gets the members of the Enterprise Vault RBA role called "File Server Administrator" from the current Enterprise Vault Directory. Note that the -Identity parameter is a positioned parameter (at position 0), so this example works without it being specified.
Additionally, -EVDirectoryServer parameter can be specified to connect to the desired Enterprise Vault directory.
Get-EVRBARoleMember "File Server Administrator" -EVDirectoryServer evs2.example.com
Gets the members of the Enterprise Vault RBA role called "File Server Administrator" from the Enterprise Vault Directory identified by the -EVDirectoryServer parameter.
String piping example:
"file server administrator" | Get-EVRBARoleMember
Gets the members of the Enterprise Vault RBA role called "File Server Administrator" from the current Enterprise Vault Directory.
-InputObject usage example:
$r = Get-EVRBARole "file server administrator"
C:\PS> Get-EVRBARoleMember -InputObject $r
Gets the members of the Enterprise Vault RBA role as specified by the input object $r from the current Enterprise Vault Directory. Note that the parameter -InputObject is a positioned parameter (again at position 0), so this example will work without it being specified.
EVRbaRole piping example:
Get-EVRBARole "file server administrator" | Get-EVRBARoleMember
Pipes the EVRbaRole object obtained from the Get-EVRBARole cmdlet to the Get-EVRBARoleMember cmdlet to get the role members for the specified identity.
Get-EVRBARoleMember returns objects of the type Symantec.EnterpriseVault.Admin.EVRbaRoleMember, which has the following properties.
Table: Symantec.EnterpriseVault.Admin.EVRbaRoleMember properties
Name | Type | Description |
|---|---|---|
Name | String | The NTAccount name of the member. |
SID | String | The security identifier (SID) of the member. |
MemberOf | String | The name of the role to which the member belongs. |
See Get-EVRBARole.
See Add-EVRBARoleMember.