You are here: Database Administration > Backing Up and Restoring Databases > Using Online Snapshot Backup > Command Format for Starting a Snapshot Manager

Command Format for Starting a Snapshot Manager

To start a snapshot storage manager (SSM), you invoke the nuodbmgr command start process ssm:

start process ssm
      database db_name 
      host host[:port]
      archive archive_dir
      [snapshotArchive snapshot_dir]
      [initialize {true | false}]
      [options other_options]

Option Description

Option Description
database db_name Required. Specify the name of the database that this SSM will be part of.
host host[:port]

Required. Specify the host machine for the SSM you are starting.

You can optionally specify the port on which the SSM will listen.

archive archive_dir

Required. Specify the directory in which the SSM will store its archive. The user that NuoDB runs as must have read, write and execute permission on the directory you specify.

The directory you specify must be in the SSM's host file system. The directory location cannot be in S3.

The default location of an SSM's journal is in the SSM's archive directory. To specify a different location, specify ‑‑journal-dir /path/to/journal as an option in the options other_options parameter.

If you previously executed the nuodbmgr hotcopy command on an SSM, then you can specify the archive directory that was the result of that operation. Hot copy of an SSM provides directories that are suitable for starting an SSM.
snapshotArchive snapshot_dir

Optionally specify the directory in which this SSM stores database snapshots. The user that NuoDB runs as must have read, write and execute permission on a directory you specify.

The directory you specify must be in the SSM's file system. The directory location cannot be in S3. The default is the database's archive directory. Alternatively, you can specify the --snapshot-archive database option with the name of a directory. See Database Options.

[initialize {true | false}]

Optional. The default is false. You must specify true when, and only when, the SSM archive directory does not yet exist or is empty. In all other situations, this option must be false.

[options other_options]

Optional.  You can specify other database options. There must be two hyphens before each option you specify. Insert a space between consecutive options. If you are using the ‑‑command format, enclose the option setting in single quotation marks. For example, to use the ‑‑command format to change the minimum number of snapshots that an albumA snapshot storage manager uses albums to efficiently manage snapshots. An album refers to a set of snapshots taken during some period of time. Also, an album provides a place to store additional state required to use snapshots. must contain before the SSM starts saving snapshots in a new album and to also change the maximum number of snapshots that can be in an album, specify the following:

options '--snapshot-min-size 50 --snapshot-max-size 200'