Deploy-B1Appliance

SYNOPSIS

Deploys a BloxOneDDI Virtual Appliance to VMware, Hyper-V or Azure.

SYNTAX

VMware

Deploy-B1Appliance [-Type] <String> [-Name] <String> [-IP] <IPAddress> [-Netmask] <String> [-Gateway] <IPAddress>
 [-DNSServers] <IPAddress[]> [-NTPServers] <IPAddress[]> [-DNSSuffix] <String> [-JoinToken] <String> [-Force] [-WhatIf] [-Confirm]
 [-DownloadLatestImage] [[-ImagesPath] <String>] [-SkipCloudChecks] [-CloudCheckTimeout] <Int> [-SkipPingChecks] [-SkipPowerOn]
 [-OVAPath] <String> [-vCenter] <String> [-Cluster] <String> [-VMHost] <String> [-Datastore] <String> [-PortGroup] <String>
 [-PortGroupType] <String> [-Creds] <PSCredential>
 [<CommonParameters>]

Hyper-V

Deploy-B1Appliance [-Type] <String> [-Name] <String> [-IP] <IPAddress> [-Netmask] <String> [-Gateway] <IPAddress>
 [-DNSServers] <IPAddress[]> [-NTPServers] <IPAddress[]> [-DNSSuffix] <String> [-JoinToken] <String> [-Force] [-WhatIf] [-Confirm]
 [-DownloadLatestImage] [[-ImagesPath] <String>] [-SkipCloudChecks] [-CloudCheckTimeout] <Int> [-SkipPingChecks] [-SkipPowerOn]
 [-VHDPath] <String> [-HyperVServer] <String> [-HyperVGeneration] <Int> [-VMPath] <String> [-VirtualNetwork] <String>
 [-VirtualNetworkVLAN] <Int> [-CPU] <Int> [-Memory] <Int>
 [<CommonParameters>]

Azure

Deploy-B1Appliance [-Type] <String> [-Name] <String> [-JoinToken] <String>  [-Force] [-WhatIf] [-Confirm]
 [-AzTenant] <String> [-AzSubscription] <String> [-AzLocation] <String> [-AzOffer] <String> [-AzSku] <String>
 [-AzResourceGroup] <String> [-AzVirtualNetwork] <String> [-AzSubnet] <String> [-AzSize] <String>
 [-AzAcceptTerms] [-SkipCloudChecks] [-SkipPingChecks] [-CloudCheckTimeout] <Int>
 [<CommonParameters>]

DESCRIPTION

This function is used to deploy a BloxOneDDI Virtual Appliance to a VMware host/cluster, Hyper-V or Azure.

EXAMPLES

VMware Example

Deploy-B1Appliance -Type "VMware" `
                    -Name "bloxoneddihost1" `
                    -IP "10.10.100.10" `
                    -Netmask "255.255.255.0" `
                    -Gateway "10.10.100.1" `
                    -DNSServers "10.30.10.10","10.30.20.10" `
                    -NTPServers "time.mydomain.corp","time2.mydomain.corp" `
                    -DNSSuffix "prod.mydomain.corp" `
                    -JoinToken "JoinTokenGoesHere" `
                    -ImagesPath .\Images `
                    -DownloadLatestImage `
                    -vCenter "vcenter.mydomain.corp" `
                    -Cluster "CLUSTER-001" `
                    -Datastore "DATASTORE-001" `
                    -PortGroup "PORTGROUP" `
                    -PortGroupType "VDS"

Hyper-V Example

Deploy-B1Appliance -Type Hyper-V `
                   -Name "bloxoneddihost1" `
                   -IP 10.10.100.10 `
                   -Netmask 255.255.255.0 `
                   -Gateway 10.10.100.1 `
                   -DNSServers 10.10.100.1 `
                   -NTPServers ntp.ubuntu.com `
                   -DNSSuffix mydomain.corp `
                   -JoinToken "JoinTokenGoesHere" `
                   -VHDPath ".\BloxOne_OnPrem_VHDX_v3.8.1.vhdx" `
                   -HyperVServer "Host1.mycompany.corp" `
                   -HyperVGeneration 2 `
                   -VMPath "A:\VMs" `
                   -VirtualNetwork "Virtual Network 1" `
                   -VirtualNetworkVLAN 101

Azure Example

Deploy-B1Appliance -Type "Azure" `
                   -Name "bloxoneddihost1" `
                   -JoinToken "JoinTokenGoesHere" `
                   -AzTenant 'g54gdeg5-gdf4-4434-dff4-7fdeswgf54ff' `
                   -AzSubscription '1234d123-abc1-4f33-r43f-5gredgrgdsdv4' `
                   -AzLocation 'UK South' `
                   -AzOffer 'infoblox-bloxone-34' `
                   -AzSku 'infoblox-bloxone' `
                   -AzResourceGroup 'rg-infoblox' `
                   -AzVirtualNetwork 'infoblox_vnet' `
                   -AzSubnet 'infoblox_snet' `
                   -AzSize 'Standard_F8s_v2' `
                   -AzBootDiagnostics `
                   -AzStorageAccount 'ibbootdiags' `
                   -AzAcceptTerms

PARAMETERS

-Type

The type of deployment to perform (VMware / Hyper-V / Azure)

Type: String
Parameter Sets: (All)
Aliases:

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

-Name

The name of the virtual machine

Type: String
Parameter Sets: (All)
Aliases:

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

-JoinToken

The Join Token for registration of the BloxOneDDI Host into the Cloud Services Portal

Type: String
Parameter Sets: (All)
Aliases:

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

-CloudCheckTimeout

The duration of time allowed for the B1 Host to register with the Cloud Services Portal before timing out. This defaults to 300s (5 Minutes)

Type: Int64
Parameter Sets: (All)
Aliases:

Required: False
Position: 11
Default value: 300
Accept pipeline input: False
Accept wildcard characters: False

-SkipCloudChecks

Using this parameter will mean the deployment will not wait for the BloxOneDDI Host to become registered/available within the Cloud Services Portal

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-SkipPingChecks

Using this parameter will skip ping checks during deployment, for cases where the deployment machine and host are separated by a device which blocks ICMP.

NOTE: This will also skip checking of IP Addresses which are already in use.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Force

Perform the operation without prompting for confirmation. By default, this function will not prompt for confirmation unless $ConfirmPreference is set to Medium.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
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

-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

DYNAMIC PARAMETERS

VMware

Important Information

These parameters are only available when -Type is VMware

-IP

The IP Address for the primary network interface of the virtual machine

Type: IPAddress
Parameter Sets: (All)
Aliases:

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

-Netmask

The Netmask for the primary network interface of the virtual machine

Type: String
Parameter Sets: (All)
Aliases:

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

-Gateway

The Gateway for the primary network interface of the virtual machine

Type: IPAddress
Parameter Sets: (All)
Aliases:

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

-DNSServers

One or more DNS Servers for the virtual machine

Type: IPAddress[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: 52.119.40.100
Accept pipeline input: False
Accept wildcard characters: False

-NTPServers

One or more NTP Servers for the virtual machine

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 7
Default value: Ntp.ubuntu.com
Accept pipeline input: False
Accept wildcard characters: False

-DNSSuffix

The DNS Suffix for the virtual machine

Type: String
Parameter Sets: (All)
Aliases:

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

-OVAPath

The path to the BloxOneDDI OVA

-OVAPath and -DownloadLatestImage are mutually exclusive.

-ImagesPath should be used for selecting the appropriate image cache location.

Type: String
Parameter Sets: (All)
Aliases:

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

-vCenter

The IP, Hostname or FQDN of the vCenter you want to deploy to.

Type: String
Parameter Sets: (All)
Aliases:

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

-Cluster

The name of the VMware cluster in vCenter to deploy to

Type: String
Parameter Sets: (All)
Aliases:

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

-VMHost

The name of the VMware Host in vCenter to deploy to

Type: String
Parameter Sets: (All)
Aliases:

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

-Datastore

The name of the VMware datastore to deploy to

Type: String
Parameter Sets: (All)
Aliases:

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

-PortGroup

The name of the port group to connect the VM's network adapters to

Type: String
Parameter Sets: (All)
Aliases:

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

-PortGroupType

The type of port group you are using. This can be Standard or vDS

Type: String
Parameter Sets: (All)
Aliases:

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

-Creds

The credentials used to connect to vCenter. If not specified, you will be prompted to enter the credentials.

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-DownloadLatestImage

Using this parameter will download the latest relevant image prior to deployment.

-DownloadLatestImage, -OVAPath & -VHDPath are mutually exclusive.

When -DownloadLatestImage is used in combination with -ImagesPath, the latest image will be downloaded to this location prior to deployment if it does not already exist. If used consistently, this will always deploy the latest image but only need to download it once; effectively caching.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-ImagesPath

Use this parameter to define the base path for images to be cached in when specifying the -DownloadLatestImage parameter.

This cannot be used in conjunction with -OVAPath or -VHDPath

Type: String
Parameter Sets: (All)
Aliases:

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

-SkipPowerOn

Using this parameter will leave the VM in a powered off state once deployed

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

Hyper-V

Important Information

These parameters are only available when -Type is Hyper-V

-IP

The IP Address for the primary network interface of the virtual machine

Type: IPAddress
Parameter Sets: (All)
Aliases:

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

-Netmask

The Netmask for the primary network interface of the virtual machine

Type: String
Parameter Sets: (All)
Aliases:

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

-Gateway

The Gateway for the primary network interface of the virtual machine

Type: IPAddress
Parameter Sets: (All)
Aliases:

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

-DNSServers

One or more DNS Servers for the virtual machine

Type: IPAddress[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: 52.119.40.100
Accept pipeline input: False
Accept wildcard characters: False

-NTPServers

One or more NTP Servers for the virtual machine

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 7
Default value: Ntp.ubuntu.com
Accept pipeline input: False
Accept wildcard characters: False

-DNSSuffix

The DNS Suffix for the virtual machine

Type: String
Parameter Sets: (All)
Aliases:

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

-VHDPath

The full path to the BloxOne VHD/VHDX file.

-VHDPath and -DownloadLatestImage are mutually exclusive.

-ImagesPath should be used for selecting the appropriate image cache location.

-HyperVServer

The IP, Hostname or FQDN of the Hyper-V Server for the new VM to be deployed to

Type: String
Parameter Sets: (All)
Aliases:

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

-HyperVGeneration

The generation of the Hyper-V VM to create. (Generation 1 or 2)

Type: Int
Parameter Sets: (All)
Aliases:

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

-VMPath

The full path where the VM should be stored. I.e A:\VMs\

Type: String
Parameter Sets: (All)
Aliases:

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

-VirtualNetwork

The name of the Virtual Network defined in Hyper-V to connect the VM to

Type: String
Parameter Sets: (All)
Aliases:

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

-VirtualNetworkVLAN

The name of the VLAN number to assosciate the new VM with.

This is optional and to be used only if attaching the VM to a trunked port.

Type: Int
Parameter Sets: (All)
Aliases:

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

-CPU

The CPU parameter is used to define the amount of CPUs to assign to the VM. The default is 8.

Type: Int
Parameter Sets: (All)
Aliases:

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

-Memory

The Memory parameter is used to define the amount of Memory to assign to the VM. The default is 16GB

The GB suffix is required when using this parameter.

Type: String
Parameter Sets: (All)
Aliases:

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

-DownloadLatestImage

Using this parameter will download the latest relevant image prior to deployment.

-DownloadLatestImage, -OVAPath & -VHDPath are mutually exclusive.

When -DownloadLatestImage is used in combination with -ImagesPath, the latest image will be downloaded to this location prior to deployment if it does not already exist. If used consistently, this will always deploy the latest image but only need to download it once; effectively caching.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-ImagesPath

Use this parameter to define the base path for images to be cached in when specifying the -DownloadLatestImage parameter.

This cannot be used in conjunction with -OVAPath or -VHDPath

Type: String
Parameter Sets: (All)
Aliases:

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

-SkipPowerOn

Using this parameter will leave the VM in a powered off state once deployed

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

Azure

Important Information

These parameters are only available when -Type is Azure

-AzTenant

The AzTenant parameter is used to define the Azure Tenant ID to connect to during deployment.

Type: String
Parameter Sets: (All)
Aliases:

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

-AzSubscription

The AzSubscription parameter is used to define the Azure Subscription ID to connect to during deployment.

Type: String
Parameter Sets: (All)
Aliases:

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

-AzLocation

The AzLocation parameter is used to define the Azure Location to deploy the new VM to.

Type: String
Parameter Sets: (All)
Aliases:

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

-AzResourceGroup

The AzResourceGroup parameter is used to define the Azure Resource Group to deploy the new VM in.

Type: String
Parameter Sets: (All)
Aliases:

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

-AzVirtualNetwork

The AzVirtualNetwork parameter is used to define the Azure Virtual Network to deploy the new VM in.

Type: String
Parameter Sets: (All)
Aliases:

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

-AzSubnet

The AzSubnet parameter is used to define the Subnet in the selected Azure Virtual Network to deploy the new VM in.

Type: String
Parameter Sets: (All)
Aliases:

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

-AzOffer

The AzOffer parameter is used to define the Azure Marketplace Image Offer to deploy the new VM with.

Type: String
Parameter Sets: (All)
Aliases:

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

-AzSku

The AzSku parameter is used to define the Azure Marketplace Image SKU to deploy the new VM with.

Type: String
Parameter Sets: (All)
Aliases:

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

-AzSize

The AzSize parameter is used to define the Azure VM Size to use when deploying the new VM.

Type: String
Parameter Sets: (All)
Aliases:

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

-AzAcceptTerms

The AzAcceptTerms parameter is used to accept the marketplace terms required when deploying a BloxOne DDI Host.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-AzBootDiagnostics

The AzBootDiagnostics parameter is used to enable Boot Diagnostics for the VM during build. This features requires a storage account be specified using -AzStorageAccount.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-AzStorageAccount

The AzStorageAccount is used to define the name of the storage account to use for Boot Diagnostics. This is only used when -AzBootDiagnostics is specified.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: False
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

BloxOne Host build attributes

OUTPUTS

BloxOne DDI Host Object

NOTES

Credits: Ollie Sheridan - Assisted with development of the Hyper-V integration

RELATED LINKS