Send-WebDAV Cmdlet

Parameters   Output Objects   Config Settings  

The Send-WebDAV component implements an easy-to-use interface to the Web Distributed Authoring and Versioning protocol (WebDAV).

Syntax

Send-WebDAV [parameters]

Remarks

The cmdlet allows the adding new resources and posting data to existing resources.

Depth is used to determine how the properties are retrieved. A depth of "0" will return only the properties associated with ResourceURI. A depth of "1" will return those properties, plus those of the member URIs. A depth of "infinity" (default) will return all properties of all the resources in the hierarchy.

The cmdlets support pipeline input for some of their parameters. Prebuilding an object and piping it to the cmdlet is very useful, but should be used with caution to prevent security conflicts. Steps have been taken to decrease the risk of a possibly accidental pipe to the cmdlet, for instance, the Credential parameter cannot be piped to the cmdlet and must be specified manually.

# create a new resource at http://localhost/temp/test.html send-webdav -uri http://localhost/temp/ -localfile C:\test.html -method put # create a new resource at http://localhost/test1.html send-webdav -uri http://localhost/test1.html -localfile C:\test.html -method put # post data to an existing resource send-webdav -uri http://localhost/temp -data $data -method post

Parameter List

---

The following is the full list of the parameters of the cmdlet with short descriptions. Click on the links for further details.

LogFile	The location of a file to which debug information is written.
AuthenticationMode	The authentication mode to use when presenting login credentials to the server.
CertPassword	The password to the certificate store.
CertStore	The name of the certificate store for the client certificate.
CertStoreType	The type of certificate store for the client certificate.
CertSubject	The subject of the certificate used for client authentication.
Config	Specifies one or more configuration settings.
Credential	The PSCredential object to use for user/password authentication.
Data	The data to be sent to the server.
FirewallHost	Name or IP address of firewall.
FirewallPassword	A password if authentication is to be used when connecting through the firewall.
FirewallPort	The port of the firewall to which to connect.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
Force	Forces the component to accept the default behavior instead of querying the user.
LocalFile	The local file specifying the data to sent to the resource.
LocalIP	The IP address of the local interface to use.
LogFile	The location of a file to which debug information is written.
Method	Specifies the HTTP operation to perform.
Password	The password to use for authentication.
ProxyAutoDetect	Specifies if proxy information is automatically detected.
ProxyPassword	The password to authenticate with.
ProxyPort	The TCP port of the Proxy .
ProxyServer	Name or IP address of a proxy server (optional).
ProxyUser	The User value to authenticate with.
SSLAccept	The encoded public key of the certificate which is to be trusted explicitly.
Timeout	The maximum time allowed for the operation.
URI	The URI where to perform the DAV operation.
User	The username to use for authentication.

Output Objects

---

The following is the full list of the output objects returned by the cmdlet with short descriptions. Click on the links for further details.

DAVFile	This object is created after a file has finished transferring.

Config Settings

---

The following is a list of config settings for the cmdlet with short descriptions. Click on the links for further details.

BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
MaskSensitive	Whether sensitive data is masked in log messages.
UseInternalSecurityAPI	Tells the component whether or not to use the system security libraries or an internal implementation.

LogFile Parameter (Send-WebDAV Cmdlet)

The location of a file to which debug information is written.

Syntax

Send-WebDAV -LogFile string

Remarks

When specified, the cmdlet will log debug information to the file. If the file exists, the information will be appended.

Default Value

null

AuthenticationMode Property (Send-WebDAV Cmdlet)

The authentication mode to use when presenting login credentials to the server.

Syntax

Send-WebDAV -AuthenticationMode string

Remarks

This parameter allows the user to specify Basic, Digest or NTLM authentication.

Default Value

0

Parameter Alias

AuthMode

CertPassword Property (Send-WebDAV Cmdlet)

The password to the certificate store.

Syntax

Send-WebDAV -CertPassword string

Remarks

Specifies a password (if required) to access the specified certificate store.

Default Value

""

Parameter Alias

CertificatePassword

CertStore Property (Send-WebDAV Cmdlet)

The name of the certificate store for the client certificate.

Syntax

Send-WebDAV -CertStore string

Remarks

The CertStoreType parameter specifies the type of the certificate store specified by CertStore. If the store is password protected, specify the password in CertPassword.

CertStore is used in conjunction with the CertSubject parameter in order to specify client certificates. If CertStore has a value, and CertSubject has been set, a search for a certificate is initiated during logon. Please refer to the CertSubject parameter for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this parameter must be set to the name of the file.

Default Value

"MY"

Parameter Alias

CertificateStore

CertStoreType Property (Send-WebDAV Cmdlet)

The type of certificate store for the client certificate.

Syntax

Send-WebDAV -CertStoreType string

Remarks

This parameter can take one of the following values:

Default Value

0

CertSubject Property (Send-WebDAV Cmdlet)

The subject of the certificate used for client authentication.

Syntax

Send-WebDAV -CertSubject string

Remarks

During the user authentication phase of the logon process, the cmdlet will search the store specified in CertStore for a certificate that matches this parameter. If the store contains a private key for that certificate, it is used to verify the user's identity with the secure server.

When this parameter is set, a search is performed in the current certificate store certificate with matching subject.

If an exact match is not found, the store is searched for subjects containing the value of the parameter.

When setting the parameter to a partial subject, CN= should be omitted. For example, the following code would find the certificate with subject CN=Test Certificate, OU=People, C=US

Example (Searching with partial subject)

-certsubject "Test"

If a match is not found, the parameter is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

Default Value

"*"

Config Property (Send-WebDAV Cmdlet)

Specifies one or more configuration settings.

Syntax

Send-WebDAV -Config string[]

Remarks

The Config parameter takes one or more name-value pairs that represent the name of the configuration setting and value, i.e.: -config "Name=Value"

Default Value

null

Credential Property (Send-WebDAV Cmdlet)

The PSCredential object to use for user/password authentication.

Syntax

Send-WebDAV -Credential PSCredential

Remarks

Every cmdlet that supports user authentication will expose a Credential parameter. A PSCredential object should be specified for this parameter. Alternatively, the User and Password parameters can be set to represent the credential information.

If the cmdlet supports client key authentication it uses the password field of this object for the certificate's password. This setting is enabled by using public key authentication. Note: Due to security reasons, it is recommended that you use the Credential parameter rather than User and Password to specify the authentication information.

Default Value

null

Parameter Position

1

Parameter Alias

auth

Data Property (Send-WebDAV Cmdlet)

The data to be sent to the server.

Syntax

Send-WebDAV -Data string

Remarks

Specifies the data to send to the server when doing a WebDAV POST or PUT request. If LocalFile is specified, it will take precedence over Data

Default Value

""

FirewallHost Property (Send-WebDAV Cmdlet)

Name or IP address of firewall.

Syntax

Send-WebDAV -FirewallHost string

Remarks

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost parameter is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost parameter is set to the corresponding address. If the search is not successful, an error is returned.

Default Value

""

FirewallPassword Property (Send-WebDAV Cmdlet)

A password if authentication is to be used when connecting through the firewall.

Syntax

Send-WebDAV -FirewallPassword string

Remarks

If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to authenticate against the firewall.

Default Value

""

FirewallPort Property (Send-WebDAV Cmdlet)

The port of the firewall to which to connect.

Syntax

Send-WebDAV -FirewallPort int

Remarks

The TCP port for the FirewallHost. See the description of the FirewallHost parameter for details.

Note that the FirewallPort is set automatically when FirewallType is set to a valid value. See the description of the FirewallType parameter for details. Setting this parameter will overwrite the default settings for the firewall port as specified by FirewallType.

Default Value

0

FirewallType Property (Send-WebDAV Cmdlet)

Determines the type of firewall to connect through.

Syntax

Send-WebDAV -FirewallType string

Remarks

The applicable values are the following:

Default Value

0

FirewallUser Property (Send-WebDAV Cmdlet)

A user name if authentication is to be used connecting through a firewall.

Syntax

Send-WebDAV -FirewallUser string

Remarks

If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to authenticate against the firewall.

Default Value

""

Force Property (Send-WebDAV Cmdlet)

Forces the component to accept the default behavior instead of querying the user.

Syntax

Send-WebDAV -Force SwitchParameter

Remarks

The Force parameter is especially useful in a script environment where user interaction is not an option. Certain cmdlets that are SSH and SSL based will query the user if the security credentials of the certificate presented by the server are not met. Setting this parameter will force the cmdlet to accept the certificate of the server unconditionally.

Default Value

false

LocalFile Property (Send-WebDAV Cmdlet)

The local file specifying the data to sent to the resource.

Syntax

Send-WebDAV -LocalFile string

Remarks

You can use LocalFile instead of specifying the data directly through the Data parameter.

Default Value

""

LocalIP Property (Send-WebDAV Cmdlet)

The IP address of the local interface to use.

Syntax

Send-WebDAV -LocalIP string

Remarks

This parameter is useful when the cmdlet is running on a machine that has more than one network interface (each with its own IP address and network access privileges).

Default Value

""

Parameter Alias

LocalAddress

LogFile Property (Send-WebDAV Cmdlet)

The location of a file to which debug information is written.

Syntax

Send-WebDAV -LogFile string

Remarks

When specified, the cmdlet will log debug information to the file. If the file exists, the information will be appended.

Default Value

""

Method Property (Send-WebDAV Cmdlet)

Specifies the HTTP operation to perform.

Syntax

Send-WebDAV -Method string

Remarks

Specifies if the cmdlet should try to do an HTTP PUT or POST request.

Default Value

0

This is a required parameter.

Password Property (Send-WebDAV Cmdlet)

The password to use for authentication.

Syntax

Send-WebDAV -Password string

Remarks

Every time User, or Password are set, the cmdlet will authenticate with the server. It is recommended that the Credential parameter is set instead of User/Password because of security reasons. If both Credential and this parameter is set, the Credential value is used.

Default Value

""

ProxyAutoDetect Property (Send-WebDAV Cmdlet)

Specifies if proxy information is automatically detected.

Syntax

Send-WebDAV -ProxyAutoDetect SwitchParameter

Remarks

This parameter tells the cmdlet whether or not to automatically detect and use proxy system settings, if available. The default value is False.

Default Value

false

ProxyPassword Property (Send-WebDAV Cmdlet)

The password to authenticate with.

Syntax

Send-WebDAV -ProxyPassword string

Remarks

If authentication is required with the proxy server, the ProxyPassword parameter specifies the password.

Default Value

""

ProxyPort Property (Send-WebDAV Cmdlet)

The TCP port of the Proxy .

Syntax

Send-WebDAV -ProxyPort int

Remarks

By default this value is set to 80.

Default Value

80

ProxyServer Property (Send-WebDAV Cmdlet)

Name or IP address of a proxy server (optional).

Syntax

Send-WebDAV -ProxyServer string

Remarks

If a Proxy is given, then the HTTP request is sent to the proxy instead of the server specified in the URL.

If the Proxy parameter is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, the Proxy parameter is set to the corresponding address. If the search is not successful, an error is returned.

Default Value

""

Parameter Alias

Proxy

ProxyUser Property (Send-WebDAV Cmdlet)

The User value to authenticate with.

Syntax

Send-WebDAV -ProxyUser string

Remarks

If authentication is required with the proxy server, the ProxyUser parameter specifies the username.

Default Value

""

SSLAccept Property (Send-WebDAV Cmdlet)

The encoded public key of the certificate which is to be trusted explicitly.

Syntax

Send-WebDAV -SSLAccept string

Remarks

Ordinarily, the certificate presented by the server will be checked against the system certificate stores to see if the Certificate Authority is trusted, and if not, the cmdlet will prompt the user to accept the certificate. Setting this parameter will override the system settings and trust the certificate provided.

After each connection, regardless of whether or not the certificate was trusted, the cmdlet will store the certificate presented by the server in the $SSLServerCertificate session variable. This variable can be inspected to view details of the server's certificate.

If the Force parameter is set, the cmdlet will accept the server's certificate unconditionally.

In cases where the certificate presented by the server is not trusted, a prompt will be shown to the user. This prompt will allow the user to decide whether or not they would like to accept the certificate presented by the server.

There may be cases where you do not want a prompt to be displayed or would like to handle the response supplied directly within your script. This can be done by setting the $SSLAcceptPreference variable prior to running the cmdlet. The available values for this variable are:

Default Value

""

Parameter Alias

Accept

Timeout Property (Send-WebDAV Cmdlet)

The maximum time allowed for the operation.

Syntax

Send-WebDAV -Timeout int

Remarks

After the specified interval in seconds, the cmdlet will throw a Timeout error if the operation is not completed.

Default Value

10

URI Property (Send-WebDAV Cmdlet)

The URI where to perform the DAV operation.

Syntax

Send-WebDAV -URI string

Remarks

The cmdlet will use this URI for all operations on the webdav server.

Default Value

""

Parameter Position

0

Parameter Alias

URL

This is a required parameter.

User Property (Send-WebDAV Cmdlet)

The username to use for authentication.

Syntax

Send-WebDAV -User string

Remarks

Every time User and Password are set, the cmdlet will authenticate with the server. It is recommended that the Credential parameter is set instead of User/Password because of security reasons. If both Credential and this parameter is set, the Credential value is used.

Default Value

""

DAVFile Output Object (Send-WebDAV Cmdlet)

This object is created after a file has finished transferring.

Syntax

Object DAVFile {
   string URI;
   int Time;
   string Text;
}

Remarks

Once a file has finished being transferred, the DAVFile object is created with the URI of the file and the Time it took to transfer. Text contains the data transferred from the server to the client.

Config Settings (Send-WebDAV Cmdlet)

The cmdlet accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the cmdlet, access to these internal properties is provided through the Config method.

Base Config Settings