Skip to content

Commit

Permalink
Fix API.md for missing fields
Browse files Browse the repository at this point in the history
I added a description of the updated fields in export_list, but forgot to
update the sentence at the beginning that listed all the fields. We added
two, and one was renamed, from 'vol' to 'vol_name'.

Signed-off-by: Andy Grover <agrover@redhat.com>
  • Loading branch information
Andy Grover committed Sep 25, 2012
1 parent 7a39990 commit d627272
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions API.md
Expand Up @@ -70,12 +70,13 @@ Exports make a volume accessible to a remote iSCSI initiator.

### export_list()
Returns an array of export objects. Each export object contains
`initiator_wwn`, `lun`, `vol`, and `pool`. `initiator_wwn` is the
iSCSI name (iqn.*) of the initiator with access to the export. `lun`
is the SCSI logical unit number the initiator will see for this
export. `vol_name` is the name of the backing volume. `vol_uuid` and
`vol_size` return the unique identifier and size of the volume. The
`pool` attribute is the name of the pool containing the backing volume.
`initiator_wwn`, `lun`, `vol_name`, `vol_size`, `vol_uuid`, and
`pool`. `initiator_wwn` is the iSCSI name (iqn.*) of the initiator
with access to the export. `lun` is the SCSI logical unit number the
initiator will see for this export. `vol_name` is the name of the
backing volume. `vol_uuid` and `vol_size` return the unique identifier
and size of the volume. The `pool` attribute is the name of the pool
containing the backing volume.

### export_create(pool, vol, initiator_wwn, lun)
Creates an export of volume `vol` in pool `pool` to the given
Expand Down

0 comments on commit d627272

Please sign in to comment.