NOVA-API-METADATA(1)

πŸ“¦
version 29.2.0 Β· 5 versions
, in ubuntu noble

πŸ’– NOVA-API-METADATA πŸ’–

okay bestie, sit down, hydrate, because this is the manual page for nova-api-metadata from the nova manual, section 1, and it's literally the moment. no cap. 🫢


🌸 NAME 🌸

nova-api-metadata β€” the server for the OpenStack Compute metadata API service. that's it, that's the girl. πŸ‘‘


✨ SYNOPSIS ✨

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

πŸ¦‹ DESCRIPTION πŸ¦‹

nova-api-metadata is a server daemon that serves the Nova Metadata API. main character energy, fr fr. πŸ’…

and here's the tea: this daemon routes database requests via the nova-conductor service, so there are some considerations about using this in a multi-cell layout. not me warning you about the multi-cell layout before you even start β€” iykyk. 🌈


πŸŽ€ 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. and listen β€” this option must be set from the command-line. no exceptions bestie. 😀
  • --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. periodt.
  • --debug, -d β€” set the logging level to DEBUG instead of the default INFO level. yes, she's loud. that's the point. πŸ”₯
  • --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. heads up though: 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). it's giving "one source of truth". πŸ’€
  • --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. the chill version. πŸ™ˆ
  • --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. very systemd-coded of her. ✨
  • --use-json β€” use JSON formatting for logging. this option is ignored if log_config_append is set. structured queen. πŸ“
  • --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. quick lil flex and she's gone. πŸ‘‹
  • --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. she's watching. always watching. πŸ‘€

πŸ› 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. 😭 fr fr, that's a real warning, not a vibe.
  • --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. same warning, same energy, do not ignore it. 🚨

πŸ—‚οΈ 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(1), nova-api-os-compute(1)

go read your siblings, they're iconic too. πŸ’•


🐞 BUGS 🐞

  • Nova bugs are managed at Launchpad

πŸ’Œ AUTHOR πŸ’Œ

openstack@lists.openstack.org


2010-present, OpenStack Foundation


okay that's the whole page bestie, every single flag accounted for, nothing skipped, you're welcome 🫢

and that's a wrap! this was nova-api-metadata, version 29.2.0, dated Jun 10, 2026 β€” go forth and serve that metadata API, you absolute legend. mwah. πŸ’–βœ¨

πŸ“¦ where this page comes from