IP*Works! SSH V9 - Online Help
IP*Works! SSH V9
Questions / Feedback?

PSClient Class

Properties   Methods   Events   Configuration Settings   Errors  

The PSClient component can be used to execute PowerShell commands remotely on PowerShell Server.

Class Name

IPWorksSSH_PSClient

Procedural Interface

 ipworksssh_psclient_open();
 ipworksssh_psclient_close($res);
 ipworksssh_psclient_register_callback($res, $id, $function);
 ipworksssh_psclient_get_last_error($res);
 ipworksssh_psclient_get_last_error_code($res);
 ipworksssh_psclient_set($res, $id, $index, $value);
 ipworksssh_psclient_get($res, $id, $index);
 ipworksssh_psclient_do_clearoutput($res);
 ipworksssh_psclient_do_config($res, $configurationstring);
 ipworksssh_psclient_do_doevents($res);
 ipworksssh_psclient_do_execute($res, $command);
 ipworksssh_psclient_do_getpropertyvalue($res, $name);
 ipworksssh_psclient_do_interrupt($res);
 ipworksssh_psclient_do_sshlogoff($res);
 ipworksssh_psclient_do_sshlogon($res, $sshhost, $sshport);

Remarks

PSClient allows any PowerShell command to be executed remotely in a secure manner, using the SSH protocol. The results of the command execution are then returned as a list of objects, each one with a base type, an (optional) value and a collection of named properties.

Note: By default no profiles are loaded when executing. However you can use dot-sourcing to load any profile. For example:


./profiles/YourProfile.ps1

Property List


The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

ConnectedTriggers a connection or disconnection.
FirewallAutoDetectThis property tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallTypeThis property determines the type of firewall to connect through.
FirewallHostThis property contains the name or IP address of firewall (optional).
FirewallPasswordThis property contains a password if authentication is to be used when connecting through the firewall.
FirewallPortThis property contains the TCP port for the firewall Host .
FirewallUserThis property contains a user name if authentication is to be used connecting through a firewall.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where IPPort binds.
PSObjectPropertyCountThe number of records in the PSObjectProperty arrays.
PSObjectPropertyDataTypeThe type of this property Each property has a unique name, a value, a type and a boolean value indicating if it's null.
PSObjectPropertyIsNullTrue, if the property has a null value Each property has a unique name, a value, a type and a boolean value indicating if it's null.
PSObjectPropertyNameThe name of a property Each property has a unique name, a value, a type and a boolean value indicating if it's null.
PSObjectPropertyValueThe value of this property Each property has a unique name, a value, a type and a boolean value indicating if it's null.
PSObjectBaseTypeThe base type name of the current output object.
PSObjectCountThe number of objects returned by the pipeline execution.
PSObjectIndexThe index of the current object selected in the list of outputs.
PSObjectValueThe value of the current output object.
SSHAcceptServerHostKeyEncodedThe certificate (PEM/base64 encoded).
SSHAuthModeThe authentication method to be used the component when performing an SSHLogon .
SSHCertEncodedThe certificate (PEM/base64 encoded).
SSHCertStoreThe name of the certificate store for the client certificate.
SSHCertStorePasswordIf the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
SSHCertStoreTypeThe type of certificate store for this certificate.
SSHCertSubjectThe subject of the certificate used for client authentication.
SSHCompressionAlgorithmsA comma-separated list containing all allowable compression algorithms.
SSHEncryptionAlgorithmsA comma-separated list containing all allowable compression algorithms.
SSHHostThe address of the SSH host.
SSHKeyExchangeAlgorithmsA comma-separated list containing all allowable key exchange algorithms.
SSHMacAlgorithmsA comma-separated list containing all allowable message authentication algorithms.
SSHPasswordThe password for SSH password-based authentication.
SSHPortThe port on the SSH server where the SSH service is running; by default, 22.
SSHPublicKeyAlgorithmsA comma-separated list containing all allowable public key authentication algorithms.
SSHUserThe username for SSH authentication.
TimeoutA timeout for the component.

Method List


The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

ClearOutputClears the output list.
ConfigSets or retrieves a configuration setting .
DoEventsProcesses events from the internal message queue.
ExecuteExecute a command on the remote PowerShell Server.
GetPropertyValueLooks up a property by name and returns the value.
InterruptStop execution of a running command.
SSHLogoffLogoff from the SSH server.
SSHLogonLogon to the selected server.

Event List


The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

ConnectedFired immediately after a connection completes (or fails).
ConnectionStatusFired to indicate changes in connection state.
DisconnectedFired when a connection is closed.
ErrorInformation about errors during data delivery.
PSObjectFires when a new object is parsed on the server output.
SSHKeyboardInteractiveFired when the component receives a request for user input from the server.
SSHServerAuthenticationFired after the server presents its public key to the client.
SSHStatusShows the progress of the secure connection.

Configuration Settings


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

StreamingModeIf set the component will only keep track of the last object returned.
EncodingThe encoding to use for decoding data sent between client and server.
ClientSSHVersionStringThe SSH version string used by the component.
SignedSSHCertThe CA signed client public key used when authenticating.
SSHAcceptServerCAKeyThe CA public key that signed the server's host key.
SSHAcceptAnyServerHostKeyIf set the component will accept any key presented by the server.
SSHAcceptServerHostKeyFingerPrintThe fingerprint of the server key to accept.
SSHKeyExchangeAlgorithmsSpecifies the supported key exchange algorithms.
SSHMacAlgorithmsSpecifies the supported Mac algorithms.
SSHKeyRenegotiateCauses the component to renegotiate the SSH keys.
KeyRenegotiationThresholdSets the threshold for the SSH Key Renegotiation.
KerberosRealmThe fully qualified domain name of the Kerberos Realm to use for GSSAPI authentication.
KerberosDelegationIf true, asks for credentials with delegation enabled during authentication.
KerberosSPNThe Kerberos Service Principal Name of the SSH host.
LogSSHPacketsIf true, detailed SSH packet logging is performed.
MaxPacketSizeThe maximum packet size of the channel, in bytes.
MaxWindowSizeThe maximum window size allowed for the channel, in bytes.
PreferredDHGroupBitsThe size (in bits) of the preferred modulus (p) to request from the server.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component 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.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
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 TCP port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
RecordLengthThe length of received data records.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
TcpNoDelayWhether or not to delay when sending packets.
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.
CodePageThe system code page used for Unicode to Multibyte translations.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 9.0.6240.0