# stafd.conf

stafd.conf

5

stafd.conf

stafd

8 configuration file

`/etc/stas/stafd.conf`

## Description

When

stafd

8 starts up, it reads its configuration from `stafd.conf`.

## Configuration File Format

`stafd.conf` is a plain text file divided into sections, with configuration entries in the style `key`=`value`. Spaces immediately before or after the `=` are ignored. Empty lines are ignored as well as lines starting with `#`, which may be used for commenting.

## Options

### [Global] section

The following options are available in the `[Global]` section:

`ignore-iface=`

- Takes a boolean argument. This option controls how connections with Discovery Controllers (DC) are made.

  DCs are automatically discovered using DNS-SD/mDNS. mDNS provides the DC's IP address and the interface on which the DC was discovered.

  There is no guarantee that there will be a route to reach that DC. However, we can use the socket option SO_BINDTODEVICE to force the connection to be made on a specific interface instead of letting the routing tables decide where to make the connection.

  This option determines whether `stafd` will use SO_BINDTODEVICE to force connections on an interface or just rely on the routing tables. The default is to use SO_BINDTODEVICE, in other words, `stafd` does not ignore the interface by default.

  Defaults to `false`.

`pleo=`

- Port Local Entries Only. Takes a string argument `enabled` or `disabled`. This option is sent in the LSP field (Log SPecific) of the Get Discovery Log Page (DLP) command. It is used by `stafd` to tell Discovery Controllers (DC) whether the response to a Get DLP command should contain all the NVM subsystems or only those reachable by the host on the interface where the Get DLP command was issued by the host.

  This parameter was introduced in TP8010. When `pleo=``enabled`, then the DC shall return records for only NVM subsystem ports that are presented through the same NVM subsystem port that received the Get Log Page command. When `pleo=``disabled`, then the DC may return all the NVM subsystem ports that it holds, even those that can only be reached on NVM subsystem ports that did not receive the Get Log Page command. In other words, the host may not even be able to reach those subsystems.

  Defaults to `enabled`.

### [Service Discovery] section

The following options are available in the `[Service Discovery]` section:

`zeroconf=`

- Enable zeroconf provisioning using DNS-SD/mDNS. Takes a string argument `enabled` or `disabled`.

  When `enabled`, the default, `stafd` makes a request with the Avahi daemon to locate Discovery Controllers using DNS-SD/mDNS.

  Discovery Controllers that support zeroconf advertize themselves over mDNS with the service type `_nvme-disc._tcp`.

  Defaults to `true`.

### [Discovery controller connection management] section

The following options are available in the `[Discovery controller connection management]` section:

`persistent-connections=`

- Takes a boolean argument. Whether connections to Discovery Controllers (DC) are persistent. When true, connections initiated by stafd will persists even when stafd is stopped. When `false`, `stafd` will disconnect from all DCs it is connected to on exit.

  Defaults to `false`.

`zeroconf-connections-persistence=`

- Takes a unit-less value in seconds, or a time span value such as "72hours" or "5days". A value of 0 means no persistence. In other words, configuration acquired through zeroconf (mDNS service discovery) will be removed immediately when mDNS no longer reports the presence of a Discovery Controller (DC) and connectivity to that DC is lost. A value of -1 means that configuration acquired through zeroconf will persist forever.

  This is used for the case where a DC that was discovered through mDNS service discovery no longer advertises itself through mDNS and can no longer be connected to. For example, the DC had some catastrophic failure (e.g. power surge) and needs to be replaced. In that case, the connection to that DC can never be restored and a replacement DC will be needed. The replacement DC will likely have a different NQN (or IP address). In that scenario, the host won't be able to determine that the old DC is not coming back. It won't know either that a newly discovered DC is really the replacement for the old one. For that reason, the host needs a way to "age" zeroconf-acquired configuration and remove it automatically after a certain amount of time. This is what this parameter is for.

  Defaults to `72hours`.

## See Also

stafd

8