--- external help file: ZertoApiWrapper-help.xml Module Name: ZertoApiWrapper online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Install-ZertoVra.md schema: 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 -datastoreName -networkName [-memoryInGB ] [-groupName ] [-Dhcp] [-UseRootCredential] -HostRootPassword [-WhatIf] [-Confirm] [] ``` ### Dhcp ``` Install-ZertoVra -hostName -datastoreName -networkName [-memoryInGB ] [-groupName ] [-Dhcp] [-WhatIf] [-Confirm] [] ``` ### StaticIpWithRoot ``` Install-ZertoVra -hostName -datastoreName -networkName [-memoryInGB ] [-groupName ] -vraIpAddress -defaultGateway -subnetMask [-UseRootCredential] -HostRootPassword [-WhatIf] [-Confirm] [] ``` ### StaticIp ``` Install-ZertoVra -hostName -datastoreName -networkName [-memoryInGB ] [-groupName ] -vraIpAddress -defaultGateway -subnetMask [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION Install Zerto VRA to a single host in the site with either a Static IP address, or DHCP. ## EXAMPLES ### Example 1 ```powershell 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 ```powershell 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 ```powershell 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 ```powershell 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. ```yaml 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 ```yaml 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. ```yaml 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' ```yaml 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. ```yaml 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. ```yaml 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 ```yaml 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. ```yaml 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 ```yaml 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. ```yaml 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. ```yaml 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. ```yaml 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. ```yaml 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 (http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### None ## OUTPUTS ### System.Object ## NOTES ## RELATED LINKS [Zerto REST API VRA End Point Documentation](http://s3.amazonaws.com/zertodownload_docs/Latest/Zerto%20Virtual%20Replication%20Zerto%20Virtual%20Manager%20%28ZVM%29%20-%20vSphere%20Online%20Help/RestfulAPIs/StatusAPIs.5.117.html#)