What does Get-ConnectedClients do?

Get-ConnectedClients lists the clients registered on an NCache server.

Which server is used by default?

If Server is not specified, the IP address of the local machine is used.

What is the default port for Get-ConnectedClients?

The default value of the Port parameter is 9803.

Can credentials be supplied to Get-ConnectedClients?

Yes. The optional Credentials parameter can be used to provide user credentials for authorization.

What does the NoLogo parameter do?

The NoLogo parameter suppresses display of the logo banner. Its default value is False.

Get-ConnectedClients

This PowerShell cmdlet enables the user to list all registered clients on the server. It displays the client machine IP when the machine is activated with a server-activated license.

Get-ConnectedClients [-Server] [-Port] `
                     [-TlsCertPath] [-TlsCertPassword] `
                     [-NoLogo] [-Credentials]

Examples

This command gets all connected clients registered on the server.

Get-ConnectedClients

This command gets all connected clients registered on server 20.200.20.11.

Get-ConnectedClients -Server 20.200.20.11

This command uses the specified port and gets all connected clients registered on server 20.200.20.11.

Get-ConnectedClients -Server 20.200.20.11 -Port 9803

This command displays the clients connected to the specified server using port 9803 with mutual TLS (mTLS) enabled. It runs from a machine where NCache is not installed and uses C:\certs\client.pem to authenticate the machine running the cmdlet. The -TlsCertPassword parameter decrypts the certificate’s password-protected private key. Omit this parameter if the private key is not encrypted.

Get-ConnectedClients -Server 20.200.20.11 -Port 9803 `
                     -TlsCertPath "C:\certs\client.pem" -TlsCertPassword "clientKeyPassword"

This command gets all connected clients registered on server, using security credentials.

Get-ConnectedClients -Credentials(Get-Credential john_smith)

Properties

Note

The parameters with asterisk (*) on their names are the required parameters and the rest are optional.

Parameters	Data Types	Description	Default Value
`-Server`	`<String>`	Specifies a server name where the NCache Service is running and a cache with the specified cache-name is registered, for which the user wants to get the list of clients connected.	IP of local machine
`-Port`	`<Long>`	Specifies the server port where the NCache Service is listening.	9803
`-NoLogo`	`<SwitchParameter>`	Suppresses display of the logo banner.	False
`-Credentials`	`<pscredential>`	Specifies the user credentials required to authorize access for the specified operation. These credentials should belong to a user with the appropriate permissions at the node.	-
`-TlsCertPath`	`<string>`	Path to the client PEM certificate used to authenticate the machine running the NCache PowerShell cmdlet when connecting to an NCache server with mutual TLS (mTLS) enabled. The PEM file must contain the private key, leaf certificate, and any intermediate certificates. You can generate a certificate using `New-NCacheTlsCertificate`. This parameter is required when running the PowerShell module from a machine where NCache is not installed and the server requires mTLS. On a machine with an NCache server installation, the node's own certificate is used automatically. Relative paths are resolved against the current PowerShell location, and the file must exist. To configure the certificate presented by the server, use `-CustomCertificatePath`.	-
`-TlsCertPassword`	`<string>`	Password used to load the encrypted private key in the PEM file specified by `-TlsCertPath`. Required only when the private key is password-protected. Not needed for an unencrypted private key. The password is used only to load the client certificate for the current command's connections. It is not saved in the NCache server configuration.	-

Get-ConnectedClients

Examples

Properties

Note

Contact Us