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
New-EVFSAFileServer
New-EVFSAFileServer adds the specified file server as a File System Archiving target.
The cmdlet tries to identify the type of the specified file server, irrespective of whether you use the -Type parameter to specify the file server type.
If you do not specify the file server type:
If the cmdlet is able to determine the file server type, the file server is added successfully.
If the cmdlet is not able to determine the file server type, you are prompted to specify the file server type using the parameter -Type and re-run the cmdlet.
If you specify the file server type:
If the specified type matches the type that the cmdlet determines, the file server is added successfully.
If the specified type does not match the type that the cmdlet determines, you are prompted to add the file server with the type determined by the cmdlet.
If the cmdlet is not able to determine the type, you are prompted to add the file server with the specified file server type.
To add a NetApp C-Mode Vserver you need to additionally enter the DNS name of the management LIF and the data LIF of the Vserver using the -Management and the -Identifier parameters, respectively. If the data and the management roles are configured on a single LIF, you must specify the same value in both parameters.
New-EVFSAFileServer is provided by Symantec.EnterpriseVault.PowerShell.AdminAPI.dll, which is loaded by the Enterprise Vault Management Shell.
New-EVFSAFileServer [-SiteId <String>] [-Identifier] <String> [-ManagementLIF <String>] [[-Type] <EVFileServerType>] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]
Table: New-EVFSAFileServer parameters
Parameter | Description |
|---|---|
-SiteId (required) | The ID of the Enterprise Vault site in which the file server is to be configured. If you omit this parameter, New-EVFSAFileServer uses the ID of the site of the Enterprise Vault server where the command is running. You can use Get-EVSite to obtain the site ID. |
-Identifier (required) | The fully-qualified DNS name, UNC name, or alias name of the file server target to be configured in the Enterprise Vault site. You can specify the UNC name with or without the \\ prefix and you can specify either the hostname or the alias as the UNC name. To add a NetApp C-Mode Vserver, you must specify the fully-qualified DNS name, UNC name, or alias name of the data LIF of the Vserver. Parameter aliases: FileServerDNSName, FileServerName, FileServerId. |
-ManagementLIF | The fully-qualified DNS name, UNC name or alias name of the management LIF of NetApp C-Mode Vserver to be configured under the Enterprise Vault site. You can specify the UNC name with or without the \\ prefix and you can specify the alias as the UNC name. This parameter is mandatory if you want to add a NetApp C-Mode Vserver as a File System Archiving target. |
-Type | The file server type. Possible values are WindowsFileServer, NetApp7ModeFileServer, NetAppCModeFileServer, and EMCCelerraOrVNXFileServer. |
-Confirm | Prompts you for confirmation before running the cmdlet. To suppress the prompt, type -Confirm:$false. |
-WhatIf | Shows what would happen if the cmdlet runs. The cmdlet is not actually run. |
New-EVFSAFileServer -Identifier \\abc
or
New-EVFSAFileServer -FileServername \\abc
Determines the file server type of the file server with the UNC name \\abc and adds it as a File System Archiving target.
New-EVFSAFileServer -SiteId 198...example.com -Identifier abc.example.com
or
New-EVFSAFileServer -SiteId 198...example.com -FileServerDNSName abc.example.com
Determines the file server type of the file server with the fully-qualified domain name 'abc.example.com' and adds it to the specified Enterprise Vault site as a File System Archiving target.
New-EVFSAFileServer -SiteId 198...example.com -Identifier abc.example.com -Type WindowsFileServer
or
New-EVFSAFileServer -SiteId 198...example.com -FileServerDNSName abc.example.com -Type WindowsFileServer
Determines the type of file server. If input type matches the type that is determined by the cmdlet, the cmdlet adds the file server as a File System Archiving target to the Enterprise Vault site. If the file server type that is determined by the cmdlet does not match with the specified file server type, the cmdlet prompts you to add the file server with the type determined by the cmdlet.
New-EVFSAFileServer -ManagementLIF managelif.example.com -Identifier datalif.example.com
Determines the type of the file server with the fully-qualified domain name managelif.example.com and, if the specified value is a valid management LIF and datalif.example.com is a valid data LIF, adds the associated NetApp C-Mode Vserver as a File System Archiving target.
The following tables list the properties that are available:
Table: New-EVFSAFileServer - WindowsFileServer properties lists the WindowsFileServer properties that are available.
Table: New-EVFSAFileServer - NetAppCModeFileServer properties lists the NetAppCModeFileServer properties that are available.
Table: New-EVFSAFileServer - NetApp7ModeFileServer properties lists the NetApp7ModeFileServer properties that are available.
Table: New-EVFSAFileServer - EMCCelerraOrVNXFileServer properties lists the EMCCelerraOrVNXFileServer properties that are available.
Table: New-EVFSAFileServer - DHSMServiceConfiguration properties lists the DHSMServiceConfiguration properties that are available.
Table: New-EVFSAFileServer - WindowsFileServer properties
Name | Type | Description |
|---|---|---|
|
FileServerName |
String |
The UNC name of the file server that is configured in the Enterprise Vault site. |
FileServerDNSName | String | The fully-qualified DNS name of the file server that is configured in the Enterprise Vault site. |
FileServerId | String | The ID of the file server that is configured in the Enterprise Vault site. |
FileServerType | FileServerType | The type of file server. In this case the value is WindowsFileServer. |
Archiving | Boolean | Specifies whether File System Archiving is enabled for this server. |
SiteId | String | The ID of the Enterprise Vault site in which the file server is configured. |
PassthroughRecall | Boolean | Specifies if pass-through recall is configured. |
PassthroughRecallCacheLocation | String | Specifies the pass-through recall cache location. |
PassthroughRecallCacheSizeInGB | Integer | Specifies the pass-through recall cache location size in gigabytes. |
ActionOnPlaceholderDelete | ActionOnPlaceholderDelete | Specifies whether to retain or delete an archived file when its placeholder is deleted. Values can be RetainArchivedFile or DeleteArchivedFile. |
Table: New-EVFSAFileServer - NetAppCModeFileServer properties
Name | Type | Description |
|---|---|---|
|
FileServerName |
String |
The UNC name of the file server that is configured in the Enterprise Vault site. |
FileServerDNSName | String | The fully-qualified DNS name of the file server that is configured in the Enterprise Vault site. |
FileServerId | String | The ID of the file server that is configured in the Enterprise Vault site. |
FileServerType | FileServerType | The type of file server. In this case the value is NetAppCModeFileServer. |
Archiving | Boolean | Specifies whether File System Archiving is enabled for this server. |
SiteId | String | The ID of the Enterprise Vault site in which the file server is configured. |
ActionOnPlaceholderDelete | ActionOnPlaceholderDelete | Specifies whether to retain or delete an archived file when its placeholder is deleted. Values can be RetainArchivedFile or DeleteArchivedFile. |
PlaceholderRecallsEnabled | Boolean | Specifies whether the processing of placeholder recalls for the NetApp filer is enabled. |
MaxRecallThreads | Integer | The maximum number of recall threads to be used when you recall items. This value is equivalent to the number of simultaneous recalls. |
RecallLimitMaxRecalls | Integer | Specifies the maximum number of items that a user is allowed to recall. |
RecallLimitTimeInterval | Integer | Specifies the maximum number of items that a user is allowed to recall in the specified time period. |
IgnoreRecallLimitForLocalAdministrators | Boolean | Specifies whether the recall limits apply to members of the local Administrators group for the NetApp filer. |
Table: New-EVFSAFileServer - NetApp7ModeFileServer properties
Name | Type | Description |
|---|---|---|
|
FileServerName |
String |
The UNC name of the file server that is configured in the Enterprise Vault site. |
FileServerDNSName | String | The fully-qualified DNS name of the file server that is configured in the Enterprise Vault site. |
FileServerId | String | The ID of the file server that is configured in the Enterprise Vault site. |
FileServerType | FileServerType | The type of file server. In this case the value is NetApp7ModeFileServer. |
Archiving | Boolean | Specifies whether File System Archiving is enabled for this server. |
SiteId | String | The ID of the Enterprise Vault site in which the file server is configured. |
ActionOnPlaceholderDelete | ActionOnPlaceholderDelete | Specifies whether to retain or delete an archived file when its placeholder is deleted. Values can be RetainArchivedFile or DeleteArchivedFile. |
PassthroughRecall | Boolean | Specifies if pass-through recall is configured. |
PlaceholderRecallsEnabled | Boolean | Specifies whether the processing of placeholder recalls for the NetApp filer is enabled. |
MaxRecallThreads | Integer | The maximum number of recall threads to be used when you recall items. This value is equivalent to the number of simultaneous recalls. |
RecallLimitMaxRecalls | Integer | Specifies the maximum number of items that a user is allowed to recall. |
RecallLimitTimeInterval | Integer | Specifies the maximum number of items that a user is allowed to recall in the specified time period. |
IgnoreRecallLimitForLocalAdministrators | Boolean | Specifies whether the recall limits apply to members of the local Administrators group for the NetApp filer. |
Table: New-EVFSAFileServer - EMCCelerraOrVNXFileServer properties
Name | Type | Description |
|---|---|---|
|
FileServerName |
String |
The UNC name of the file server that is configured in the Enterprise Vault site. |
FileServerDNSName | String | The fully-qualified DNS name of the file server that is configured in the Enterprise Vault site. |
FileServerId | String | The ID of the file server that is configured in the Enterprise Vault site. |
FileServerType | FileServerType | The type of file server. For Celerra or VNX the value is EMCCelerraOrVNXFileServer. |
Archiving | Boolean | Specifies whether File System Archiving is enabled for this server. |
SiteId | String | The ID of the Enterprise Vault site in which the file server is configured. |
PlaceholdersEnabled | Boolean | Specifies whether placeholders are created on the share for the file server if the policy is enabled to create shortcuts. |
DHSMServiceConfiguration | DHSMServiceConfiguration | Specifies the DHSM service configuration that is required for placeholder creation. |
Table: New-EVFSAFileServer - DHSMServiceConfiguration properties
Name | Type | Description |
|---|---|---|
|
UserName |
String |
Specifies the Data Mover user name with which Enterprise Vault authenticates the DHSM service. |
Password | SecureString | Specifies the password for the Data Mover account with which Enterprise Vault authenticates the DHSM service. This password is stored in an encrypted format in the Enterprise Vault Directory database. |
PortNumber | Integer | Specifies the port number on which the DHSM is configured. |
SSLRequired | Boolean | Specifies whether the DHSM service requires SSL connections. |
See Get-EVSite.
See Get-EVFSAFileServer.
See Set-EVFSAFileServer.