Connect-SMS Cmdlet

Parameters   Output Objects   Configuration 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.

LogFileThe location of a file to which debug information is written.
ConfigSpecifies one or more configuration settings.
CredentialThe PSCredential object to use for user/password authentication.
FirewallHostName or IP address of firewall.
FirewallPasswordA password if authentication is to be used when connecting through the firewall.
FirewallPortThe port of the firewall to which to connect.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
ForceForces the cmdlet to accept the default behavior instead of querying the user.
LocalIPThe IP address of the local interface to use.
LogFileThe location of a file to which debug information is written.
PasswordThe password to use for authentication.
PortThe TCP port in the remote host to which to connect.
SenderAddressThe address of the ESME.
ServerThe address of the Server.
SSLDetermines how the cmdlet starts SSL negotiation.
SSLAcceptThe encoded public key of the certificate which is to be trusted explicitly.
SystemTypeThis is a string representing the type of system during a connection.
TimeoutThe maximum time allowed for the operation.
UserThe 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.

SMSConnectionThe connection object.

Configuration Settings


The following is a list of configuration settings for the cmdlet with short descriptions. Click on the links for further details.

AddressRangeSpecifies the addr_range parameter when binding.
BinaryDataCodingWhether or not to binary encode the message when DataCoding is set.
BindAsReceiverCauses the component to bind as a receiver.
BindAsTransmitterCauses the component to bind as a transmitter.
CustomTLVOptional TLV parameters added after the mandatory parameters and before the payload.
DataCodingThe data encoding mechanism to be used for the current message.
DestinationNPIThe Number Planning Indicator for the destination ESME.
DestinationTONThe Type of Number for the destination ESME.
DoSplitLargeMessagesSplits long messages and returns the UDH and Message Parts.
HexStringA hex-encoded binary string to be sent to the current recipient.
IntermediateNotificationCauses the component to request intermediate notification.
MaxCIMDSMSLengthIndicates the maximum SMS message length for the CIMD protocol.
MaxSMSLengthIndicates the maximum SMS message length.
MCReceiptThe Type of MC Delivery Receipt requested.
MessageInReceiptedMessageIdThe receipted_message_id field of an incoming deliver_sm PDU.
MessageModeThe Type of Messaging Mode requested.
MessageTypeThe Type of Message.
ProtocolIdThe protocol identifier.
SMEAcknowledgementThe Type of SME originated acknowledgement requested.
SourceNPIThe Number Planning Indicator for the ESME.
SourceTONThe Type of Number for the ESME.
SplitLargeMessagesDetermines whether large messages are split into multiple parts.
SplitMessageMethodDetermines how large messages are split into multiple parts.
StatusReportRequestDefines in what cases a status report is created by the server.
SubAddrDefines a unique index for application instance.
SynchronousSendCommandControls whether SendCommand behaves synchronously or asynchronously.
SynchronousSendMessageControls whether SendMessage behaves synchronously or asynchronously.
UseGSM7BitEncodingWhether or not to use GSM 7-bit encoding.
UseGSM7bitEncodingCompressionWhether to compress GSM 7-bit encoded characters.
WaitForBannerSpecifies the CIMD2 banner the cmdlet will wait for when connecting.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the cmdlet whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the cmdlet binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
UseInternalSecurityAPITells the cmdlet whether or not to use the system security libraries or an internal implementation.

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
NetCmdlets 2020 - Version 20.0 [Build 7877]