The Set-OfficeWebAppsFarm cmdlet configures the settings of an existing Office Online Server farm.
Examples
EXAMPLE 1
Set-OfficeWebAppsFarm -ClipartEnabled:$true
This example enables insertion of clip art from Office.com.
EXAMPLE 2
Set-OfficeWebAppsFarm -EditingEnabled:$true
This example enables edit functionality for Office in a browser.
EXAMPLE 3
Set-OfficeWebAppsFarm -OpenFromUncEnabled:$false
This example turns off the ability to view any Office file from a UNC path.
Parameters
-AllowCEIP
Enables Customer Experience Improvement Program (CEIP) reporting on all servers in the Office Online
Server farm.
You must restart every server in the Office Online Server farm for this change to take effect.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-AllowHttp
Indicates that IIS sites should be provisioned on port 80 for HTTP access. Use AllowHTTP only in
environments where all computers require IPSEC (full encryption) or in test environments that do not
contain sensitive files.
Enabled automatically when you enable SSLOffloaded.
You must restart every server in the farm for this change to take effect.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-AllowHttpSecureStoreConnections
Indicates that secure store connections can be made by using non-SSL connections (such as HTTP). The
default is False.
Use AllowHTTPSecureStoreConnections only in environments where all computers require IPSEC (full
encryption) or in test environments that do not contain sensitive files.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-AllowOutboundHttp
Allows outbound HTTP connections from Office Online Server.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-CacheLocation
Specifies the location of the global disk cache that is used to store rendered image files.
The default location is %programdata%\Microsoft\OfficeWebApps\Working\d\.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-CacheSizeInGB
Specifies the maximum size of the global disk cache in gigabytes. The type must be an integer value
in the range of 0 to any positive integer. The default size is 15 GB.
Parameter properties
Type:
Int32
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-CertificateName
Specifies the friendly name of the certificate that Office Online Server uses to create HTTPS
bindings.
If the specified certificate is not found or has expired, or if the specified value is associated
with more than one certificate, an error is logged and the farm is not created.
This value is used on every server that joins the Office Online Server farm. Therefore, every server
in the farm must have a certificate that has this friendly name.
You don't have to specify the CertificateName parameter if you are using either the AllowHttp or
SSLOffloaded parameter.
You must restart every server in the farm for this change to take effect.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-ClipartEnabled
Enables support for inserting clip art from Office.com into Office documents. This feature requires
server-to-web communication, configured either directly or by using a proxy that you specify by
using the Proxy parameter.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Confirm
Prompts you for confirmation before executing the command.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Aliases:
cf
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-DocumentInfoCacheSize
Specifies the maximum number of document conversion records that are stored in a memory cache.
The default value is 5000 records.
Parameter properties
Type:
UInt32
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-EditingEnabled
Enables support for editing in the browser. The default is False. Only set to True if you have the
appropriate licensing to use the edit functionality.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-ExcelAbortOnRefreshOnOpenFail
Prevents a workbook from loading if data refresh fails. This helps prevent users from seeing
out-of-date information or possibly information that they should not have access to.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-ExcelAllowExternalData
Enables the refresh of supported external data in Excel workbooks in a browser where workbooks
contain connections to external data. The default is True.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-ExcelAutomaticVolatileFunctionCacheLifeTime
Specifies the maximum time, in seconds, that a computed value for a volatile function is cached for
automatic recalculations.
-1: Calculates once when the workbook loads.
0: Always calculates.
1 to 2073600: Caches 1 second to 24 days.
Parameter properties
Type:
Int32
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-ExcelCachingUnusedFiles
Enable caching of files that are no longer in use by Web Excel sessions.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-ExcelChartAndImageSizeMax
Specifies the maximum size, in megabytes, of a chart or image that can be opened by Excel in a
browser. The value must be an integer greater than 0.
Parameter properties
Type:
Int32
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-ExcelConcurrentDataRequestsPerSessionMax
Specifies the maximum number of concurrent external data requests allowed in each session. If a
session must issue more than this number of requests, additional requests are queued.
Parameter properties
Type:
Int32
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-ExcelConnectionLifetime
Specifies the duration, in seconds, of external data connections for Excel in a browser. The default
is 1800 seconds.
Parameter properties
Type:
Int32
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-ExcelDefaultWorkbookCalcMode
PARAMVALUE: File | Manual | Auto | AutoDataTables
Parameter properties
Type:
DefaultWorkbookCalcMode
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-ExcelExternalDataCacheLifetime
Specifies the duration, in seconds, of the external data cache lifetime in Excel in a browser. The
default is 300 seconds.
Parameter properties
Type:
Int32
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-ExcelMemoryCacheThreshold
The percentage of the Maximum Private Bytes that can be allocated to inactive objects. When the
memory cache threshold is exceeded, cached objects that are not currently in use are released. Valid
values: 0 (disables caching of inactive objects); from 1 through 95.
Parameter properties
Type:
Int32
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-ExcelPrivateBytesMax
Specifies the maximum private bytes, in megabytes, used by Excel in a browser. When set to -1, the
maximum private bytes use 50 percent of physical memory on the computer.
The type must be -1 or any positive integer. The default value is -1.
You must restart every server in the farm for this change to take effect.
Parameter properties
Type:
Int32
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-ExcelRequestDurationMax
Specifies the maximum duration, in seconds, for a single request in a session. After this time
elapses, the request times out.
The type must be -1 (no limit) or an integer in the range of 1 to 2073600. The default value is 300.
Parameter properties
Type:
Int32
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-ExcelRestExternalDataEnabled
Allow requests from the REST API to refresh external data connections. This setting has no effect if
Allow External Data is set to None. Check box Bool. Default is False.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-ExcelSessionTimeout
Specifies the time, in seconds, that a session remains active in Excel in a browser when there is no
user activity. Valid values include the following:
-1 Session never expires.
0 Session expires at the end of a single request.
1 to 2073600 Session remains active for 1 second to 24 days.
The default value is 450.
Parameter properties
Type:
Int32
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-ExcelUdfsAllowed
Enables User Defined Functions for Excel in a browser. The default is False.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-ExcelUnusedObjectAgeMax
The maximum time (in minutes) that inactive objects remain in the memory cache. Inactive objects are
objects that are not used in a session.
Valid values:
-1 (no maximum)
1 through 34560 (24 days).
Default is -1.
Parameter properties
Type:
Int32
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-ExcelUseEffectiveUserName
Enables the use of the Analysis Services EffectiveUserName parameter with Excel in a browser. The
default is False.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-ExcelWarnOnDataRefresh
Turns off or on the warning dialog box that is displayed when data refreshes in Excel in a browser.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-ExcelWorkbookSizeMax
Specifies the maximum size, in megabytes, of a workbook that can be loaded.
The type must be an integer value in the range of 1 to 2000. The default value is 10.
Parameter properties
Type:
Int32
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-ExternalURL
Specifies the URL root that clients use to access the Office Online Server farm from the Internet.
In the case of a load-balanced, multiserver Office Online Server farm, the external URL is bound to
the IP address of the external-facing load balancer.
An Office Online Server farm requires at least one URL,that isset by using either ExternalURL or
InternalURL. You can also set both internal and external URLs.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-FarmOU
Specifies the name of the Active Directory organizational unit (OU) that servers must be a member of
to join the Office Online Server farm. Use this parameter to prevent unauthorized servers (that is,
servers that are not in the OU) from joining an Office Online Server farm.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Force
Suppresses any user prompts by answering "Yes."
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-InternalURL
Specifies the URL root that clients must use to access the Office Online Server farm from the
intranet.
An Office Online Server farm requires at least one URL. It is set using either ExternalURL or
InternalURL. You can also set both internal and external URLs.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-LogLocation
Specifies the location on the local computer where activity logs are stored.
The location applies for every server in the farm and cannot be customized on a per-server basis.
The default location is %programdata%\Microsoft\OfficeWebApps\Data\Logs\ULS\.
Be sure to allow sufficient disk space on the drive where logs are stored.
You must restart every server in the farm for this change to take effect.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-LogRetentionInDays
Specifies the number of days that log entries are stored. Log entries older than the configured date
are trimmed.
The type must be an integer value in the range of 0 to 365. The default value is 7 days.
You must restart every server in the farm for this change to take effect.
Parameter properties
Type:
UInt32
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-LogVerbosity
Specifies how much information is stored in the trace log files. The values are as follows:
VerboseEX writes low-level detail to the trace log file. Useful for traces that are likely to be
high volume.
Verbose writes low-level detail to the trace log file.
Medium writes medium-level detail to the trace log file.
High writes high-level detail to the trace log file.
Monitorable writes traces that represent an unusual code path and actions that should be
monitored.
Unexpected writes traces that represent an unexpected code path and actions that should be
monitored.
None writes no trace information to the trace log file.
Leaving the LogVerbosity at a low level for a long time will adversely affect performance.
You must restart every server in the farm for this change to take effect.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-MaxMemoryCacheSizeInMB
Specifies, in megabytes, the maximum amount of memory that the rendering cache can use.
The type must be an integer value in the range of 0 to any positive integer. The default size is
1024 MB.
Parameter properties
Type:
Int32
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-MaxTranslationCharacterCount
Specifies the maximum number of characters a document can have in order to be translated.
The type must be an integer value. The value can be set to 0 to indicate no limit or a value from
2000 to 2,000,000. The default value is 125,000.
Parameter properties
Type:
Int32
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-OpenFromUncEnabled
Turns on or off the ability to use Online Viewers to view Office files from a UNC path.
You must first set OpenFromUrlEnabled to True to allow Online Viewers to display files in UNC paths.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-OpenFromUrlEnabled
Turns on or off the ability to use Online Viewers to view Office files from a URL or UNC path.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-OpenFromUrlThrottlingEnabled
Throttles the number of Open From URL requests from any given server in a time period. The default
throttling values, which are not configurable, make sure that an Office Online Server farm will not
overwhelm a single server with requests for content to be viewed in the Online Viewers.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-PicturePasteDisabled
Turns off the ability for users to paste images from a web page into Office in a browser. The
default is False. If OpenFromURLEnabled is set to True and PicturePasteDisabled is not set or set to
False, users can paste images into Office in a browser.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Proxy
Specifies the URL of the proxy server that is configured to allow HTTP requests to external sites.
Typically configured together with the ClipartEnabled and TranslationEnabled parameters.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-RecycleActiveProcessCount
Specifies the number of files that a single Word or PowerPoint process can render before the process
is recycled. The type must be an integer value in the range of 1 to 1000. The default value is 5.
You must restart every server in the farm for this change to take effect.
Parameter properties
Type:
UInt32
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-RemovePersonalInformationFromLogs
Provides a best effort scrub of personal information from Office Online Server logs and replaces
values with a SHA256 hash. Potentially scrubbed information can be:
Document names and URLs
IP addresses
Email addresses
User names
The default is False. Note that enabling this parameter doesn't guarantee that personal information
won't be logged to the Office Online Server logs.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-RenderingLocalCacheLocation
Specifies the location of the temporary cache for use by the Word and PowerPoint Viewing Services.
The default location is %programdata%\Microsoft\OfficeWebApps\Working\waccache\.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-S2SCertificateName
The friendly name of the certificate to use for server-to-server authentication with SharePoint
Server.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-SSLOffloaded
Indicates to the servers in the Office Online Server farm that SSL is offloaded to the load
balancer. When SSLOffloaded is enabled, web applications are bound to port 80 (HTTP) on the local
server. However, HTML that references other resources, such as CSS or images, uses HTTPS URLs for
those references.
You must restart every server in the farm for this change to take effect.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-TranslationEnabled
Enables support for automatic document translation using Microsoft Translator, an online service
that translates text between languages. The translated file is shown in Word. Because Microsoft
Translator is an online service, you must enable server-to-web communication directly or by using a
proxy that you specify by using the Proxy parameter.
Microsoft Translator may collect data to improve the quality of translations.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-TranslationServiceAddress
Specifies the URL of the translation server that translation requests are sent to. The default is
the Microsoft Translator online service. Typically you will not use this parameter unless you must
change translation services.
You must restart every server in the Office Online Server farm for this change to take effect.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-TranslationServiceAppId
Specifies the application ID for the translation service. The default is the public application ID
for Office in a browser. Typically you will not use this parameter unless you have negotiated with
Microsoft Translator for additional services and they have provided you with a private application
ID.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-WhatIf
Displays a message that describes the effect of the command instead of executing the command.