| .\" Man page generated from reStructuredText. |
| . |
| .TH RDMA-NDD 8 "@BUILD_DATE@" "" "OpenIB Diagnostics" |
| .SH NAME |
| RDMA-NDD \- RDMA device Node Description update daemon |
| . |
| .nr rst2man-indent-level 0 |
| . |
| .de1 rstReportMargin |
| \\$1 \\n[an-margin] |
| level \\n[rst2man-indent-level] |
| level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] |
| - |
| \\n[rst2man-indent0] |
| \\n[rst2man-indent1] |
| \\n[rst2man-indent2] |
| .. |
| .de1 INDENT |
| .\" .rstReportMargin pre: |
| . RS \\$1 |
| . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] |
| . nr rst2man-indent-level +1 |
| .\" .rstReportMargin post: |
| .. |
| .de UNINDENT |
| . RE |
| .\" indent \\n[an-margin] |
| .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] |
| .nr rst2man-indent-level -1 |
| .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] |
| .in \\n[rst2man-indent\\n[rst2man-indent-level]]u |
| .. |
| .SH SYNOPSIS |
| .sp |
| rdma\-ndd <options> |
| .SH DESCRIPTION |
| .sp |
| rdma\-ndd is a system daemon which watches for rdma device changes and/or |
| hostname changes and updates the Node Description of the rdma devices based on |
| those changes. |
| .SH DETAILS |
| .sp |
| Full operation of this daemon requires kernels which support polling of the |
| procfs hostname file as well as libudev. |
| .sp |
| If your system does not support either of these features, the daemon will set |
| the Node Descriptions at start up and then sleep forever. |
| .SS Node Description configuration |
| .sp |
| The daemon uses the environment variable RDMA_NDD_ND_FORMAT to set the node |
| description. The following wild cards can be specified for more dynamic |
| control. |
| .sp |
| %h \-\- replace with the current hostname (not including domain) |
| .sp |
| %d \-\- replace with the device name (for example mlx4_0, qib0, etc.) |
| .sp |
| If not specified the default is "%h %d". |
| .sp |
| NOTE: At startup, and on new device detection, the Node Description is always |
| written to ensure the SM and rdma\-ndd are in sync. Subsequent events will only |
| write the Node Description on a device if it has changed. |
| .SS Using systemd |
| .sp |
| Setting the environment variable for the daemon is normally be done via a |
| systemd drop in unit. For example the following could be added to a file named |
| /etc/systemd/system/rdma\-ndd.service.d/nd\-format.conf to use only the |
| hostname as your node description. |
| .sp |
| [Service] |
| Environment="RDMA_NDD_ND_FORMAT=%%h" |
| .sp |
| NOTE: Systemd requires an extra \(aq%\(aq. |
| .SH OPTIONS |
| .sp |
| \fB\-f, \-\-foreground\fP |
| Run in the foreground instead of as a daemon |
| .sp |
| \fB\-d, \-\-debug\fP |
| Log additional debugging information to syslog |
| .sp |
| \fB\-\-systemd\fP |
| Enable systemd integration. |
| .SH AUTHOR |
| .INDENT 0.0 |
| .TP |
| .B Ira Weiny |
| < \fI\%ira.weiny@intel.com\fP > |
| .UNINDENT |
| .\" Generated by docutils manpage writer. |
| . |
