.\" Automatically generated by Pandoc 1.19.2.4
.\"
.TH "fi_info" "1" "2020\-01\-30" "Libfabric Programmer\[aq]s Manual" "\@VERSION\@"
.hy
.SH NAME
.PP
fi_info \- Simple utility to query for fabric interfaces
.SH SYNOPSIS
.IP
.nf
\f[C]
\ fi_info\ [OPTIONS]
\f[]
.fi
.SH DESCRIPTION
.PP
The fi_info utility can be used to query for available fabric
interfaces.
The utility supports filtering based on a number of options such as
endpoint type, provider name, or supported modes.
Additionally, fi_info can also be used to discover the environment
variables that can be used to tune provider specific parameters.
If no filters are specified, then all available fabric interfaces for
all providers and endpoint types will be returned.
.SH OPTIONS
.SS Filtering
.TP
.B \f[I]\-n, \-\-node=<NAME>\f[]
Node name or address used to filter interfaces.
Only interfaces which can reach the given node or address will respond.
.RS
.RE
.TP
.B \f[I]\-P, \-\-port=<PORT>\f[]
Port number used to filter interfaces.
.RS
.RE
.TP
.B \f[I]\-c, \-\-caps=<CAP1|CAP2>..\f[]
Pipe separated list of capabilities used to filter interfaces.
Only interfaces supporting all of the given capabilities will respond.
For more information on capabilities, see fi_getinfo(3).
.RS
.RE
.TP
.B \f[I]\-m, \-\-mode=<MOD1|MOD2>..\f[]
Pipe separated list of modes used to filter interfaces.
Only interfaces supporting all of the given modes will respond.
For more information on, modes see fi_getinfo(3).
.RS
.RE
.TP
.B \f[I]\-t, \-\-ep_type=<EPTYPE>\f[]
Specifies the type of fabric interface communication desired.
For example, specifying FI_EP_DGRAM would return only interfaces which
support unreliable datagram.
For more information on endpoint types, see fi_endpoint(3).
.RS
.RE
.TP
.B \f[I]\-a, \-\-addr_format=<FMT>\f[]
Filter fabric interfaces by their address format.
For example, specifying FI_SOCKADDR_IN would return only interfaces
which use sockaddr_in structures for addressing.
For more information on address formats, see fi_getinfo(3).
.RS
.RE
.TP
.B \f[I]\-p, \-\-provider=<PROV>\f[]
Filter fabric interfaces by the provider implementation.
For a list of providers, see the \f[C]\-\-list\f[] option.
.RS
.RE
.TP
.B \f[I]\-d, \-\-domain=<DOMAIN>\f[]
Filter interfaces to only those with the given domain name.
.RS
.RE
.TP
.B \f[I]\-f, \-\-fabric=<FABRIC>\f[]
Filter interfaces to only those with the given fabric name.
.RS
.RE
.SS Discovery
.TP
.B \f[I]\-e, \-\-env\f[]
List libfabric related environment variables which can be used to enable
extra configuration or tuning.
.RS
.RE
.TP
.B *\-g [filter]
Same as \-e option, with output limited to environment variables
containing filter as a substring.
.RS
.RE
.TP
.B \f[I]\-l, \-\-list\f[]
List available libfabric providers.
.RS
.RE
.TP
.B \f[I]\-v, \-\-verbose\f[]
By default, fi_info will display a summary of each of the interfaces
discovered.
If the verbose option is enabled, then all of the contents of the
fi_info structure are displayed.
For more information on the data contained in the fi_info structure, see
fi_getinfo(3).
.RS
.RE
.TP
.B \f[I]\-\-version\f[]
Display versioning information.
.RS
.RE
.SH USAGE EXAMPLES
.IP
.nf
\f[C]
$\ fi_info\ \-n\ 30.0.11.1\ \-p\ usnic\ \-t\ FI_EP_DGRAM
\f[]
.fi
.PP
This will respond with all fabric interfaces that can reach address
30.0.11.1 using endpoint type FI_EP_DGRAM with the usNIC provider.
.SH OUTPUT
.PP
By default fi_info will output a summary of the fabric interfaces
discovered:
.IP
.nf
\f[C]
$\ ./fi_info\ \-n\ 30.0.11.1\ \-p\ usnic\ \-t\ FI_EP_DGRAM
provider:\ usnic
\ \ \ \ fabric:\ 30.0.11.0/24
\ \ \ \ domain:\ usnic_2
\ \ \ \ version:\ 1.0
\ \ \ \ type:\ FI_EP_DGRAM
\ \ \ \ protocol:\ FI_PROTO_UDP
\f[]
.fi
.PP
To see the full fi_info structure, specify the \f[C]\-v\f[] option.
.SH SEE ALSO
.PP
\f[C]fi_getinfo(3)\f[], \f[C]fi_endpoint(3)\f[]
.SH AUTHORS
OpenFabrics.