Session parameters

Commands to view and manipulate the session parameters.

Session parameters can be set to their default values with reset.

Session parameters can be stored in files for reuse with load and save. When these commands are issued without filenames, they default to using the .d1client.conf file, located in the user’s home directory.

The full set of session parameters can be displayed with get and individual parameters can be displayed with get <pid> <file>.

Most of the session parameters are modified with set. The session parameters also contain an access control list. The access control list is manipulated with a separate set of commands.

An unset session parameter has its value displayed as None. A session parameter can either be a Boolean (True / False), numeric or string value. See set for more information on how to set session parameters.

In the following commands, session parameter is a parameter name taken from the Name column in the overview of session parameters.

reset

Set all session parameters to their default values, listed in the Default column in the overview of session parameters.

load [file]

Load session parameters from file. If file is not provided, defaults to .d1client.conf, located in the user’s home directory.

save [file]

Save session parameters to file. If file is not provided, defaults to .d1client.conf, located in the user’s home directory.

show [session parameter]

Display the value of a session parameter. If session parameter is not provided, display all session parameters.

set <session parameter> <value>

Set the value of a session parameter.

clear <session parameter>

Clear the value of a session parameter.

Overview of session parameters

Name	Default	Type	Description
CLI configuration
pretty	True	Boolean	Display XML with human friendly formatting
verbose	False	Boolean	Display more information
Node selection
dataone-url	SYSTEM DEFAULT	String	Node to which to connect for operations that access the DataONE Root CN
mn-url	https://localhost/mn/	String	Node to connect to for operations that access a DataONE MN
Slicing
start	0	Integer	First item to display for operations that display lists of items
count	SYSTEM DEFAULT	Integer	Maximum number of items to display for operations that display lists of items
Authentication
anonymous	True	Boolean	Ignore any installed certificates and connect anonymously
cert-path	None	String	Filesystem path to client certificate
key-path	None	String	Filesystem path to the client certificate private key. Not required if the certificate provided with certpath contains both the public and private keys
System Metadata
algorithm	SYSTEM DEFAULT	String	Checksum algorithm to use when calculating the checksum for a Science Data Object
authoritative-mn	None	String	Authoritative Member Node to use when generating System Metadata
origin-mn	None	String	Originating Member Node to use when generating System Metadata
format-id	None	String	ID for the Object Format to use when generating System Metadata
rights-holder	None	String	Subject of the rights holder to use when generating System Metadata
submitter	None	String	Subject of the submitter to use when generating System Metadata
Search
from-date	None	String	Start time used by operations that accept a time range
to-date	None	String	End time used by operations that accept a time range
search-format-id	None	String	Include only objects of this format
query	*:*	String	Query string (SOLR or Lucene query syntax) for searches
query-type	solr	String	Select search engine (currently, only SOLR is available)
Access Policy
Parameters managed by a separate set of commands.
Replication Policy
Parameters managed by a separate set of commands.