Connect-IMCmdlet
Parameters Output Objects Config Settings
The Connect-IM cmdlet is used to create a persistent connection object.
Syntax
$cnn = Connect-IM [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-IM.
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. |
| AuthDomain | The domain under which the user will be authenticated. |
| AuthenticationMechanism | Controls how the component authenticates itself with the XMPP 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. |
| 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. |
| ServerDomain | The XMPP server's domain. |
| 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. |
| UserDomain | Gets or sets the domain value used for Jabber IDs. |
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.
| IMConnection | 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.
| AccessToken | The OAuth access token used for authentication. |
| BlockSize | Specifies the block size for file transfers. |
| ClientId | The OAuth client Id used for authentication. |
| MessageXML | Returns the last root-level element received by the component. |
| Overwrite | Specifies whether or not to overwrite received files. |
| ParseHTML | Tells XMPP whether or not to parse MessageHTML when it's set. |
| RetrieveRoster | Whether to automatically retrieve the roster when logging in. |
| SendSubscriptionResponse | Determines whether a response will be sent to a Subscription Request. |
| UseCompression | Specified whether or not stream compression is used. |
| 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-IM Cmdlet)
The location of a file to which debug information is written.
Syntax
Connect-IM -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
AuthDomain Parameter (Connect-IM Cmdlet)
The domain under which the user will be authenticated.
Syntax
Connect-IM -AuthDomain string
Remarks
Default Value
""
AuthenticationMechanism Parameter (Connect-IM Cmdlet)
Controls how the component authenticates itself with the XMPP Server .
Syntax
Connect-IM -AuthenticationMechanism string
Remarks
Default Value
"PlainText"
Parameter Alias
AuthMechanism
CertPassword Parameter (Connect-IM Cmdlet)
The password to the certificate store.
Syntax
Connect-IM -CertPassword string
Remarks
Default Value
""
Parameter Alias
CertificatePassword
CertStore Parameter (Connect-IM Cmdlet)
The name of the certificate store for the client certificate.
Syntax
Connect-IM -CertStore string
Remarks
Default Value
"MY"
Parameter Alias
CertificateStore
CertStoreType Parameter (Connect-IM Cmdlet)
The type of certificate store for the client certificate.
Syntax
Connect-IM -CertStoreType string
Remarks
Default Value
0
CertSubject Parameter (Connect-IM Cmdlet)
The subject of the certificate used for client authentication.
Syntax
Connect-IM -CertSubject string
Remarks
Default Value
"*"
Config Parameter (Connect-IM Cmdlet)
Specifies one or more configuration settings.
Syntax
Connect-IM -Config string[]
Remarks
Default Value
null
Credential Parameter (Connect-IM Cmdlet)
The PSCredential object to use for user/password authentication.
Syntax
Connect-IM -Credential PSCredential
Remarks
Default Value
null
Parameter Position
1
Parameter Alias
auth
FirewallHost Parameter (Connect-IM Cmdlet)
Name or IP address of firewall.
Syntax
Connect-IM -FirewallHost string
Remarks
Default Value
""
FirewallPassword Parameter (Connect-IM Cmdlet)
A password if authentication is to be used when connecting through the firewall.
Syntax
Connect-IM -FirewallPassword string
Remarks
Default Value
""
FirewallPort Parameter (Connect-IM Cmdlet)
The port of the firewall to which to connect.
Syntax
Connect-IM -FirewallPort int
Remarks
Default Value
0
FirewallType Parameter (Connect-IM Cmdlet)
Determines the type of firewall to connect through.
Syntax
Connect-IM -FirewallType string
Remarks
Default Value
0
FirewallUser Parameter (Connect-IM Cmdlet)
A user name if authentication is to be used connecting through a firewall.
Syntax
Connect-IM -FirewallUser string
Remarks
Default Value
""
Force Parameter (Connect-IM Cmdlet)
Forces the component to accept the default behavior instead of querying the user.
Syntax
Connect-IM -Force SwitchParameter
Remarks
Default Value
false
LocalIP Parameter (Connect-IM Cmdlet)
The IP address of the local interface to use.
Syntax
Connect-IM -LocalIP string
Remarks
Default Value
""
Parameter Alias
LocalAddress
LogFile Parameter (Connect-IM Cmdlet)
The location of a file to which debug information is written.
Syntax
Connect-IM -LogFile string
Remarks
Default Value
""
Message Parameter (Connect-IM Cmdlet)
The full text of the message to send (without headers).
Syntax
Connect-IM -Message string
Remarks
Default Value
""
Password Parameter (Connect-IM Cmdlet)
The password to use for authentication.
Syntax
Connect-IM -Password string
Remarks
Default Value
""
Port Parameter (Connect-IM Cmdlet)
The TCP port in the remote host to which to connect.
Syntax
Connect-IM -Port int
Remarks
Default Value
5222
Recipient Parameter (Connect-IM Cmdlet)
The recipient of the instant message.
Syntax
Connect-IM -Recipient string
Remarks
Default Value
""
Parameter Position
2
Parameter Alias
To
Server Parameter (Connect-IM Cmdlet)
The address of the Server.
Syntax
Connect-IM -Server string
Remarks
Default Value
""
Parameter Position
0
This is a required parameter.
ServerDomain Parameter (Connect-IM Cmdlet)
The XMPP server's domain.
Syntax
Connect-IM -ServerDomain string
Remarks
Default Value
""
SSL Parameter (Connect-IM Cmdlet)
Determines how the component starts SSL negotiation.
Syntax
Connect-IM -SSL string
Remarks
Default Value
3
SSLAccept Parameter (Connect-IM Cmdlet)
The encoded public key of the certificate which is to be trusted explicitly.
Syntax
Connect-IM -SSLAccept string
Remarks
Default Value
""
Parameter Alias
Accept
Timeout Parameter (Connect-IM Cmdlet)
The maximum time allowed for the operation.
Syntax
Connect-IM -Timeout int
Remarks
Default Value
10
User Parameter (Connect-IM Cmdlet)
The username to use for authentication.
Syntax
Connect-IM -User string
Remarks
Default Value
""
UserDomain Parameter (Connect-IM Cmdlet)
Gets or sets the domain value used for Jabber IDs.
Syntax
Connect-IM -UserDomain string
Remarks
Default Value
""
WaitForError Parameter (Connect-IM Cmdlet)
Specifies how many seconds to wait for an error during delivery.
Syntax
Connect-IM -WaitForError int
Remarks
Default Value
0
IMConnection Output Object (Connect-IM Cmdlet)
The connection object.
Syntax
Object IMConnection {string AuthDomain;
string AuthenticationMechanism;
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 ServerDomain;
string SSL;
string SSLAccept;
int Timeout;
string User;
string UserDomain;
}