Connect-SMSCmdlet
Parameters Output Objects Config Settings
The Connect-SMS cmdlet is used to create a persistent connection object.
Syntax
$cnn = Connect-SMS [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-SMS.
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. |
| 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. |
| SenderAddress | The address of the ESME. |
| 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. |
| SystemType | This is a string representing the type of system during a connection. |
| 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.
| SMSConnection | 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.
| AddressRange | Specifies the addr_range parameter when binding. |
| BinaryDataCoding | Whether or not to binary encode the message when DataCoding is set. |
| BindAsReceiver | Causes the component to bind as a receiver. |
| BindAsTransmitter | Causes the component to bind as a transmitter. |
| CustomTLV | Optional TLV parameters added after the mandatory parameters and before the payload. |
| DataCoding | The data encoding mechanism to be used for the current message. |
| DecodeHexStrings | Will decode an ascii hex-representation of binary data prior to transmission. |
| DestinationNPI | The Number Planning Indicator for the destination ESME. |
| DestinationTON | The Type of Number for the destination ESME. |
| DoSplitLargeMessages | Splits long messages and returns the UDH and Message Parts. |
| HexString | A hex-encoded binary string to be sent to the current recipient. |
| IncomingDestinationAddress | Returns the dest_addr field inside the received message. |
| IntermediateNotification | Causes the component to request intermediate notification. |
| MaxCIMDSMSLength | Indicates the maximum SMS message length for the CIMD protocol. |
| MaxSMSLength | Indicates the maximum SMS message length. |
| MCReceipt | The Type of MC Delivery Receipt requested. |
| MessageInReceiptedMessageId | The receipted_message_id field of an incoming deliver_sm PDU. |
| MessageMode | The Type of Messaging Mode requested. |
| MessageType | The Type of Message. |
| PDUFormat | The format of the PDU. |
| ProtocolId | The protocol identifier. |
| SMEAcknowledgement | The Type of SME originated acknowledgement requested. |
| SourceNPI | The Number Planning Indicator for the ESME. |
| SourceTON | The Type of Number for the ESME. |
| SplitLargeMessages | Determines whether large messages are split into multiple parts. |
| SplitMessageMethod | Determines how large messages are split into multiple parts. |
| StatusReportRequest | Defines in what cases a status report is created by the server. |
| SubAddr | Defines a unique index for application instance. |
| SynchronousSendCommand | Controls whether SendCommand behaves synchronously or asynchronously. |
| SynchronousSendMessage | Controls whether SendMessage behaves synchronously or asynchronously. |
| UseGSM7BitEncoding | Whether or not to use GSM 7-bit encoding. |
| UseGSM7bitEncodingCompression | Whether to compress GSM 7-bit encoded characters. |
| WaitForBanner | Specifies the CIMD2 banner the component will wait for when connecting. |
| 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-SMS Cmdlet)
The location of a file to which debug information is written.
Syntax
Connect-SMS -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
Config Parameter (Connect-SMS Cmdlet)
Specifies one or more configuration settings.
Syntax
Connect-SMS -Config string[]
Remarks
Default Value
null
Credential Parameter (Connect-SMS Cmdlet)
The PSCredential object to use for user/password authentication.
Syntax
Connect-SMS -Credential PSCredential
Remarks
Default Value
null
Parameter Position
1
Parameter Alias
auth
FirewallHost Parameter (Connect-SMS Cmdlet)
Name or IP address of firewall.
Syntax
Connect-SMS -FirewallHost string
Remarks
Default Value
""
FirewallPassword Parameter (Connect-SMS Cmdlet)
A password if authentication is to be used when connecting through the firewall.
Syntax
Connect-SMS -FirewallPassword string
Remarks
Default Value
""
FirewallPort Parameter (Connect-SMS Cmdlet)
The port of the firewall to which to connect.
Syntax
Connect-SMS -FirewallPort int
Remarks
Default Value
0
FirewallType Parameter (Connect-SMS Cmdlet)
Determines the type of firewall to connect through.
Syntax
Connect-SMS -FirewallType string
Remarks
Default Value
0
FirewallUser Parameter (Connect-SMS Cmdlet)
A user name if authentication is to be used connecting through a firewall.
Syntax
Connect-SMS -FirewallUser string
Remarks
Default Value
""
Force Parameter (Connect-SMS Cmdlet)
Forces the component to accept the default behavior instead of querying the user.
Syntax
Connect-SMS -Force SwitchParameter
Remarks
Default Value
false
LocalIP Parameter (Connect-SMS Cmdlet)
The IP address of the local interface to use.
Syntax
Connect-SMS -LocalIP string
Remarks
Default Value
""
Parameter Alias
LocalAddress
LogFile Parameter (Connect-SMS Cmdlet)
The location of a file to which debug information is written.
Syntax
Connect-SMS -LogFile string
Remarks
Default Value
""
Message Parameter (Connect-SMS Cmdlet)
The full text of the message to send (without headers).
Syntax
Connect-SMS -Message string
Remarks
Default Value
""
Password Parameter (Connect-SMS Cmdlet)
The password to use for authentication.
Syntax
Connect-SMS -Password string
Remarks
Default Value
""
Port Parameter (Connect-SMS Cmdlet)
The TCP port in the remote host to which to connect.
Syntax
Connect-SMS -Port int
Remarks
Default Value
2775
Recipient Parameter (Connect-SMS Cmdlet)
The recipient of the instant message.
Syntax
Connect-SMS -Recipient string
Remarks
Default Value
""
Parameter Position
2
Parameter Alias
To
SenderAddress Parameter (Connect-SMS Cmdlet)
The address of the ESME.
Syntax
Connect-SMS -SenderAddress string
Remarks
Default Value
""
Server Parameter (Connect-SMS Cmdlet)
The address of the Server.
Syntax
Connect-SMS -Server string
Remarks
Default Value
""
Parameter Position
0
This is a required parameter.
SSL Parameter (Connect-SMS Cmdlet)
Determines how the component starts SSL negotiation.
Syntax
Connect-SMS -SSL string
Remarks
Default Value
3
SSLAccept Parameter (Connect-SMS Cmdlet)
The encoded public key of the certificate which is to be trusted explicitly.
Syntax
Connect-SMS -SSLAccept string
Remarks
Default Value
""
Parameter Alias
Accept
SystemType Parameter (Connect-SMS Cmdlet)
This is a string representing the type of system during a connection.
Syntax
Connect-SMS -SystemType string
Remarks
Default Value
""
Timeout Parameter (Connect-SMS Cmdlet)
The maximum time allowed for the operation.
Syntax
Connect-SMS -Timeout int
Remarks
Default Value
10
UseHex Parameter (Connect-SMS Cmdlet)
Specifies if Message is hex encoded.
Syntax
Connect-SMS -UseHex SwitchParameter
Remarks
Default Value
false
User Parameter (Connect-SMS Cmdlet)
The username to use for authentication.
Syntax
Connect-SMS -User string
Remarks
Default Value
""
SMSConnection Output Object (Connect-SMS Cmdlet)
The connection object.
Syntax
Object SMSConnection {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 SenderAddress;
string Server;
string SSL;
string SSLAccept;
string SystemType;
int Timeout;
string User;
}