|
APIs in Category: fcp |
7-Mode API version 1.15 |
| fcp-adapter-clear-partner | [top] |
Removes the name of the partner adapter which the local adapter should takeover. Partner adapter setting is obsolete and this operation is no longer supported.
Input Name Range Type Description fcp-adapter string
Local FC adapter.
Errno Description EOPNOTSUPPORTED
License fcp
| fcp-adapter-config-down | [top] |
Bring a Fibre Channel target adapter offline. The adapter may not be offline immediately after the call returns, it may take up to a few seconds for the adapter to change state. In Data ONTAP 7-Mode, if the FCP service is not running then all adapters are automatically offlined. They cannot be brought online again until FCP service is started. adapter to change state. In Data ONTAP Cluster-Mode, offlining an adapter will operationally disable all FCP logical interfaces (LIFs) hosted by the adapter.
Input Name Range Type Description fcp-adapter string
FC adapter to bring offline.
Errno Description EINTERNALERROR EADAPTERNOTFOUND EADAPTERINVALIDTYPE EADAPTERPARTNER ENOTSTARTED ENTAPI_EINVAL
License fcp
| fcp-adapter-config-media-type | [top] |
Sets the link type on the Fibre Channel target adapter. It can be configured to establish a point-to-point link, a loop configuration or to automatically sense whether the connection type is a point-to-point or loop link. Setting the link to point-to-point in a loop configuration can prevent the loop from coming up properly. If the adapter is online, it must be brought offline and then online in order for a new mediatype to take effect. This may temporarily disrupt fcp service on the target adapter.
Input Name Range Type Description fcp-adapter string
FC adapter to bring offline. media-type string
Media type to set. Valid values are point-to-point ("ptp"), loop configuration ("loop"), or automatic ("auto").
Errno Description EINTERNALERROR EADAPTERNOTFOUND EADAPTERINVALIDTYPE EADAPTERPARTNER ENOTSTARTED ECLUSTERED EONTAPI_EINVAL
License fcp
| fcp-adapter-config-up | [top] |
Bring a Fibre Channel target adapter online. The adapter may not be online immediately after the call returns, it may take up to a few seconds for the adapter to initialize. In Data ONTAP 7-Mode, if the FCP service is not running then all adapters are automatically offlined. They cannot be brought online again until FCP service is started. In Data ONTAP Cluster-Mode, offlining an adapter will operationally disable all FCP logical interfaces (LIFs) hosted by the adapter.
Input Name Range Type Description fcp-adapter string
FC adapter to bring online.
Errno Description EINTERNALERROR EADAPTERNOTFOUND EADAPTERINVALIDTYPE EADAPTERPARTNER ENOTSTARTED EONTAPI_EINVAL
License fcp
| fcp-adapter-initiators-list-info | [top] |
Get the list of initiators currently connected to the specified Fibre Channel target adapter, or if none specified, a list of initiators connected to any FC target adapter. Information returned for each initiator includes the portname of initiators that are currently logged in with the the FC target adapters. If the portname is in an initiator group, then the group name is also included. Also the Fibre Channel host address and the nodename/portname of the initiators are included as well. Connectivity of adapters running on behalf of partners are not included in the list when requesting for all adapters. If listing for all adapters and an error occurred for while retrieving connection status for an adapter, status for that adapter will not be returned, and the API will continue on with the rest of the adapters without erroring out. You can get the error msg for that adapter, by specifically specifying that adapter.
Input Name Range Type Description fcp-adapter string
optional
Adapter to get initiator list for. If no adapter is specified, information is returned for all initiators connected through any fcp adapter in the system. Output Name Range Type Description fcp-adapters fcp-adapter-initiators-info[]
A list of FC adapters containing list of initiators and their aliases.
Errno Description EINTERNALERROR EADAPTERNOTFOUND
Vfiler-enabled Yes
License fcp
| fcp-adapter-list-info | [top] |
Gets information such as nodename/portname and link state about the specified Fibre Channel target adapter, or if no adapter is specified, about all the FC target adapters.
Input Name Range Type Description fcp-adapter string
optional
FC target Adapter to get config information for. If no adapter is specified, information is returned for all FC target Adapters. partner-only boolean
optional
If specified with "true", only adapters that are operating on behalf of partners will be returned. verbose boolean
optional
If specified with "true", additional adapter info is returned. Look at description of output for what additions. Output Name Range Type Description fcp-config-adapters fcp-config-adapter-info[]
List of adapter configuration information.
Errno Description EINTERNALERROR EADAPTERNOTFOUND ENOADAPTERNOTFOUND ENOVIRTUALADAPTERS
Vfiler-enabled Yes
License fcp
| fcp-adapter-nameserver-list-iter-end | [top] |
Terminate a list iteration and clean up any saved info.
Input Name Range Type Description tag string
Tag from a previous fcp-adapter-nameserver-list-iter-start.
Vfiler-enabled Yes
License fcp
| fcp-adapter-nameserver-list-iter-next | [top] |
Return items from a previous call to fcp-adapter-nameserver-list-iter-start Information returned for each nameserver entry include the port identifier, port type, port name, node name, symbolic port name, symbolic node name, fabric port name, class of service, and registered FC4 types.
Input Name Range Type Description maximum integer
The maximum number of entries to retrieve. tag string
Tag from a previous fcp-adapter-nameserver-list-iter-start. Output Name Range Type Description fcp-adapter-nameserver-objects fcp-adapter-nameserver-object-info[]
List of nameserver objects. records integer
This tells you how many records are being returned from this particular call to fcp-adapter-nameserver-list-iter-next When this value is 0, you have retrieved everything.
Errno Description EINTERNALERROR
Vfiler-enabled Yes
License fcp
| fcp-adapter-nameserver-list-iter-start | [top] |
Get the fabric nameserver objects the results of which are retreived by using fcp-adapter-nameserver-list-iter-next. Connectivity of adapters running on behalf of partners are not included in the list when requesting for all adapters. If listing for all adapters and an error occurs while retrieving connection status for an adapter, status for that adapter will not be returned and the API will continue on with the rest of the adapters without erroring out. You can get the error msg for that adapter, by specifically specifying that adapter.
Input Name Range Type Description fcp-adapter string
optional
Adapter to get nameserver objects for. If no adapter is specified, information is returned for all fcp adapter. Output Name Range Type Description records integer
Number which tells you how many items have been saved for future retrieval with fcp-adapter-nameserver-list-iter-next. tag string
Tag to be used in subsequent calls to fcp-adapter-nameserver-list-iter-next.
Errno Description EINTERNALERROR EADAPTERNOTFOUND
Vfiler-enabled Yes
License fcp
| fcp-adapter-reset-stats | [top] |
Resets the stats for the specified Fibre Channel Target Adapter. If none specified, reset stats for all FC adapters.
Input Name Range Type Description fcp-adapter string
optional
FC Target adapter.
Errno Description EINTERNALERROR EADAPTERNOTFOUND
License fcp
| fcp-adapter-set-partner | [top] |
Sets the name of the partner adapter which the local adapter should takeover. Partner adapter setting is obsolete and this operation is no longer supported.
Input Name Range Type Description fcp-adapter string
Local FC adapter. partner-adapter string
Partner FC adapter to takeover.
Errno Description EOPNOTSUPPORTED
License fcp
| fcp-adapter-set-speed | [top] |
Sets the speed on the Fibre Channel target adapter. It can be configured to run at 1Gb, 2Gb, 4Gb, or to autonegotiate. Note only 4Gb adapters support the 4Gb speed. If the adapter is online it must be brought offline before setting the speed, and then online in order for a new speed to take effect. This may temporarily disrupt fcp service on the target adapter.
Input Name Range Type Description fcp-adapter string
FC Target adapter speed string
Link speed (in Gb). Possible values: "1", "2", "4", or "auto" (autonegotiate speed).
Errno Description EINTERNALERROR EADAPTERNOTFOUND EADAPTERINVALIDTYPE EADAPTERPARTNER ENOTSTARTED EONTAPI_EINVAL
License fcp
| fcp-adapter-stats-list-info | [top] |
Get statistics about the Fibre Channel target adapters. Statistics of adapters running on behalf of partners are not included in the list when requesting stats for all adapters. If listing stats for all adapters and an error occurred for while retrieving stats for an adapter, stats for that adapter will not be returned, and the API will continue on with the rest of the adapters without erroring out. You can get the error msg for that adapter, by specifically specifying that adapter.
Input Name Range Type Description fcp-adapter string
optional
FC target Adapter. If no adapter is specified, stats for all adapters are retruned. Output Name Range Type Description fcp-adapter-stats fcp-adapter-stats-info[]
List of statistics for FC adapters.
Errno Description EINTERNALERROR EADAPTERNOTFOUND
License fcp
| fcp-adapter-topology-list-iter-end | [top] |
Terminate a list iteration and clean up any saved info.
Input Name Range Type Description tag string
Tag from a previous fcp-adapter-topology-list-iter-start.
Vfiler-enabled Yes
License fcp
| fcp-adapter-topology-list-iter-next | [top] |
Return items from a previous call to fcp-adapter-topology-list-iter-start Information returned for each switch includes the nodename, logical name, domain identifier, vendor, release version, and port information. If a port has devices attached to it, then information about each attached device is included as well.
Input Name Range Type Description maximum integer
The maximum number of entries to retrieve. tag string
Tag from a previous fcp-adapter-topology-list-iter-start. Output Name Range Type Description fcp-adapter-topology-switches fcp-adapter-topology-switch-info[]
Information about the connected FC switch. records integer
This tells you how many records are being returned from this particular call to fcp-adapter-topology-list-iter-next When this value is 0, you have retrieved everything.
Errno Description EINTERNALERROR
Vfiler-enabled Yes
License fcp
| fcp-adapter-topology-list-iter-start | [top] |
Get the fabric topology for one or more switches the results of which are retreived by using fcp-adapter-topology-list-iter-next. Connectivity of adapters running on behalf of partners are not included in the list when requesting for all adapters. If listing for all adapters and an error occurrs while retrieving connection status for an adapter, information for that adapter will not be returned and the API will continue on with the rest of the adapters without erroring out. You can get the error msg for that adapter, by specifically specifying that adapter.
Input Name Range Type Description fcp-adapter string
optional
Adapter to get topology information for. If no adapter is specified, information is returned for all fcp adapter. Output Name Range Type Description records integer
Number which tells you how many items have been saved for future retrieval with fcp-adapter-topology-list-iter-next. tag string
Tag to be used in subsequent calls to fcp-adapter-topology-list-iter-next.
Errno Description EINTERNALERROR EADAPTERNOTFOUND
Vfiler-enabled Yes
License fcp
| fcp-adapter-zone-list-iter-end | [top] |
Terminate a list iteration and clean up any saved info.
Input Name Range Type Description tag string
Tag from a previous fcp-adapter-zone-list-iter-start.
Vfiler-enabled Yes
License fcp
| fcp-adapter-zone-list-iter-next | [top] |
Return items from a previous call to fcp-adapter-zone-list-iter-start Information returned for each zone entry include the active zone set name, the zone name, and the zone members.
Input Name Range Type Description maximum integer
The maximum number of entries to retrieve. Range: [0..2^32-1] tag string
Tag from a previous fcp-adapter-zone-list-iter-start. Output Name Range Type Description fcp-adapter-zones fcp-adapter-zone-info[]
List of zone entries. records integer
This tells you how many records are being returned from this particular call to fcp-adapter-zone-list-iter-next When this value is 0, you have retrieved everything. Range: [0..2^32-1]
Errno Description EINTERNALERROR
Vfiler-enabled Yes
License fcp
| fcp-adapter-zone-list-iter-start | [top] |
Get the active zone set information from the zone server. The results can then be retreived by using fcp-adapter-zone-list-iter-next. Connectivity of adapters running on behalf of partners is not included in the list when requesting for all adapters. If listing for all adapters and an error occurs while retrieving connection status for an adapter, status for that adapter will not be returned and the API will continue on with the rest of the adapters without erroring out. You can get the error msg for that adapter, by specifically specifying that adapter.
Input Name Range Type Description fcp-adapter string
optional
Adapter to get zone information for. If no adapter is specified, information is returned for all fcp adapter. Output Name Range Type Description records integer
Number which tells you how many items have been saved for future retrieval with fcp-adapter-zone-list-iter-next. Range: [0..2^32-1] tag string
Tag to be used in subsequent calls to fcp-adapter-zone-list-iter-next.
Errno Description EINTERNALERROR EADAPTERNOTFOUND
Vfiler-enabled Yes
License fcp
| fcp-get-cfmode | [top] |
Get the current cfmode setting for the system.
Output Name Range Type Description fcp-cfmode string
Current FCP cfmode setting. Possible values: single_image, unknown
Errno Description EINTERNALERROR ENOTCLUSTERED
License fcp
| fcp-node-get-name | [top] |
Get the current FCP World Wide Node Name (WWNN). This WWNN name is in the form XX:XX:XX:XX:XX:XX:XX:XX where X is a hexadecimal digit. In Data ONTAP 7-Mode, this is the WWNN of the individual storage system. In "single_image" cfmode, the WWNN of the system and its high availability partner will be the same. In Data ONTAP Cluster-Mode, this is the WWNN of the Vserver FCP Service.
Output Name Range Type Description node-name string
Current FCP World Wide Node Name (WWNN).
Errno Description EINTERNALERROR EOPNOTSUPPORTED
License fcp
| fcp-node-set-name | [top] |
Set the current FCP World Wide Node Name (WWNN). This WWNN is in the form XX:XX:XX:XX:XX:XX:XX:XX where X is a hexadecimal digit. The supplied WWNN must also match the vendor's registered namespace unless the force argument is also supplied. In Data ONTAP 7-Mode, the registered namespace is "50:0a:80:8X:XX:XX:XX" and all Fibre Channel adapters must be offline. Changes will take place when the adapters are brought online. In Data ONTAP Cluster-Mode, the registered namespace is "2X:XX:00:a0:98:XX:XX:XX" and the FCP service must be offline. Changes will take place when the service is brought online.
Input Name Range Type Description force boolean
optional
If true, allow setting the WWNN to a value outside the vendor's registered namespace for the current mode. If false or not present, the request will fail unless the supplied WWNN is inside the correct namespace. node-name string
FCP World Wide Node Name.
Errno Description EINTERNALERROR EONTAPI_EINVAL EALREADYSTARTED EOPNOTSUPPORTED
License fcp
| fcp-ping | [top] |
Send an ELS ECHO frame to a Fibre Channel address or WWPN. EHOSTNOTFOUND is returned if the WWPN cannot be resolved. EONTAPI_EHOSTDOWN is returned if the address cannot be pinged.
Input Name Range Type Description fcp-adapter string
Adapter to send the ping request from. payload string
optional
Additional data to send in the payload of the ELS ECHO frame. The payload can be up to 255 characters long. port-id-or-wwpn string
The Fibre Channel address or the WWPN to ping. The format of a Fibre channel address is a hexadecimal or numeric value with the range [0..2^24-1]. The format of a WWPN is XX:XX:XX:XX:XX:XX:XX:XX where X is a hexadecimal digit.
Errno Description EHOSTNOTFOUND EONTAPI_EHOSTDOWN EADAPTERNOTFOUND EONTAPI_EINVAL
License fcp
| fcp-ping-info | [top] |
Send an ELS ECHO frame to a Fibre Channel address or WWPN. The API pings the address or WWPN count times and returns the number of successful pings and times. EHOSTNOTFOUND is returned if the WWPN cannot be resolved. EONTAPI_EHOSTDOWN is returned if the address cannot be pinged. The interval between ping attempts is 1 second.
Input Name Range Type Description fcp-adapter string
Adapter to send the ping request from. payload string
optional
Additional data to send in the payload of the ELS ECHO frame. The payload can be up to 255 characters long. ping-count integer
optional
The number of pings. Default is 3. Range: [1..16] port-id-or-wwpn string
The Fibre Channel address or the WWPN to ping. The format of a Fibre channel address is a hexadecimal or numeric value with the range [0..2^24-1]. The format of a WWPN is XX:XX:XX:XX:XX:XX:XX:XX where X is a hexadecimal digit. Output Name Range Type Description frames-received integer
optional
The number of frames received. The number of frames lost is the frames-transmitted minus frames-received. Range: [0..16] frames-transmitted integer
optional
Number of frames transmitted. Should be equal to ping-count. Range: [1..16] round-trip-maximum-time integer
optional
Maximum time in microseconds for a round trip between the target adapter and the destination if frames-received is greater than zero. Range: [0..2^31-1] round-trip-mean-time integer
optional
Mean time in microseconds for a round trip between the target adapter and the destination if frames-received is greater than zero. Range: [0..2^31-1] round-trip-minimum-time integer
optional
Minimum time in microseconds for a round trip between the target adapter and the destination if frames-received is greater than zero. Range: [0..2^31-1]
Errno Description EHOSTNOTFOUND EONTAPI_EHOSTDOWN EADAPTERNOTFOUND EONTAPI_EINVAL
License fcp
| fcp-port-name-list-info | [top] |
Get the list of valid Fibre Channel target port names on a filer's local adapters. The filer needs to be in standby or single_image cfmode.
Input Name Range Type Description verbose boolean
optional
If specified with "true", unused port names are also reported. Default value is "false". Output Name Range Type Description fcp-port-names fcp-port-name-info[]
List of valid local port names and associated adapters.
Errno Description EOPNOTSUPPORTED EADAPTERNOTFOUND
License fcp
| fcp-port-name-set | [top] |
Set a valid but unused port name on a Fibre Channel target interface.
Input Name Range Type Description fcp-adapter string
FCP target interface to set the WWPN on. In Data ONTAP 7-Mode, the name of a local adapter in standby single_image cfmode. In Data ONTAP Cluster-Mode, the name of an FCP data LIF in the vserver. port-name string
WWPN to be set on the interface. It has to be a valid and unused one.
Errno Description EOPNOTSUPPORTED EONTAPI_EINVAL EADAPTERNOTFOUND EADAPTERINVALIDTYPE EINTERNALERROR EALREADYSTARTED
License fcp
| fcp-port-name-swap | [top] |
Swap port names of two local Fibre Channel target adapters.
Input Name Range Type Description fcp-adapter-1 string
One of the adapters to swap their port names. It has to be a local adapter in standby or single_image cfmode. fcp-adapter-2 string
One of the adapters to swap their port names. It has to be a local adapter in standby or single_image cfmode.
Errno Description EOPNOTSUPPORTED EONTAPI_EINVAL EADAPTERNOTFOUND EADAPTERINVALIDTYPE EINTERNALERROR EALREADYSTARTED
License fcp
| fcp-service-start | [top] |
Starts FCP service. When FCP service is started, the adapters are brought online. Service will be avaliable once the call returns with success. The adapters however, may not be available immediately after the call, it may take up to a few seconds for the adapters to initialize.
Errno Description EINTERNALERROR EALREADYSTARTED VDISK_ERROR_CFMODE_MISMATCH VDISK_ERROR_PARTNER_NOT_REACHABLE EREVERTINPROGRESS VDISK_ERROR_PARTNER_WWNN_MISMATCH_FOR_SSI
License fcp
| fcp-service-status | [top] |
Get status of the FCP service, whether or not it is running.
Output Name Range Type Description is-available boolean
"true" if FCP service is running, "false" otherwise.
Errno Description EINTERNALERROR
License fcp
| fcp-service-stop | [top] |
Stops FCP service. When FCP service is stopped, the adapters are brought offline. Service will be unavaliable once the call returns with success.
Errno Description EINTERNALERROR ENOTSTARTED
License fcp
| fcp-set-cfmode | [top] |
Set the current cfmode setting for the system. This setting controls how the cluster behaves during a takeover/giveback. It also controls if the filer should use multiple virtual target adapters per physical target adapter. fcp service must be stopped before executing this API. The only valid value for cfmode is 'single_image' If cfmode is set to 'single_image' the filer connects to the FC fabric in ptp mode by default but is configurable, and all luns in the cluster are visible on all FC target ports. In this mode all hosts require multipathing software. When setting the cfmode to 'single_image' configuration checks are performed. If these checks fail an EPERM error will be returned. See the lun-config-check-single-image-info API for more information.
Input Name Range Type Description fcp-cfmode string
Set current cfmode setting. Possible values: single_image force boolean
optional
Forcibly change the cfmode, overriding cluster partner checks. Obsolete.
Errno Description ENOTCLUSTERED ESERVICENOTSTOPPED EINTERNALERROR EONTAPI_EINVAL EONTAPI_EPERM EVDISK_ERROR_PARTNER_NOT_REACHABLE EVDISK_ERROR_IN_TAKEOVER
License fcp
| fcp-wwpnalias-get-alias-info | [top] |
Get the list of WWPN for a given alias or an alias for for a given WWPN or complete list of all current alias- WWPN mappings.
Input Name Range Type Description alias string
optional
Alias for a WWPN is the 32-character alias that may contain A-Z, a-z, 0-9, _,-,.,{,} and no spaces. When supplied, the alias with the corresponding WWPN will be returned. Otherwise, all aliases with their WWPNs present in the system will be returned. wwpn string
optional
WWPN for which all aliases will be returned. When supplied all aliases for that WWPN will be returned. Otherwise, all aliases with their WWPNs present in the system will be returned. Output Name Range Type Description aliases aliases-info[]
A list of alias-WWPN mappings
Errno Description EVDISK_ERROR_WWPN_ALIASES_NOT_SET EVDISK_ERROR_WWPN_ALIAS_INVALID EVDISK_ERROR_WWPN_ALIAS_NOT_FOUND EVDISK_ERROR_NOT_VALID_FC_WWN EVDISK_ERROR_WWPN_ALIAS_REMOVE_INVALID_NUM_ARGS
Vfiler-enabled Yes
License fcp
| fcp-wwpnalias-remove | [top] |
Remove an alias for a World Wide Port Name of an initiator. Either the alias or the wwpn argument must be provided.
Input Name Range Type Description alias string
optional
WWPN Alias to be removed. Either the alias or the wwpn argument must be provided. wwpn string
optional
WWPN for which all aliases are to be removed. Either the wwpn or the alias argument must be provided.
Errno Description EVDISK_ERROR_WWPN_ALIAS_NOT_FOUND EVDISK_ERROR_WWPN_NOT_FOUND EVDISK_ERROR_WWPN_ALIAS_REMOVE_INVALID_NUM_ARGS
License fcp
| fcp-wwpnalias-set | [top] |
Set an alias for a World Wide Port Name of an initiator that might login to the target.
Input Name Range Type Description alias string
Alias to be set for the given WWPN ("wwpn"); The alias can be 32-characters long and may contain: A-Z, a-z, 0-9, _,-,.,{,} and no spaces force boolean
optional
When set to true, the WWPN associated with the alias will be over-written. Default value is false. wwpn string
WWPN for which alias is being set
Errno Description EVDISK_ERROR_WWPN_ALIASES_TOO_MANY EVDISK_ERROR_WWPN_ALIAS_INVALID EVDISK_ERROR_NOT_VALID_FC_WWN EVDISK_ERROR_WWPN_ALIAS_ALREADY_SET
License fcp
| Element definition: aliases-info | [top] |
A list of WWPNs and their aliases generated according to the input - alias, WWPN or nothing.
Name Range Type Description aliases-alias string
The 32-character alias for a given FCP WWPN aliases-wwpn string
The FCP WWPN for which the alias is given
| Element definition: fcp-adapter-initiators-info | [top] |
A list of initiators currently connected to the FC adapter or FCP data LIF.
Name Range Type Description adapter string
In Data ONTAP 7-Mode, the name of the physical FC adapter. In Data ONTAP Cluser-Mode, the name of the FCP data LIF. fcp-connected-initiators fcp-connected-initiator-info[]
Information about the connected initiators
| Element definition: fcp-adapter-nameserver-object-info | [top] |
Information about a nameserver object entry.
Name Range Type Description adapter string
The adapter this nameserver object is visible through. class-service string
optional
Registered class of services as defined in the FC-FS standard. This element is omitted if the device has not registered a class of service. Comma separated possible values: "F", "1", "2", "3", "4", and "6". fabric-port-name string
optional
Fabric world wide port name (WWPN) of this entry. This element is omitted if the fabric WWPN is not registered. fc4-type string
optional
Registered FC4 Types. This element is omitted if the device has not registered an FC4 Type. Comma separated possible values: "llc/snap", "ipfc", "fcp", "gpp", "ipi-3m", "ipi-3s", "ipi-3p", "sbccs-ch", "sbccs-cu", "fc-sb-3_ch2cu", "fc-sb-3_cu2ch", "fc-gs", "fc-sw", "fc-al", "snmp", "hippi-fp", "mil-std-1553", "asm", "fc-vi", and "fc-av". node-name string
optional
World wide node name (WWNN) of this entry. This element is omitted if the device has not registered a WWNN. port-id integer
Assigned port identifier of this entry. Range: [0..2^24-1] port-name string
optional
World wide port name (WWPN) of this entry. This element is omitted if the device has not registered a WWPN. port-type string
Port type of this entry. Possible values: "n-port", "nl-port", "fnl-port", "nx-port", "f-port", "fl-port", "e-port", "b-port", "nv-port", "fv-port", "sd-port", "te-port", "tl-port", and "none". symbolic-node-name string
optional
Registered symbolic node name. If the device has not registered one, this element will be omitted. symbolic-port-name string
optional
Registered symbolic port name. If the device has not registered one, this element will be omitted.
| Element definition: fcp-adapter-stats-info | [top] |
Statistics for one FC adapter.
Name Range Type Description adapter string
Which FC adapter. adapter-resets integer
Number of adapter resets occurred. crc-errors integer
Total CRC errors occurred. discarded-frames integer
Number of frames discarded by the target HBA. Range [0..2^31-1] frame-overruns integer
Number of frame overruns detected by the adapter during write requests. frame-underruns integer
Number of frame underruns detected by the adapter during read requests. initiators-connected integer
Total number of initiators connected to this target adapter. invalid-xmit-words integer
Number of invalid words transmitted. Range [0..2^31-1] is-sfp-diagnostics-internally-calibrated boolean
Indicates if the SFP diagnostics are internally calibrated or not. The optional SFP rx/tx fields are invalid (and therefore not provided) if the SFP diagnostics are not internally calibrated. is-sfp-optical-transceiver-valid boolean
Validity of the optical transceiver. Until Data ONTAP 8.0.0, this field was incorrectly named "is-spf-optical-transceiver-valid". While that field is also returned for backward compatibility, all new applications must use the current version. is-sfp-rx-power-in-range boolean
optional
Flag to indicate received optical power is in range. is-sfp-tx-power-in-range boolean
optional
Flag to indicate transmitted optical power is in range. link-breaks integer
Number of times that the link breaks. lip-resets integer
Number of times that a selective Reset LIP (Loop Initialization Primitive) occurred. LIP reset is used to preform a verndorspecific reset at the loop port specified by the AL-PA value. lr-received integer
Number of LRs (Link Reset) received by the target HBA. Range [0..2^31-1] lr-sent integer
Number of LRs (Link Reset) sent from the target HBA. Range [0..2^31-1] nos-received integer
Number of NOSs (Not_Operational Primitive Sequence)received by the target HBA. Range [0..2^31-1] ols-received integer
Number of OLSs (Offline Primitive Sequence) received by the target HBA. Range [0..2^31-1] protocol-errors integer
Number of protocol errors occured. Range [0..2^31-1] queue-depth integer
Counts the queue depth on the target HBA. scsi-requests-dropped integer
Number of SCSI requests being dropped. sfp-connector string
Connector used with the optical transceiver. sfp-date-code string
Date code for the optical transceiver. sfp-encoding string
Encoding used with the optical transceiver. Possible values ["8B10B", "?????"] sfp-fc-speed-capabilties string
FC speed capabilities for the optical transceiver. Possible values [1, 2, 4, 8 in Gbps] sfp-formfactor string
Form factor of the optical transceiver. Possible values: "SFP" (for Small FormFactor). sfp-part-number string
Part number for the optical transceiver. sfp-rev string
Revision for the optical transceiver. sfp-rx-power string
optional
SFP received optical power, reported to tenth decimal in uWatts. sfp-serial-number string
Serial number for the optical transceiver. sfp-tx-power string
optional
SFP transmitted optical power, reported to tenth decimal in uWatts. sfp-vendor-name string
Vendor name for the optical transceiver. sfp-vendor-oui string
Vendor OUI (The IEEE Organizationally Unique Identifier) for the optical transceiver. sfp-wavelength integer
Wavelength for the optical transceiver. Measured in nanometers. Range [830..860] spurious-interrupts integer
Count of spurious interrupts. total-logins integer
Counts the times of initiators added. Each time a new initiator is added, the total logins is incremented by 1. Each time an initiator is removed, the total logouts is incremented by 1. total-logouts integer
Counts the times of initiators removed. Each time a new initiator is added, the total logins is incremented by 1. Each time an initiator is removed, the total logouts is incremented by 1.
| Element definition: fcp-adapter-topology-switch-info | [top] |
Information about an FC switch connected to an FC adapter.
Name Range Type Description adapter string
The name of the adapter this switch is visible through. domain integer
The domain identifier of the FC switch. Range: [1..255] fcp-adapter-topology-switch-ports fcp-adapter-topology-switch-port-info[]
List of ports for the FC switch. logical-name string
The logical name of the FC switch. The maximum length is 64. node-name string
Node name of the FC switch. The format is: XX:XX:XX:XX:XX:XX:XX:XX where X is a hexadecimal digit. release string
The release version of the FC switch. The maximum length is 64. vendor string
The name of the FC switch vendor. The maximum length is 64.
| Element definition: fcp-adapter-zone-info | [top] |
Information about a zone.
Name Range Type Description adapter string
The adapter this zone is visible through. fcp-adapter-zone-members fcp-adapter-zone-member-info
List of zone members. zone-name string
The name of the zone. The maximum length is 64. zone-set-name string
The name of the zone set containing this zone. The maximum length is 64.
| Element definition: fcp-config-adapter-info | [top] |
Configuration information for one physical FC adapter.
Name Range Type Description adapter string
The slot name of the FC adapter. adapter-type string
optional
Type of the adapter. Possible values are "physical", "local", "standby", "partner". If an error occured while retrieving info for this adapter, this will not be returned. Starting with Data ONTAP 8.0, only single_image cfmode is supported. Outputs related to other cfmodes are deprecated and no longer returned by this api. cache-line-size integer
optional
Cache line size of adapter. verbose only. connection-established string
optional
Type of connection established, "ptp" or "loop". data-link-rate integer
optional
Data Link Rate in Gbits. verbose only. error-msg string
optional
Error message, if an error occured while retrieving info for this adapter. This will only be used if listing all adapters. If an error occurred while retrieving info for a specific adapter, the API will fail with error message. external-gbic-enabled boolean
optional
"true" if enabled, "false" otherwise. verbose only. fabric-established boolean
optional
"true" if fabric is established to this adapter, "false" otherwise. verbose only. firmware-rev string
optional
Firmware revision of adapter. verbose only. hardware-rev string
optional
Hardware revision of adapter. verbose only. info-name string
optional
Info name given to this adapter. verbose only. loop-id integer
optional
Loop address of adapter. If an error occured while retrieving info for this adapter, this will not be returned. This value lies between 0 and 255. Starting with Data ONTAP 8.0, only single_image cfmode is supported. Outputs related to other cfmodes are deprecated and no longer returned by this api. media-type string
optional
Media configured for this adapter, "ptp", "loop", or "auto". If an error occured while retrieving info for this adapter, this will not be returned. mpi-firmware-rev string
optional
MPI Firmware revision of adapter. verbose only. This is only available for converged network adapters (CNA). node-name string
optional
FCP World Wide Node Name (WWNN) of the adapter. If an error occured while retrieving info for this adapter, this will not be returned. packet-size integer
optional
FC packet size of adapter. verbose only. partner-adapter string
optional
Name of partner adapter for takeover if configured. Value of "none" indicates no partner set for this adapter. If an error occured while retrieving info for this adapter, this will not be returned. Starting with Data ONTAP 8.0, only single_image cfmode is supported. Outputs related to other cfmodes are deprecated and no longer returned by this api. pci-bus-width integer
optional
PCI bus width in bits. verbose only. pci-clock-speed integer
optional
PCI clock speed in MHz. verbose only. phy-firmware-rev string
optional
PHY Firmware revision of adapter. verbose only. This is only available for converged network adapters (CNA). physical-data-link-rate integer
optional
Physical Data Link Rate in Gbits. verbose only. This is only available for converged network adapters (CNA). physical-link-state string
optional
Physical Status of the adapter. verbose only. Possible values are "link up", "link down". This is only available for converged network adapters (CNA). port-address integer
optional
Host port address of adapter. If an error occured while retrieving info for this adapter, this will not be returned. port-id integer
optional
Port address of adapter. If an error occured while retrieving info for this adapter, this will not be returned. Starting with Data ONTAP 8.0, only single_image cfmode is supported. Outputs related to other cfmodes are deprecated and no longer returned by this api. port-name string
optional
FCP World Wide Port Name (WWPN) of adapter. If an error occured while retrieving info for this adapter, this will not be returned. speed string
optional
Speed configured for this adapter. Possible values: "auto", "1Gb", "2Gb", "4Gb", "8Gb", "10Gb". If an error occured while retrieving info for this adapter, this will not be returned. sram-parity-enabled boolean
optional
"true" if enabled, "false" otherwise. verbose only. standby boolean
optional
"true" if adapter is on standby, "false" otherwise. If an error occured while retrieving info for this adapter, this will not be returned. Starting with Data ONTAP 8.0, only single_image cfmode is supported. Outputs related to other cfmodes are deprecated and no longer returned by this api. state string
optional
Status of the adapter. Possible values are "startup", "uninitialized", "initializing firmware", "link not connected", "waiting for link up", "online", "link disconnected", "resetting", "offline", "offlined by user/system". If an error occured while retrieving info for this adapter, this will not be returned. switch-port string
optional
Switch and port this adapter is connected to. The string will be of the form X:Y where X is the name of the switch and Y is the port value. verbose only. vlan-id integer
optional
Assigned FC VLAN ID. verbose only. This is only available for converged network adapters (CNA).
| Element definition: fcp-port-name-info | [top] |
Information for one valid local port name.
Name Range Type Description fcp-adapter string
optional
Only if this WWPN is being used by a Fibre Channel interface, the name of the interface is returned. In Data ONTAP 7-Mode, the name of a local adapter. In Data ONTAP Cluster-Mode, the name of an FCP data LIF. is-used boolean
This indicates whether this WWPN is being used by a Fibre Channel target interface. port-name string
A Fibre Channel WWPN in the form XX:XX:XX:XX:XX:XX:XX:XX where X is a hexadecimal digit.
| Element definition: fcp-adapter-topology-switch-port-info | [top] |
Information about the FC switch port.
Name Range Type Description fcp-adapter-topology-attached-ports fcp-adapter-topology-attached-port-info[]
List of devices attached to this port. port-name string
World wide port name (WWPN) of the port. The format is: XX:XX:XX:XX:XX:XX:XX:XX where X is a hexadecimal digit. port-number integer
Port index number. Range: [0..2^32-1] port-state string
Port state. Possible values: "online", "offline", "testing", "fault", and "unknown". port-type string
Port type. Possible values: "n-port", "nl-port", "fnl-port", "nx-port", "f-port", "fl-port", "e-port", "b-port", "nv-port", "fv-port", "sd-port", "te-port", "tl-port", and "none".
| Element definition: fcp-adapter-zone-member-info | [top] |
Information about a zone member.
Name Range Type Description domain-id integer
optional
Domain identifier of the switch. This element is returned if the zone-member-type is "domain-id-port". Range: [0..2^32-1] fabric-port-name string
optional
World wide port name (WWPN) of the fabric port. This element is returned if the zone-member-type is "fabric-port-name". The format is: XX:XX:XX:XX:XX:XX:XX:XX where X is a hexadecimal digit. node-name string
optional
World wide node name (WWNN) of the N-port. This element is returned if the zone-member-type is "node-name". The format is: XX:XX:XX:XX:XX:XX:XX:XX where X is a hexadecimal digit. port integer
optional
Port number on the switch. This element is returned if the zone-member-type is "domain-id-port". Range: [0..2^32-1] port-id integer
optional
Assigned port identifier. This element is returned if the zone-member-type is "port-id". Range: [0..2^24-1] port-name string
optional
World wide port name (WWPN) of the N-port. This element is returned if the zone-member-type is "port-name". The format is: XX:XX:XX:XX:XX:XX:XX:XX where X is a hexadecimal digit. zone-member-type string
The type of zone member. Possible values are: "port-name", "domain-id-port", "port-id", "node-name", "fabric-port-name", and "unknown". zone-member-value integer
optional
Uninterpreted value. This element is returned if the zone-member-type is "unknown". Range: [0..2^32-1]
| Element definition: fcp-connected-initiator-info | [top] |
Information about an initiator connected to an FC adapter.
Name Range Type Description initiator-group-list initiator-group-list-info[]
List of initiator groups this initiator belongs to. node-name string
World Wide Node Name (WWNN) of initiator. port-address [0..2^32-1] integer
Fibre Channel host address it is connected to. port-name string
World Wide Port Name (WWPN) of the initiator. portname-alias-list portname-alias-name[]
List of aliases for the WWPN.
| Element definition: fcp-adapter-topology-attached-port-info | [top] |
Information about the attached device.
Name Range Type Description is-visible boolean
Visibility of this device through this adapter from a zoning perspective. port-id integer
Assigned port identifier of the attached device. A value of 0 indicates no value has been assigned. Range: [0..2^24-1] port-name string
World wide port name (WWPN) of the attached device. The format is: XX:XX:XX:XX:XX:XX:XX:XX where X is a hexadecimal digit.
| Element definition: initiator-group-list-info | [top] |
Initiator group this initiator belogs to.
Name Range Type Description initiator-group-name string
Name of initiator group.
| Element definition: portname-alias-name | [top] |
Aliases for this WWPN
Name Range Type Description portname-alias string
Alias for the WWPN