Set-SCVirtualFloppyDisk

Set-SCVirtualFloppyDisk

Changes the properties of a virtual floppy disk used in VMM.

Syntax

Parameter Set: Default
Set-SCVirtualFloppyDisk [-VirtualFloppyDisk] <VirtualFloppyDisk> [-Description <String> ] [-Enabled <Boolean> ] [-FamilyName <String> ] [-JobVariable <String> ] [-Name <String> ] [-Owner <String> ] [-PROTipID <Guid]> ] [-Release <String> ] [-RunAsynchronously] [-SharePath <String> ] [-UserRole <UserRole> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]

Parameter Set: EquivalencySet
Set-SCVirtualFloppyDisk [-VirtualFloppyDisks] <List`1> -FamilyName <String> -Release <String> [-JobVariable <String> ] [-PROTipID <Guid]> ] [-RunAsynchronously] [-VMMServer <ServerConnection> ] [ <CommonParameters>]

Detailed Description

The Set-SCVirtualFloppyDisk cmdlet changes one or more properties of a virtual floppy disk used in a Virtual Machine Manager (VMM) environment. A virtual floppy disk file used in VMM is either a Windows-based .vfd file or a VMware-based .flp file.

Properties that you can change include:

-- Description
-- Enabled
-- Name
-- Owner
-- SharePath

You can store a virtual floppy disk file in the VMM library, or you can add the virtual floppy disk to a virtual machine.

Parameters

-Description<String>

States a description for the specified object.

-Enabled<Boolean>

Enables an object when set to $True, or disables an object when set to $False. For example, if you want to upgrade software on a virtual machine template, you can disable the template object in the VMM library to temporarily prevent users from using that object.

-FamilyName<String>

Specifies a family name for a physical resource in the VMM library. This value is used in conjunction with Release, Namespace, and Type to establish equivalency among library resources.

-JobVariable<String>

Specifies that job progress is tracked and stored in the variable named by this parameter.

-Name<String>

Specifies the name of a VMM object.

-Owner<String>

Specifies the owner of a VMM object in the form of a valid domain user account.

Example format: -Owner "Contoso\ReneeLo"

Example format: -Owner "ReneeLo@Contoso"

-PROTipID<Guid]>

Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

-Release<String>

Specifies a string that describes the release of a library resource. VMM automatically creates a release value for every resource imported into the library. After the resource has been imported, the string can be customized.

-RunAsynchronously

Indicates that the job runs asynchronously so that control returns to the command shell immediately.

-SharePath<String>

Specifies a path to a valid library share on an existing library server that uses a Universal Naming Convention (UNC) path.

Example format: -SharePath "\\LibServer01\LibShare"

-UserRole<UserRole>

Specifies a user role object.

-VirtualFloppyDisk<VirtualFloppyDisk>

Specifies a virtual floppy disk object.

-VirtualFloppyDisks<List`1>

Specifies an array of floppy disk objects.

-VMMServer<ServerConnection>

Specifies a VMM server object.

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

• VirtualFloppyDisk

Notes

• This cmdlet requires a VMM virtual floppy disk object, which can be retrieved by using the Get-SCVirtualFloppyDisk cmdlet.

Examples

Example Example 1: Change the description of a virtual floppy disk.

The first command gets the floppy disk object named BootFloppy.vfd from the VMM library on VMMServer01 whose file is stored on LibraryServer01, and then stores the object in the $VFD variable.

The second command changes the description of the virtual floppy disk object stored in $VFD to Latest Boot Floppy.

PS C:\> $VFD = Get-SCVirtualFloppyDisk -VMMServer "VMMServer01.Contoso.com"  | where { $_.Name -eq "BootFloppy.vfd" -and $_.LibraryServer.Name -eq "LibraryServer01.Contoso.com" }
PS C:\> Set-SCVirtualFloppyDisk -VirtualFloppyDisk $VFD -Description "Latest Boot Floppy"

Example 2: Disable a virtual floppy disk

The first command gets the virtual floppy disk object named BootFloppy.vfd whose file is stored on LibraryServer01, and then stores the object in the $VFD variable.

The second command disables the virtual floppy disk object stored in $VFD.

PS C:\> $VFD = Get-SCVirtualFloppyDisk -VMMServer "VMMServer01.Contoso.com" | where { $_.Name -eq "BootFloppy.vfd" -and $_.LibraryServer.Name -eq "LibraryServer01.Contoso.com" }
PS C:\> Set-SCVirtualFloppyDisk -VirtualFloppyDisk $VFD -Enabled $False

Example 3: Change the name of a VMware-based virtual floppy disk

The first command gets the floppy disk object named ESXBootFloppy.flp on LibraryServer01, and then stores the object in the $FLP variable.

The second command changes the name of the virtual floppy disk object stored in $FLP to ESXBootFloppy-Beta.flp.

Note: By default, the name of a virtual floppy disk object in the library is the same name, including the extension, as the name of the actual virtual floppy disk file on the library share. Changing the name of the virtual floppy disk object in the library does not change the name of the actual virtual floppy disk file stored on the library server.

PS C:\> $FLP = Get-SCVirtualFloppyDisk -VMMServer "VMMServer01.Contoso.com" | where { $_.Name -eq "ESXBootFloppy.flp" -and $_.LibraryServer.Name -eq "LibraryServer01.Contoso.com" }
PS C:\> Set-SCVirtualFloppyDisk -VirtualFloppyDisk $FLP -Name "ESXBootFloppy-Beta.flp"

Example Example 4: Specify an owner for all virtual floppy disks with an "Unknown" owner.

This command gets all virtual floppy disk objects from the VMM library whose owner is Unknown, and then specifies an owner for each virtual floppy disk object.

PS C:\> Get-SCVirtualFloppyDisk -VMMServer "VMMServer01.Contoso.com" | where {$_.Owner -eq "Unknown"} | Set-SCVirtualFloppyDisk -Owner "Contoso\ReneeLo"

Related topics

Get-SCVirtualFloppyDisk

Get-SCVirtualFloppyDrive

Remove-SCVirtualFloppyDisk

Set-SCVirtualFloppyDrive