Files
ZertoApiWrapper/docs/Install-ZertoVra.md
2020-04-04 10:26:56 -04:00

7.2 KiB

external help file, Module Name, online version, schema
external help file Module Name online version schema
ZertoApiWrapper-help.xml ZertoApiWrapper https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Install-ZertoVra.md 2.0.0

Install-ZertoVra

SYNOPSIS

Install Zerto VRA to a single host in the site with either a Static IP address, or DHCP.

SYNTAX

DhcpWithRoot

Install-ZertoVra -hostName <String> -datastoreName <String> -networkName <String> [-memoryInGB <Int32>]
 [-groupName <String>] [-Dhcp] [-UseRootCredential] -HostRootPassword <SecureString> [-WhatIf] [-Confirm]
 [<CommonParameters>]

Dhcp

Install-ZertoVra -hostName <String> -datastoreName <String> -networkName <String> [-memoryInGB <Int32>]
 [-groupName <String>] [-Dhcp] [-WhatIf] [-Confirm] [<CommonParameters>]

StaticIpWithRoot

Install-ZertoVra -hostName <String> -datastoreName <String> -networkName <String> [-memoryInGB <Int32>]
 [-groupName <String>] -vraIpAddress <String> -defaultGateway <String> -subnetMask <String>
 [-UseRootCredential] -HostRootPassword <SecureString> [-WhatIf] [-Confirm] [<CommonParameters>]

StaticIp

Install-ZertoVra -hostName <String> -datastoreName <String> -networkName <String> [-memoryInGB <Int32>]
 [-groupName <String>] -vraIpAddress <String> -defaultGateway <String> -subnetMask <String> [-WhatIf]
 [-Confirm] [<CommonParameters>]

DESCRIPTION

Install Zerto VRA to a single host in the site with either a Static IP address, or DHCP.

EXAMPLES

Example 1

PS C:\> Install-ZertoVra -hostName "Host01" -datastoreName "Datastore01" -networkName "VM Network" -vraIpAddress "192.168.1.50" -defaultGateway "192.168.1.254" -subnetMask "255.255.255.0"

Installs a VRA on the Host "Host01" using datastore "Datastore01" on network "VM Network" assigning an IP address if "192.168.1.50", subnetmask of "255.255.255.0" and default gateway of "192.168.1.254"

Example 2

PS C:\> Install-ZertoVra -hostName "Host01" -datastoreName "Datastore01" -networkName "VM Network" -dhcp

Installs a VRA on the Host "Host01" using datastore "Datastore01" on network "VM Network" assigning a DHCP address.

Example 3

PS C:\> Install-ZertoVra -hostName "Host01" -datastoreName "Datastore01" -networkName "VM Network" -vraIpAddress "192.168.1.50" -defaultGateway "192.168.1.254" -subnetMask "255.255.255.0" -UseRootCredential -HostRootPassword $RootPasswordAsSecureString

Installs a VRA on the Host "Host01" using datastore "Datastore01" on network "VM Network" assigning an IP address if "192.168.1.50", subnetmask of "255.255.255.0" and default gateway of "192.168.1.254" using the Root Credential install method.

Example 4

PS C:\> Install-ZertoVra -hostName "Host01" -datastoreName "Datastore01" -networkName "VM Network" -dhcp -UseRootCredential -HostRootPassword $RootPasswordAsSecureString

Installs a VRA on the Host "Host01" using datastore "Datastore01" on network "VM Network" assigning a DHCP address using the Root Credential install method.

PARAMETERS

-datastoreName

Datastore name where the VRA is to be installed.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-defaultGateway

Default gateway to assign to the VRA

Type: String
Parameter Sets: StaticIpWithRoot, StaticIp
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Dhcp

Assign a DHCP address to the VRA.

Type: SwitchParameter
Parameter Sets: DhcpWithRoot, Dhcp
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-groupName

Bandwidth group to assign to the VRA. If unspecified will assign to the 'default_group'

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-hostName

Host name where the VRA is to be installed.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-HostRootPassword

The password for the root user of the ESXi host where the VRA is to be installed.

Type: SecureString
Parameter Sets: DhcpWithRoot, StaticIpWithRoot
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-memoryInGB

Initial amount of memory to assign to the VRA in GB. Default is 3, Minimum is 1, Maximum is 16

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-networkName

Network name the VRA is to be assigned.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-subnetMask

Subnetmask to be assigned to the VRA

Type: String
Parameter Sets: StaticIpWithRoot, StaticIp
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-UseRootCredential

Use this switch to install the VRA using the root password install method.

Type: SwitchParameter
Parameter Sets: DhcpWithRoot, StaticIpWithRoot
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-vraIpAddress

Static IP address to assign to the VRA.

Type: String
Parameter Sets: StaticIpWithRoot, StaticIp
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None

OUTPUTS

System.Object

NOTES

Zerto REST API VRA End Point Documentation