xref: /illumos-gate/usr/src/man/man8/pptadm.8 (revision 9b9d39d2a32ff806d2431dbcc50968ef1e6d46b2)
1.\"
2.\" This file and its contents are supplied under the terms of the
3.\" Common Development and Distribution License ("CDDL"), version 1.0.
4.\" You may only use this file in accordance with the terms of version
5.\" 1.0 of the CDDL.
6.\"
7.\" A full copy of the text of the CDDL should have accompanied this
8.\" source.  A copy of the CDDL is also available via the Internet at
9.\" http://www.illumos.org/license/CDDL.
10.\"
11.\" Copyright 2018 Joyent, Inc.
12.\"
13.Dd April 10, 2018
14.Dt PPTADM 8
15.Os
16.Sh NAME
17.Nm pptadm
18.Nd PPT administration utility
19.Sh SYNOPSIS
20.Nm
21.Cm list -j
22.Op Fl a
23.Nm
24.Cm list
25.Op Fl ap Op Fl o Ar fields
26.Sh DESCRIPTION
27The
28.Nm
29utility can enumerate passthrough devices for use by a virtualized guest.
30.Sh OPTIONS
31The following options to the
32.Cm list
33command are supported:
34.Bl -tag -width Ds
35.It Fl a
36Show all PPT devices, both available and assigned.
37.It Fl j
38Output JSON.
39.It Fl o
40Specify fields to output, or "all". Available fields are
41dev,path,vendor,device,subvendor,subdevice,rev,label
42.It Fl p
43Output in a parsable format; this requires the -o option to be specified.
44.El
45.Sh JSON OUTPUT
46The JSON output consists of an array under the key "devices" with the fields:
47.Bl -tag -width Ds
48.It dev
49The PPT /dev path, if assigned and bound.
50.It path
51The physical /devices path.
52.It vendor-id
53The PCI vendor ID.
54.It device-id
55The PCI device ID.
56.It subsystem-vendor-id
57The PCI subsystem vendor ID.
58.It subsystem-id
59The PCI subsystem ID.
60.It revision-id
61The PCI device revision.
62.It label
63Human-readable description from the PCI database.
64.El
65.Sh FILES
66.Bl -tag -width Ds
67.It /etc/ppt_aliases
68Containts the bindings of PPT devices in the same format as /etc/driver_aliases
69.It /etc/ppt_matches
70Identifies devices that PPT could be bound to, either by physical path, or by
71PCI ID.
72.El
73.Sh EXIT STATUS
74.Ex -std
75