Export (0) Print
Expand All

New-MedvConfiguration

New-MedvConfiguration

Creates an object that contains configuration settings for MED-V.

Syntax

Parameter Set: Default
New-MedvConfiguration [-DiagEventLogLevel <NONE | ERROR | WARNING | INFORMATION | DEBUG> ] [-ForceDefaults] [-FtsAddUserToAdminGroupEnabled <Boolean> ] [-FtsComputerNameMask <String> ] [-FtsDeleteVMStateTimeout <Int32> ] [-FtsDetachVfdTimeout <Int32> ] [-FtsDialogUrl <String> ] [-FtsExplorerTimeout <Int32> ] [-FtsFailureDialogMsg <String> ] [-FtsLogFilePaths <String[]> ] [-FtsMaxPostponeTime <Int32> ] [-FtsMaxRetryCount <Int32> ] [-FtsMode <ATTENDED | UNATTENDED | SILENT> ] [-FtsNonInteractiveRetryTimeoutInc <Int32> ] [-FtsNonInteractiveTimeout <Int32> ] [-FtsPostponeUtcDateTimeLimit <String> ] [-FtsRetryDialogMsg <String> ] [-FtsSetComputerNameEnabled <Boolean> ] [-FtsSetJoinDomainEnabled <Boolean> ] [-FtsSetMachineObjectOUEnabled <Boolean> ] [-FtsSetRegionalSettingsEnabled <Boolean> ] [-FtsSetUserDataEnabled <Boolean> ] [-FtsStartDialogMsg <String> ] [-FtsTaskCancelTimeout <Int32> ] [-FtsTaskVMTurnOffTimeout <Int32> ] [-FtsUpgradeTimeout <Int32> ] [-UxAppPublishingEnabled <Boolean> ] [-UxAudioSharingEnabled <Boolean> ] [-UxClipboardSharingEnabled <Boolean> ] [-UxCredentialCacheEnabled <Boolean> ] [-UxDialogTimeout <Int32> ] [-UxHideVmTimeout <Int32> ] [-UxLogonStartEnabled <Boolean> ] [-UxPrinterSharingEnabled <Boolean> ] [-UxRebootAbsoluteDelayTimeout <Int32> ] [-UxRedirectUrls <String[]> ] [-UxShowExit <Boolean> ] [-UxSmartCardLogonEnabled <Boolean> ] [-UxSmartCardSharingEnabled <Boolean> ] [-UxUSBDeviceSharingEnabled <Boolean> ] [-VmCloseAction <HIBERNATE | SHUTDOWN | TURN-OFF> ] [-VmGuestMemFromHostMem <Int32[]> ] [-VmGuestUpdateDuration <Int32> ] [-VmGuestUpdateTime <String> ] [-VmHostMemToGuestMem <Int32[]> ] [-VmHostMemToGuestMemCalcEnabled <Boolean> ] [-VmMemory <Int32> ] [-VmMultiUserEnabled <Boolean> ] [-VmNetworkingMode <BRIDGED | NAT> ] [-VmTaskTimeout <Int32> ] [ <CommonParameters>]




Detailed Description

The New-MedvConfiguration cmdlet creates an object that contains configuration settings for Microsoft Enterprise Desktop Virtualization (MED-V). You can use the Export-MedvConfiguration cmdlet to save the settings to a registry file that has the .reg file name extension. That file can be packaged with a MED-V workspace or imported into the registry of a MED-V computer.

This cmdlet creates a MedvConfiguration object. You can modify the settings in that object directly.

If you do not specify a setting, Export-MedvConfiguration does not export that setting to the registry file. When you apply settings to a MED-V client, if a setting is not specified, the client uses the default value.

Parameters

-DiagEventLogLevel<NONE | ERROR | WARNING | INFORMATION | DEBUG>

Specifies levels of information to log in the Event Log. Valid values are:

-- None
-- Error
-- Warning
-- Information
-- Debug

Each warning level includes information from the prior levels. For example, the Information event level includes both Warning and Error level events.


Aliases

none

Required?

false

Position?

named

Default Value

Warning

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-ForceDefaults

Indicates that this cmdlet sets each setting to its default before it applies other settings. This is not necessary in most cases because unspecified settings use the default. If you specify this parameter, the cmdlet applies user-specified settings to the HKLM registry hive that is governed completely by the administrator.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-FtsAddUserToAdminGroupEnabled<Boolean>

Indicates whether to automatically add the user to the Administrator group of the virtual machine.


Aliases

none

Required?

false

Position?

named

Default Value

False

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-FtsComputerNameMask<String>

Specifies a mask used to create the computer name for the MED-V workspace. Specify the %username% tag to insert the user name as part of the computer name. Specify the %hostname% tag to insert the name of the host computer. Capture a specific number of characters from %hostname% and %username% by using square brackets. For example %username%[3] specifies the first three character of the user name. The cmdlet replaces every # character in the mask with a random digit. The cmdlet replaces a * character at the end of the mask by a random alphanumeric character.


Aliases

none

Required?

false

Position?

named

Default Value

MEDV*

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-FtsDeleteVMStateTimeout<Int32>

Specifies the time-out value, in seconds, when initial setup attempts to delete a virtual machine.


Aliases

none

Required?

false

Position?

named

Default Value

90

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-FtsDetachVfdTimeout<Int32>

Specifies the time-out value, in seconds, when initial setup attempts to detach the virtual floppy drive from the virtual machine.


Aliases

none

Required?

false

Position?

named

Default Value

120

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-FtsDialogUrl<String>

Specifies a custom URL displayed in the initial setup dialog messages.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-FtsExplorerTimeout<Int32>

Specifies the time-out value, in seconds, that the initial setup completion application waits for the Windows Explorer process prior to issuing the command to shut down the virtual machine.


Aliases

none

Required?

false

Position?

named

Default Value

900

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-FtsFailureDialogMsg<String>

Specifies a customizable message to display when initial setup fails.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-FtsLogFilePaths<String[]>

Specifies an array of log files to collect during initial setup.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-FtsMaxPostponeTime<Int32>

Specifies the maximum number of hours that initial setup can be postponed.


Aliases

none

Required?

false

Position?

named

Default Value

120

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-FtsMaxRetryCount<Int32>

Specifies the maximum number of times initial setup can attempt to run.


Aliases

none

Required?

false

Position?

named

Default Value

3

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-FtsMode<ATTENDED | UNATTENDED | SILENT>

Specifies how initial setup interacts with the user. Valid values are:

-- Attended. Shows the virtual machine window during initial setup.
-- Unattended. Hides the virtual machine windows during initial setup.
-- Silent. Hides all user interaction during initial setup.


Aliases

none

Required?

false

Position?

named

Default Value

UnAttended

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-FtsNonInteractiveRetryTimeoutInc<Int32>

Specifies the amount of time, in minutes, by which to increase the NonInteractive Timeout value for each retry of the initial setup in Unattended or Silent mode.


Aliases

none

Required?

false

Position?

named

Default Value

15

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-FtsNonInteractiveTimeout<Int32>

Specifies the time-out value, in minutes, on the first attempt to perform initial setup in Unattended or Silent mode.


Aliases

none

Required?

false

Position?

named

Default Value

45

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-FtsPostponeUtcDateTimeLimit<String>

Specifies the date and time, in UTC DateTime format, that initial setup can be postponed. Specify this parameter in the format yyyy-mm-dd hh:mm with hours in 24 hour-clock format.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-FtsRetryDialogMsg<String>

Specifies a message to display when initial setup fails and must retry.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-FtsSetComputerNameEnabled<Boolean>

Indicates whether to update the ComputerName setting under the [UserData] section of the Sysprep.Inf file in the MED-V workspace according to the configured ComputerNameMask.


Aliases

none

Required?

false

Position?

named

Default Value

False

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-FtsSetJoinDomainEnabled<Boolean>

Specifies whether to update the JoinDomain setting under the [Identification] section of the Sysprep.Inf file in the MED-V workspace should to match the settings on the host computer.


Aliases

none

Required?

false

Position?

named

Default Value

False

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-FtsSetMachineObjectOUEnabled<Boolean>

Specifies whether to update the MachineObjectOU setting under the [Identification] section of the Sysprep.Inf file in the MED-V workspace to match the host computer. If the value of FtsSetJoinDomainEnabled is not ENABLED, this parameter has no effect.


Aliases

none

Required?

false

Position?

named

Default Value

False

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-FtsSetRegionalSettingsEnabled<Boolean>

Specifies whether to update the settings under the [RegionalSettings] section and the TimeZone setting under the [GuiUnattended] section of the Sysprep.Inf file in the MED-V workspace to match the host computer.


Aliases

none

Required?

false

Position?

named

Default Value

False

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-FtsSetUserDataEnabled<Boolean>

Specifies whether to update the FullName and the OrgName settings under the [UserData] section of the Sysprep.Inf file in the MED-V workspace to match the settings on the host computer.


Aliases

none

Required?

false

Position?

named

Default Value

False

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-FtsStartDialogMsg<String>

Specifies the message to display when initial setup is ready to start.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-FtsTaskCancelTimeout<Int32>

Specifies the time-out value, in seconds, that initial setup waits for the virtual machine to respond to a cancel operation.


Aliases

none

Required?

false

Position?

named

Default Value

30

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-FtsTaskVMTurnOffTimeout<Int32>

Specifies the time-out value, in seconds, that initial setup waits for the virtual machine to shut down.


Aliases

none

Required?

false

Position?

named

Default Value

60

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-FtsUpgradeTimeout<Int32>

Specifies the time-out value, in minutes, to use when trying to upgrade the MED-V agent software in a virtual machine.


Aliases

none

Required?

false

Position?

named

Default Value

15

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-UxAppPublishingEnabled<Boolean>

Indicates whether to enable application publishing from the MED-V workspace to the host computer. If application publishing is enabled, applications in the MED-V workspace are published in the Start menu of the host.


Aliases

none

Required?

false

Position?

named

Default Value

True

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-UxAudioSharingEnabled<Boolean>

Indicates whether to enable sharing of the audio I/O device between the MED-V workspace and the host computer.


Aliases

none

Required?

false

Position?

named

Default Value

True

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-UxClipboardSharingEnabled<Boolean>

Indicates whether to enable sharing of the clipboard between the MED-V workspace and the host computer.


Aliases

none

Required?

false

Position?

named

Default Value

True

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-UxCredentialCacheEnabled<Boolean>

Indicates whether to cache end user credentials. If UxSmartCardLogonEnabled and UxCredentialCacheEnabled are both enabled, UxSmartCardLogonEnabled overrides UxCredentialCacheEnabled.

The end user domain credential is stored in a reversible format in the Windows Credential Manager. As a result, an attacker could write a program that retrieves the password and could gain access to the user credentials. You can lessen the risk to user credentials by disabling the storing of end-user credentials.


Aliases

none

Required?

false

Position?

named

Default Value

True

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-UxDialogTimeout<Int32>

Specifies the amount of time, in seconds, for dialogs that prompt a user to postpone an action.


Aliases

none

Required?

false

Position?

named

Default Value

300

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-UxHideVmTimeout<Int32>

Specifies time-out value, in minutes, that the full screen virtual machine window is hidden from the end user during a long login attempt.


Aliases

none

Required?

false

Position?

named

Default Value

30

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-UxLogonStartEnabled<Boolean>

Specifies whether to start the MED-V workspace when the user logs on to the host computer. If you specify a value of $False, the MED-V workspace is started when the first MED-V workspace application is launched.


Aliases

none

Required?

false

Position?

named

Default Value

True

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-UxPrinterSharingEnabled<Boolean>

Indicates whether to enable sharing of printers between the MED-V workspace and the host computer.


Aliases

none

Required?

false

Position?

named

Default Value

True

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-UxRebootAbsoluteDelayTimeout<Int32>

Specifies the time-out value, in minutes, before MED-V restarts.


Aliases

none

Required?

false

Position?

named

Default Value

1440

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-UxRedirectUrls<String[]>

Specifies an array of URLs to redirect to the MED-V workspace.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-UxShowExit<Boolean>

Indicates whether to show the Exit menu in the MED-V Host Agent tray icon.


Aliases

none

Required?

false

Position?

named

Default Value

True

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-UxSmartCardLogonEnabled<Boolean>

Indicates whether smart cards can be used to authenticate users to MED-V. If UxSmartCardLogonEnabled and UxCredentialCacheEnabled are both enabled, UxSmartCardLogonEnabled overrides UxCredentialCacheEnabled.


Aliases

none

Required?

false

Position?

named

Default Value

False

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-UxSmartCardSharingEnabled<Boolean>

Indicates whether to share smart cards between the MED-V workspace and the host computer.


Aliases

none

Required?

false

Position?

named

Default Value

True

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-UxUSBDeviceSharingEnabled<Boolean>

Specifies whether to share USB devices between the MED-V workspace and the host computer.


Aliases

none

Required?

false

Position?

named

Default Value

True

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-VmCloseAction<HIBERNATE | SHUTDOWN | TURN-OFF>

Specifies the action of the virtual machine when the last MED-V application is closed. Valid values are:

-- HIBERNATE
-- SHUTDOWN
-- TURN-OFF

If the LogonStart is enabled, the value of this parameter has no effect.


Aliases

none

Required?

false

Position?

named

Default Value

HIBERNATE

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-VmGuestMemFromHostMem<Int32[]>

Specifies the amount of memory, in megabytes, for the MED-V workspace that sets the amount of random access memory (RAM) available to the MED-V workspace. Valid values are: integers from 128 MB to 2048 MB.

Combined with HostMemToGuestMem, a lookup table is created to determine how much RAM to allocate on the MED-V workspace virtual machine. The amount of RAM on the host computer is read to determine the nearest value, rounded down, in HostMemToGuestMem. The cmdlet indexes this array at the same location to determine the RAM value of the virtual machine.

If HostMemToVmMemCalcEnabled is not enabled, the value that you specify for this parameter has no effect.


Aliases

none

Required?

false

Position?

named

Default Value

378 512 1024 1536 2048

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-VmGuestUpdateDuration<Int32>

Specifies the number of minutes that MED-V should keep the MED-V workspace awake for updating, starting at the time contained in GuestUpdateTime. Specify a value of zero to disable this feature. Valid values are: 0 to 1440 minutes.


Aliases

none

Required?

false

Position?

named

Default Value

240

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-VmGuestUpdateTime<String>

Specifies the hour and minute when the MED-V workspace should wake up for updating. Specify a time in the format hh:mm using 24-hour clock time.


Aliases

none

Required?

false

Position?

named

Default Value

00:00

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-VmHostMemToGuestMem<Int32[]>

Specifies an array of values, in megabtyes, for the MED-V workspace determined by the amount of RAM available on the host computer. Combined with GuestMemFromHostMem, a lookup table is created to determine how much RAM to allocate on the MED-V workspace virtual machine. Valid values are: integers from 1024 MB to 16384 MB. The amount of RAM on the host computer is read and the nearest value in this list is used to index the GuestMemFromHostMem list.


Aliases

none

Required?

false

Position?

named

Default Value

1024 2048 4096 8192 16384

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-VmHostMemToGuestMemCalcEnabled<Boolean>

Indicates whether to calculate the amount of memory allocated for the MED-V workspace from the amount of memory present on the host computer.


Aliases

none

Required?

false

Position?

named

Default Value

True

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-VmMemory<Int32>

Specifies the amount of RAM, in megabytes, allocated for the MED-V virtual machine. Valid values are: integers from 128 MB to 2048 MB. If HostMemToVmMemCalc is enabled, the value that you specify for this parameter has no effect.


Aliases

none

Required?

false

Position?

named

Default Value

512

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-VmMultiUserEnabled<Boolean>

Indicates whether multiple users share a single MED-V workspace.


Aliases

none

Required?

false

Position?

named

Default Value

False

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-VmNetworkingMode<BRIDGED | NAT>

Specifies the type of network connection that the MED-V workspace uses. Valid values are: NAT and BRIDGED.


Aliases

none

Required?

false

Position?

named

Default Value

NAT

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-VmTaskTimeout<Int32>

Specifies a general time-out value, in seconds, that MED-V waits for a task such as shutdown to complete.


Aliases

none

Required?

false

Position?

named

Default Value

600

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (http://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.

  • Microsoft.Medv.Administration.Commands.MedvConfiguration

    This cmdlet generates a MedvConfiguration object that contains configuration settings.


Examples

Example 1: Create a configuration object

This command creates a MedvConfiguration object. The cmdlet sets LogonStartEnabled to $True and sets CloseAction to a value of HIBERNATE.


New-MedvConfiguration -UxLogonStartEnabled $True -VmCloseAction HIBERNATE

Example 2: Export new object to a file

This command creates a MedvConfiguration object, and then passes that object to the Export-MedvConfiguration cmdlet by using the pipeline operator. That cmdlet saves the object as a .reg file.


New-MedvConfiguration -UxLogonStartEnabled $True -VmCloseAction HIBERNATE | Export-MedvConfiguration -Path "c:\temp\medvsettings.reg"

Example 3: Add redirection URLs

This command creates a MedvConfiguration object that contains redirection for the browser in the guest virtual machine. The command exports the configuration object to a file.


New-MedvConfiguration -UxRedirectUrls "http://webapp1/contoso.com","http://webapp2/contoso.com" | Export-MedvConfiguration -Path "c:\temp\redirUrls.reg"

Example 4: Add redirection URLs from a file

This command gets a list of redirected URLs from the file named url.txt. The command adds those URLs to a new configuration object, and then saves that object in a .reg file.


New-MedvConfiguration -UxRedirectUrls (Get-Content "url.txt") | Export-MedvConfiguration -Path "UpdatedUrls.reg"

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft