Blob Blame History Raw
'\" t
.\"     Title: fcping
.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\"      Date: 05/24/2011
.\"    Manual: Open-FCoE Tools
.\"    Source: Open-FCoE
.\"  Language: English
.\"
.TH "FCPING" "8" "05/24/2011" "Open\-FCoE" "Open\-FCoE Tools"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
fcping \- Fibre Channel Ping (ELS ECHO) tool
.SH "SYNOPSIS"
.sp
\fBfcping\fR [\-fqx] [ \-i \fIinterval\fR ] [ \-c \fIcount\fR ] [ \-s \fIsize\fR ] \-h \fIsource\fR \fItarget\fR
.sp
source = \fIinterface\fR | \fIMAC\fR | \fIWWPN\fR | \fIFC\-ID\fR
.sp
target = \-P \fIWWPN\fR | \-N \fIWWPN\fR | \-F \fIFC\-ID\fR
.SH "DESCRIPTION"
.sp
The \fBfcping\fR command performs the Fibre Channel FC\-LS\-2 ECHO ELS command and displays the reply\&. The max payload for \fBfcping\fR is 2108 bytes\&. When no \fB\-c\fR is given, \fBfcping\fR will continue until user interrupts\&.
.SH "OPTIONS"
.PP
\fB\-f\fR
.RS 4
Flood ping
.RE
.PP
\fB\-q\fR
.RS 4
Quiet! just print summary
.RE
.PP
\fB\-x\fR
.RS 4
Hex dump of responses
.RE
.PP
\fB\-i\fR \fIinterval\fR
.RS 4
Wait
\fIinterval\fR
seconds between each ping
.RE
.PP
\fB\-c\fR \fIcount\fR
.RS 4
Stop after sending
\fIcount\fR
pings
.RE
.PP
\fB\-h\fR \fIsource\fR
.RS 4
Source is
\fIinterface\fR
like ethX,
\fIMAC\fR
address,
\fIWWPN\fR, or
\fIFC\-ID\fR
.RE
.PP
\fB\-s\fR \fIsize\fR
.RS 4
Byte\-length of ping request payload (max 2108)
.RE
.PP
\fB\-F\fR \fIFC\-ID\fR
.RS 4
Destination port ID
.RE
.PP
\fB\-P\fR \fIWWPN\fR
.RS 4
Destination world\-wide port name
.RE
.PP
\fB\-N\fR \fIWWNN\fR
.RS 4
Destination world\-wide node name
.RE
.SH "EXAMPLES"
.sp
Sends ELS ECHO to Port FC\-ID 0xbf0027 from interface n0\&.170 with max 3 pings\&.
.sp
.if n \{\
.RS 4
.\}
.nf
fcping \-c 3 \-h n0\&.170 \-F 0xbf0027
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
sending echo to 0xBF0027
echo    1 accepted                       16\&.170 ms
echo    2 accepted                        7\&.053 ms
echo    3 accepted                        6\&.803 ms
3 frames sent, 3 received 0 errors, 0\&.000% loss, avg\&. rt time 10\&.009 ms
.fi
.if n \{\
.RE
.\}
.sp
Sends ELS ECHO to WWNN 0x1000001B213C9DDA from interface n0\&.170 with max 3 pings and payload size 1500 bytes
.sp
.if n \{\
.RS 4
.\}
.nf
fcping \-c 3 \-h n0\&.170 \-s 1500 \-N 0x1000001B213C9DDA
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
sending echo to 0xBF0027
echo    1 accepted                        6\&.597 ms
echo    2 accepted                        6\&.925 ms
echo    3 accepted                       12\&.419 ms
3 frames sent, 3 received 0 errors, 0\&.000% loss, avg\&. rt time 8\&.647 ms
.fi
.if n \{\
.RE
.\}
.sp
Sends ELS ECHO to WWNN 0x1000001B213C9DDA from interface n0\&.170 continuously with payload of 32 bytes and hex\-dump the reply to the screen
.sp
.if n \{\
.RS 4
.\}
.nf
fcping \-x \-h n0\&.170 \-s 32 \-N 0x1000001B213C9DDA
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
sending echo to 0xBF0027
echo    1 accepted                        6\&.937 ms
response length 32
     0 02000000 00000001 00010203 04050607
    10 08090a0b 0c0d0e0f 10111213 14151617
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
echo    2 accepted                        6\&.923 ms
response length 32
     0 02000000 00000002 00010203 04050607
    10 08090a0b 0c0d0e0f 10111213 14151617
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
echo    3 accepted                       84\&.929 ms
response length 32
     0 02000000 00000003 00010203 04050607
    10 08090a0b 0c0d0e0f 10111213 14151617
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.sp
\fBfcoeadm\fR(8)
.SH "SUPPORT"
.sp
\fBfcping\fR is part of the \fIfcoe\-utils\fR package, maintained through the \fIOpen\-FCoE\fR project\&. Resources for both developers and users can be found at the \fIOpen\-FCoE\fR website http://open\-fcoe\&.org/\&.