====== Attach SAN device ======

===== Synopsis =====

    sanhook [--drive <drive>] [--no-describe] <uri> [<uri>...]

===== Examples =====

=== Attach an iSCSI target ===

    sanhook iscsi:10.0.4.1:::1:iqn.2010-04.org.ipxe.dolphin:storage

=== Attach a multipath iSCSI target ===

    sanhook iscsi:192.168.0.101::::iqn.2010-04.org.ipxe.squirrel:storage \
            iscsi:192.168.0.102::::iqn.2010-04.org.ipxe.squirrel:storage

=== Attach two independent iSCSI targets ===

    sanhook --drive 0x80 iscsi:10.0.4.1:::1:iqn.2010-04.org.ipxe.dolphin:storage
    sanhook --drive 0x81 iscsi:192.168.0.1::::iqn.2010-04.org.ipxe.chipmunk:storage

=== Check ability to attach a SAN target ===

    sanhook ${root-path} && sanunhook || echo Could not attach ${root-path}

=== Attach a SAN target and then boot an installer held on another target ===

    sanhook --drive 0x81 ${root-path}
    sanboot --no-describe iscsi:10.0.4.1:::1:iqn.2010-04.org.ipxe.dolphin:liveinstall

===== Description =====

Attach the specified [[:sanuri|SAN target URIs]] as the specified SAN drive.  If no SAN drive is explicitly specified then the default SAN drive (''%%0x80%%'') will be used.

The SAN drive will be described via an appropriate mechanism (such as an iBFT for an iSCSI drive) unless the ''%%--no-describe%%'' option is specified.

===== Command status =====

^ Success   | The SAN target was successfully attached      |
^ Failure   | The SAN target was not successfully attached  |

===== See also =====

  * ''[[:cmd:sanboot]]''
  * ''[[:cmd:sanunhook]]''
  * [[:cmd|List of all iPXE commands]]

===== Notes =====

You can create a multipath SAN device by specifying multiple SAN target URIs.  iPXE will use whichever SAN target responds first, and will retry all URIs if the original SAN target fails for any reason.  You must ensure that all SAN URIs in a multipath SAN device point to the same underlying SAN drive.

If you wish to attach to multiple independent SAN drives, then you must use the ''sanhook'' command once for each independent SAN drive.