OrangeFS Config File

The OrangeFS installation directory on the Build system will need an OrangeFS configuration file. You will enter basic information for this file in a program called pvfs2-genconfig. Once the configuration file has been created, you might need to make additional modifications (regarding security, for example) for the initial deployment.

After standard installation, consult Advanced Configuration > OrangeFS Configuration File for details on the options and values available for fine tuning the configuration file.

Creating the OrangeFS Configuration File

Automatically generate the configuration file using the pvfs2-genconfig tool:

/opt/orangefs/bin/pvfs2-genconfig /opt/orangefs/etc/orangefs-server.conf

The program presents a series of prompts to enter the required settings for your OrangeFS configuration file. Answer all the prompts to generate the configuration file in the etc directory of your OrangeFS installation. Following is a list of possible entries for these prompts:


Network protocol(s) the filesystem will use for communication. The choices are tcp, gm, mx, ib, and portals. Default is tcp. For multi-homed configurations, separate multiple protocols with commas (e.g. ib,tcp).

Each protocol has its own option(s) you will also need to specify. Those options are described below.


The pvfs2-genconfig script assumes that all servers will use the same port number, board number, or portal index.

Data Directory

Full path + directory name where each OrangeFS server will store its data.
Default: <path_to_orangefs_installation>/storage/data
Example: /opt/orangefs/storage/data

Metadata Directory

Full path + directory name where each OrangeFS server will store its metadata.
Default: <path_to_orangefs_installation>/storage/meta
Example: /opt/orangefs/storage/meta

Log File

Full path + file name where each server will write its log messages.
Default: /var/log/orangefs-server.log

Data Server Hostnames

Hostname of each OrangeFS data server (server on which data directory is located). This should be the value returned by the hostname command. Syntax is node1, node2, … or node{#-#,#,#}.
Default: localhost
Example: ofs{1-4}

Shared Data/Metadata Servers

Yes or no whether to use the list of servers entered above for metadata servers as well. If you enter no, you are prompted to enter a list of hostnames for metadata servers. The same rules apply as above.
Default: yes

Security Options

Options that display for security are based on the security mode you chose when you built OrangeFS. The three security modes are default, key-based, or certificate-based.


If you selected this security mode, you will not be prompted with any more security options.


Verify Server List

Asks (y/n) if you want to redisplay the server hostnames you entered.
Default: n

Standard installation, as configured above, places file system storage directories inside the OrangeFS installation directory under opt for portability. These directories can be located elsewhere for system optimization and larger space allocations. For detailed information on all options in the OrangeFS configuration file, see Advanced Configuration > OrangeFS Configuration File.


When you are finished running pvfs2-genconfig, the OrangeFS configuration file is saved to the file specified on the command line; otherwise, if no filename was specified, it is saved to <path_to_orangefs_installation>/etc/orangefs.conf (e.g. /opt/orangefs/etc/orangefs.conf).

The configuration file is a simple text file that can be opened and modified manually. While pvfs2-genconfig will query you about the most important options, default values are assigned to many additional options. You can consider changes for most of these defaults later after installation, when you can reference Advanced Configuration > OrangeFS Configuration File for performance-tuning and optimization.