Invoke-PowerShellServer Cmdlet

Parameters   Output Objects   Config Settings  

The Invoke-PowerShellServer Component is used to remotely execute a command on the PowerShell Server.

Syntax

Invoke-PowerShellServer [parameters]

Remarks

This cmdlet uses SSH to invoke a remote command on the PowerShell session hosted by the remote PowerShell Server. Using the cmdlet is very simple. The command is specified by the Command parameter. The command is executed on the remote shell, and the resulting objects are serialized and sent back to the client. PSObject instances with matching fields are reconstructed locally and then returned by the Invoke-PowerShellServerExpression cmdlet.

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.

# create an SSH connection and store the connection object in a shell variable $conn = Connect-PowerShellServer -server SERVER -cred $mycred #invoke a command on the remote connection Invoke-PowerShellServer $conn -command ls

Connection Handling

This cmdlet supports persistent connections through the Connection parameter. To establish a new PowerShellServer connection, use the Connect-PowerShellServer cmdlet. To close the connection, use the Disconnect-PowerShellServer cmdlet.

Parameter List


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

ConnectionAn already established connection.
LogFileThe location of a file to which debug information is written.
AuthModeThe type of authentication used by the component.
CertPasswordThe password to the certificate store.
CertStoreThe name of the certificate store for the client certificate.
CertStoreTypeThe type of certificate store for the client certificate.
CertSubjectThe subject of the certificate used for client authentication.
CommandThe command to send to the remote SSH Server.
CompressionAlgorithmsA comma-separated list containing all allowable compression algorithms.
ConfigSpecifies one or more configuration settings.
CredentialThe PSCredential object to use for user/password authentication.
EncryptionAlgorithmsA comma-separated list containing all allowable compression algorithms.
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 component 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 port to be used.
ServerThe address of the Server.
SSHAcceptThe hex-encoded fingerprint of the host to trust explicitly.
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.

SSHOutputThe PSObject object returned by the Invoke-PowerShellServerExpression Component will have properties matching those of the original object in the remote machine.

Config Settings


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

GSSAPIMechanismsThe desired GSS-API authentication mechanism.
KerberosDelegationIf true, asks for credentials with delegation enabled during authentication.
KerberosRealmThe fully qualified domain name of the Kerberos Realm to use for GSSAPI authentication.
KerberosSPNThe Kerberos Service Principal Name of the SSH host.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveWhether sensitive data is masked in log messages.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

LogFile Parameter (Invoke-PowerShellServer Cmdlet)

The location of a file to which debug information is written.

Syntax

Invoke-PowerShellServer -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

Connection Parameter (Invoke-PowerShellServer Cmdlet)

An existing PowerShellServer connection.

Syntax

Invoke-PowerShellServer -Connection PowerShellServerConnection

Remarks

Represents an existing, persistent PowerShellServer connection to be used. After this cmdlet executes, the connection will remain opened to be used in an another call. New connections can be established using the Connect-PowerShellServer cmdlet and closed using the Disconnect-PowerShellServer cmdlet.

Default Value

null

AuthMode Property (Invoke-PowerShellServer Cmdlet)

The type of authentication used by the component.

Syntax

Invoke-PowerShellServer -AuthMode string

Remarks

Normally, the cmdlet will attempt to log in to the SSH server and authenticate via username and password. This behavior can be changed to use client key (RSA) authentication by setting this parameter to 'PublicKey'.

PasswordPassword authentication used with the SSH server.
PublicKeyWhen Public Key authentication is used, the cmdlet will search the certificate store specified in CertStore for a private key associated with CertSubject when logging onto the SSH server. This private key is used to verify the client's identity during the user authentication phase of the SSH logon process.
GSSAPIGSSAPI-With-MIC authentication using NTLM.

Default Value

2

CertPassword Property (Invoke-PowerShellServer Cmdlet)

The password to the certificate store.

Syntax

Invoke-PowerShellServer -CertPassword string

Remarks

Specifies a password (if required) to access the specified certificate store.

Default Value

""

Parameter Alias

CertificatePassword

CertStore Property (Invoke-PowerShellServer Cmdlet)

The name of the certificate store for the client certificate.

Syntax

Invoke-PowerShellServer -CertStore string

Remarks

The CertStoreType parameter specifies the type of the certificate store specified by CertStore. If the store is password protected, specify the password in CertPassword.

CertStore is used in conjunction with the CertSubject parameter in order to specify client certificates. If CertStore has a value, and CertSubject has been set, a search for a certificate is initiated during logon. Please refer to the CertSubject parameter for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.
SPCSoftware publisher certificates.

When the certificate store type is PFXFile, this parameter must be set to the name of the file.

Default Value

"MY"

Parameter Alias

CertificateStore

CertStoreType Property (Invoke-PowerShellServer Cmdlet)

The type of certificate store for the client certificate.

Syntax

Invoke-PowerShellServer -CertStoreType string

Remarks

This parameter can take one of the following values:

User (default)This specifies that the certificate store is owned by the current user (these are the user's registry certificate stores such as MY, CA, etc.).
MachineThe certificate store is a machine store.
PFXFileThe certificate store is the name of a PFX (PKCS12) file containing certificates.
PFXBlobThe certificate store is a string (base64 encoded) representing a certificate store in PFX (PKCS12) format. You should use this option if storing a pfx file's content in a shell variable.
PEMKeyFileThe certificate store is the name of a file that contains a PEM encoded certificate and private key.
PEMKeyBlobThe certificate store is a string that contains a PEM encoded certificate and private key.
P7BFileThe certificate store is the name of a file that contains P7B encoded certificates.
SSHPublicKeyFileThe certificate store is the name of a file that contains an SSH-style public key.
PPKFileThe certificate store is the name of a file that contains a PPK (PuTTY Private Key).
PPKBlobThe certificate store is a string (binary) that contains a PPK (PuTTY Private Key).

Default Value

0

CertSubject Property (Invoke-PowerShellServer Cmdlet)

The subject of the certificate used for client authentication.

Syntax

Invoke-PowerShellServer -CertSubject string

Remarks

During the user authentication phase of the logon process, the cmdlet will search the store specified in CertStore for a certificate that matches this parameter. If the store contains a private key for that certificate, it is used to verify the user's identity with the secure server.

When this parameter is set, a search is performed in the current certificate store certificate with matching subject.

If an exact match is not found, the store is searched for subjects containing the value of the parameter.

When setting the parameter to a partial subject, CN= should be omitted. For example, the following code would find the certificate with subject CN=Test Certificate, OU=People, C=US

Example (Searching with partial subject)

-certsubject "Test"

If a match is not found, the parameter is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

Default Value

"*"

Command Property (Invoke-PowerShellServer Cmdlet)

The command to send to the remote SSH Server.

Syntax

Invoke-PowerShellServer -Command string

Remarks

The command will be sent to the remote SSH Server.

Default Value

""

Parameter Position

1

This is a required parameter.

CompressionAlgorithms Property (Invoke-PowerShellServer Cmdlet)

A comma-separated list containing all allowable compression algorithms.

Syntax

Invoke-PowerShellServer -CompressionAlgorithms string

Remarks

During the SSH handshake, this list will be used to negotiate the compression algorithm to be used between the client and server. This list is used for both directions: client to server and server to client. When negotiating algorithms, each side sends a list of all algorithms it supports or allows. The algorithm chosen for each direction is the first algorithm to appear in the sender's list that the receiver supports, so it is important to list multiple algorithms in preferential order. If no algorithm can be agreed upon, the cmdlet will raise an error and the connection will be aborted.

At least one support algorithm must appear in this list. The following compression algorithms are supported by the cmdlet:

  • zlib
  • none

Default Value

"zlib,none"

Config Property (Invoke-PowerShellServer Cmdlet)

Specifies one or more configuration settings.

Syntax

Invoke-PowerShellServer -Config string[]

Remarks

The Config parameter takes one or more name-value pairs that represent the name of the configuration setting and value, i.e.: -config "Name=Value"

Default Value

null

Credential Property (Invoke-PowerShellServer Cmdlet)

The PSCredential object to use for user/password authentication.

Syntax

Invoke-PowerShellServer -Credential PSCredential

Remarks

Every cmdlet that supports user authentication will expose a Credential parameter. A PSCredential object should be specified for this parameter. Alternatively, the User and Password parameters can be set to represent the credential information.

If the cmdlet supports client key authentication it uses the password field of this object for the certificate's password. This setting is enabled by using public key authentication. Note: Due to security reasons, it is recommended that you use the Credential parameter rather than User and Password to specify the authentication information.

Default Value

null

Parameter Position

1

Parameter Alias

auth

EncryptionAlgorithms Property (Invoke-PowerShellServer Cmdlet)

A comma-separated list containing all allowable compression algorithms.

Syntax

Invoke-PowerShellServer -EncryptionAlgorithms string

Remarks

During the SSH handshake, this list will be used to negotiate the encryption algorithm to be used between the client and server. This list is used for both directions: client to server and server to client. When negotiating algorithms, each side sends a list of all algorithms it supports or allows. The algorithm chosen for each direction is the first algorithm to appear in the sender's list that the receiver supports, so it is important to list multiple algorithms in preferential order. If no algorithm can be agreed upon, the cmdlet will raise an error and the connection will be aborted.

At least one support algorithm must appear in this list. The following encryption algorithms are supported by the cmdlet:

aes256-cbc256-bit AES encryption in CBC mode
aes192-cbc192-bit AES encryption in CBC mode
aes128-cbc128-bit AES encryption in CBC mode
3des-cbc192-bit (3-key) triple DES encryption in CBC mode
noneNo encryption will be used (not recommended)

By default, "aes256-cbc", the only encryption algorithm recommended by the SSH specification, and "3des-cbc", the only algorithm required, are enabled. It is not recommended to enable "none", as this defeats the purpose of an SSH connection.

Default Value

"aes256-cbc,3des-cbc"

FirewallHost Property (Invoke-PowerShellServer Cmdlet)

Name or IP address of firewall.

Syntax

Invoke-PowerShellServer -FirewallHost string

Remarks

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost parameter is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost parameter is set to the corresponding address. If the search is not successful, an error is returned.

Default Value

""

FirewallPassword Property (Invoke-PowerShellServer Cmdlet)

A password if authentication is to be used when connecting through the firewall.

Syntax

Invoke-PowerShellServer -FirewallPassword string

Remarks

If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to authenticate against the firewall.

Default Value

""

FirewallPort Property (Invoke-PowerShellServer Cmdlet)

The port of the firewall to which to connect.

Syntax

Invoke-PowerShellServer -FirewallPort int

Remarks

The TCP port for the FirewallHost. See the description of the FirewallHost parameter for details.

Note that the FirewallPort is set automatically when FirewallType is set to a valid value. See the description of the FirewallType parameter for details. Setting this parameter will overwrite the default settings for the firewall port as specified by FirewallType.

Default Value

0

FirewallType Property (Invoke-PowerShellServer Cmdlet)

Determines the type of firewall to connect through.

Syntax

Invoke-PowerShellServer -FirewallType string

Remarks

The applicable values are the following:

None No firewall (default setting).
TunnelConnect through a tunneling proxy. FirewallPort is set to 80.
SOCKS4Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
SOCKS5Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.

Default Value

0

FirewallUser Property (Invoke-PowerShellServer Cmdlet)

A user name if authentication is to be used connecting through a firewall.

Syntax

Invoke-PowerShellServer -FirewallUser string

Remarks

If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to authenticate against the firewall.

Default Value

""

Force Property (Invoke-PowerShellServer Cmdlet)

Forces the component to accept the default behavior instead of querying the user.

Syntax

Invoke-PowerShellServer -Force SwitchParameter

Remarks

The Force parameter is especially useful in a script environment where user interaction is not an option. Certain cmdlets that are SSH and SSL based will query the user if the security credentials of the certificate presented by the server are not met. Setting this parameter will force the cmdlet to accept the certificate of the server unconditionally.

Default Value

false

LocalIP Property (Invoke-PowerShellServer Cmdlet)

The IP address of the local interface to use.

Syntax

Invoke-PowerShellServer -LocalIP string

Remarks

This parameter is useful when the cmdlet is running on a machine that has more than one network interface (each with its own IP address and network access privileges).

Default Value

""

Parameter Alias

LocalAddress

LogFile Property (Invoke-PowerShellServer Cmdlet)

The location of a file to which debug information is written.

Syntax

Invoke-PowerShellServer -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

""

Password Property (Invoke-PowerShellServer Cmdlet)

The password to use for authentication.

Syntax

Invoke-PowerShellServer -Password string

Remarks

Every time User, or Password are set, the cmdlet will authenticate with the server. It is recommended that the Credential parameter is set instead of User/Password because of security reasons. If both Credential and this parameter is set, the Credential value is used.

Default Value

""

Port Property (Invoke-PowerShellServer Cmdlet)

The port to be used.

Syntax

Invoke-PowerShellServer -Port int

Remarks

Port specifies a service port on the remote host to which to connect.

A valid port number (a value between 1 and 65535) is required for the connection to take place.

Default Value

22

Server Property (Invoke-PowerShellServer Cmdlet)

The address of the Server.

Syntax

Invoke-PowerShellServer -Server string

Remarks

The cmdlet requires a server address to be provided. Either an IP address or the server host name can be provided.

Default Value

""

Parameter Position

0

This is a required parameter.

SSHAccept Property (Invoke-PowerShellServer Cmdlet)

The hex-encoded fingerprint of the host to trust explicitly.

Syntax

Invoke-PowerShellServer -SSHAccept string

Remarks

The fingerprint will be an MD5 hash of the host key in hex-encoded form, i.e. "0a:1b:2c:3d". Setting this will instruct the cmdlet to trust the fingerprint provided without prompting for verification.

After each connection, regardless of whether or not the key was trusted, the cmdlet will store the server's host key in the $SSHServerHostKey session variable. This variable can be inspected to view details of the server's key.

If the Force parameter is set, the cmdlet will accept the server's key unconditionally.

In cases where the host key presented by the server is not trusted, a prompt will be shown to the user. This prompt will allow the user to decide whether or not they would like to accept the host key presented by the server.

There may be cases where you do not want a prompt to be displayed or would like to handle the response supplied directly within your script. This can be done by setting the $SSHAcceptPreference variable prior to running the cmdlet. The available values for this variable are:

None (default)Maintains the default behavior. If the host key is not trusted by default, the user will be prompted.
AcceptAccepts the host key without prompting the user, even if it is not trusted by default.
RejectRejects the host key without prompting the user only if it is not trusted by default. Thus if the host key is found to be trusted or the Force parameter is set, the connection will still be accepted.

Default Value

""

Parameter Alias

Fingerprint

Timeout Property (Invoke-PowerShellServer Cmdlet)

The maximum time allowed for the operation.

Syntax

Invoke-PowerShellServer -Timeout int

Remarks

After the specified interval in seconds, the cmdlet will throw a Timeout error if the operation is not completed.

Default Value

10

User Property (Invoke-PowerShellServer Cmdlet)

The username to use for authentication.

Syntax

Invoke-PowerShellServer -User string

Remarks

Every time User and Password are set, the cmdlet will authenticate with the server. It is recommended that the Credential parameter is set instead of User/Password because of security reasons. If both Credential and this parameter is set, the Credential value is used.

Default Value

""

SSHOutput Output Object (Invoke-PowerShellServer Cmdlet)

The PSObject object returned by the Invoke-PowerShellServerExpression Component will have properties matching those of the original object in the remote machine.

Syntax

Object SSHOutput {
   string Property;
}

Remarks

The object coming back from the server is de-serialized into a PSObject with matching fields.

Config Settings (Invoke-PowerShellServer Cmdlet)

The cmdlet accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the cmdlet, access to these internal properties is provided through the Config method.

Invoke-PowerShellServer Config Settings

GSSAPIMechanisms:   The desired GSS-API authentication mechanism.

This setting determines the mechanism used for authentication with Kerberos. Possible values are:

1 (Kerberos)
2 (NTLM - default)
KerberosDelegation:   If true, asks for credentials with delegation enabled during authentication.

The default value is "true". If set to "false", the client will not ask for credentials delegation support during authentication. Note that even if the client asks for delegation, the server/KDC might not grant it and authentication will still succeed.

KerberosRealm:   The fully qualified domain name of the Kerberos Realm to use for GSSAPI authentication.

This property may be set to the fully qualified (DNS) name of the kerberos realm (or Windows Active Directory domain name) to use during GSSAPI authentication. This can be used to force authentication with a given realm if the client and server machines are not part of the same domain.

KerberosSPN:   The Kerberos Service Principal Name of the SSH host.

This property can be set to specify the Service Principal Name (SPN) associated with the SSH service on the remote host. This will usually be in the form "host/fqdn.of.sshhost[@REALM]". If not specified, the cmdlet will assume the SPN is based on the value of the SSHHost property and the kerberos realm used for authentication.

Base Config Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8
The following is a list of valid code page identifiers for Mac OS only:
IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a cmdlet is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
  • Last Valid Build: The last valid build number for which the license will work.
MaskSensitive:   Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

This setting only works on these cmdlets: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

UseInternalSecurityAPI:   Whether or not to use the system security libraries or an internal implementation.

When set to false, the cmdlet will use the system security libraries by default to perform cryptographic functions where applicable. In this case, calls to unmanaged code will be made. In certain environments, this is not desirable. To use a completely managed security implementation, set this setting to true.

Setting this configuration setting to true tells the cmdlet to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.

If using the .NET Standard Library, this setting will be true on all platforms. The .NET Standard library does not support using the system security libraries.

Note: This setting is static. The value set is applicable to all cmdlets used in the application.

When this value is set, the product's system dynamic link library (DLL) is no longer required as a reference, as all unmanaged code is stored in that file.