New-VBRIndividualComputerCustomCredentials

Short Description

Specifies a method for authenticating individual computers.

Product Edition: Community, Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

This cmdlet provides the following parameter sets:

Credentials

New-VBRIndividualComputerCustomCredentials -HostName <String> -Credentials <CCredentials> [<CommonParameters>]
TempCertificates

New-VBRIndividualComputerCustomCredentials -HostName <String> [-UseTemporaryCertificate] [<CommonParameters>]

TempCredentials

New-VBRIndividualComputerCustomCredentials -HostName <String> [-SSHTempCredentials] -SSHUser <String>

-SSHPassword <String> [-SSHPort <UInt16>] [-SSHElevateToRoot] [-SSHFailoverToSu] [-SSHRootPassword <String>] [<CommonParameters>]

Detailed Description

This cmdlet specifies a method for authenticating individual computers that you want to add to a protection group. Veeam Backup & Replication uses this method for Veeam Agent deployment and backup\restore activities.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Credentials	Specifies a method to authenticate against individual computers in a protection group. Note: for string type, enter a user name in the `DNS.DOMAIN.NAME\USERNAME` or `USERNAME@DNS.DOMAIN.NAME` format. Accepts string (user name) or the `CCredentials` object. To get this object, run the `Get-VBRCredentials` cmdlet.	`CCredentials`	True	Named	True (ByPropertyName)
HostName	Specifies the DNS name or an IP address of the computer for which you want to specify custom credentials.	`String`	True	Named	True (ByPropertyName, ByValue)
SSHElevateToRoot	Defines that the cmdlet will grant the non-root users with root account privileges.	`SwitchParameter`	False	Named	True (ByPropertyName)
SSHFailoverToSu	Defines that Veeam Backup & Replication will use the su command if the sudo command fails.	`SwitchParameter`	False	Named	True (ByPropertyName)
SSHPassword	Specifies the password you want to use to authenticate against individual computers in a protection group.	`String`	True	Named	True (ByPropertyName)
SSHPort	Specifies the Web service port to connect to Linux-based machines. Default: `443`.	`UInt16`	False	Named	True (ByPropertyName)
SSHRootPassword	Specifies the root password used for authentication.	`String`	False	Named	True (ByPropertyName)
SSHTempCredentials	Defines that the cmdlet will use single-use credentials to access Linux-based machines.	`SwitchParameter`	True	Named	True (ByPropertyName)
SSHUser	Specifies the user name you want to use to authenticate against individual computers in a protection group.	`String`	True	Named	True (ByPropertyName)
UseTemporaryCertificate	Defines that the cmdlet will use temporary certificate.	`SwitchParameter`	True	Named	True (ByPropertyName)

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

The cmdlet returns the VBRIndividualComputerCustomCredentials object that contains a method for authenticating individual computers.

Examples

Specifying Credentials for Authenticating with Individual Computers

This example shows how to specify credentials for authenticating individual computers.

$ccreds = Get-Credential

New-VBRIndividualComputerCustomCredentials -HostName 172.19.51.50 -Credentials $creds

Perform the following steps:

Run the Get-Credential cmdlet. Type the credentials and save the result to the $ccreds variable.
Run the New-VBRIndividualComputerCustomCredentials cmdlet. Specify the HostName parameter value. Set the $ccreds variable as the Credentials parameter value.

New-VBRIndividualComputerContainer