This is an archive version of the document. To get the most up-to-date information, see the current version.New-VEORLinuxCredential
Short Description
Creates Linux credential records to connect to Linux VMs.
Applies to Veeam Backup & Replication
Product Edition: Enterprise, Enterprise Plus
Syntax
This cmdlet provides parameter sets that allow you to:
- To define credentials that will connect to Linux VMs using a password:
New-VEORLinuxCredential [-Account] <string> -Password <securestring> [-ElevateAccountToRoot] [-AddToSudoers][-UseSuIfSudoUnavailable] [-RootPassword <securestring>] [<CommonParameters>] |
- To define credentials that will connect to Linux VMs using a private key:
New-VEORLinuxCredential [-Account] <string> -PrivateKeyFilePath <string> -Passphrase <securestring> [-ElevateAccountToRoot] [-AddToSudoers] [-UseSuIfSudoUnavailable] [-RootPassword <securestring>][<CommonParameters>] |
Detailed Description
This cmdlet creates Linux credential records. You can use these credential records to connect to the Oracle database and restore this database to a Linux VM.
Run Restore-VEORDatabase to restore an Oracle database.
Parameters
Parameter | Description | Type | Required | Position | Accept Pipeline Input | Accept Wildcard Characters |
Account | Specifies a login that will be used to connect to the target Linux server. NOTE: The account must be a member of the dba group. | String | True | 0 | False | False |
Password | Specifies a password that will be used to connect to the target Linux server. | Securestring | True | Named | False | False |
PrivateKeyFilePath | Specifies the path for the private key. The cmdlet will use that key to connect to the target Linux server. | String | True | Named | False | False |
Passphrase | Specifies a passphrase. The cmdlet will use that passphrase to connect to the target Linux server. | Securestring | True | Named | False | False |
ElevateAccountToRoot | Indicates that the account must be elevated to root. | SwitchParameter | False | Named | False | False |
AddToSudoers | Indicates that the cmdlet will add the account to sudoers. | SwitchParameter | False | Named | False | False |
UseSuIfSudoUnavailable | Indicates that the Su is used instead of the Sudo. | SwitchParameter | False | Named | False | False |
RootPassword | Specifies the root password. | Securestring | False | Named | False | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.
Examples
Example 1. Creating Linux Credential Records With Password
This example shows how to create Linux credential records. Veeam Explorer for Oracle will use these credentials to connect to Linux VMs using a password.
$securepassword = Read-Host -Prompt "Enter password" -AsSecureString New-VEORLinuxCredential -Account "root" -Password $securepassword |
You must perform the following steps:
- Run the Read-Host cmdlet to create a secure password. Enter credentials that will be used to connect to the Veeam Backup & Replication server. Define the AsSecureString parameter. Save the result to the $securepassword variable.
- Run the New-VEORLinuxCredential cmdlet. Specify the Account parameter value. Set the $securepassword variable as the Password parameter value.
Example 2. Creating Linux Credential Records With Private Key
This example shows how to create Linux credential records. Veeam Explorer for Oracle will use these credentials to connect to Linux VMs using the private key.
$securepassword = Read-Host -Prompt "Enter secure string" -AsSecureString New-VEORLinuxCredential -Account "root" -PrivateKeyFilePath "/home/.ecryptfs/<user>/.Private/" -Passphrase $securepassword |
You must perform the following steps:
- Run the Read-Host cmdlet to create a secure password. Enter credentials that will be used to connect to the Veeam Backup & Replication server. Define the AsSecureString parameter. Save the result to the $securepassword variable.
- Run the New-VEORLinuxCredential cmdlet. Specify the following settings:
- Specify the Account parameter value.
- Specify the PrivateKeyFilePath parameter value.
- Set $securepassword variable as the Passphrase parameter value.
Related Commands