Logging into IPLM
This section describes how to access Perforce IPLM and how to get help within the platform.
Supported browsers for IPLM Web
Always use updated browsers to access IPLM Web. The latest versions of these browsers are supported:
-
Chrome browser
-
Firefox browser
Logging into the Perforce IPLM Web client (IPLM Web)
Supported browsers and their minimum versions:
A Grade: Chrome 88; Firefox 70
B Grade: none
C Grade: Safari 14
Not supported: IE/Edge
IPLM Web communicates directly with both the PiServer and data management systems. IPLM Web runs on port :80 by default, but can be configured to any port or owner.
Accessing IPLM Web requires a user account to log into the Perforce IPLM Server, as shown below. Perforce IPLM credentials are used to log in to both IPLM CLI and IPLM Web.
Logging out of Perforce IPLM Web
To log out of Perforce IPLM from IPLM Web, click the username dropdown menu in the top right corner, and select Logout.
Troubleshooting login issues
If you are having issues logging into IPLM Web, see Login troubleshooting.
Command line
Logging in
To log in to Perforce IPLM from the command line, use the 'pi login' command:
> pi login -h Usage: pi login [-h] [--pw PASSWORD] [username] Description: Authenticate with the Perforce IPLM server. The login command enables a User to access Perforce IPLM using the "pi" command. The login is valid until it expires or the User logs out. When a User logs in to Perforce IPLM, they are prompted for a password. Perforce IPLM uses LDAP for authentication so the User's normal login password is expected. Positional arguments: username The User's login name Optional arguments: --pw PASSWORD Provide a password. Not recommended -h, --help Show this help message and exit
Example login:
> pi login mdx Password: Successfully logged in as 'mdx'.
Logging out
To log out of Perforce IPLM, use the 'pi logout' command:
> pi logout -h Usage: pi logout [-h] [username] Description: Logout from the Perforce IPLM server. The logout command disables access to Perforce IPLM until the User logs back in. Positional arguments: username The User's login name Optional arguments: -h, --help Show this help message and exit
Example logout:
> pi logout Successfully logged out.
Changing a user's password (local users only)
The 'pi passwd' command can be used to set a local user's password, defined in Perforce IPLM via the 'pi user add' command. In most cases, Perforce IPLM users and groups are defined externally via LDAP or another similar mechanism, so authentication is done through the same system and the 'pi passwd' command is not widely used.
> pi passwd -h
Usage: pi passwd [-h] [username]
Description: Change a User password. The password command enables a User to
modify their password, or for an Administrator to modify another User's
password.
Positional arguments:
username The User whose password must be changed. Default is the User
currently logged in.
Optional arguments:
-h, --help Show this help message and exit
Example 'pi passwd' output:
> pi passwd mdx Changing password for User 'mdx'. Current password: Enter new password: Retype new password: Successfully changed password for User 'mdx'.
After changing the password, the user account is logged out and must log in again with the new password to continue using the Perforce IPLM platform.
Getting help
The Perforce IPLM Command Line help can be accessed using the "-h" flag with various pi commands and sub-commands. To see a top level list of all available sub-commands, use the following:
> pi -h
Usage: pi [-h] [--picache PICACHE] [--piserver PISERVER] [--project PROJECT]
SUBCOMMAND ...
Optional arguments:
--picache PICACHE Specify the IPLM Cache server to connect to
--piserver PISERVER, -s PISERVER
Specify the PiServer to connect to
--project PROJECT Specify the Project
-h, --help Show this help message and exit
Available sub-commands:
SUBCOMMAND
alias Commands related to Aliases.
dmtype (dm) Commands related to DM Types.
group Commands related to Groups.
integrate (merge) Merge another IPV's resources into your Workspace.
ip Commands related to IP.
label Manipulate and list Labels.
library (lib) Commands related to Libraries.
license (lic) Commands related to Licenses.
login Authenticate with the Perforce IPLM server.
logout Logout from the Perforce IPLM server.
passwd Change a User password.
perm Commands related to Permissions.
property (prop) Commands related to Properties.
property-set (propset)
Commands related to Property Sets.
query Commands related to Queries.
release (rel) Make a new release.
settings Show settings of configuration variables.
snapshot (snap) Commands related to Snapshots.
subscription (sub) Commands related to Subscriptions.
update (up) Update a Workspace.
user Commands related to Users.
version Report Pi Client and Server versions.
whoami Report who you are logged in as.
workspace (ws) Commands related to Workspaces.
Getting Help:
The -h or --help flag will display help specific to the arguments
preceding their position in the command line:
pi -h Display generic help about pi (this screen)
pi ip -h Display help about the ip sub-commands
pi ip load -h Display help about the ip load sub-command
pi ip -h load Display help about the ip sub-commands, NOT the
ip load sub-command
More information and documentation available at:
https://help.perforce.com/methodics/
Copyright © 2010-2025 Perforce, Inc.
To see the sub-commands of one of the top level commands use "-h" with the sub-command:
> pi ip -h
Usage: pi ip [-h] SUBCOMMAND ...
Description: Commands related to IP. These subcommands are used to add, edit,
delete and list information about IP.
Optional arguments:
-h, --help Show this help message and exit
Available sub-commands:
SUBCOMMAND
add Create a new IP.
attribute (attr) Commands related to IP, Line or IPV Attributes.
copy (cp) Create a new IP or new Line based on an existing IPV.
delete (del, remove, rm)
Delete an IP or a Line, along with all of its IPVs.
diff Compare two IPVs.
edit Edit an existing IP.
list (ls) List all matching IP.
load Load an IP into a Workspace.
local Create a local copy of an IP.
obliterate Obliterate an existing IP.
properties (prop) Edit the IP/IPV Properties on an existing IP.
publish Publish the given IPV to a IPLM Cache.
refer Switch an IP to refer mode.
rm-from-filelist Remove a file from the filelists of IPVs on a Line.
tree Display the hierarchy of the specified IPV.
usage Report on IPV usage by other IPVs.
More information and documentation available at:
https://help.perforce.com/methodics/
Copyright © 2010-2025 Perforce, Inc.
Help text is available down to the individual command level:
> pi ip add -h
Usage: pi ip add [-h] [--template TEMPLATE | identifier]
Description: Create a new IP. The command puts the IP specification into a
temporary file and invokes the editor specified by the EDITOR environment
variable. Saving the file adds the IP.
Positional arguments:
identifier The name of the IP being created.
Optional arguments:
--template TEMPLATE, -t TEMPLATE
Use the specified template to add the IP. The template
is an ASCII file that defines the IP. This can be used
to add IP with a script and avoid the interactive
editor. To read the template from STDIN, set
TEMPLATE='-'.
-h, --help Show this help message and exit
Examples:
# Invoke the editor to create IP mmu.
pi ip add mmu
# Create IP using the mmu.info template.
pi ip add -t mmu.info
# Create IP using redirected STDOUT from script new_ip.py as template.
new_ip.py | pi ip add --template -
More information and documentation available at:
https://help.perforce.com/methodics/
Copyright © 2010-2025 Perforce, Inc.