openpbs/doc/man8/pbs_password.8B

.\" Copyright (C) 1994-2018 Altair Engineering, Inc.
.\" For more information, contact Altair at www.altair.com.
.\"
.\" This file is part of the PBS Professional ("PBS Pro") software.
.\"
.\" Open Source License Information:
.\"
.\" PBS Pro is free software. You can redistribute it and/or modify it under the
.\" terms of the GNU Affero General Public License as published by the Free
.\" Software Foundation, either version 3 of the License, or (at your option) any
.\" later version.
.\"
.\" PBS Pro is distributed in the hope that it will be useful, but WITHOUT ANY
.\" WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
.\" FOR A PARTICULAR PURPOSE.
.\" See the GNU Affero General Public License for more details.
.\"
.\" You should have received a copy of the GNU Affero General Public License
.\" along with this program.  If not, see <http://www.gnu.org/licenses/>.
.\"
.\" Commercial License Information:
.\"
.\" For a copy of the commercial license terms and conditions,
.\" go to: (http://www.pbspro.com/UserArea/agreement.html)
.\" or contact the Altair Legal Department.
.\"
.\" Altair’s dual-license business model allows companies, individuals, and
.\" organizations to create proprietary derivative works of PBS Pro and
.\" distribute them - whether embedded or bundled with other software -
.\" under a commercial license agreement.
.\"
.\" Use of Altair’s trademarks, including but not limited to "PBS™",
.\" "PBS Professional®", and "PBS Pro™" and Altair’s logos is subject to Altair's
.\" trademark licensing policies.
.\"
.TH pbs_password 8B "23 October 2017" Local "PBS Professional"
.SH NAME
.B pbs_password 
\- set or update password of a PBS user
.SH SYNOPSIS
.B pbs_password 
[-d] [-r] [-s <server>] [<username>] 
.br
.B pbs_password 
--version

.SH DESCRIPTION
The
.B pbs_password
command is used to set or update the password of a PBS user.
The user does not have to have any jobs on the system.
.LP
Available on Windows and supported Linux x86 and x86_64 platforms only.
.LP
The 
.B pbs_password
command has no effect on running jobs.  Queued jobs use the new password.
.LP
The 
.B pbs_password 
command does not change the user's login password on the current host, only the 
password that is cached in PBS.
.LP
The
.B pbs_password
command encrypts the password obtained from the user before sending it to the PBS
server.

.B Required Privilege
.br
An unprivileged user can use the command to set or update their own password.

Root or Admin can use this command to set or update the password of another user.

.LP
.SH OPTIONS
.IP "(no options)" 15
The user executing this command is prompted for a new password.  This user's password 
credential on the default PBS server is updated to the prompted password.  Any user jobs previously held due to an invalid password are not released.

.IP "-d" 15   
Deletes password.  If 
.I username
is not specified, deletes the password of the current user.  If
.I username
is specified and the current user is root or Admin, deletes the password of the
specified user.

.IP "-r" 15
Any user jobs previously held due to an invalid password 
are released.

.IP "-s <server>" 15  
The 
.I server
where the password is to be changed.

.IP "<username>" 15
The password credential of user 
.I username
is updated to the prompted password.
If 
.I username
is not the current user, this action is only allowed if one of the following is true: 
.RS 
.IP "1." 5 
The current user is root or Admin
.IP "2." 5
User
.I username
has given the current user explicit access via the 
.I ruserok() 
mechanism: 
.RS 
.IP "a." 5
The hostname of the machine from which the 
current user is logged in appears in the server's hosts.equiv
file, or 

.IP "b." 5 
The current user has an entry in 
.I username's
HOMEDIR\\.rhosts file.
.RE
.RE
.RE
.RE
.LP
.IP "--version" 15
The 
.B pbs_password
command returns its PBS version information and exits.
This option can only be used alone.

.SH EXIT STATUS
.IP " 0" 15
Success
.IP "-1" 15
single_signon_password_enable not set
.IP "-2" 15
Password of username on server failed to be created/updated
.IP "-3" 15
Failed to release jobs held due to bad password owned by 
username on server
.IP "-4" 15
Failed to delete password of username on server
.IP "-5" 15
Current user not authorized to change password of 
.I username
.SH SEE ALSO
qhold(1B), qrls(1B), qselect(1B), ruserok()