Skip to content

New-vRAMachineAttachedDisk

SYNOPSIS

Retrieve a vRA Machine's Disks

SYNTAX

ByName (Default)

New-vRAMachineAttachedDisk -Name <String> -BlockDeviceId <String[]> [-DeviceName <String[]>]
 [-DeviceDescription <String[]>] [-WaitForCompletion] [-CompletionTimeout <Int32>] [-Force] [-WhatIf]
 [-Confirm] [<CommonParameters>]

ById

New-vRAMachineAttachedDisk -Id <String> -BlockDeviceId <String[]> [-DeviceName <String[]>]
 [-DeviceDescription <String[]>] [-WaitForCompletion] [-CompletionTimeout <Int32>] [-Force] [-WhatIf]
 [-Confirm] [<CommonParameters>]

DESCRIPTION

Retrieve the disks for a vRA Machine

EXAMPLES

EXAMPLE 1

New-vRAMachineAttachedDisk -Id 'b1dd48e71d74267559bb930934470' -BlockDeviceId'123456'

EXAMPLE 2

New-vRAMachineAttachedDisk -Name 'iaas01' -BlockDeviceId'123456'

EXAMPLE 3

New-vRAMachineAttachedDisk -Name 'iaas01' -BlockDeviceId'123456' -WaitForCompletion

EXAMPLE 4

New-vRAMachineAttachedDisk -Name 'iaas01' -BlockDeviceId'123456' -WaitForCompletion -CompletionTimeout 300

EXAMPLE 5

New-vRAMachineAttachedDisk -Name 'iaas01' -BlockDeviceId'123456' -DeviceName 'Disk 17' -DeviceDescription 'This is a disk attached from script'

PARAMETERS

-Id

The ID of the vRA Machine

Type: String
Parameter Sets: ById
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-Name

The Name of the vRA Machine

Type: String
Parameter Sets: ByName
Aliases:

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

-BlockDeviceId

The Id of the individual Disk to attach (Block Device ID)

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

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

-DeviceName

The name we wish to give the device as we attach it to the machine

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

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

-DeviceDescription

A description we can associate with the disk after attaching it to the machine

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

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

-WaitForCompletion

If this flag is added, this function will wait for the request to complete and will return the created Virtual Disk

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-CompletionTimeout

The default of this paramter is 2 minutes (120 seconds), but this parameter can be overriden here

Type: Int32
Parameter Sets: (All)
Aliases:

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

-Force

Force this change

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

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

OUTPUTS

System.Management.Automation.PSObject.

NOTES