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
Remove-EVRBARoleMember
Remove-EVRBARoleMember removes one or more Active Directory users, groups, or built-in security principals from an Enterprise Vault RBA role.
The -Identity parameter specifies the Enterprise Vault RBA role to access. You can identify an RBA role by its name or its 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 Remove-EVRBARoleMember. If you do not specify the -Identity or the -InputObject parameter, you are prompted to enter the value for -Identity.
The -Members parameter specifies the members to remove from the role. You can identify a member by its security identifier (SID) or its SAM account name. If you are specifying more than one member, use a comma-separated list. You cannot pass member objects through the pipeline to this cmdlet. If you do not specify the -Members parameter, you are prompted to enter the value for -Members.
You can specify the Enterprise Vault Directory using the -EVDirectoryServer parameter.
If you do not specify the -EVDirectoryServer parameter, and Remove-EVRBARoleMember cannot determine the server, you are prompted to enter the Enterprise Vault directory server.
If you execute Remove-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.
Remove-EVRBARoleMember is provided by Symantec.EnterpriseVault.PowerShell.AdminAPI.dll, which is loaded by the Enterprise Vault Management Shell.
Remove-EVRBARoleMember [-Identity] <String> [-Members] <String[]> -EVDirectoryServer <String> [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>]
Remove-EVRBARoleMember [-InputObject] <Symantec.EnterpriseVault.Admin.EVRbaRole> [-Members] <String[]> -EVDirectoryServer <String> [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>]
Table: Remove-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. |
-Members (required) | Specifies a set of Active Directory users, groups, or built-in security principal objects in a comma-separated list to remove from a role. To identify each object, use one of the following property values. Note that the identifier in parentheses is the LDAP display name. The acceptable values for this parameter are:
The following example shows how to specify this parameter. This example specifies a user and a group by their SAM Account Name property and another user by its SID property. -Members "fsaadmin1@example.com", "NT AUTHORITY\This Organization", "S-1-5-21-1529523603-1500826627-74573220-1119" You cannot provide objects to this parameter. You cannot pass objects through the pipeline to this parameter. |
-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. |
-PassThru | Returns an object representing the role with which you are working. By default, this cmdlet does not generate any output. |
-Confirm | Prompts you for confirmation before running the cmdlet. |
-WhatIf | Shows what would happen if the cmdlet runs. The cmdlet is not actually run. |
Remove-EVRBARoleMember -Identity "File Server Administrator" -Members "fsaAdmin1@example.com", "example\fsaGroup1", "S-1-5-21-1529523603-1500826627-74573220-1119"
Removes the specified Active Directory members from an Enterprise Vault RBA role called "File Server Administrator".
Remove-EVRBARoleMember "File Server Administrator"
Prompts for the members to be removed and removes them from an Enterprise Vault RBA role called "File Server Administrator". Note that the parameter -Identity 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.
Remove-EVRBARoleMember "File Server Administrator" -EVDirectoryServer evs2.example.com
Prompts for the members to be removed and removes them from an Enterprise Vault RBA role called "File Server Administrator" in the Enterprise Vault Directory identified by the -EVDirectoryServer parameter.
-InputObject usage example:
$r = Get-EVRBARole "file server administrator"
Remove-EVRBARoleMember -InputObject $r
Prompts for the members to be removed and removes them from an Enterprise Vault RBA role called "File Server Administrator" in 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.
String piping example:
"file server administrator" | Remove-EVRBARoleMember
Prompts for the members to be removed and removes them from an Enterprise Vault RBA role called "File Server Administrator" in the current Enterprise Vault Directory.
EVRbaRole piping example:
Get-EVRBARole "file server administrator" -EVDirectoryServer evs2.example.com | Remove-EVRBARoleMember -Members "fsaAdmin1", "fsaAdmin2" -EVDirectoryServer evs2.example.com
Pipes the EVRbaRole object obtained from the Get-EVRBARole cmdlet to the Remove-EVRBARoleMember cmdlet and removes the specified members from that role. Also note that the parameter -EVDirectoryServer specifies the Enterprise Vault Directory for each cmdlet to use.
Remove-EVRBARoleMember returns no output, or a modified object of the type Symantec.EnterpriseVault.Admin.EVRbaRole when the -PassThru parameter is specified. Symantec.EnterpriseVault.Admin.EVRbaRole 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 Get-EVRBARole.
See Add-EVRBARoleMember.
See Get-EVRBARoleMember.