OS Manuals

/usr/bin/neutron-db-manage

Neutron networking API server (Kolla neutron-server)

From openstack-neutron-2026.1-server 28.0.2_git20261109-r0 (enterprise-packages), captured 2026-11-09 by running neutron-db-manage --help (exit 0). permalink

usage: neutron-db-manage [-h] [--config-dir DIR] [--config-file PATH]
                         [--shell_completion SHELL_COMPLETION] [--subproject SUBPROJECT]
                         [--database-connection DATABASE_CONNECTION]
                         [--database-engine DATABASE_ENGINE]
                         {current,history,branches,heads,check_migration,upgrade,downgrade,stamp,revision,has_offline_migrations} ...

options:
  -h, --help            show this help message and exit
  --config-dir DIR      Path to a config directory to pull `*.conf` files from. This file set is
                        sorted, so as to provide a predictable parse order if individual options
                        are over-ridden. The set is parsed after the file(s) specified via
                        previous --config-file, arguments hence over-ridden options in the
                        directory take precedence. This option must be set from the command-line.
  --config-file PATH    Path to a config file to use. Multiple config files can be specified, with
                        values in later files taking precedence. Defaults to None. This option
                        must be set from the command-line.
  --shell_completion SHELL_COMPLETION
                        Display a shell completion script Allowed values: bash, zsh
  --subproject SUBPROJECT
                        The subproject to execute the command against. Can be one of: 'tap-as-a-
                        service', 'neutron-vpnaas', 'neutron-fwaas', 'neutron-dynamic-routing',
                        'neutron', 'networking-sfc'. Allowed values: tap-as-a-service, neutron-
                        vpnaas, neutron-fwaas, neutron-dynamic-routing, neutron, networking-sfc

Command:
  {current,history,branches,heads,check_migration,upgrade,downgrade,stamp,revision,has_offline_migrations}
                        Available commands
    current             Display the current revision for a database. :param config: a
                        :class:`.Config` instance. :param check_heads: Check if all head revisions
                        are applied to the database. Raises :class:`.DatabaseNotAtHead` if this is
                        not the case. .. versionadded:: 1.17.1 :param verbose: output in verbose
                        mode.
    history             List changeset scripts in chronological order. :param config: a
                        :class:`.Config` instance. :param rev_range: string revision range. :param
                        verbose: output in verbose mode. :param indicate_current: indicate current
                        revision.
    branches            Show current branch points. :param config: a :class:`.Config` instance.
                        :param verbose: output in verbose mode.
    heads               Show current available heads in the script directory. :param config: a
                        :class:`.Config` instance. :param verbose: output in verbose mode. :param
                        resolve_dependencies: treat dependency version as down revisions.
    check_migration     Show current branch points. :param config: a :class:`.Config` instance.
                        :param verbose: output in verbose mode. and validate head file
    upgrade             Upgrade to a later version. :param config: a :class:`.Config` instance.
                        :param revision: string revision target or range for --sql mode. May be
                        ``"heads"`` to target the most recent revision(s). :param sql: if True,
                        use ``--sql`` mode. :param tag: an arbitrary "tag" that can be intercepted
                        by custom ``env.py`` scripts via the
                        :meth:`.EnvironmentContext.get_tag_argument` method.
    downgrade           (No longer supported)
    stamp               'stamp' the revision table with the given revision; don't run any
                        migrations. :param config: a :class:`.Config` instance. :param revision:
                        target revision or list of revisions. May be a list to indicate stamping
                        of multiple branch heads; may be ``"base"`` to remove all revisions from
                        the table or ``"heads"`` to stamp the most recent revision(s). .. note::
                        this parameter is called "revisions" in the command line interface. :param
                        sql: use ``--sql`` mode :param tag: an arbitrary "tag" that can be
                        intercepted by custom ``env.py`` scripts via the
                        :class:`.EnvironmentContext.get_tag_argument` method. :param purge: delete
                        all entries in the version table before stamping.
    revision            Create a new revision file. :param config: a :class:`.Config` object.
                        :param message: string message to apply to the revision; this is the
                        ``-m`` option to ``alembic revision``. :param autogenerate: whether or not
                        to autogenerate the script from the database; this is the
                        ``--autogenerate`` option to ``alembic revision``. :param sql: whether to
                        dump the script out as a SQL string; when specified, the script is dumped
                        to stdout. This is the ``--sql`` option to ``alembic revision``. :param
                        head: head revision to build the new revision upon as a parent; this is
                        the ``--head`` option to ``alembic revision``. :param splice: whether or
                        not the new revision should be made into a new head of its own; is
                        required when the given ``head`` is not itself a head. This is the
                        ``--splice`` option to ``alembic revision``. :param branch_label: string
                        label to apply to the branch; this is the ``--branch-label`` option to
                        ``alembic revision``. :param version_path: string symbol identifying a
                        specific version path from the configuration; this is the ``--version-
                        path`` option to ``alembic revision``. :param rev_id: optional revision
                        identifier to use instead of having one generated; this is the ``--rev-
                        id`` option to ``alembic revision``. :param depends_on: optional list of
                        "depends on" identifiers; this is the ``--depends-on`` option to ``alembic
                        revision``. :param process_revision_directives: this is a callable that
                        takes the same form as the callable described at
                        :paramref:`.EnvironmentContext.configure.process_revision_directives`;
                        will be applied to the structure generated by the revision process where
                        it can be altered programmatically. Note that unlike all the other
                        parameters, this option is only available via programmatic use of
                        :func:`.command.revision`.
    has_offline_migrations
                        Determine whether there are pending migration scripts that require full
                        shutdown for all services that directly access database.

database options:
  --database-connection DATABASE_CONNECTION
                        URL to database
  --database-engine DATABASE_ENGINE
                        Database engine for which script will be generated when using offline
                        migration.
Options (7)
OptionDescriptionSource
-h, --helpshow this help message and exithelp
--config-dir DIRPath to a config directory to pull `*.conf` files from.help
--config-file PATHPath to a config file to use.help
--shell_completion SHELL_COMPLETIONDisplay a shell completion script Allowed values: bash, zshhelp
--subproject SUBPROJECTThe subproject to execute the command against.help
--database-connection DATABASE_CONNECTIONURL to databasehelp
--database-engine DATABASE_ENGINEDatabase engine for which script will be generated when using offline migration.help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.