Commands ¶

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

Also see overview of session variables.

load [file]¶

Load session variables from file

load (without parameters): Load session from default file ~/.dataone_cli.conf

load <file>: Load session from specified file

save [config_file]¶

Save session variables to file

save (without parameters): Save session to default file ~/.dataone_cli.conf

save <file>: Save session to specified file

reset ¶

Set all session variables to their default values

The defaults are listed in the Default column in the overview of session variables.

Session, Access Control ¶

The Access Policy is a list of subjects and their associated access levels. The Access Policy is applied to new objects as they are created. The Access Policy can also be updated on existing Science Data Objects with updateaccess <identifier> [identifier …].

Use the set [variable [value]] command without any parameters to view the current Access Policy.

allowaccess <subject> [access level]¶

Set the access level for subject

Access level is read, write` or changePermission.

Access level defaults to read if not specified.

Special subjects:

public: Any subject, authenticated and not authenticated

authenticatedUser: Any subject that has authenticated with CILogon

verifiedUser: Any subject that has authenticated with CILogon and has been verified by DataONE

Any access level implicitly includes less permissive levels. E.g., giving changePermission to a subject implicitly gives read and write permissions as well.

To make objects accessible to the general public, give read access to the public user. In some cases, it is desirable to obtain log records that include information about who accessed a given object while still making the object publicly accessible. This can be accomplished by giving read access only to authenticatedUser. Access higher than read should not be given to any of the special subjects.

denyaccess <subject>¶

Remove subject from Access Policy.

clearaccess ¶

Remove all subjects from Access Policy.

Only the submitter will have access to the object.

Session, Replication Policy ¶

allowrep ¶

Allow new objects to be replicated

denyrep ¶

Prevent new objects from being replicated

preferrep <member node> [member node …]¶

Add one or more preferred Member Nodes to replication policy

blockrep <member node> [member node …]¶

Add Member Node to list of blocked replication targets.

removerep <member node> [member node …]¶

Remove Member Node from list of preferred or blocked replication targets.

numberrep <number of replicas>¶

Set preferred number of replicas for new objects

If the preferred number of replicas is set to zero, replication is also disallowed.

clearrep ¶

Set the replication policy to default

The default replication policy has no preferred or blocked member nodes, allows replication and sets the preferred number of replicas to 3.

Read Operations ¶

Commands that cause read operations to be issued against Coordinating Nodes and Member Nodes.

Commands for retrieving Science Data Objects, System Metadata and related information.

get <identifier> <file>¶

Get an object from a Member Node

The object is saved to file.

Active session variables: mn-url, Authentication

meta <identifier> [file]¶

Get the System Metadata that is associated with a Science Object

If the metadata is not on the Coordinating Node, the Member Node is checked.

Provide file to save the System Metada to disk instead of displaying it.

Active session variables: cn-url, Authentication

list ¶

Retrieve a list of available Science Data Objects from Member Node

The response is filtered by the from-date, to-date, search, start and count session variables.

Active session variables: mn-url, start, count, from-date, to-date, search-format-id, Authentication

log ¶

Retrieve event log from Member Node

The response is filtered by the from-date, to-date, start and count session parameters.

Active session variables: mn-url, start, count, from-date, to-date, search-format-id, Authentication

resolve <pid>¶

Find all locations from which the given Science Object can be downloaded.

Active session variables: cn-url, Authentication

Write Operations ¶

Commands that cause write operations to be issued against Coordinating Nodes and Member Nodes.

create <pid> <file>¶

Create a new Science Object on a Member Node.

The System Metadata that becomes associated with the new Science Object is generated from the session variables.

The algorithm set in algorithm is used for calculating the checksum for the new object. If the value is unset, it defaults to the DataONE system wide default, which is currently SHA1.

Active session variables: mn-url, format-id, submitter, rights-holder, origin-mn, authoritative-mn, algorithm, Access Policy, Replication Policy, Authentication

update <old-pid> <new-pid> <file>¶

Replace an existing Science Object in a MN with another.

The existing Science Object becomes obsoleted by the new Science Object. obsoleted by the new values in the System Metadata, Access Policy and Replication Policy session variables.

The algorithm set in algorithm is used for calculating the checksum for the new object. If the value is unset, it defaults to the DataONE system wide default, which is currently SHA1.

Active session variables: mn-url, format-id, submitter, rights-holder, origin-mn, authoritative-mn, algorithm, Access Policy, Replication Policy, Authentication

package <package-pid> <science-metadata-pid> <science-pid> [science-pid …]¶

Create a simple OAI-ORE Resource Map on a Member Node

archive <identifier> [identifier …]¶

Mark one or more existing Science Objects as archived

updateaccess <identifier> [identifier …]¶

Update the Access Policy on one or more existing Science Data Objects

Requires that the calling subject has authenticated and has changePermission access level on the object for which Access Policy is to be updated.

Active session variables: cn-url, Authentication, Access Policy

updatereplication <identifier> [identifier …]¶

Update the Replication Policy on one or more existing Science Data Objects

Requires that the calling subject has authenticated and has changePermission access level on the object for which Replication Policy is to be updated.

Active session variables: cn-url, Replication Policy, Authentication

See https://releases.dataone.org/online/api-documentation-v2.0.1/design/SearchMetadata.html for the available search terms.

run ¶

Perform each operation in the queue of write operations

edit ¶

Edit the queue of write operations

clearqueue ¶

Remove the operations in the queue of write operations without performing them