Veritas Enterprise Vault™ PowerShell Cmdlets

Last Published:
Product(s): Enterprise Vault (12.2)
  1. Introducing the Enterprise Vault PowerShell cmdlets
    1.  
      About the Enterprise Vault Management Shell
    2.  
      Importing modules
    3.  
      Getting Help for Enterprise Vault PowerShell cmdlets
    4.  
      Rules for PowerShell strings
    5. Where to get more information about Enterprise Vault
      1.  
        Enterprise Vault training modules
  2. Archiving: Exchange
    1.  
      Add-EVPstComputer
    2.  
      Add-EVPstFile
    3.  
      Get-EVExchangeMailboxPolicy
    4.  
      New-EVExchangeMailboxPolicy
    5.  
      Remove-EVExchangeFolderPolicy
    6.  
      Remove-EVExchangeMailboxPolicy
    7.  
      Set-EVExchangeMailboxPolicy
  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: Skype for Business
    1.  
      Get-EVSkypeForBusinessTarget
    2.  
      New-EVSkypeForBusinessTarget
    3.  
      Remove-EVSkypeForBusinessTarget
    4.  
      Set-EVSkypeForBusinessTarget
  5. Archiving: SMTP
    1.  
      Get-EVSMTPHoldingFolder
    2.  
      Get-EVSMTPMessageTrackingLogLocation
    3.  
      Get-EVSMTPPolicy
    4.  
      Get-EVSMTPServerSettings
    5.  
      Get-EVSMTPTarget
    6.  
      New-EVSMTPPolicy
    7.  
      New-EVSMTPServerSettings
    8.  
      New-EVSMTPTarget
    9.  
      Remove-EVSMTPPolicy
    10.  
      Remove-EVSMTPTarget
    11.  
      Set-EVSMTPMessageTrackingLogLocation
    12.  
      Set-EVSMTPPolicy
    13.  
      Set-EVSMTPServerSettings
    14.  
      Set-EVSMTPTarget
    15.  
      Sync-EVSMTPServerSettings
  6. Backup
    1.  
      Clear-IndexLocationBackupMode
    2.  
      Clear-VaultStoreBackupMode
    3.  
      Get-IndexLocationBackupMode
    4.  
      Get-VaultStoreBackupMode
    5.  
      Set-IndexLocationBackupMode
    6.  
      Set-VaultStoreBackupMode
  7. Classification
    1.  
      Disable-EVClassification
    2.  
      Get-EVClassificationFCITags
    3.  
      Get-EVClassificationPolicy
    4.  
      Get-EVClassificationStatus
    5.  
      Get-EVClassificationTestMode
    6.  
      Get-EVClassificationVICTags
    7.  
      Import-EVClassificationFCIRules
    8.  
      Initialize-EVClassificationVIC
    9.  
      New-EVClassificationPolicy
    10.  
      Publish-EVClassificationFCIRules
    11.  
      Remove-EVClassificationPolicy
    12.  
      Set-EVClassificationPolicy
    13.  
      Set-EVClassificationTestMode
  8. Databases
    1.  
      Get-EVDatabase
    2.  
      Get-EVDatabaseDetail
    3.  
      Get-EVDatabaseFileInfo
    4.  
      Get-EVStorageDatabase
    5.  
      Set-EVDatabaseDetail
    6.  
      Start-EVDatabaseUpgrade
  9. IMAP access
    1.  
      Get-EVIMAPUsers
    2.  
      Get-EVIMAPUserSettings
    3.  
      Set-EVIMAPServerDisabled
    4.  
      Set-EVIMAPServerEnabled
  10. Indexing
    1.  
      Get-EVIndexLocation
    2.  
      Get-EVMDSStatus
    3.  
      Get-IndexServerForIndexLocation
    4.  
      New-EVMDSBuildTask
    5.  
      Set-IndexMetadataSyncLevel
  11. Records management
    1.  
      Export-EVNARAArchive
    2.  
      Get-EVRecordSettings
  12. Retention plans
    1.  
      Get-EVRetentionPlan
    2.  
      New-EVRetentionPlan
    3.  
      Remove-EVRetentionPlan
    4.  
      Set-EVRetentionPlan
  13. Roles-based administration
    1.  
      Add-EVRBARoleMember
    2.  
      Get-EVRBAAzStoreXml
    3.  
      Get-EVRBARole
    4.  
      Get-EVRBARoleMember
    5.  
      Remove-EVRBARoleMember
    6.  
      Set-EVRBAAzStoreXml
  14. Sites and servers
    1.  
      Get-EVComputers
    2.  
      Get-EVFileLocation
    3.  
      Get-EVIISWebsite
    4.  
      Get-EVServer
    5.  
      Get-EVSite
    6.  
      Get-EVSiteInfo
  15. Tasks and services
    1.  
      Get-EVDependencyService
    2.  
      Get-EVDependencyServiceState
    3.  
      Get-EVService
    4.  
      Get-EVServiceState
    5.  
      Get-EVTask
    6.  
      Get-EVTaskState
  16. Vault stores and archives
    1.  
      Export-EVArchive
    2.  
      Get-EVArchive
    3.  
      Get-EVVaultStore
    4.  
      Get-EVVaultStorePartition
    5.  
      Set-EVArchive
    6.  
      Start-PartitionRollover

Add-EVRBARoleMember

Add-EVRBARoleMember adds one or more Active Directory users, groups, or built-in security principals as new members of 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 Add-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 new members to add to a role. You can identify a new member by its security identifier (SID) or its SAM account name. If you specify more than one new 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 server using the -EVDirectoryServer parameter. If you do not use the -EVDirectoryServer parameter, and Add-EVRBARoleMember cannot determine the server, you are prompted to enter the Enterprise Vault directory server.

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

Add-EVRBARoleMember is provided by Symantec.EnterpriseVault.PowerShell.AdminAPI.dll, which is loaded automatically by the Enterprise Vault Management Shell.

Syntax

Add-EVRBARoleMember [-Identity] <String> [-Members] <String[]> -EVDirectoryServer <String> [-PassThru <Switch>] [-Confirm <Switch>] [-WhatIf <Switch>] [<CommonParameters>]

Add-EVRBARoleMember [-InputObject] <Symantec.EnterpriseVault.Admin.EVRbaRole> [-Members] <String[]> -EVDirectoryServer <String> [-PassThru <Switch>] [-Confirm <Switch>] [-WhatIf <Switch>] [<CommonParameters>]

Parameters

Table: Add-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 add to 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:

  • Security Identifier (objectSid)

  • SAM Account Name (sAMAccountName)

The following example shows how to specify this parameter. This example specifies a user and a group by its SAM Account Name property and another user by its SID property.

-Members "fsaAdmin@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.

Examples
  • Add-EVRBARoleMember -Identity "File Server Administrator" -Members "fsaAdmin@example.com", "example\fsaGroup", "S-1-5-21-1529523603-1500826627-74573220-1119"

    Adds the specified Active Directory members to an Enterprise Vault RBA role called "File Server Administrator".

  • Add-EVRBARoleMember "File Server Administrator"

    Prompts for the members to be added and adds them to 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:

    Add-EVRBARoleMember "File Server Administrator" -EVDirectoryServer evs2.example.com

    Prompts for the members to be added and adds them to 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"

    Add-EVRBARoleMember -InputObject $r

    Prompts for the members to be added and adds them to 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" | Add-EVRBARoleMember

    Prompts for the members to be added and adds them to 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 | Add-EVRBARoleMember -Members "fsaAdmin1", "fsaAdmin2" -EVDirectoryServer evs2.example.com

    Pipes the EVRbaRole object obtained from the Get-EVRBARole cmdlet to the Add-EVRBARoleMember cmdlet and adds the specified members to that role. Also note that the parameter -EVDirectoryServer specifies the Enterprise Vault directory for each cmdlet to use.

Output

Add-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.

Related cmdlets