p4 admin
Synopsis
Perform administrative operations on the server.
Syntax
p4 [g-opts
] admin checkpoint [-z | -Z] [prefix
]
p4 [g-opts
] admin journal [-z] [prefix
]
p4 [g-opts
] admin stop
p4 [g-opts
] admin restart
p4 [g-opts
] admin updatespecdepot [-a | -s type
]
p4 [g-opts
] admin resetpassword -a | -u user
p4 [g-opts
] admin setldapusers
Description
The p4 admin command allows Perforce superusers to perform administrative tasks even when working from a different machine than the one running the shared Perforce service.
To stop the Perforce service, use p4 admin stop. This locks the database to ensure that it is in a consistent state upon restart, and then shuts down the Perforce background process.
To restart the service, use p4 admin restart. The database is locked, the service restarts, and any p4 configure settings that require a restart are then applied.
To take a checkpoint, use p4 admin checkpoint
[prefix
]. This is equivalent to
logging in to the server machine and taking a checkpoint with p4d
-jc [prefix
]. A checkpoint is taken
and the journal is copied to a numbered file. If a
prefix
is specified, the files are named
or
prefix
.ckp.n
respectively, where prefix
.jnl.n-1
n
is a sequence number. The
MD5 checksum of the checkpoint is written to a separate file,
checkpoint.
, and the
n
.md5lastCheckpointAction
counter is updated to reflect
successful completion.
You can store checkpoints and journals in the directory of your choice by
specifying the directory as part of the prefix. (Rotated journals are
stored in the P4ROOT
directory, regardless of the directory in which the current journal is
stored.) If no prefix
is specified, the default
filenames checkpoint.
and
n
journal.
are used.
n-1
The p4 admin journal command is equivalent to p4d -jj. For details, see the Perforce Server Administrator's Guide: Fundamentals. The files are created in the server root specified when the Perforce service was started.
The p4 admin updatespecdepot command causes the
Perforce service to archive stored forms (specifically,
client
, depot
,
branch
, label
,
typemap
, group
,
user
, and job
forms) into the spec
depot. If the -a
option is used, all of the form
specification types are archived. If the -s
option option
is used, then only those of the specified type
are archived. Only those forms that have not yet been archived are
created.
The p4 admin resetpassword command forces specified
users with existing passwords to change their passwords before they can
run another command. To force password reset of all users with passwords
(including the superuser who issued the command), use p4 admin
resetpassword -a. To force a single user to reset their
password, use p4 admin resetpassword -u
user
.
The p4 admin setldapusers command allows you to convert
all existing non-super users to use LDAP authentication. The command
changes the AuthMethod
field in the user specification
for each user from perforce
to ldap
.
If super
users want to use LDAP authentication, they
must set their AuthMethod
manually.
Options
|
For p4 admin updatespecdepot, update the spec depot with all current forms. |
|
For p4 admin updatespecdepot, update the spec
depot with forms of the specified type, where type is one of
|
|
For p4 admin checkpoint and p4
admin journal, save the checkpoint and saved journal
file in compressed (gzip) format, appending the
|
|
For p4 admin checkpoint and p4 admin
journal, save the checkpoint in compressed (gzip)
format, appending the |
|
See “Global Options”. |
Usage Notes
Can File Arguments Use Revision Specifier? |
Can File Arguments Use Revision Range? |
Minimal Access Level Required |
---|---|---|
N/A |
N/A |
|
-
The p4 admin updatespecdepot and p4 admin resetpassword commands require
super
access. The others require that the user be an operator (see p4 user) or havesuper
access. -
To require all newly-created users with passwords to reset their passwords before invoking their first command, set the
dm.user.resetpassword
configurable:p4 configure set dm.user.resetpassword=1
Running p4 admin resetpassword -a resets only the passwords of users who presently exist (and who have passwords).
-
Because p4 admin stop shuts down the Perforce service, you may see an error message indicating that the connection was closed unexpectedly. You can ignore this message.
-
The spec depot must exist before running p4 admin updatespecdepot.
-
p4 dbstat, p4 lockstat, and p4 logstat are standalone commands; the old p4 admin syntax remains as an alias for backward compatibility.
-
For more about administering Perforce, see the Perforce Server Administrator's Guide: Fundamentals and Perforce Server Administrator's Guide: Multi-site Deployment.
Examples
p4 admin stop |
Stop the shared Perforce service |
p4 admin checkpoint |
Create a checkpoint named
|
p4 admin checkpoint name |
Create a checkpoint named
|