Differential D3343 Diff 14699 sbin/geom/class/multipath/gmultipath.8

Changeset View

Standalone View

sbin/geom/class/multipath/gmultipath.8

	Show All 18 Lines
	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)			.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT			.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY			.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF			.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	.\" SUCH DAMAGE.			.\" SUCH DAMAGE.
	.\"			.\"
	.\" $FreeBSD$			.\" $FreeBSD$
	.\"			.\"
	.Dd July 18, 2015			.Dd August 8, 2015
	.Dt GMULTIPATH 8			.Dt GMULTIPATH 8
	.Os			.Os
	.Sh NAME			.Sh NAME
	.Nm gmultipath			.Nm gmultipath
	.Nd "disk multipath control utility"			.Nd "disk multipath control utility"
	.Sh SYNOPSIS			.Sh SYNOPSIS
	.Nm			.Nm
	.Cm create			.Cm create
	.Op Fl ARv			.Op Fl ARv
				.Op Fl L Ar logicalblock
	.Ar name			.Ar name
	.Ar prov ...			.Ar prov ...
	.Nm			.Nm
	.Cm label			.Cm label
	.Op Fl ARv			.Op Fl ARv
				.Op Fl L Ar logicalblock
	.Ar name			.Ar name
	.Ar prov ...			.Ar prov ...
	.Nm			.Nm
	.Cm configure			.Cm configure
	.Op Fl APRv			.Op Fl APRv
				.Op Fl L Ar logicalblock
	.Ar name			.Ar name
	.Nm			.Nm
	.Cm add			.Cm add
	.Op Fl v			.Op Fl v
	.Ar name prov			.Ar name prov
	.Nm			.Nm
	.Cm remove			.Cm remove
	.Op Fl v			.Op Fl v
	▲ Show 20 Lines • Show All 74 Lines • ▼ Show 20 Lines
	Kernel will only check that all given providers have same media and			Kernel will only check that all given providers have same media and
	sector sizes.			sector sizes.
	.Pp			.Pp
	.Fl A			.Fl A
	option enables Active/Active mode,			option enables Active/Active mode,
	.Fl R			.Fl R
	option enables Active/Read mode, otherwise Active/Passive mode is used			option enables Active/Read mode, otherwise Active/Passive mode is used
	by default.			by default.
				.Pp
				.Fl L
				option enables Logical Block mode, the device is divided into stripes of
				wblockUnsubmitted Not Done Inline Actions If "option" is used, it needs to be "The .Fl -L option". Otherwise, leave out the word "option". Also, comma splice. Not sure about the capitalization of logical block, either, although the other sections do it. Suggestion: .Fl L enables Logical Block mode. The device is divided into stripes of wblock: If "option" is used, it needs to be "The .Fl -L option". Otherwise, leave out the word…
				.No 2** Ns Ar logicalblock
				bytes, and all requests to a stripe are served via the same path.
				wblockUnsubmitted Not Done Inline Actions "served via the same path" is kind of vague. It's hard to see how the path ties in to the size of the requests, but the sentence implies it. Maybe this should be two separate sentences. wblock: "served via the same path" is kind of vague. It's hard to see how the path ties in to the size…
				This can improve performance by taking advantage of read-ahead and caching.
				wblockUnsubmitted Not Done Inline Actions How? You mean because this ensures that requests are going to the same device? wblock: How? You mean because this ensures that requests are going to the same device?
	.It Cm label			.It Cm label
	Create multipath device with			Create multipath device with
	.Dq automatic			.Dq automatic
	method.			method.
	Label the first given provider with on-disk metadata using the specified			Label the first given provider with on-disk metadata using the specified
	.Ar name .			.Ar name .
	The rest of given providers will be retasted to detect these metadata.			The rest of given providers will be retasted to detect these metadata.
	It reliably protects against specifying unrelated providers.			It reliably protects against specifying unrelated providers.
	Providers with no matching metadata detected will not be added to the device.			Providers with no matching metadata detected will not be added to the device.
	.Pp			.Pp
	.Fl A			.Fl A
	option enables Active/Active mode,			option enables Active/Active mode,
	.Fl R			.Fl R
	option enables Active/Read mode, otherwise Active/Passive mode is used			option enables Active/Read mode, otherwise Active/Passive mode is used
	by default.			by default.
				.Pp
				.Fl L
				option enables Logical Block mode, the device is divided into stripes of
				.No 2** Ns Ar logicalblock
				bytes, and all requests to a stripe are served via the same path.
				This can improve performance by taking advantage of read-ahead and caching.
	.It Cm configure			.It Cm configure
	Configure the given multipath device.			Configure the given multipath device.
	.Pp			.Pp
	.Fl A			.Fl A
	option enables Active/Active mode,			option enables Active/Active mode,
	.Fl P			.Fl P
	option enables Active/Passive mode,			option enables Active/Passive mode,
	.Fl R			.Fl R
	option enables Active/Read mode.			option enables Active/Read mode.
				.Pp
				.Fl L
				option enables Logical Block mode, the device is divided into stripes of
				.No 2** Ns Ar logicalblock
				bytes, and all requests to a stripe are served via the same path.
				This can improve performance by taking advantage of read-ahead and caching.
				wblockUnsubmitted Not Done Inline Actions I count three instances of this same text. Is that Phabricator helping us again? wblock: I count three instances of this same text. Is that Phabricator helping us again?
	.It Cm add			.It Cm add
	Add the given provider as a path to the given multipath device.			Add the given provider as a path to the given multipath device.
	Should normally be used only for devices created with			Should normally be used only for devices created with
	.Dq manual			.Dq manual
	method, unless you know what you are doing (you are sure that it is another			method, unless you know what you are doing (you are sure that it is another
	device path, but tasting its metadata in regular			device path, but tasting its metadata in regular
	.Dq automatic			.Dq automatic
	way is not possible).			way is not possible).
	▲ Show 20 Lines • Show All 205 Lines • Show Last 20 Lines