Get-CloudStorage Cmdlet
Parameters Output Objects Config Settings
The Get-CloudStorage component is used to download files and retrieve directory listings from Cloud Storage providers.
Syntax
Get-CloudStorage [parameters]
Remarks
To list a directory, set the List parameter to the remote path of the target directory. Passing "/" as the List parameter will list the root directory of the remote host.
To download files or entire directories, set the RemoteFile parameter to the name of the target file or directory. Wildcards (*) can be used to download multiple files. When downloading multiple files or a directory, the LocalFile parameter must be set to the local directory where the target files/directory should be stored. When downloading a single file, the LocalFile parameter must be set to the local path and file name to the file where the downloaded content will be stored. If the local file already exists, the Overwrite switch must be passed to overwrite the local file.
The following providers use OAuth 2.0 for authentication:
- Box.com
- DropBox
- Google Drive
- Google Cloud Storage*
- Microsoft OneDrive
For each of these providers, OAuthClientId and OAuthClientSecret are required to generate the OAuth token. The cmdlet will automatically fetch and cache OAuth tokens, which requires user-interaction the first time.
Once the token has been cached the cmdlet will automatically use and refresh this token without additional interaction. The OAuthCacheDir parameter governs the location of the OAuth cache files, and passing the empty string to this parameter will disable OAuth caching entirely.
To authenticate with the remaining providers, use the parameters shown in the table below:
Provider | Relevant Parameters |
Amazon S3 | AccessKey and SecretKey |
Azure Blob | Account and AccessKey |
Azure File | Account and AccessKey |
Digital Ocean Spaces | AccessKey and SecretKey |
Google Cloud Storage* | ProjectId (if using OAuthClientId and OAuthClientSecret for OAuth); or, AccessKey and SecretKey |
Hadoop DFS | Multiple HTTP authentication schemes are supported; refer to AuthMechanism for more information. HadoopURL must always be set. |
Wasabi | AccessKey and SecretKey |
*Google Cloud Storage supports two authentication methods. To authenticate with OAuth 2.0 (preferred) set the OAuthClientId, OAuthClientSecret, and ProjectId parameters. To authenticate with an access and secret key, set the AccessKey and SecretKey parameters instead.
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.
#list all buckets (the root directory) for Amazon S3
Get-CloudStorage -ServiceProvider Amazons3 -AccessKey $accesskey -SecretKey $secretkey -List "/"
#download all text files from a subfolder of Box
Get-CloudStorage -ServiceProvider Box -OAuthClientId $boxid -OAuthClientSecret $boxsecret -RemoteFile "test/*.txt" -LocalFile "C:/test"
#download a single file from Wasabi
Get-CloudStorage -ServiceProvider Wasabi -AccessKey $accesskey -SecretKey $secretkey -RemoteFile "Apple.txt" -LocalFile "C:/test/downloaded_apple.txt"
#download an entire directory from DropBox
Get-CloudStorage -ServiceProvider DropBox -OAuthClientId $dropboxid -OAuthClientSecret $dropboxsecret -RemoteFile "folder/subfolder" -LocalFile "C:/test"
Connection Handling
This cmdlet supports persistent connections through the Connection parameter. To establish a new CloudStorage connection, use the Connect-CloudStorage cmdlet. To close the connection, use the Disconnect-CloudStorage cmdlet.
Parameter List
The following is the full list of the parameters of the cmdlet with short descriptions. Click on the links for further details.
Connection | An already established connection. |
LogFile | The location of a file to which debug information is written. |
AccessKey | A storage service provider access key. |
Account | A storage service provider account string. |
AuthMechanism | The HTTP authentication scheme to use (for storage service providers that support multiple). |
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. |
EncryptionAlgorithm | The encryption algorithm. |
EncryptionPassword | The encryption password. |
Force | Forces the component to accept the default behavior instead of querying the user. |
HadoopURL | The URL of the Hadoop WebHDFS server. |
List | Get a directory listing for the path and file mask specified. |
LocalFile | The local file to download to. |
LogFile | The location of a file to which debug information is written. |
OAuthCacheDir | The directory where OAuth settings will be stored. |
OAuthClientId | Account credential for services that require OAuth authentication. |
OAuthClientSecret | Account credential for services that require OAuth authentication. |
OAuthWebServerPort | The port on the local machine where the OAuth web server will listen. |
Overwrite | Indicates whether the LocalFile may be overwritten. |
Password | A storage service provider password. |
ProjectId | A Google Cloud Platform project Id string. |
RemoteFile | The name of the remote file(s)/directory to download. |
RemotePath | The path on the server. |
SecretKey | A storage service provider access key. |
ServiceProvider | The storage service provider. |
Timeout | The maximum time allowed for the operation. |
User | A storage service provider user name. |
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.
EntryInfo | This object contains details about a file returned from the Cloud Storage provider. |
Config Settings
The following is a list of config settings for the cmdlet with short descriptions. Click on the links for further details.
AWSProfile | The name of the AWS CLI profile that the component should use to obtain authentication and region information. |
AWSProfileDir | The location of the AWS CLI credentials and config files. |
ContentDisposition | The Content-Disposition to send when uploading an file to an S3-like storage provider. |
ContentType | The Content-Type to send when uploading an file to an S3-like storage provider. |
DateFormat | The date format of the file time. |
DocsExportFormat | The file format to export Google Docs files as when downloading. |
DrawingsExportFormat | The file format to export Google Drawings files as when downloading. |
EncryptionIV | The initialization vector to be used for encryption/decryption. |
EncryptionKey | The key to use during encryption/decryption. |
EncryptionPasswordKDF | The KDF algorithm to use during password based encryption and decryption. |
FragmentSize | The fragment size that the component should use when uploading files in multiple fragments. |
ListResourcesScope | Controls the scope of the results when listing GoogleDrive resources. |
NewVersionOnOverwrite | Whether to upload new file versions instead of performing true overwrites. |
NormalizedFileName[i] | The normalized file name. |
Region | For applicable providers, specifies the region to use. |
SharedDriveId | The Id of the Google Drive shared drive to list resources for. |
SheetsExportFormat | The file format to export Google Sheets files as when downloading. |
SimpleUploadLimit | The threshold above which the component will choose to perform a multipart upload, for applicable storage service providers. |
SlidesExportFormat | The file format to export Google Slides files as when downloading. |
UseVirtualHosting | Determines which URL style S3-like storage service providers should use. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
Append | Whether to append data to LocalFile. |
Authorization | The Authorization string to be sent to the server. |
BytesTransferred | Contains the number of bytes transferred in the response data. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
EncodeURL | If set to True the URL will be encoded by the component. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to True the component will perform a GET on the new location. |
HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
HTTPVersion | The version of HTTP used by the component. |
IfModifiedSince | A date determining the maximum age of the desired document. |
KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
LogLevel | The level of detail that is logged. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
NegotiatedHTTPVersion | The negotiated HTTP version. |
OtherHeaders | Other headers as determined by the user (optional). |
ProxyAuthorization | The authorization string to be sent to the proxy server. |
ProxyAuthScheme | The authorization scheme to be used for the proxy. |
ProxyPassword | A password if authentication is to be used for the proxy. |
ProxyPort | Port for the proxy server (default 80). |
ProxyServer | Name or IP address of a proxy server (optional). |
ProxyUser | A user name if authentication is to be used for the proxy. |
SentHeaders | The full set of headers as sent by the client. |
StatusCode | The status code of the last response from the server. |
StatusLine | The first line of the last response from the server. |
TransferredData | The contents of the last response from the server. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the component. |
TransferredHeaders | The full set of headers as received from the server. |
TransferredRequest | The full request as sent by the client. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
UseIDNs | Whether to encode hostnames to internationalized domain names. |
UseProxyAutoConfigURL | Whether to use a Proxy auto-config file when attempting a connection. |
UserAgent | Information about the user agent (browser). |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the component whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the component binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
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 (Get-CloudStorage Cmdlet)
The location of a file to which debug information is written.
Syntax
Get-CloudStorage -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
Connection Parameter (Get-CloudStorage Cmdlet)
An existing CloudStorage connection.
Syntax
Get-CloudStorage -Connection CloudStorageConnection
Remarks
Represents an existing, persistent CloudStorage connection to be used. After this cmdlet executes, the connection will remain opened to be used in an another call. New connections can be established using the Connect-CloudStorage cmdlet and closed using the Disconnect-CloudStorage cmdlet.Default Value
null
AccessKey Property (Get-CloudStorage Cmdlet)
A storage service provider access key.
Syntax
Get-CloudStorage -AccessKey string
Remarks
This property specifies the access key to use for authentication. It must be populated when using one of these storage service providers:
- AmazonS3
- AzureBlob
- Wasabi
- DigitalOcean
- GoogleStorage (only if OAuthClientId, OAuthClientSecret, and ProjectId are not populated)
- AzureFile
Default Value
""
Account Property (Get-CloudStorage Cmdlet)
A storage service provider account string.
Syntax
Get-CloudStorage -Account string
Remarks
This property specifies the account string to use for authentication. It must be populated when using one of these storage service providers:
- AzureBlob
- AzureFile
Default Value
""
AuthMechanism Property (Get-CloudStorage Cmdlet)
The HTTP authentication scheme to use (for storage service providers that support multiple).
Syntax
Get-CloudStorage -AuthMechanism string
Remarks
For storage service providers that support more than one HTTP authentication scheme, this property specifies which should be used. This property is only relevant for the following storage service providers:
- HadoopDFS
Usage
Possible values for this property are:
None (default) | No authentication is performed. |
Simple | Hadoop pseudo/simple authentication is performed. |
Basic | Basic authentication is performed. |
NTLM | NTLM authentication is performed. |
Negotiate | Negotiate authentication is performed. |
When set to Simple, the value of the User property is automatically sent in every request using the user.name query parameter. (Note: This authentication scheme is only valid for the HadoopDFS storage service provider.)
When set to Basic, NTLM, or Negotiate, the values held by the User and Password properties will be used to perform Basic, NTLM, or Negotiate authentication.
Default Value
0
CertPassword Property (Get-CloudStorage Cmdlet)
The password to the certificate store.
Syntax
Get-CloudStorage -CertPassword string
Remarks
Specifies a password (if required) to access the specified certificate store.
Default Value
""
Parameter Alias
CertificatePassword
CertStore Property (Get-CloudStorage Cmdlet)
The name of the certificate store for the client certificate.
Syntax
Get-CloudStorage -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:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
SPC | Software publisher certificates. |
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 (Get-CloudStorage Cmdlet)
The type of certificate store for the client certificate.
Syntax
Get-CloudStorage -CertStoreType string
Remarks
This parameter can take one of the following values:
User (default) | This specifies that the certificate store is owned by the current user (these are the user's registry certificate stores such as MY, CA, etc.). |
Machine | The certificate store is a machine store. |
PFXFile | The certificate store is the name of a PFX (PKCS12) file containing certificates. |
PFXBlob | The certificate store is a string (base64 encoded) representing a certificate store in PFX (PKCS12) format. You should use this option if storing a pfx file's content in a shell variable. |
PEMKeyFile | The certificate store is the name of a file that contains a PEM encoded certificate and private key. |
PEMKeyBlob | The certificate store is a string that contains a PEM encoded certificate and private key. |
P7BFile | The certificate store is the name of a file that contains P7B encoded certificates. |
SSHPublicKeyFile | The certificate store is the name of a file that contains an SSH-style public key. |
PPKFile | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
PPKBlob | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
Default Value
0
CertSubject Property (Get-CloudStorage Cmdlet)
The subject of the certificate used for client authentication.
Syntax
Get-CloudStorage -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 (Get-CloudStorage Cmdlet)
Specifies one or more configuration settings.
Syntax
Get-CloudStorage -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 (Get-CloudStorage Cmdlet)
The PSCredential object to use for user/password authentication.
Syntax
Get-CloudStorage -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
EncryptionAlgorithm Property (Get-CloudStorage Cmdlet)
The encryption algorithm.
Syntax
Get-CloudStorage -EncryptionAlgorithm string
Remarks
This property specifies the encryption algorithm to be used. The maximum allowable key size is automatically used for the selected algorithm. Possible values are:
Algorithm | Key Size |
0 (eaAES - default) | 256 |
1 (eaBlowfish) | 448 |
2 (eaCAST) | 128 |
3 (eaDES) | 64 |
4 (eaIDEA) | 128 |
5 (eaRC2) | 128 |
6 (eaRC4) | 2048 |
7 (eaTEA) | 128 |
8 (eaTripleDES) | 192 |
9 (eaTwofish) | 256 |
10 (eaRijndael) | 256 |
11 (eaChaCha) | 256 |
12 (eaXSalsa20) | 256 |
Default Value
0
EncryptionPassword Property (Get-CloudStorage Cmdlet)
The encryption password.
Syntax
Get-CloudStorage -EncryptionPassword string
Remarks
When this property is specified the cmdlet will attempt to decrypt the file when downloading. For decryption to succeed, the password must match the password used to encrypt the file and the EncryptionAlgorithm must be the same algorithm that was used during encryption. The cmdlet uses the value specified here to generate the necessary encryption Key and IV values using the PKCS5 password digest algorithm.
Default Value
""
Force Property (Get-CloudStorage Cmdlet)
Forces the component to accept the default behavior instead of querying the user.
Syntax
Get-CloudStorage -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
HadoopURL Property (Get-CloudStorage Cmdlet)
The URL of the Hadoop WebHDFS server.
Syntax
Get-CloudStorage -HadoopURL string
Remarks
This property specifies the URL of the Hadoop WebHDFS server to make requests against. It must be set when ServiceProvider is set to HadoopDFS.
A full WebHDFS URL looks like http[s]://<HOST>:<PORT>/webhdfs/v1. The cmdlet will automatically append /webhdfs/v1 when making requests (if necessary).
The cmdlet automatically detects whether to secure the connection using SSL/TLS based on whether the value begins with http (not secured) or https (secured).
Default Value
""
List Property (Get-CloudStorage Cmdlet)
Get a directory listing for the path and file mask specified.
Syntax
Get-CloudStorage -List string
Remarks
Set List to a path and file mask to cause the contents of that directory matching that mask to be listed. The path can be a relative directory or an absolute path, but directories must be separated using the "/" separator.
For instance:
#list all buckets (the root directory) for Amazon S3
Get-CloudStorage -ServiceProvider Amazons3 -AccessKey $accesskey -SecretKey $secretkey -List "/"
Default Value
""
Parameter Alias
Path
LocalFile Property (Get-CloudStorage Cmdlet)
The local file to download to.
Syntax
Get-CloudStorage -LocalFile string
Remarks
LocalFile contains the full path and filename on your machine that the RemoteFile will be saved to. If RemoteFile specifies multiple files or a directory, LocalFile must be set to a local directory.
Default Value
""
LogFile Property (Get-CloudStorage Cmdlet)
The location of a file to which debug information is written.
Syntax
Get-CloudStorage -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
""
OAuthCacheDir Property (Get-CloudStorage Cmdlet)
The directory where OAuth settings will be stored.
Syntax
Get-CloudStorage -OAuthCacheDir string
Remarks
If OAuth settings are cached, user-interaction is only necessary for the first connection, after which the OAuth credentials will be automatically updated when required. To disable caching, set this value to empty string.
Default Value
"%APPDATA%/nsoftware/NetCmdlets/OAuth/"
OAuthClientId Property (Get-CloudStorage Cmdlet)
Account credential for services that require OAuth authentication.
Syntax
Get-CloudStorage -OAuthClientId string
Remarks
This property is required when using the following providers: Box, DropBox, OneDrive, and GoogleDrive.
Default Value
""
OAuthClientSecret Property (Get-CloudStorage Cmdlet)
Account credential for services that require OAuth authentication.
Syntax
Get-CloudStorage -OAuthClientSecret string
Remarks
This property is required when using the following providers: Box, DropBox, OneDrive, and GoogleDrive.
Default Value
""
OAuthWebServerPort Property (Get-CloudStorage Cmdlet)
The port on the local machine where the OAuth web server will listen.
Syntax
Get-CloudStorage -OAuthWebServerPort int
Remarks
During the OAuth process, the OAuth server will redirect to a given URI. This cmdlet hosts an internal web server on the local machine to listen for this redirection. The redirect URI must be registered with the application when OAuth is configured, and this parameter can be used to make sure the port of the web server matches the port registered with the application.
Default Value
0
Parameter Alias
RedirectPort
Overwrite Property (Get-CloudStorage Cmdlet)
Indicates whether the LocalFile may be overwritten.
Syntax
Get-CloudStorage -Overwrite SwitchParameter
Remarks
If the LocalFile exists on the machine, Overwrite must be passed for the download to succeed.
Default Value
false
Password Property (Get-CloudStorage Cmdlet)
A storage service provider password.
Syntax
Get-CloudStorage -Password string
Remarks
This property specifies the password to use for authentication. It must be populated when using one of these storage service providers:
- HadoopDFS (only required for certain AuthMechanism options)
Default Value
""
ProjectId Property (Get-CloudStorage Cmdlet)
A Google Cloud Platform project Id string.
Syntax
Get-CloudStorage -ProjectId string
Remarks
This property specifies the Google Cloud Platform project Id string to use for authentication. It must be set when using OAuth 2.0 authentication (i.e., the OAuthClientId and OAuthClientSecret properties are populated) with one of these storage service providers:
- GoogleStorage
Note that the above providers will fall back to using an AccessKey and SecretKey for authentication if this property or either of the OAuthClientId or OAuthClientSecret properties is empty.
Default Value
""
RemoteFile Property (Get-CloudStorage Cmdlet)
The name of the remote file(s)/directory to download.
Syntax
Get-CloudStorage -RemoteFile string
Remarks
The RemoteFile is either an absolute file path, or a relative path based on the home path set by the server. If a filemask is provided, all files matching the mask will be downloaded, and if a directory is specified, the directory will be downloaded.
For instance:
#download all text files from a subfolder of Box
Get-CloudStorage -ServiceProvider Box -OAuthClientId $boxid -OAuthClientSecret $boxsecret -RemoteFile "test/*.txt" -LocalFile "C:/test"
#download a single file from Wasabi
Get-CloudStorage -ServiceProvider Wasabi -AccessKey $accesskey -SecretKey $secretkey -RemoteFile "Apple.txt" -LocalFile "C:/test/downloaded_apple.txt"
#download an entire directory from DropBox
Get-CloudStorage -ServiceProvider DropBox -OAuthClientId $dropboxid -OAuthClientSecret $dropboxsecret -RemoteFile "folder/subfolder" -LocalFile "C:/test"
Default Value
""
Parameter Position
1
Parameter Alias
Download
RemotePath Property (Get-CloudStorage Cmdlet)
The path on the server.
Syntax
Get-CloudStorage -RemotePath string
Remarks
If specified, this parameter will be combined with RemoteFile to determine the location of the file(s) on the server. Alternatively, the full path and file name can be specified in RemoteFile.
Default Value
""
SecretKey Property (Get-CloudStorage Cmdlet)
A storage service provider access key.
Syntax
Get-CloudStorage -SecretKey string
Remarks
This property specifies the access key to use for authentication. It must be populated when using one of these storage service providers:
- AmazonS3
- Wasabi
- DigitalOcean
- GoogleStorage (only if OAuthClientId, OAuthClientSecret, and ProjectId are not populated)
Default Value
""
ServiceProvider Property (Get-CloudStorage Cmdlet)
The storage service provider.
Syntax
Get-CloudStorage -ServiceProvider string
Remarks
This property specifies the storage service provider which will be used. Possible values are:
- AmazonS3 (default): Amazon S3
- Box: Box.com
- Dropbox: Dropbox
- GoogleDrive: Google Drive
- OneDrive: Microsoft OneDrive
- AzureBlob: Azure Blob
- Wasabi: Wasabi
- DigitalOcean: Digital Ocean Spaces
- GoogleStorage: Google Cloud Storage
- HadoopDFS: Hadoop DFS
- AzureFile: Azure File
Default Value
0
Parameter Alias
Provider
Timeout Property (Get-CloudStorage Cmdlet)
The maximum time allowed for the operation.
Syntax
Get-CloudStorage -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
User Property (Get-CloudStorage Cmdlet)
A storage service provider user name.
Syntax
Get-CloudStorage -User string
Remarks
This property specifies the user name to use for authentication. It must be populated when using one of these storage service providers:
- HadoopDFS (only required for certain AuthMechanism options)
Default Value
""
EntryInfo Output Object (Get-CloudStorage Cmdlet)
This object contains details about a file returned from the Cloud Storage provider.
Syntax
Object EntryInfo {string DirEntry;
string FileName;
long FileSize;
string FileTime;
bool IsDir;
}
Remarks
After using List to retrieve a directory listing, information about each entry returned in that listing will be stored in one or more EntryInfo objects.
Config Settings (Get-CloudStorage 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.Get-CloudStorage Config Settings
The cmdlet supports key-based credential profiles; i.e., those which include the aws_access_key_id, aws_secret_access_key, and (optionally) aws_session_token elements. Role-based profiles are not supported at this time.
In addition to the authentication-related elements mentioned above, the cmdlet also supports the region element, if it is present in the specified profile.
The cmdlet searches for the specified profile's information in the credentials and config files. The AWSProfileDir setting can be used to configure the directory where the cmdlet looks for these files. If the aforementioned files do not exist, or the specified profile cannot be found or is missing information, an error will occur.
Note: This setting is applicable only when ServiceProvider is set to one of the following:
- cspAmazonS3 (0)
- cspWasabi (7)
- cspDigitalOcean (8)
- cspGoogleStorage (9)
- cspIBMStorage (13)
- cspLinode (14)
By default, this setting is empty, which will cause the cmdlet to check the default location used by the AWS CLI: an .aws directory in the current user's home directory; i.e., %UserProfile%\.aws (Windows) or ~/.aws (Linux/macOS).
Note: This setting is applicable only when ServiceProvider is set to one of the following:
- cspAmazonS3 (0)
- cspWasabi (7)
- cspDigitalOcean (8)
- cspGoogleStorage (9)
- cspIBMStorage (13)
- cspLinode (14)
Note: This setting is applicable only when ServiceProvider is set to one of the following:
- cspAmazonS3 (0)
- cspWasabi (7)
- cspDigitalOcean (8)
- cspGoogleStorage (9)
- cspIBMStorage (13)
- cspLinode (14)
Note: This setting is applicable only when ServiceProvider is set to one of the following:
- cspAmazonS3 (0)
- cspWasabi (7)
- cspDigitalOcean (8)
- cspGoogleStorage (9)
- cspIBMStorage (13)
- cspLinode (14)
If this setting is set to empty string the exact value sent by the server will be returned.
- docx (default) - application/vnd.openxmlformats-officedocument.wordprocessingml.document
- epub - application/epub+zip
- htm or html - text/html
- odt - application/vnd.oasis.opendocument.text
- pdf - application/pdf
- rtf - application/rtf
- txt - text/plain
- zip - application/zip
Note that this configuration setting is only valid when the ServiceProvider property is set to cspGoogleDrive (3).
- jpg or jpeg - image/jpeg
- pdf - application/pdf
- png (default) - image/png
- svg - image/svg+xml
Note that this configuration setting is only valid when the ServiceProvider property is set to cspGoogleDrive (3).
This setting accepts a hex encoded value.
This setting accepts a hex encoded value.
- 0 (default) - PBKDF1
- 1 - PBKDF2
This setting's default and minimum values vary by ServiceProvider; its maximum value is 2147483647 (2GB). Refer to the configuration settings documentation for each individual storage service provider cmdlet for more information.
Note that this setting cannot be changed when ServiceProvider is set to one of the following:
- cspBox (1)
- cspAzureFile (11)
0 - User (default) | Items in the user's "My Drive" and "Shared with me" collections. |
1 - Domain | Items shared to the users domain. |
2 - Shared Drive | Items within the shared drive specified by the SharedDriveId configuration setting. |
3 - All Drives | Items in the user's "My Drive" and "Shared with me" collections, as well as all items in all shared drives that the user is a member of. |
By default, this setting is disabled. It is only applicable when the ServiceProvider property is set to one of the following:
- cspBox (1)
cloudfiles1.RemotePath = "folder1/folder2/";
cloudfiles1.ListDirectory();
for (int i = 0; i < cloudfiles1.DirList.Count; i++) {
CFDirEntry entry = cloudfiles1.DirList[i];
cloudfiles1.RemoteFile = entry.FileName;
cloudfiles1.LocalFile = "C:\\Test\\" +
cloudfiles1.Config("NormalizedFileName[" + i + "]");
cloudfiles1.Download();
}
For Google Apps files, the normalized file name is the name of the file, plus the appropriate extension (if not already present) based on which export formats were set when ListDirectory was last called. For other files, the normalized file name is the same as the file name reported in the DirList entry.
If you change one of the *ExportFormat configuration settings, you'll need to call ListDirectory again to refresh the values returned by this setting.
Note that this configuration setting is only valid when the ServiceProvider property is set to cspGoogleDrive (3).
- cspAmazonS3 (0) - Refer to the AMAZONS3 cmdlet's Region property for more information.
- cspWasabi (7) - Refer to the WASABI cmdlet's Region property for more information.
- cspDigitalOcean (8) - Refer to the DIGITALOCEAN cmdlet's Region property for more information.
- cspGoogleStorage (9) - Refer to the GOOGLESTORAGE cmdlet's Region property for more information.
- cspIBMStorage (13) - Refer to the IBMSTORAGE cmdlet's Region property for more information.
- cspLinode (14) - Refer to the LINODE cmdlet's Region property for more information.
- csv - text/csv
- ods - application/vnd.oasis.opendocument.spreadsheet
- pdf - application/pdf
- tsv - text/tab-separated-values
- xlsx (default) - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
- zip - application/zip
Note that this configuration setting is only valid when the ServiceProvider property is set to cspGoogleDrive (3).
- cspAmazonS3 (0)
- cspAzureBlob (6)
- cspWasabi (7)
- cspDigitalOcean (8)
- cspBackblazeB2 (12)
- cspIBMStorage (13)
- cspLinode (14)
For all other providers, the limit is either defined by the server, or the service's API includes native support for resumable uploads.
- odp - application/vnd.oasis.opendocument.presentation
- pdf - application/pdf
- pptx (default) - application/vnd.openxmlformats-officedocument.presentationml.presentation
- txt - text/plain
Note that this configuration setting is only valid when the ServiceProvider property is set to cspGoogleDrive (3).
- cspAmazonS3 (0) - Defaults to true; refer to the AMAZONS3 cmdlet's UseVirtualHosting property for more information.
- cspWasabi (7) - Defaults to false; refer to the WASABI cmdlet's UseVirtualHosting property for more information.
- cspDigitalOcean (8) - Defaults to false; refer to the DIGITALOCEAN cmdlet's UseVirtualHosting property for more information.
- cspGoogleStorage (9) - Defaults to false; refer to the GOOGLESTORAGE cmdlet's UseVirtualHosting property for more information.
- cspIBMStorage (13) - Defaults to true; refer to the IBMSTORAGE cmdlet's UseVirtualHosting property for more information.
- cspLinode (14) - Defaults to true; refer to the LINODE cmdlet's UseVirtualHosting property for more information.
HTTP Config Settings
When True, the cmdlet adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".
The default value is True.
If set to True (default), the cmdlet will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the cmdlet throws an exception if the server does not support HTTP/2.
The default value is True.
This property is provided so that the HTTP cmdlet can be extended with other security schemes in addition to the authorization schemes already implemented by the cmdlet.
The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".
The default value is False.
If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same; otherwise, the cmdlet throws an exception.
Note: Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.
Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.
A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).
The default value is 0 (Never). In this case, redirects are never followed, and the cmdlet throws an exception instead.
Following are the valid options:
- 0 - Never
- 1 - Always
- 2 - Same Scheme
- "1.0"
- "1.1" (default)
- "2.0"
- "3.0"
When using HTTP/2 ("2.0"), additional restrictions apply. Please see the following notes for details.
HTTP/2 Notes
When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.
If the server does not support HTTP/2, the cmdlet will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.
HTTP/2 is supported on all versions of Windows. If the Windows version is an earlier version than Windows 8.1/Windows Server 2012 R2, the internal security implementation will be used. If the Windows version is Window 8.1/Windows Server 2012 R2 or later, the system security libraries will be used by default.
HTTP/3 Notes
HTTP/3 is supported only in .NET and Java.
When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.
The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:
Sat, 29 Oct 2017 19:43:31 GMT.
The default value for KeepAlive is false.
0 (None) | No events are logged. |
1 (Info - default) | Informational events are logged. |
2 (Verbose) | Detailed data are logged. |
3 (Debug) | Debug data are logged. |
The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.
The value 2 (Verbose) logs additional information about the request and response.
The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).
The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .
Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.
This configuration setting is useful for extending the functionality of the cmdlet beyond what is provided.
.NET
Http http = new Http();
http.Config("TransferredRequest=on");
http.PostData = "body";
http.Post("http://someserver.com");
Console.WriteLine(http.Config("TransferredRequest"));
C++
HTTP http;
http.Config("TransferredRequest=on");
http.SetPostData("body", 5);
http.Post("http://someserver.com");
printf("%s\r\n", http.Config("TransferredRequest"));
Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.
The default value is False and the hostname will always be used exactly as specified.
When True (default), the cmdlet will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.
Override the default with the name and version of your software.
TCPClient Config Settings
If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.
Note: This setting is provided for use by cmdlets that do not directly expose Firewall properties.
Note: This setting is provided for use by cmdlets that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by cmdlets that do not directly expose Firewall properties.
0 | No firewall (default setting). |
1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
10 | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Note: This setting is provided for use by cmdlets that do not directly expose Firewall properties.
Note: This setting is provided for use by cmdlets that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.
In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.
The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the cmdlet returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).
Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the cmdlet initiate connections (or accept in the case of server cmdlets) only through that interface.
If the cmdlet is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.
LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.
This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.
If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.
If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.
The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this config is set to false.
0 | IPv4 Only |
1 | IPv6 Only |
2 | IPv6 with IPv4 fallback |
Socket Config Settings
Note: This option is not valid for UDP ports.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the cmdlet is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the cmdlet is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Base Config Settings
The following is a list of valid code page identifiers:
Identifier | Name |
037 | IBM EBCDIC - U.S./Canada |
437 | OEM - United States |
500 | IBM EBCDIC - International |
708 | Arabic - ASMO 708 |
709 | Arabic - ASMO 449+, BCON V4 |
710 | Arabic - Transparent Arabic |
720 | Arabic - Transparent ASMO |
737 | OEM - Greek (formerly 437G) |
775 | OEM - Baltic |
850 | OEM - Multilingual Latin I |
852 | OEM - Latin II |
855 | OEM - Cyrillic (primarily Russian) |
857 | OEM - Turkish |
858 | OEM - Multilingual Latin I + Euro symbol |
860 | OEM - Portuguese |
861 | OEM - Icelandic |
862 | OEM - Hebrew |
863 | OEM - Canadian-French |
864 | OEM - Arabic |
865 | OEM - Nordic |
866 | OEM - Russian |
869 | OEM - Modern Greek |
870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
875 | IBM EBCDIC - Modern Greek |
932 | ANSI/OEM - Japanese, Shift-JIS |
936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
949 | ANSI/OEM - Korean (Unified Hangul Code) |
950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
1026 | IBM EBCDIC - Turkish (Latin-5) |
1047 | IBM EBCDIC - Latin 1/Open System |
1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
1147 | IBM EBCDIC - France (20297 + Euro symbol) |
1148 | IBM EBCDIC - International (500 + Euro symbol) |
1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
1201 | Unicode UCS-2 Big-Endian |
1250 | ANSI - Central European |
1251 | ANSI - Cyrillic |
1252 | ANSI - Latin I |
1253 | ANSI - Greek |
1254 | ANSI - Turkish |
1255 | ANSI - Hebrew |
1256 | ANSI - Arabic |
1257 | ANSI - Baltic |
1258 | ANSI/OEM - Vietnamese |
1361 | Korean (Johab) |
10000 | MAC - Roman |
10001 | MAC - Japanese |
10002 | MAC - Traditional Chinese (Big5) |
10003 | MAC - Korean |
10004 | MAC - Arabic |
10005 | MAC - Hebrew |
10006 | MAC - Greek I |
10007 | MAC - Cyrillic |
10008 | MAC - Simplified Chinese (GB 2312) |
10010 | MAC - Romania |
10017 | MAC - Ukraine |
10021 | MAC - Thai |
10029 | MAC - Latin II |
10079 | MAC - Icelandic |
10081 | MAC - Turkish |
10082 | MAC - Croatia |
12000 | Unicode UCS-4 Little-Endian |
12001 | Unicode UCS-4 Big-Endian |
20000 | CNS - Taiwan |
20001 | TCA - Taiwan |
20002 | Eten - Taiwan |
20003 | IBM5550 - Taiwan |
20004 | TeleText - Taiwan |
20005 | Wang - Taiwan |
20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
20106 | IA5 German (7-bit) |
20107 | IA5 Swedish (7-bit) |
20108 | IA5 Norwegian (7-bit) |
20127 | US-ASCII (7-bit) |
20261 | T.61 |
20269 | ISO 6937 Non-Spacing Accent |
20273 | IBM EBCDIC - Germany |
20277 | IBM EBCDIC - Denmark/Norway |
20278 | IBM EBCDIC - Finland/Sweden |
20280 | IBM EBCDIC - Italy |
20284 | IBM EBCDIC - Latin America/Spain |
20285 | IBM EBCDIC - United Kingdom |
20290 | IBM EBCDIC - Japanese Katakana Extended |
20297 | IBM EBCDIC - France |
20420 | IBM EBCDIC - Arabic |
20423 | IBM EBCDIC - Greek |
20424 | IBM EBCDIC - Hebrew |
20833 | IBM EBCDIC - Korean Extended |
20838 | IBM EBCDIC - Thai |
20866 | Russian - KOI8-R |
20871 | IBM EBCDIC - Icelandic |
20880 | IBM EBCDIC - Cyrillic (Russian) |
20905 | IBM EBCDIC - Turkish |
20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
20932 | JIS X 0208-1990 & 0121-1990 |
20936 | Simplified Chinese (GB2312) |
21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
21027 | Extended Alpha Lowercase |
21866 | Ukrainian (KOI8-U) |
28591 | ISO 8859-1 Latin I |
28592 | ISO 8859-2 Central Europe |
28593 | ISO 8859-3 Latin 3 |
28594 | ISO 8859-4 Baltic |
28595 | ISO 8859-5 Cyrillic |
28596 | ISO 8859-6 Arabic |
28597 | ISO 8859-7 Greek |
28598 | ISO 8859-8 Hebrew |
28599 | ISO 8859-9 Latin 5 |
28605 | ISO 8859-15 Latin 9 |
29001 | Europa 3 |
38598 | ISO 8859-8 Hebrew |
50220 | ISO 2022 Japanese with no halfwidth Katakana |
50221 | ISO 2022 Japanese with halfwidth Katakana |
50222 | ISO 2022 Japanese JIS X 0201-1989 |
50225 | ISO 2022 Korean |
50227 | ISO 2022 Simplified Chinese |
50229 | ISO 2022 Traditional Chinese |
50930 | Japanese (Katakana) Extended |
50931 | US/Canada and Japanese |
50933 | Korean Extended and Korean |
50935 | Simplified Chinese Extended and Simplified Chinese |
50936 | Simplified Chinese |
50937 | US/Canada and Traditional Chinese |
50939 | Japanese (Latin) Extended and Japanese |
51932 | EUC - Japanese |
51936 | EUC - Simplified Chinese |
51949 | EUC - Korean |
51950 | EUC - Traditional Chinese |
52936 | HZ-GB2312 Simplified Chinese |
54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
57002 | ISCII Devanagari |
57003 | ISCII Bengali |
57004 | ISCII Tamil |
57005 | ISCII Telugu |
57006 | ISCII Assamese |
57007 | ISCII Oriya |
57008 | ISCII Kannada |
57009 | ISCII Malayalam |
57010 | ISCII Gujarati |
57011 | ISCII Punjabi |
65000 | Unicode UTF-7 |
65001 | Unicode UTF-8 |
Identifier | Name |
1 | ASCII |
2 | NEXTSTEP |
3 | JapaneseEUC |
4 | UTF8 |
5 | ISOLatin1 |
6 | Symbol |
7 | NonLossyASCII |
8 | ShiftJIS |
9 | ISOLatin2 |
10 | Unicode |
11 | WindowsCP1251 |
12 | WindowsCP1252 |
13 | WindowsCP1253 |
14 | WindowsCP1254 |
15 | WindowsCP1250 |
21 | ISO2022JP |
30 | MacOSRoman |
10 | UTF16String |
0x90000100 | UTF16BigEndian |
0x94000100 | UTF16LittleEndian |
0x8c000100 | UTF32String |
0x98000100 | UTF32BigEndian |
0x9c000100 | UTF32LittleEndian |
65536 | Proprietary |
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
This setting only works on these cmdlets: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
Setting this configuration setting to true tells the cmdlet to use the internal implementation instead of using the system security libraries.
On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.
If using the .NET Standard Library, this setting will be true on all platforms. The .NET Standard library does not support using the system security libraries.
Note: This setting is static. The value set is applicable to all cmdlets used in the application.
When this value is set, the product's system dynamic link library (DLL) is no longer required as a reference, as all unmanaged code is stored in that file.