APIs in Category: storage-adapter | Cluster-Mode API version 1.21

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.
> node-name |  | string | This field is only valid when the request is sent to the Admin Vserver LIF. This is the storage system name the command will be executed on.

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

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, Parallel 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".
> node-name |  | string optional | This field is only valid when the request is sent to the Admin Vserver LIF. If node-name is not specified when the request is sent to Admin VserverLIF, then all matching adapters in the cluster will be returned. This is the storage system name the command will be executed on.
> 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.

> Input Name | Range | Type | Description
> node-name |  | string optional | This field is only valid when the request is sent to the Admin Vserver LIF. If node-name is not specified when the request is sent to Admin VserverLIF, then all matching adapters in the cluster will be returned. This is the storage system name the command will be executed on.
> 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 | Adapter port name, which is adapter slot number and, if presented, the port letter designator together. Examples are 8a, 11b. Note that a physical adapter may contain multiple ports.
> 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".
> node-name |  | string optional | This field is only valid when the request is sent to the Admin Vserver LIF, in which case it is the storage system name.

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
> node-name |  | string optional | This field is only valid when the request is sent to the Admin Vserver LIF, in which case it is the storage system name.

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 | [0..2^8-1] | integer optional | Storage port adapter's data cache size,
> fc-link-rate | [0..2^16-1] | integer | Link rate of Fibre Channel port.
> fc-node-name |  | string | Fibre Channel node name.
> fc-packet-size | [0..2^32-1] | integer | Size of Fibre Channel packets.
> fc-port-name |  | string optional | Fibre Channel World Wide Port Name (WWPN) of adapter.
> firmware-rev |  | string | Firmware revision of adapter.
> hardware-rev |  | string | Hardware revision of adapter.
> host-loop-id | [0..125] | integer optional | Storage port adapter's Fibre Channel loop id,
> host-port-id | [0..125] | integer optional | Storage port adapter's port id,
> is-enabled |  | boolean | Is the adapter enabled? true or false.
> is-ext-gbic |  | boolean | Is the Fibre Channel gbic external? true or false.
> is-in-use |  | boolean | Is the adapter inuse? true or false
> is-pci-64-capable |  | boolean optional | Is the adapter pci-64-capable? true or false.
> is-redundant |  | boolean | Is the adapter used in dual-attached config? true or false
> is-sram-parity |  | boolean optional | Is the adapter sram parity configured and enabled? true or false.
> preload-table-rev |  | string optional | Preload table revision of adapter.

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-board-revision |  | string optional | Adapter board revision as assigned by the manufacturer. Will be missing if data not available or not supported.
> adapter-date-code |  | string optional | Adapter data code assigned by the manufacturer. Will be missing if data not available or not supported.
> adapter-family |  | string optional | Adapter family as assigned by the vendor. Example: 2432. Will be missing if data not available or not supported.
> adapter-manufacturer |  | string optional | Manufacturing facility where adapter was built. Will be missing if data not available or not supported.
> adapter-manufacturer-part-number |  | string optional | Adapter part number assigned by the manufacturer. Will be missing if data not available or not supported.
> adapter-model |  | string | Model of the adapter. This is the same as adapter-vendor followed with adapter-family. Example: "Qlogic 2432"
> adapter-part-number |  | string optional | Adapter part number assigned by the vendor. Will be missing if data not available or not supported.
> adapter-serial-number |  | string optional | Adapter serial number. Will be missing if data not available or not supported.
> adapter-slot | [0..20] | integer | Slot number for the adapter port.
> adapter-state |  | string | Current state of the adapter. Possible values: "up", "down", "offline_soft", "offline_hard", "offline_loopback".
> adapter-vendor |  | string optional | Represents the adapter vendor. Example: Qlogic. Will be missing if data not available or not supported.
> base-wwn |  | string | Physical base node world-wide name
> firmware-rev |  | string | Firmware revision of adapter
> hardware-rev |  | string | This is the hardware chip revision of adapter.
> is-enabled |  | boolean | Is the adapter enabled?
> is-in-use |  | boolean | Is adapter in use? true or false.
> is-redundant |  | boolean | Is adapter dual-attached? true or false.
> sas-adapter-disabled-phy-count | [0..4] | integer optional | Number of disabled PHYs on the host adapter.
> sas-adapter-enabled-phy-count | [0..4] | integer optional | Number of enabled PHYs on the host adapter.
> sas-adapter-expander-phy-states |  | sas-adapter-expander-phy-state-info[] optional | List of expander PHYs, a SAS adapter transceivers, state info. It will be missing if data is not available or if no expander is connected to the adapter.
> sas-phy |  | phy-state-info[] optional | List of adapter PHY state info.
> sas-qsfp-cable |  | sas-qsfp-cable-info optional | QSFP information of the cable. QSFP is acronym for Quad Small Form-factor Pluggable.. Will be missing if data not available or not or cable not present supported.

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. If data not available, value will be "not_available".
> serial-number |  | string | Serial number for sff. If data not available, value will be "not_available".
> speed-capabilities |  | string | Comma separated list of speed capabilities of the sff. Example: "1, 2 Gbit/Sec". If data not available, value will be "not_available".
> vendor |  | string | sff vendor name. If data not available, value will be "not_available".

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. If data not available, value will be "not_available".
> serial-number |  | string | Serial number for sfp. If data not available, value will be "not_available".
> speed-capabilities |  | string optional | Comma separated list of speed capabilities of the sfp. Example: "1, 2 Gbit/Sec". If data not available, value will be "not_available".
> vendor |  | string | sfp vendor name If data not available, value will be "not_available".

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

> Adapter PHY state information.

> Name | Range | Type | Description
> phy | [0..3] | integer | A PHY is a transceiver; it is the object in a device that electrically interfaces to a physical link.
> phy-state |  | string | Adapter PHY 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", "sas_phy_state_enabled_60gbs", "unknown".
> phy-wwn |  | string optional | Adapter PHY's world-wide name.

Element definition: sas-adapter-expander-phy-state-info | [top]

> Adapter PHY and list of connected expander PHYs.

> Name | Range | Type | Description
> adapter-phy | [0..3] | integer | Adapter PHY connected to a list of expander PHYs.
> expander-phy-states |  | expander-phy-state-info[] | List of all expanders connected to an adapter's PHY.

Element definition: sas-qsfp-cable-info | [top]

> QSPF Cable information.

> Name | Range | Type | Description
> attached-serial-number |  | string optional | Serial number of the attached cable as assigned by the cable manufacturer. This field will not be present if the information is not available, or if a cable is not connected at this connector. Note that depending on the cable, the serial number at the two ends of the cable may or may not match. An example of this is SAS optical cables that do not have integrated QSFP's, which will show different attached serial numbers at the ends of cable. Cables with integrated QSFP's will have matching serial numbers at both ends.
> cable-end-identifier |  | string optional | Each cable has two ends. This field shows which end of the cable is connected to the shelf. This field will not be present if the information is not available or accessible, or if a cable is not connected at this connector. Possible values: "end_0", "end_1".
> cable-length |  | string optional | Length of the cable. Will be missing if data not available or not present.
> cable-manufacturer |  | string optional | Manufacturer of the cable. Will be missing if data not available or not present.
> cable-part-number |  | string optional | Cable part number as assigned by the manufacturer. Will be missing if data not available or not present.
> cable-serial-number |  | string optional | This is actually not serial number, but rather cable identifier. For backwards compatibility this is reported as cable-serial-number. For the actual serial number see attached-serial-number. The connectors at both ends of the same cable will report the same value for this field. This field can be used to generate topology. This field will not be present if a cable is not connected to the connector or if the cable is not connected to a functioning device.
> cable-technology |  | string optional | Cable technology. This field will not be present if the information is not available or accessible, or if a cable is not connected at this connector. Possible values: "active_copper", "passive_copper", "copper", "optical".

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

> Expander PHY state information.

> Name | Range | Type | Description
> expander-phy | [0..70] | integer | A PHY is a transceiver; it is the object in a device that electrically interfaces to a physical link.
> expander-phy-attached-device-type |  | string | Device type attached to an adapter PHY. Possible values: "initiator" - A device type that can initiate a SAS communication, "expander" - A device type that facilitates communication between multiple SAS devices, "sas_end_device" - A SAS device that is not contained within an expander device, "sata_end_device" - A SATA end device, "unknown" - An unknown device type.
> expander-phy-state |  | string | Expander PHY state info. Possible values: "sas_phy_state_enabled_rate_unknown" - PHY is enabled but data transfer rate is unknown, "sas_phy_state_disabled" - PHY is disabled, "sas_phy_state_speed_neg_failed" - Data tranfer rate negotiation failed, "sas_phy_state_sata_oob_failed" - SATA OOB(Out Of Band) signaling failed, "sas_phy_state_enabled_15gbs" - 1.5 Gb/s data transfer rate, "sas_phy_state_enabled_30gbs" - 3.0 Gb/s data transfer rate, "sas_phy_state_enabled_60gbs" - 6.0 Gb/s data transfer rate, "unknown" - Unknown PHY state.
> expander-phy-wwn |  | string | Expander PHY's world-wide name.