heat/doc/source/man/heat-manage.rst
Angus Salkeld d08101eef6 Add a man page for heat-manage
Change-Id: I9b3d6b3b227ca2a2a2786837b941fdc420d3b2b6
Closes-bug: #1189651
2013-11-01 21:55:53 +11:00

1.1 KiB

heat-manage

heat-manage

SYNOPSIS

heat-manage <action> [options]

DESCRIPTION

heat-manage helps manage heat specific database operations.

OPTIONS

The standard pattern for executing a heat-manage command is: heat-manage <command> [<args>]

Run with -h to see a list of available commands: heat-manage -h

Commands are db_version, db_sync and purge_deleted. Detailed descriptions are below.

Heat Db version

heat-manage db_version

Print out the db schema revision.

heat-manage db_sync

Sync the database up to the most recent version.

heat-manage purge_deleted [-g {days,hours,minutes,seconds}] [age]

Purge db entries marked as deleted and older than [age].

FILES

The /etc/heat/heat.conf file contains global options which can be used to configure some aspects of heat-manage, for example the DB connection and logging.

BUGS