Send-Page Cmdlet
Parameters Output Objects Configuration Settings
The Send-Page cmdlet is used to send messages using the SNPP protocol.
Syntax
Send-Page [parameters]
Remarks
It is a client implementation of Simple Network Paging Protocol Version 3 as specified in RFC 1861. Service extensions level 2 are supported intrinsically and the user can access all of level 3 extensions. Send-Page allows for immediate notification of message delivery, gives absolute flexibility over the content sent to the recipient, allows the specification of multiple choice responses, etc. To send a message the Server, recipient's PagerNumber and Message parameters should be set (these are also the require parameters). A PAGEObject is returned by the cmdlet Optional properties include: CallerNumber, Port and LocalIP.
The cmdlets support pipeline input for some of their parameters. Prebuilding an object and piping it to the cmdlet is very useful, but should be used with caution to prevent security conflicts. Steps have been taken to decrease the risk of a possibly accidental pipe to the cmdlet, for instance, the Credential parameter cannot be piped to the cmdlet and must be specified manually.
# send an IMsend-page -server $snpp_server -CallerNumber $my_number -PagerNumber $recipient_number -message "Hi!"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. |
| CallerNumber | The pager number of the caller. |
| 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. |
| 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. |
| LocalIP | The IP address of the local interface to use. |
| LocalPort | The local port that the cmdlet should use. |
| LogFile | The location of a file to which debug information is written. |
| Message | The message being sent (alphanumeric). |
| PagerNumber | The number of the pager to send a Message to. |
| Port | The server port for SNPP (default 444). |
| Server | The name or address of the SNPP server. |
| SSL | Determines how the cmdlet 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. |
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.
| PAGE | This object contains the delivery information of the message. |
Configuration Settings
The following is a list of configuration settings for the cmdlet with short descriptions. Click on the links for further details.
| LoginID | Login ID used to authenticate with an SNPP server. |
| ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
| FirewallAutoDetect | Tells the cmdlet 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. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| 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 cmdlet 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. |
| UseIPv6 | Whether to use IPv6. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| 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. |
| UseBackgroundThread | Whether threads created by the cmdlet are background threads. |
| UseInternalSecurityAPI | Tells the cmdlet whether or not to use the system security libraries or an internal implementation. |