APIs in Category: storage-adapter | API version 1.14

storage-adapter-enable-adapter storage-adapter-get-adapter-info storage-adapter-get-adapter-list

NetApp Manage ONTAP

storage-adapter-enable-adapter | [top]

> Enables specified host adapter. I/O traffic can be issued on the adapter.

> Input Name | Range | Type | Description
> adapter-name |  | string | The adapter name is either a slot number, or, if a port letter is also present, a slot number and port letter concatenated into a single name -- for example, "8a" or "11b". If adapter-name is not supplied, the command will return EAPIMISSINGARGUMENT.

> Errno | Description
> EAPIMISSINGARGUMENT |  |
> EOPNOTSUPPORTED |  |
> EINVALIDINPUTERROR |  |

storage-adapter-get-adapter-info | [top]

> Display the information about a specified host adapter. The information is displayed base on the controller interface type. ATA, Paralell SCSI, SAS, FC.

> Input Name | Range | Type | Description
> adapter-name |  | string | The adapter name is either a slot number, or, if a port letter is also presented, a slot number and port letter concatenated into a single name -- for example, "8a" or "11b".
> Output Name | Range | Type | Description
> adapter-details |  | adapter-detail-info | List of detail info for given adapter.

storage-adapter-get-adapter-list | [top]

> Get the list of adapters present on this system.

> Output Name | Range | Type | Description
> adapter-list |  | adapter-name-elem[] | The adapter-list is a list of the names of adapters on this system. These adapter names can be used by other commands, including storage-adapter-enable-adapter and storage-adapter-disable-adapter.

Element definition: adapter-detail-info | [top]

> Detailed information for specific adapter. Display different info base on the type of adapter.

> Name | Range | Type | Description
> adapter-fc |  | adapter-fc-info optional | information for fc (Fibre Channel) adapter.
> adapter-name |  | string | The adapter name is the slot number and if presented, the port letter designator together. Examples are 8a, 11b
> adapter-parallel-scsi |  | adapter-parallel-scsi-info optional | information for parallel SCSI adapter.
> adapter-sas |  | adapter-sas-info optional | information for sas (serial attached SCSI) adapter.
> adapter-type |  | string | type of adapter present in the system Possible values: "ADT_IF_ATA", "ADT_IF_PARALLEL_SCSI", "ADT_IF_SAS", "ADT_IF_FC"

Element definition: adapter-name-elem | [top]

> A list of adapter-names that can be used in other storage-adapter interface calls.

> Name | Range | Type | Description
> adapter-name |  | string | The adapter name is the slot number and, if present, the port letter designate. Examples are 8a, 11b

Element definition: adapter-fc-info | [top]

> Detailed information for fc adapter.

> Name | Range | Type | Description
> adapter-bar |  | adapter-bar-info[] optional | list of base address information
> adapter-model |  | string | model of the adapter
> adapter-sff-info |  | adapter-sff-info optional | If the port has a small form factor transceiver/connector (also known as sff), then this is the vendor information on the sff.
> adapter-sfp-info |  | adapter-sfp-info optional | If the port has a small form factor pluggable transceiver/connector (also known as sfp), then this is the vendor information on the sfp.
> cache-line-sz |  | integer optional | Storage port adapter's data cache size, Range: [0..(2^8)-1]
> fc-link-rate |  | integer | link rate of Fibre Channel, Range: [0..2^16-1].
> fc-node-name |  | string | node name of Fibre Channel
> fc-packet-size |  | integer | packet-size of Fibre Channel, Range: [0..2^32-1].
> firmware-rev |  | string | firmware revision of adapter
> hardware-rev |  | string | hardware revision of adapter
> host-loop-id |  | integer optional | Storage port adapter's Fibre Channel loop id, Range: [0..125]
> host-port-id |  | integer optional | Storage port adapter's port id, Range: [0..125]
> is-enabled |  | boolean | Is the adapter enabled? true or false.
> is-ext-gbic |  | boolean | external gbic of Fibre Channel, true or false.
> is-in-use |  | boolean | inuse? true or false
> is-pci-64-capable |  | boolean optional | pci-64-capable, true or false.
> is-redundant |  | boolean | dual-attached? true or false
> is-sram-parity |  | boolean optional | sram parity of Fibre Channel, true or false.

Element definition: adapter-parallel-scsi-info | [top]

> Detailed information for parallel SCSI adapter.

> Name | Range | Type | Description
> adapter-model |  | string | model of the adapter
> bus-width |  | string | Possible values: "narrow", or "wide".
> firmware-rev |  | string | Firmware revision of adapter
> hardware-rev |  | string | hardware revision of adapter
> is-enabled |  | boolean | Is the adapter enabled?

Element definition: adapter-sas-info | [top]

> Detailed information for sas (Serial Attached SCSI) adapter.

> Name | Range | Type | Description
> adapter-model |  | string | model of the adapter
> base-wwn |  | string | physical base node name
> firmware-rev |  | string | Firmware revision of adapter
> hardware-rev |  | string | hardware revision of adapter
> is-enabled |  | boolean | Is the adapter enabled?
> is-in-use |  | boolean | inuse? true or false
> is-redundant |  | boolean | dual-attached? true or false
> sas-phy |  | phy-state-info[] optional | list of physical state info

Element definition: adapter-bar-info | [top]

> display base address information

> Name | Range | Type | Description
> bar-base |  | integer | Base address occupied by the storage port adapter, Range: [0..(2^32)-1]
> bar-size |  | integer | Address range occupied by the storage port adapter, Range: [0..(2^32)-1]
> bar-type |  | string | type of base address information. Possible values are: "I/O", and "memory mapped I/O".

Element definition: adapter-sff-info | [top]

> Information on small form factor transceiver/connector (also known as sff).

> Name | Range | Type | Description
> part-number |  | string | Vendor's part number for the sff.
> serial-number |  | string | serial number for sff.
> speed-capabilities |  | string | comma separated list of speed capabilities of the sff. Example: "1, 2 Gbit/Sec".
> vendor |  | string | sff vendor name

Element definition: adapter-sfp-info | [top]

> Information on small form factor pluggable transceiver/connector (also known as sfp).

> Name | Range | Type | Description
> part-number |  | string | Vendor's part number for the sfp.
> serial-number |  | string | serial number for sfp.
> speed-capabilities |  | string | comma separated list of speed capabilities of the sfp. Example: "1, 2 Gbit/Sec".
> vendor |  | string | sfp vendor name

Element definition: phy-state-info | [top]

> Display physical state info

> Name | Range | Type | Description
> phy |  | integer | A phy is a transceiver; it is the object in a device that electrically interfaces to a physical link. Range: [0..3].
> phy-state |  | string | physical state info possible values: sas_phy_state_enabled_rate_unknown, sas_phy_state_disabled, sas_phy_state_speed_neg_failed, sas_phy_state_SATA_OOB_failed, sas_phy_state_enabled_15gbs, sas_phy_state_enabled_30gbs. or return "Unknown" if not listed above.