Connect-FTPCmdlet
Parameters Output Objects Config Settings
The Connect-FTP cmdlet is used to create a persistent connection object.
Syntax
$cnn = Connect-FTP [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-FTP.
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. |
| ActiveMode | Controls whether to direct the server into active mode. |
| AfterConnect | A set of FTP commands to be executed immediately after connecting to the Server . |
| AuthMode | The type of authentication used by the component. |
| 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. |
| 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. |
| LocalIP | The IP address of the local interface to use. |
| LogFile | The location of a file to which debug information is written. |
| Password | The password to use for authentication. |
| Port | The TCP port in the remote host to which to connect. |
| Server | The address of the Server. |
| SSL | Determines how the component starts SSL negotiation. |
| SSLAccept | The encoded public key of the certificate which is to be trusted explicitly. |
| Timeout | The maximum time allowed for the 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.
| FTPConnection | 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.
| UseFSwitch | Specifies whether or not the -F parameter is used when listing directory contents. |
| UseSimpleDirList | Instructs the adapter to issue the NLST command instead of LIST. |
| ActiveModeIP | Allows the specification of the IP address that the server will connect to for active mode connections. |
| ActiveModePORTAddress | Allows the specification of the PORT address value for active mode connections. |
| AppendToLocalFile | Append downloaded files to a local file. |
| ApplyFileMaskLocally | Whether to filter the directory listing locally or on the server. |
| AutoSelectDataIP | Automatically select the data connection IP. |
| CalculatePercentDone | Enables or Disables calculating the percent complete for downloads. |
| CheckTotalEntry | Whether to ignore directory listing total lines. |
| DILinger | When set to True, DI connections are terminated gracefully. |
| DILingerTime | Time in seconds to have the DI connection linger. |
| FileTimeFormat | The format of file time reported by the server. |
| IgnoreEntries | Directory entry data to ignore. |
| MaskSensitive | Masks passwords in logs. |
| ModeZCompressionLevel | Used to specify the level of compression used. |
| PortRange | Allows the specification of a port range where the component listens for active mode connections. |
| PreserveFileTime | Attempts to preserve timestamps when transferring files. |
| RealTimeUpload | Enables real time uploading. |
| RealTimeUploadAgeLimit | The age limit in seconds when using RealTimeUpload. |
| ReusePISSLSessionInDI | Whether the PI SSL session will be reused for the DI connection. |
| ReuseSSLSessionInDI | Whether the SSL session will be reused for the DI connection. |
| UseClearChannel | Allows for the Clear Command Channel (CCC) command. |
| UseClearDataChannel | Allows for the PROT C command. |
| UseEPSV | Allows extended passive mode. |
| UseMLSD | Uses listings for machine processing. |
| UseMLST | Uses single file listing for machine processing. |
| UseModeZ | Allows compression to be used when transferring data. |
| UseOldAUTHSSL | Allows use of the 'AUTH SSL' command instead of 'AUTH TLS'. |
| UseProtWhenImplicit | Sends the PROT P command to the server. |
| UseRemoteHostAddressForPassive | Instructs the component to use the address specified by RemoteHost when establishing a data connection. |
| VirtualHostName | Sends the HOST command to the server. |
| 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-FTP Cmdlet)
The location of a file to which debug information is written.
Syntax
Connect-FTP -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
ActiveMode Parameter (Connect-FTP Cmdlet)
Controls whether to direct the server into active mode.
Syntax
Connect-FTP -ActiveMode SwitchParameter
Remarks
Default Value
false
AfterConnect Parameter (Connect-FTP Cmdlet)
A set of FTP commands to be executed immediately after connecting to the Server .
Syntax
Connect-FTP -AfterConnect string[]
Remarks
Default Value
null
AfterDownload Parameter (Connect-FTP Cmdlet)
A set of FTP commands to be executed immediately after each file downloaded.
Syntax
Connect-FTP -AfterDownload string[]
Remarks
Default Value
null
AuthMode Parameter (Connect-FTP Cmdlet)
The type of authentication used by the component.
Syntax
Connect-FTP -AuthMode string
Remarks
Default Value
2
BeforeDownload Parameter (Connect-FTP Cmdlet)
A set of FTP commands to be executed immediately before each file is downloaded.
Syntax
Connect-FTP -BeforeDownload string[]
Remarks
Default Value
null
Binary Parameter (Connect-FTP Cmdlet)
Forces binary transfer mode for FTP and FTPS connections.
Syntax
Connect-FTP -Binary SwitchParameter
Remarks
Default Value
false
Parameter Alias
TransferMode
CertPassword Parameter (Connect-FTP Cmdlet)
The password to the certificate store.
Syntax
Connect-FTP -CertPassword string
Remarks
Default Value
""
Parameter Alias
CertificatePassword
CertStore Parameter (Connect-FTP Cmdlet)
The name of the certificate store for the client certificate.
Syntax
Connect-FTP -CertStore string
Remarks
Default Value
"MY"
Parameter Alias
CertificateStore
CertStoreType Parameter (Connect-FTP Cmdlet)
The type of certificate store for the client certificate.
Syntax
Connect-FTP -CertStoreType string
Remarks
Default Value
0
CertSubject Parameter (Connect-FTP Cmdlet)
The subject of the certificate used for client authentication.
Syntax
Connect-FTP -CertSubject string
Remarks
Default Value
"*"
Config Parameter (Connect-FTP Cmdlet)
Specifies one or more configuration settings.
Syntax
Connect-FTP -Config string[]
Remarks
Default Value
null
Credential Parameter (Connect-FTP Cmdlet)
The PSCredential object to use for user/password authentication.
Syntax
Connect-FTP -Credential PSCredential
Remarks
Default Value
null
Parameter Position
1
Parameter Alias
auth
FirewallHost Parameter (Connect-FTP Cmdlet)
Name or IP address of firewall.
Syntax
Connect-FTP -FirewallHost string
Remarks
Default Value
""
FirewallPassword Parameter (Connect-FTP Cmdlet)
A password if authentication is to be used when connecting through the firewall.
Syntax
Connect-FTP -FirewallPassword string
Remarks
Default Value
""
FirewallPort Parameter (Connect-FTP Cmdlet)
The port of the firewall to which to connect.
Syntax
Connect-FTP -FirewallPort int
Remarks
Default Value
0
FirewallType Parameter (Connect-FTP Cmdlet)
Determines the type of firewall to connect through.
Syntax
Connect-FTP -FirewallType string
Remarks
Default Value
0
FirewallUser Parameter (Connect-FTP Cmdlet)
A user name if authentication is to be used connecting through a firewall.
Syntax
Connect-FTP -FirewallUser string
Remarks
Default Value
""
Force Parameter (Connect-FTP Cmdlet)
Forces the component to accept the default behavior instead of querying the user.
Syntax
Connect-FTP -Force SwitchParameter
Remarks
Default Value
false
List Parameter (Connect-FTP Cmdlet)
Get a directory listing for the path and file mask specified.
Syntax
Connect-FTP -List string
Remarks
Default Value
""
Parameter Alias
Path
LocalFile Parameter (Connect-FTP Cmdlet)
The local file to download to.
Syntax
Connect-FTP -LocalFile string
Remarks
Default Value
""
LocalIP Parameter (Connect-FTP Cmdlet)
The IP address of the local interface to use.
Syntax
Connect-FTP -LocalIP string
Remarks
Default Value
""
Parameter Alias
LocalAddress
LogFile Parameter (Connect-FTP Cmdlet)
The location of a file to which debug information is written.
Syntax
Connect-FTP -LogFile string
Remarks
Default Value
""
Overwrite Parameter (Connect-FTP Cmdlet)
Indicates whether the LocalFile may be overwritten.
Syntax
Connect-FTP -Overwrite SwitchParameter
Remarks
Default Value
false
Password Parameter (Connect-FTP Cmdlet)
The password to use for authentication.
Syntax
Connect-FTP -Password string
Remarks
Default Value
""
Port Parameter (Connect-FTP Cmdlet)
The TCP port in the remote host to which to connect.
Syntax
Connect-FTP -Port int
Remarks
Default Value
21
RemoteFile Parameter (Connect-FTP Cmdlet)
The name of the remote file to download.
Syntax
Connect-FTP -RemoteFile string
Remarks
Default Value
""
Parameter Position
1
Parameter Alias
Download
Server Parameter (Connect-FTP Cmdlet)
The address of the Server.
Syntax
Connect-FTP -Server string
Remarks
Default Value
""
Parameter Position
0
This is a required parameter.
SSL Parameter (Connect-FTP Cmdlet)
Determines how the component starts SSL negotiation.
Syntax
Connect-FTP -SSL string
Remarks
Default Value
3
SSLAccept Parameter (Connect-FTP Cmdlet)
The encoded public key of the certificate which is to be trusted explicitly.
Syntax
Connect-FTP -SSLAccept string
Remarks
Default Value
""
Parameter Alias
Accept
Timeout Parameter (Connect-FTP Cmdlet)
The maximum time allowed for the operation.
Syntax
Connect-FTP -Timeout int
Remarks
Default Value
10
User Parameter (Connect-FTP Cmdlet)
The username to use for authentication.
Syntax
Connect-FTP -User string
Remarks
Default Value
""
FTPConnection Output Object (Connect-FTP Cmdlet)
The connection object.
Syntax
Object FTPConnection {SwitchParameter ActiveMode;
string[] AfterConnect;
string AuthMode;
string CertPassword;
string CertStore;
string CertStoreType;
string CertSubject;
string[] Config;
PSCredential Credential;
string FirewallHost;
string FirewallPassword;
int FirewallPort;
string FirewallType;
string FirewallUser;
SwitchParameter Force;
string LocalIP;
string LogFile;
string Password;
int Port;
string Server;
string SSL;
string SSLAccept;
int Timeout;
string User;
}