Connect-CloudStorageCmdlet
Parameters Output Objects Config Settings
The Connect-CloudStorage cmdlet is used to create a persistent connection object.
Syntax
$cnn = Connect-CloudStorage [parameters]
Remarks
This cmdlet allows you to create a persistent connection object to be used with related cmdlets.When executing the cmdlet a connection object is returned. Pass this object to the Connection parameter of related cmdlets to use the newly created connection object.
To disconnect call Disconnect-CloudStorage.
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. |
| 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. |
| Force | Forces the component to accept the default behavior instead of querying the user. |
| HadoopURL | The URL of the Hadoop WebHDFS server. |
| 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. |
| Password | A storage service provider password. |
| ProjectId | A Google Cloud Platform project Id string. |
| 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.
| CloudStorageConnection | The connection object. |
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 (Connect-CloudStorage Cmdlet)
The location of a file to which debug information is written.
Syntax
Connect-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
AccessKey Parameter (Connect-CloudStorage Cmdlet)
A storage service provider access key.
Syntax
Connect-CloudStorage -AccessKey string
Remarks
Default Value
""
Account Parameter (Connect-CloudStorage Cmdlet)
A storage service provider account string.
Syntax
Connect-CloudStorage -Account string
Remarks
Default Value
""
AuthMechanism Parameter (Connect-CloudStorage Cmdlet)
The HTTP authentication scheme to use (for storage service providers that support multiple).
Syntax
Connect-CloudStorage -AuthMechanism string
Remarks
Default Value
0
CertPassword Parameter (Connect-CloudStorage Cmdlet)
The password to the certificate store.
Syntax
Connect-CloudStorage -CertPassword string
Remarks
Default Value
""
Parameter Alias
CertificatePassword
CertStore Parameter (Connect-CloudStorage Cmdlet)
The name of the certificate store for the client certificate.
Syntax
Connect-CloudStorage -CertStore string
Remarks
Default Value
"MY"
Parameter Alias
CertificateStore
CertStoreType Parameter (Connect-CloudStorage Cmdlet)
The type of certificate store for the client certificate.
Syntax
Connect-CloudStorage -CertStoreType string
Remarks
Default Value
0
CertSubject Parameter (Connect-CloudStorage Cmdlet)
The subject of the certificate used for client authentication.
Syntax
Connect-CloudStorage -CertSubject string
Remarks
Default Value
"*"
Config Parameter (Connect-CloudStorage Cmdlet)
Specifies one or more configuration settings.
Syntax
Connect-CloudStorage -Config string[]
Remarks
Default Value
null
Credential Parameter (Connect-CloudStorage Cmdlet)
The PSCredential object to use for user/password authentication.
Syntax
Connect-CloudStorage -Credential PSCredential
Remarks
Default Value
null
Parameter Position
1
Parameter Alias
auth
EncryptionAlgorithm Parameter (Connect-CloudStorage Cmdlet)
The encryption algorithm.
Syntax
Connect-CloudStorage -EncryptionAlgorithm string
Remarks
Default Value
0
EncryptionPassword Parameter (Connect-CloudStorage Cmdlet)
The encryption password.
Syntax
Connect-CloudStorage -EncryptionPassword string
Remarks
Default Value
""
Force Parameter (Connect-CloudStorage Cmdlet)
Forces the component to accept the default behavior instead of querying the user.
Syntax
Connect-CloudStorage -Force SwitchParameter
Remarks
Default Value
false
HadoopURL Parameter (Connect-CloudStorage Cmdlet)
The URL of the Hadoop WebHDFS server.
Syntax
Connect-CloudStorage -HadoopURL string
Remarks
Default Value
""
List Parameter (Connect-CloudStorage Cmdlet)
Get a directory listing for the path and file mask specified.
Syntax
Connect-CloudStorage -List string
Remarks
Default Value
""
Parameter Alias
Path
LocalFile Parameter (Connect-CloudStorage Cmdlet)
The local file to download to.
Syntax
Connect-CloudStorage -LocalFile string
Remarks
Default Value
""
LogFile Parameter (Connect-CloudStorage Cmdlet)
The location of a file to which debug information is written.
Syntax
Connect-CloudStorage -LogFile string
Remarks
Default Value
""
OAuthCacheDir Parameter (Connect-CloudStorage Cmdlet)
The directory where OAuth settings will be stored.
Syntax
Connect-CloudStorage -OAuthCacheDir string
Remarks
Default Value
"%APPDATA%/nsoftware/NetCmdlets/OAuth/"
OAuthClientId Parameter (Connect-CloudStorage Cmdlet)
Account credential for services that require OAuth authentication.
Syntax
Connect-CloudStorage -OAuthClientId string
Remarks
Default Value
""
OAuthClientSecret Parameter (Connect-CloudStorage Cmdlet)
Account credential for services that require OAuth authentication.
Syntax
Connect-CloudStorage -OAuthClientSecret string
Remarks
Default Value
""
OAuthWebServerPort Parameter (Connect-CloudStorage Cmdlet)
The port on the local machine where the OAuth web server will listen.
Syntax
Connect-CloudStorage -OAuthWebServerPort int
Remarks
Default Value
0
Parameter Alias
RedirectPort
Overwrite Parameter (Connect-CloudStorage Cmdlet)
Indicates whether the LocalFile may be overwritten.
Syntax
Connect-CloudStorage -Overwrite SwitchParameter
Remarks
Default Value
false
Password Parameter (Connect-CloudStorage Cmdlet)
A storage service provider password.
Syntax
Connect-CloudStorage -Password string
Remarks
Default Value
""
ProjectId Parameter (Connect-CloudStorage Cmdlet)
A Google Cloud Platform project Id string.
Syntax
Connect-CloudStorage -ProjectId string
Remarks
Default Value
""
RemoteFile Parameter (Connect-CloudStorage Cmdlet)
The name of the remote file(s)/directory to download.
Syntax
Connect-CloudStorage -RemoteFile string
Remarks
Default Value
""
Parameter Position
1
Parameter Alias
Download
RemotePath Parameter (Connect-CloudStorage Cmdlet)
The path on the server.
Syntax
Connect-CloudStorage -RemotePath string
Remarks
Default Value
""
SecretKey Parameter (Connect-CloudStorage Cmdlet)
A storage service provider access key.
Syntax
Connect-CloudStorage -SecretKey string
Remarks
Default Value
""
ServiceProvider Parameter (Connect-CloudStorage Cmdlet)
The storage service provider.
Syntax
Connect-CloudStorage -ServiceProvider string
Remarks
Default Value
0
Parameter Alias
Provider
Timeout Parameter (Connect-CloudStorage Cmdlet)
The maximum time allowed for the operation.
Syntax
Connect-CloudStorage -Timeout int
Remarks
Default Value
10
User Parameter (Connect-CloudStorage Cmdlet)
A storage service provider user name.
Syntax
Connect-CloudStorage -User string
Remarks
Default Value
""
CloudStorageConnection Output Object (Connect-CloudStorage Cmdlet)
The connection object.
Syntax
Object CloudStorageConnection {string AccessKey;
string Account;
string AuthMechanism;
string CertPassword;
string CertStore;
string CertStoreType;
string CertSubject;
string[] Config;
PSCredential Credential;
SwitchParameter Force;
string HadoopURL;
string LogFile;
string OAuthCacheDir;
string OAuthClientId;
string OAuthClientSecret;
int OAuthWebServerPort;
string Password;
string ProjectId;
string SecretKey;
string ServiceProvider;
int Timeout;
string User;
}