---
name: "nova-api"
section: "1"
platform: "linux"
package: "nova-api"
version: "2:31.0.0-6+deb13u2"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/nova-api"
---

# nova-api(1)

Server for the OpenStack Compute API service.

## NAME

nova-api - Server for the OpenStack Compute API service.

## SYNOPSIS

```
nova-api [<options>...]
```

## DESCRIPTION

**nova-api** is a server daemon that serves the metadata and compute APIs in separate greenthreads.

## OPTIONS

General options

- **--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.

- **--debug, -d**

  Set the logging level to DEBUG instead of the default INFO level.

- **--log-config-append PATH, --log-config PATH, --log\_config PATH**

  The name of a logging configuration file. This file is appended to any existing logging configuration files.  For details about logging configuration files, see the Python logging module documentation. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log-date-format).

- **--log-date-format DATE\_FORMAT**

  Defines the format string for %(asctime)s in log records. Default: None . This option is ignored if log\_config\_append is set.

- **--log-dir LOG\_DIR, --logdir LOG\_DIR**

  (Optional) The base directory used for relative log\_file paths. This option is ignored if log\_config\_append is set.

- **--log-file PATH, --logfile PATH**

  (Optional) Name of log file to send logging output to.  If no default is set, logging will go to stderr as defined by use\_stderr. This option is ignored if log\_config\_append is set.

- **--nodebug**

  The inverse of *--debug*.

- **--nouse-journal**

  The inverse of *--use-journal*.

- **--nouse-json**

  The inverse of *--use-json*.

- **--nouse-syslog**

  The inverse of *--use-syslog*.

- **--nowatch-log-file**

  The inverse of *--watch-log-file*.

- **--syslog-log-facility SYSLOG\_LOG\_FACILITY**

  Syslog facility to receive log lines. This option is ignored if log\_config\_append is set.

- **--use-journal**

  Enable journald for logging. If running in a systemd environment you may wish to enable journal support.  Doing so will use the journal native protocol which includes structured metadata in addition to log messages.This option is ignored if log\_config\_append is set.

- **--use-json**

  Use JSON formatting for logging. This option is ignored if log\_config\_append is set.

- **--use-syslog**

  Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424.  This option is ignored if log\_config\_append is set.

- **--version**

  Show program's version number and exit

- **--watch-log-file**

  Uses logging handler designed to watch file system.  When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log\_file option is specified and Linux platform is used. This option is ignored if log\_config\_append is set.

Debugger options

- **--remote\_debug-host REMOTE\_DEBUG\_HOST**

  Debug host (IP or name) to connect to. This command line parameter is used when you want to connect to a nova service via a debugger running on a different host. Note that using the remote debug option changes how Nova uses the eventlet library to support async IO. This could result in failures that do not occur under normal operation. Use at your own risk.

- **--remote\_debug-port REMOTE\_DEBUG\_PORT**

  Debug port to connect to. This command line parameter allows you to specify the port you want to use to connect to a nova service via a debugger running on different host. Note that using the remote debug option changes how Nova uses the eventlet library to support async IO. This could result in failures that do not occur under normal operation. Use at your own risk.

## FILES

- •

  **/etc/nova/nova.conf**

- •

  **/etc/nova/api-paste.ini**

- •

  **/etc/nova/policy.yaml**

- •

  **/etc/nova/policy.d/**

- •

  **/etc/nova/rootwrap.conf**

- •

  **/etc/nova/rootwrap.d/**

## SEE ALSO

*nova-api-metadata(1)*, *nova-api-os-compute(1)*

## BUGS

- •

  Nova bugs are managed at *Launchpad*

## AUTHOR

openstack@lists.openstack.org

## COPYRIGHT

2010-present, OpenStack Foundation