umad_get_port(3) [debian man page]

UMAD_GET_PORT(3)					    OpenIB Programmer's Manual						  UMAD_GET_PORT(3)

NAME

       umad_get_port, umad_release_port - open and close an InfiniBand port

SYNOPSIS

       #include <infiniband/umad.h>

       int umad_get_port(char *ca_name, int portnum, umad_port_t *port);
       int umad_release_port(umad_port_t *port);

DESCRIPTION

       umad_get_port()	fills  the port structure with the IB port attributes specified by ca_name and portnum , or the default port if ca_name is
       NULL and portnum is zero. If only one of ca_name and portnum are specified, the other is used as a filter.  For	example,  passing  a  NULL
       ca_name	and  2 for the portnum means get a port from any of the local IB devices, as long as it is the second port.  Note that the library
       may use some reference scheme to support port caching therefore umad_release_port() should be called before the port structure can be deal-
       located.  The argument port is an umad_port_t struct, as specified in <infiniband/umad.h>.

       typedef struct umad_port {
	       char ca_name[UMAD_CA_NAME_LEN];		       /* Name of the device */
	       int portnum;				       /* Physical port number */
	       uint base_lid;				       /* Base port LID */
	       uint lmc;				       /* LMC of LID */
	       uint sm_lid;				       /* SM LID */
	       uint sm_sl;				       /* SM service level */
	       uint state;				       /* Logical port state */
	       uint phys_state; 			       /* Physical port state */
	       uint rate;				       /* Port link bit rate */
	       uint64_t capmask;			       /* Port capabilities */
	       uint64_t gid_prefix;			       /* Gid prefix of this port */
	       uint64_t port_guid;			       /* GUID of this port */
       } umad_port_t;

       umad_release_port() releases the resources that were allocated by the umad_get_port() function for the specified IB port.

RETURN VALUE

       umad_get_port() and umad_release_port() return 0 on success, and a negative value on error.

AUTHORS

       Hal Rosenstock <halr@voltaire.com>

       Dotan Barak <dotanb@mellanox.co.il>

OpenIB								   May 21, 2007 						  UMAD_GET_PORT(3)

IBSTAT(8)							OpenIB Diagnostics							 IBSTAT(8)

NAME

       ibstat - query basic status of InfiniBand device(s)

SYNOPSIS

       ibstat [-d(ebug)] [-l(ist_of_cas)] [-s(hort)] [-p(ort_list)] [-V(ersion)] [-h] <ca_name> [portnum]

DESCRIPTION

       ibstat  is  a binary which displays basic information obtained from the local IB driver. Output includes LID, SMLID, port state, link width
       active, and port physical state.

       It is similar to the ibstatus utility but implemented as a binary rather than a script. It has options to list CAs and/or  ports  and  dis-
       plays more information than ibstatus.

OPTIONS

       -l, --list_of_cas
	      list all IB devices

       -s, --short
	      short output

       -p, --port_list
	      show port list

       ca_name
	      InfiniBand device name

       portnum
	      port number of InfiniBand device

COMMON OPTIONS

       Most  OpenIB  diagnostics  take the following common flags. The exact list of supported flags per utility can be found in the usage message
       and can be shown using the util_name -h syntax.

       # Debugging flags

       -d      raise the IB debugging level.
	       May be used several times (-ddd or -d -d -d).

       -e      show send and receive errors (timeouts and others)

       -h      show the usage message

       -v      increase the application verbosity level.
	       May be used several times (-vv or -v -v -v)

       -V      show the version info.

       # Addressing flags

       -D      use directed path address arguments. The path
	       is a comma separated list of out ports.
	       Examples:
	       "0"	       # self port
	       "0,1,2,1,4"     # out via port 1, then 2, ...

       -G      use GUID address argument. In most cases, it is the Port GUID.
	       Example:
	       "0x08f1040023"

       -s <smlid>      use 'smlid' as the target lid for SM/SA queries.

       # Other common flags:

       -C <ca_name>    use the specified ca_name.

       -P <ca_port>    use the specified ca_port.

       -t <timeout_ms> override the default timeout for the solicited mads.

       Multiple CA/Multiple Port Support

       When no IB device or port is specified, the port to use is selected by the following criteria:

       1. the first port that is ACTIVE.

       2. if not found, the first port that is UP (physical link up).

       If a port and/or CA name is specified, the user request is attempted to be fulfilled, and will fail if it is not possible.

EXAMPLES

       ibstat		 # display status of all ports on all IB devices

       ibstat -l	 # list all IB devices

       ibstat -p	 # show port guids

       ibstat mthca0 2	 # show status of port 2 of 'mthca0'

SEE ALSO

       ibstatus(8)

AUTHOR

       Hal Rosenstock
	      <halr@voltaire.com>

OpenIB								   July 25, 2006							 IBSTAT(8)