Export (0) Print
Expand All

New-MedvConfiguration

New-MedvConfiguration

The New-MedvConfiguration cmdlet creates an object to hold MED-V configuration settings. You can use the Export-MedvConfiguration cmdlet to save your settings to a registry (.reg) file that can be packaged with a MED-V workspace or imported into the registry of a MED-V computer.

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 to hold MED-V configuration settings. You can use the Export-MedvConfiguration cmdlet to save your settings to a registry (.reg) file that can be packaged with a MED-V workspace or imported into the registry of a MED-V computer.
Settings specified with the parameters of the New-MedvConfiguration cmdlet are stored in the MedvConfiguration object returned by the cmdlet. You can set or modify the settings in the MedvConfiguration object by modifying the object directly.
If settings are not specified they are not exported to the Registry (.reg) file. When applying settings to a MED-V client, if the settings is not specified the default value is used.

Parameters

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

Defines what information is logged in the event log. Levels include: None, Error, Warning, Information, and Debug. Each warning level will include information from the prior levels. The Information event level includes both Warnings and Errors.


Aliases

none

Required?

false

Position?

named

Default Value

Warning

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-ForceDefaults

Sets each setting to its default before applying other settings. This is not necessary in most cases because unspecified settings use the default. This forces user-specified settings to be applied 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>

Defines whether the user will be added automatically to the Administrator's 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>

The mask is used to create the computer name for the MED-V workspace. The mask is used to name the MED-V workspace's computer. The mask can contain a %username% tag to insert the username as part of the computer name. The %hostname% tag will insert the name of the host computer. Every "#" character in the mask will be replaced by a random digit. A "*" character at the end of the mask will be replaced by random alphanumeric characters. A specific number of characters from %hostname% and %username% can be captured by using square brackets. For example "%username%[3]" would use the first 3 character of the username.


Aliases

none

Required?

false

Position?

named

Default Value

MEDV*

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-FtsDeleteVMStateTimeout<Int32>

Configures the timeout value, in seconds, when first time 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>

Defines the timeout value in seconds when first time 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>

Defines the custom URL displayed in the first time setup dialog messages.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-FtsExplorerTimeout<Int32>

Defines the timeout value, in seconds, when first time setup completion application waits for the Explorer process prior to issuing the command to shutdown the virtual machine.


Aliases

none

Required?

false

Position?

named

Default Value

900

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-FtsFailureDialogMsg<String>

Defines a customizable message to display when first time setup fails.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-FtsLogFilePaths<String[]>

Defines a list of log files to collect during first time setup.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-FtsMaxPostponeTime<Int32>

Defines the maximum number of hours that first time setup can be postponed.


Aliases

none

Required?

false

Position?

named

Default Value

120

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-FtsMaxRetryCount<Int32>

Defines the maximum number of times first time 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>

Defines how first time setup interacts with the user. The different modes are: Attended, Unattended, and Silent. Attended mode will show the virtual machine window during first time setup. Unattended mode will hide the virtual machine windows during first time setup. Silent mode will hide all user interaction during first time setup.


Aliases

none

Required?

false

Position?

named

Default Value

UnAttended

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-FtsNonInteractiveRetryTimeoutInc<Int32>

Defines the amount of time in minutes by which the NonInteractive Timeout value is increased for each retry of the first time 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>

Defines the timeout value in minutes on the first attempt to perform first time 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>

Defines the date and time in UTC DateTime format that first time setup can be postponed. Enter 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>

Provides a message to display when first time 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>

Defines whether or not the ComputerName setting under the [UserData] section of the Sysprep.Inf file in the MED-V workspace should be updated 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>

Defines whether or not the JoinDomain setting under the [Identification] section of the Sysprep.Inf file in the MED-V workspace should be updated 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>

Defines whether the MachineObjectOU setting under the [Identification] section of the Sysprep.Inf file in the MED-V workspace is updated to match the host computer. This setting is ignored if the FtsSetJoinDomainEnabled does not equal ENABLED.


Aliases

none

Required?

false

Position?

named

Default Value

False

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-FtsSetRegionalSettingsEnabled<Boolean>

Defines whether the settings under the [RegionalSettings] section and the TimeZone setting under the [GuiUnattended] section of the Sysprep.Inf file in the MED-V workspace are updated 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>

Defines whether the FullName and the OrgName settings under the [UserData] section of the Sysprep.Inf file in the MED-V workspace is updated 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>

Defines the message displayed when first time 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>

Defines the timeout value in seconds that first time setup will wait 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>

Defines the timeout value in seconds that first time setup will wait 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>

Defines the timeout value, in minutes, used 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>

Defines whether application publishing from the MED-V workspace to the host computer is enabled. When application publishing is enabled, applications in the MED-V workspace are published in the host's start menu.


Aliases

none

Required?

false

Position?

named

Default Value

True

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-UxAudioSharingEnabled<Boolean>

Defines whether sharing of the audio I/O device between the MED-V workspace and the host computer is enabled.


Aliases

none

Required?

false

Position?

named

Default Value

True

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-UxClipboardSharingEnabled<Boolean>

Defines whether sharing of the clipboard between the MED-V workspace and the host computer is enabled.


Aliases

none

Required?

false

Position?

named

Default Value

True

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-UxCredentialCacheEnabled<Boolean>

Defines whether end user credentials are cached. If UxSmartCardLogonEnabled and UxCredentialCacheEnabled are both enabled, UxSmartCardLogonEnabled overrides UxCredentialCacheEnabled.

Even though caching the end user's credentials provides the best user experience, you should be aware of the risks involved. The end user's 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's credentials. You can only lessen this risk 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>

Defines the amount of time, in seconds, for dialogs that prompt end users to postpone an action.


Aliases

none

Required?

false

Position?

named

Default Value

300

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-UxHideVmTimeout<Int32>

Defines timeout 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>

Defines whether the MED-V workspace should be started when the user logs on to the host computer. If 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>

Defines whether sharing of printers between the MED-V workspace and the host computer is enabled.


Aliases

none

Required?

false

Position?

named

Default Value

True

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-UxRebootAbsoluteDelayTimeout<Int32>

Defines the timeout 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[]>

Defines a list of URLs that will be redirected 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>

Defines 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>

Defines 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>

Defines whether smart cards are shared 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>

Defines whether USB devices are shared 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>

Defines the action of the virtual machine when the last MED-V application is closed. This setting is ignored if the LogonStart is enabled. The values are: HIBERNATE, SHUTDOWN, and TURN-OFF.


Aliases

none

Required?

false

Position?

named

Default Value

HIBERNATE

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-VmGuestMemFromHostMem<Int32[]>

Specifies memory (in megabytes) values for the MED-V workspace that sets the amount of RAM available to the MED-V workspace. Combined with HostMemToGuestMem, a lookup table is created to determine how much RAM to allocate on the MED-V workspace virtual machine. The valid range for this setting is 128 MB to 2048 MB. The amount of RAM on the host computer is read to determine the nearest value (rounded down) in HostMemToGuestMem. This array will be indexed at the same location to determine the RAM value of the virtual machine. This setting is ignored if the HostMemToVmMemCalcEnabled setting is not enabled.


Aliases

none

Required?

false

Position?

named

Default Value

378 512 1024 1536 2048

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-VmGuestUpdateDuration<Int32>

Defines the number of minutes that MED-V should keep the MED-V workspace awake for updating, starting at the time contained in GuestUpdateTime. Enter 0 to disable. The valid range for this setting is 0-1440 minutes.


Aliases

none

Required?

false

Position?

named

Default Value

240

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-VmGuestUpdateTime<String>

Defines the hour and minute when the MED-V workspace should wake up for updating. Format is 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[]>

Defines a list of memory (MB) values 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. The valid range for this setting is 1024-16384 MBs. 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>

Defines whether the amount of memory allocated for the MED-V workspace is calculated 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>

Defines the amount of RAM (MB) allocated for the MED-V virtual machine. This setting is ignored if the HostMemToVmMemCalc setting is enabled. The valid range for this setting is 128 MB to 2048 MB.


Aliases

none

Required?

false

Position?

named

Default Value

512

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-VmMultiUserEnabled<Boolean>

Defines 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>

Defines the type of network connection used by the MED-V workspace. Values are NAT or BRIDGED.


Aliases

none

Required?

false

Position?

named

Default Value

NAT

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-VmTaskTimeout<Int32>

Defines a general timeout value in seconds that MED-V will wait 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

Outputs

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

  • Microsoft.Medv.Administration.Commands.MedvConfiguration

    The MedvConfiguration object contains specified configuration settings.


Examples

-------------------------- EXAMPLE 1 --------------------------

Description

-----------

Gets a MedvConfiguration object with the LogonStartEnabled setting enabled and the CloseAction setting set to HIBERNATE.


C:\PS>New-MedvConfiguration -UxLogonStartEnabled True -VmCloseAction HIBERNATEDiagEventLogLevel                   :FtsAddUserToAdminGroupEnabled       :FtsComputerNameMask                 :FtsDeleteVMStateTimeout             :FtsDetachVfdTimeout                 :FtsDialogUrl                        :FtsExplorerTimeout                  :FtsFailureDialogMsg                 :FtsLogFilePaths                     :FtsMaxPostponeTime                  :FtsMaxRetryCount                    :FtsMode                             :FtsNonInteractiveRetryTimeoutInc    :FtsNonInteractiveTimeout            :FtsPostponeUtcDateTimeLimit         :FtsRetryDialogMsg                   :FtsSetComputerNameEnabled           :FtsSetJoinDomainEnabled             :FtsSetMachineObjectOUEnabled        :FtsSetRegionalSettingsEnabled       :FtsSetUserDataEnabled               :FtsStartDialogMsg                   :FtsTaskCancelTimeout                :FtsTaskVMTurnOffTimeout             :FtsUpgradeTimeout                   :UxAppPublishingEnabled              :UxAudioSharingEnabled               :UxClipboardSharingEnabled           :UxCredentialCacheEnabled            :UxDialogTimeout                     :UxHideVmTimeout                     :UxLogonStartEnabled                 : TrueUxPrinterSharingEnabled             :UxRebootAbsoluteDelayTimeout        :UxRedirectUrls                      :UxSmartCardLogonEnabled             :UxSmartCardSharingEnabled           :UxShowExit                          :UxUSBDeviceSharingEnabled           :VmCloseAction                       : HIBERNATEVmGuestMemFromHostMem               :VmGuestUpdateDuration               :VmGuestUpdateTime                   :VmHostMemToGuestMem                 :VmHostMemToGuestMemCalcEnabled      :VmMemory                            :VmMultiUserEnabled                  :VmNetworkingMode                    :VmTaskTimeout                       :

-------------------------- EXAMPLE 2 --------------------------

Description

-----------

Creates a registry file that disables the start at logon feature and sets the guest close action to HIBERNATE for the machine.


C:\PS>New-MedvConfiguration -UxLogonStartEnabled True -VmCloseAction HIBERNATE | Export-MedvConfiguration -Path c:\temp\medvsettings.reg

-------------------------- EXAMPLE 3 --------------------------

Description

-----------

Creates a registry file that when imported to a registry will set the specified Urls that will be redirected to the browser in the guest VM.


C:\PS>New-MedvConfiguration -UxRedirectUrls http://webapp1/acme.com,http://webapp2/acme.com| Export-MedvConfiguration -Path c:\temp\redirUrls.reg

-------------------------- EXAMPLE 4 --------------------------

Description

-----------

Defines a list of redirected urls from a file (url.txt).


C:\PS>New-MedvConfiguration -UxRedirectUrls:(get-content "url.txt") | Export-MedvConfiguration UpdatedUrls.reg
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft