pvnetpass
Description
Pvnetpass is the PSQL network password tool. It is a command line tool used to manage the user IDs and passwords for servers to which your client connects. When trying to connect to a server, the client looks up the server name in the registry and uses the user name and password set for that server.
If your application uses the MicroKernel Engine and connects to a Linux, macOS, or Raspbian database engine that is configured to use BTPASSWD or PAM authentication, the application requires a set of credentials to connect to the database engine. Use pvnetpass to configure the sets of credentials that the application will use. Pvnetpass must be run on every machine that connects to the database engine, whether the database engine is local or remote. For more information, see
Authentication in
Getting Started with PSQL.
If you have a global and a user entry for the same server, the user entry overrides the global. The user name should include the full user context. For example, in a Windows environment with domain names, specify the user as domain\user. For a Linux, macOS, or Raspbian environment, use the user account name and the full machine DNS name, such as mymachine.mydomain.
The
pvnetpass tool can also be used by Windows clients to change their stored credentials that were saved when using the security login dialog. See also
Allow Client-Stored Credentials and
Prompt for Client Credentials, both in
Advanced Operations Guide.
Synopsis
pvnetpass [-g] {-a | -r | -m} server [-u user] [-p pwd]
pvnetpass -d
Options
-a | Adds a server entry for a user specified by the -u parameter. If no user is specified, current user is assumed. |
-d | Displays the list of configured servers. The configured servers will display in two groups that are separated by a dashed line. The ones above the line are global entries and are only viewable by administrators who are a member of group pvsw. The ones below the line are the current user’s entries. If you have a global and a user entry for the same server, the user’s entry overrides the global. |
-g | Manipulates default settings for all users. Settings created with -g can be overridden by individual users. |
-m | Modifies a server entry for a user specified by the -u parameter. If no user is specified, current user is assumed. |
-p | Specifies the password for the user. If not provided, pvnetpass prompts for a password. |
-r | Removes a server entry for a user specified by the -u parameter. If no user is specified, current user is assumed. |
server | Server, local or remote, to which you want to add a connection entry. Server can be '*' (include the single quotes) to set the default server entry information. This default entry is used when there is no user entry for the server. |
-u | Specifies the name of the user. If -u is not specified, your current user name will be used. |
See Also
Examples
From current user to all servers (overrides -g)
pvnetpass -a '*' -p password
From current user to one server 'myserver' (overrides -g)
pvnetpass -a myserver -p password
From all users (-g) to one server 'myserver' using credentials joe:password
pvnetpass -g -a myserver -u joe -p password
From all users (-g) to all servers ('*'), use default credentials joe:password
pvnetpass -g -a '*' -u joe -p password
To add user ‘acctadmin’ with password ‘88sJkE5’ to the local server named ‘sles2HR’:
pvnetpass -a sles2HR -u acctadmin -p p88sJkE5
To add user ‘bholly’ with password ‘peggysue’ to a remote server named ‘myserver’:
pvnetpass -a myserver -u bholly -p peggysue
To verify your entry was accepted, use the -d option:
pvnetpass -d
This command results in:
Server: myserver
User: bholly
Password: (not displayed)
To change the password with which you will connect to ‘myserver’ from your Linux or macOS client:
pvnetpass -m myserver -u bholly -p newpassword
To remove the entry for server ‘myserver’:
pvnetpass -r myserver
To add the default entry for users trying to connect to server ‘myserver’ when no user-specific entry exists:
pvnetpass -g -a myserver -u admin -p adminpassword
To add the default server entry in the user context (PS_HKEY_USER):
pvnetpass -a '*' -u admin -p adminpassword
To add the default server entry in the machine context (PS_HKEY_CONFIG):
pvnetpass -g -a '*' -u admin -p adminpassword
To authenticate from a Linux or macOS client to a Windows domain server (myserver) with a domain named mydomain and a user named user1:
pvnetpass -a myserver -u mydomain\user1 -p user1password