PiCLI environment

Learn how to view the current configuration of the Helix IPLM environment from the command line interface (PiCLI). 

Viewing the Helix IPLM configuration

The 'pi settings' output lists the possible configuration options, their values, and what the source of the settings are. Settings denoted 'Env var' have been set by environment variables (see Helix IPLM environment variables), and settings denoted 'Config' are set by the '$MDX_CONFIG_DIR/piclient.conf' configuration file. See Workspace configuration for more information on piclient.conf settings.

If a configuration item is set in multiple locations, the following precedence is used, where each subsequent level overrides the one before it:

1. Program default settings

2. piclient.conf

3. Environmental options

4. CLI args

pi settings

The 'pi settings' command can be used to view the overall Helix IPLM configuration.

> pi settings -h
Usage: pi settings [-h] [--format {json,long}]

Description: Show settings of configuration variables. This command will
display the current configuration after evaluating all configuration files,
environment variables and command line overrides. It is useful for debug.

Optional arguments:
  --format {json,long}  Return the results using the specified data structure.
  -h, --help            Show this help message and exit

Example output of 'pi settings'

> pi settings
You are logged in as 'admin'.

MDX_CONFIG_DIR 			Env var 	/usr/share/mdx/config
MDX_MAX_LIST_RECORDS_LIMIT 		Unset
MDX_PI_ASCII 				Config 		False
MDX_PI_COMPRESS 			Default 	False
MDX_PI_SERVER 				Env var 	http://methodicsiplm:8080
MDX_PI_TIME_FORMAT 			Config 		%Y-%m-%d %H:%M:%S %z %Z
MDX_PROJECT 				Unset
MDX_WORKSPACE_MANAGER 			Config 		PWM
MDX_PWM_CDSLIB_DIR 			Unset
MDX_PWM_CLIENT_FORMAT 			Default 	ws:{user}:{lib_ip}:{wsid}
MDX_PWM_DEFINE_CDSLIB 			Config 		.:cds/*
MDX_PWM_INCLUDE_CDSLIB 		Config 		cds.lib
MDX_PWM_P4_SYNC_BATCHSIZE 		Default 	2000
MDX_PWM_POST_REFERENCE_CDSLIB 		Config 		/mdx/tools/cds/IC617/share/cdssetup/dfII/cds.lib
MDX_PWM_PRE_REFERENCE_CDSLIB 		Unset
MDX_PWM_TEMPLATE_CLIENT 		Unset
MDX_PWM_UNDEFINE_CDSLIB 		Unset
MDX_PWM_WORKSPACE_CDSLIB 		Unset
MDX_PWM_WORK_LINK 			Config 		$VSC_INSTALL_DIR/config/cadence/dot_cdsinit:cds_run/.cdsinit,$VSC_INSTALL_DIR/config/cadence/cdsLibMgr.il:cds_run/cdsLibMgr.il,cds.lib:cds_run/cds.lib
MDX_PICACHE_BIC_DIR 			Unset
MDX_PICACHE_COMPRESSION 		Unset
MDX_PICACHE_DATA_WAIT_TIME 		Default 	10
MDX_PICACHE_SERVER 			Env var 	picache:5000

IPLM Cache Server configuration:
Root 				/picache-root
Server Version 		1.8.3
Site 				minneapolis
 

pi whoami

The 'pi whoami' command reports the user account running the command. 

> pi whoami -h
Usage: pi whoami [-h] [--format {json}]

Description: Report who you are logged in as.

Optional arguments:
  --format {json}  Return the results using the specified data format.
  -h, --help       Show this help message and exit

Example output of 'pi whoami':

> pi whoami
You are logged in as 'admin'.

pi version

The 'pi version' command reports the current versions of PiServer, PiCLI, and IPLM Cache.

> pi version -h
Usage: pi version [-h]

Description: Report Pi Client and Server versions.

Optional arguments:
  -h, --help  Show this help message and exit

Example output of 'pi version'

> pi version 
PiServer version : 3.0.5
PiClient version : 3.0.5
IPLM Cache version : 1.8.3

Helix IPLM environment variables

The following tables list the minimum set of configuration variables required to configure Helix IPLM. These settings (other than $MDX_CONFIG_DIR) can also be set through the piclient.conf file (see Workspace Configuration) which should be placed in a directory pointed to by the $MDX_CONFIG_DIR variable.

export MDX_PI_SERVER=http://<my_servername>:8080

pi --piserver http://<myservername>:8080

export MDX_CONFIG_DIR=/usr/share/mdx/config

export MDX_PICACHE_SERVER=<my_PiCache_server>:5000

pi --picache <my_PiCache_server>:5000

export PATH=<path_to_picli>:$PATH

Perforce environment variables

export P4PORT=<my_servername>:1666

export P4CONFIG=.p4config

export PATH=/usr/share/mdx/products/piextras/perforce/current/bin:$PATH