Help Center
Choose product document...
Veeam Backup & Replication 9.5 Update 4
Veeam Explorers PowerShell Reference

New-VEORLinuxCredential

Short Description

Creates Linux credentials for the Oracle database restore.

Applies to

Product Edition: Enterprise, Enterprise Plus

Syntax

This cmdlet provides the following parameter sets.

  • To restore using the password:

New-VEORLinuxCredential [-Account] <string> -Password <securestring> [-ElevateAccountToRoot] [-AddToSudoers][-UseSuIfSudoUnavailable] [-RootPassword <securestring>]  [<CommonParameters>]

  • To restore using the private key:

New-VEORLinuxCredential [-Account] <string> -PrivateKeyFilePath <string> -Passphrase <securestring> [-ElevateAccountToRoot] [-AddToSudoers] [-UseSuIfSudoUnavailable] [-RootPassword <securestring>][<CommonParameters>]

Detailed Description

This cmdlet creates the Linux credentials object.The cmdlet will use these credentials to restore the Oracle database to a Linux VM.

New-VEORLinuxCredential Note:

This cmdlet requires the PSCredential object. Use the Get-Credential cmdlet to create the PSCredentials object. For detailed instructions on how to run Get-Credential, see this Microsoft article.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Account

Specifies a login. The cmdlet will use this login to connect to the target Linux server.

NOTE: The account must be a member of the dba group.

True

0

False

False

Password

Specifies a password. The cmdlet will use this password to connect to the target Linux server.

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.

True

Named

False

False

Passphrase

Specifies a passphrase. The cmdlet will use that passphrase to connect to the target Linux server.

True

Named

False

False

ElevateAccountToRoot

Indicates that the account must be elevated to root.

False

Named

False

False

AddToSudoers

Indicates that the cmdlet will add the account to sudoers.

False

Named

False

False

UseSuIfSudoUnavailable

Indicates that the Su is used instead of the Sudo.

False

Named

False

False

RootPassword

Specifies the root password.

False

Named

False

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Return Type

Example 1

This example shows how to create Linux credentials. Veeam Explorer for Oracle will use these credentials to restore an Oracle database using the password.

  1. Create a secure password. Save the result to the $securepassword variable.
  2. Run New-VEORLinuxCredential with the $securepassword variable. Use the Account parameter to specify the user account.

PS C:\PS> $securepassword = Read-Host -Prompt "Enter password" -AsSecureString

PS C:\PS> New-VEORLinuxCredential -Account "root" -Password $securepassword

Example 2

This example shows how to create Linux credentials. Veeam Explorer for Oracle will use these credentials to restore an Oracle database using the private key.

  1. Create a secure password. Save the result to the $securepassword variable.
  2. Run New-VEORLinuxCredential with the $securepassword variable. Use the Account parameter to specify the user account and the PrivateKeyFilePath parameter to specify the directory, where the passphrase is stored.

PS C:\PS> $securestring = Read-Host -Prompt "Enter secure string" -AsSecureString

PS C:\PS> New-VEORLinuxCredential -Account <string> -PrivateKeyFilePath "/home/.ecryptfs/<user>/.Private/" -Passphrase $securestring

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Explorers User Guide

Backup and Restore of SQL Server Databases

Veeam Plug-ins for Enterprise Applications

PowerShell Reference

Veeam Explorers PowerShell Reference

RESTful API Reference

Required Permissions

Veeam Availability for Nutanix AHV

Veeam Backup for Microsoft Office 365 Documentation

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation