Input Name	Range	Type	Description
fcp-adapter		string	FC adapter to bring offline.
node		string	The name of the storage system node where the adapter is installed.

Errno	Description
EINTERNALERROR
EADAPTERNOTFOUND
EADAPTERINVALIDTYPE
EADAPTERPARTNER
ENOTSTARTED
ENTAPI_EINVAL

License

fcp

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.
node		string	The name of the storage system node where the adapter is installed.

Errno	Description
EINTERNALERROR
EADAPTERNOTFOUND
EADAPTERINVALIDTYPE
EADAPTERPARTNER
ENOTSTARTED
EONTAPI_EINVAL

License

fcp

Iterate over the list of physical FC adapters.

Input Name	Range	Type	Description
desired-attributes		fcp-config-adapter-info optional	Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
max-records	[1..100]	integer optional	The maximum number of records to return in this call. Default: 20
query		fcp-config-adapter-info optional	A query that specifies which objects to return. A query could be specified on any number of attributes in the FC Adapter object. All FC Adapter objects matching this query up to 'max-records' will be returned.
tag		string optional	Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
Output Name	Range	Type	Description
attributes-list		fcp-config-adapter-info[] optional	The list of attributes of FC Adapter objects.
next-tag		string optional	Tag for the next call. Not present when there are no more FC Adapter objects to return.
num-records	[0..100]	integer	The number of records returned in this call.

Errno	Description
EINTERNALERROR

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
node		string	The name of the storage system node where the adapter is installed.
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

Iterate over a list of fcp objects.

Input Name	Range	Type	Description
desired-attributes		fcp-adapter-stats-info optional	Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
max-records	[1..100]	integer optional	The maximum number of records to return in this call. Default: 20
query		fcp-adapter-stats-info optional	A query that specifies which objects to return. A query could be specified on any number of attributes in the fcp object. All fcp objects matching this query up to 'max-records' will be returned.
tag		string optional	Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
Output Name	Range	Type	Description
attributes-list		fcp-adapter-stats-info[] optional	The list of attributes of fcp objects.
next-tag		string optional	Tag for the next call. Not present when there are no more fcp objects to return.
num-records	[0..100]	integer	The number of records returned in this call.

Errno	Description
EINTERNALERROR

List all initiators connected to FCP target LIFs.

Input Name	Range	Type	Description
desired-attributes		fcp-adapter-initiators-info optional	Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
max-records	[1..100]	integer optional	The maximum number of records to return in this call. Default: 20
query		fcp-adapter-initiators-info optional	A query that specifies which objects to return. A query could be specified on any number of attributes in the connected FCP initiator object. All connected FCP initiator objects matching this query up to 'max-records' will be returned.
tag		string optional	Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
Output Name	Range	Type	Description
attributes-list		fcp-adapter-initiators-info[] optional	The list of attributes of connected FCP initiator objects.
next-tag		string optional	Tag for the next call. Not present when there are no more connected FCP initiator objects to return.
num-records	[0..100]	integer	The number of records returned in this call.

Errno	Description
EINTERNALERROR

Iterate over a list of FCP Target Logical Interfaces (LIF).

Input Name	Range	Type	Description
desired-attributes		fcp-interface-info optional	Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
max-records	[1..100]	integer optional	The maximum number of records to return in this call. Default: 20
query		fcp-interface-info optional	A query that specifies which objects to return. A query could be specified on any number of attributes in the FCP data LIF object. All FCP data LIF objects matching this query up to 'max-records' will be returned.
tag		string optional	Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
Output Name	Range	Type	Description
attributes-list		fcp-interface-info[] optional	The list of attributes of FCP data LIF objects.
next-tag		string optional	Tag for the next call. Not present when there are no more FCP data LIF objects to return.
num-records	[0..100]	integer	The number of records returned in this call.

Errno	Description
EINTERNALERROR

Iterate over the list of valid Fibre Channel target port names on a Vserver's FCP LIFs.

Input Name	Range	Type	Description
desired-attributes		fcp-port-name-info optional	Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
max-records	[1..100]	integer optional	The maximum number of records to return in this call. Default: 20
query		fcp-port-name-info optional	A query that specifies which objects to return. A query could be specified on any number of attributes in the Fibre Channel target port name object. All Fibre Channel target port name objects matching this query up to 'max-records' will be returned.
tag		string optional	Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
Output Name	Range	Type	Description
attributes-list		fcp-port-name-info[] optional	The list of attributes of Fibre Channel target port name objects.
next-tag		string optional	Tag for the next call. Not present when there are no more Fibre Channel target port name objects to return.
num-records	[0..100]	integer	The number of records returned in this call.

Errno	Description
EINTERNALERROR

Iterate over the list of FCP Services.

Input Name	Range	Type	Description
desired-attributes		fcp-service-info optional	Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
max-records	[1..100]	integer optional	The maximum number of records to return in this call. Default: 20
query		fcp-service-info optional	A query that specifies which objects to return. A query could be specified on any number of attributes in the FCP Service object. All FCP Service objects matching this query up to 'max-records' will be returned.
tag		string optional	Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
Output Name	Range	Type	Description
attributes-list		fcp-service-info[] optional	The list of attributes of FCP Service objects.
next-tag		string optional	Tag for the next call. Not present when there are no more FCP Service objects to return.
num-records	[0..100]	integer	The number of records returned in this call.

Errno	Description
EINTERNALERROR

Iterate over the list of assigned World Wide Port Name (WWPN) aliases.

Input Name	Range	Type	Description
desired-attributes		aliases-info optional	Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
max-records	[1..100]	integer optional	The maximum number of records to return in this call. Default: 20
query		aliases-info optional	A query that specifies which objects to return. A query could be specified on any number of attributes in the WWPN aliases object. All WWPN aliases objects matching this query up to 'max-records' will be returned.
tag		string optional	Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
Output Name	Range	Type	Description
attributes-list		aliases-info[] optional	The list of attributes of WWPN aliases objects.
next-tag		string optional	Tag for the next call. Not present when there are no more WWPN aliases objects to return.
num-records	[0..100]	integer	The number of records returned in this call.

Errno	Description
EINTERNALERROR

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
vserver		string optional	Vserver containing the alias

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
vserver		string optional	Vserver of the FCP LIF.

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.

Configuration information for one physical FC adapter.

Name	Range	Type	Description
adapter		string	The slot name of the FC adapter.
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.
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.
max-speed	[1..10]	integer	The maximum speed of this adapter in Gbit/sec.
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		string	The name of the node where the adapter is installed.
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.
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).
physical-protocol		string	The physical protocol of the adapter. Possible values: "fibre_channel" - The adapter is a Fibre Channel adapter, "ethernet" - The adapter is a Fibre Channel over Ethernet adapter.
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-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.
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).

Information about a single FCP Logical Interface (LIF). When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

Name	Range	Type	Description
current-node		string optional	Node currently hosting the LIF. Attributes: non-creatable, non-modifiable
current-port		string optional	FC Adapter currently hosting the LIF. Attributes: non-creatable, non-modifiable
interface-name		string optional	Name of the LIF. Attributes: key, required-for-create, non-modifiable
node-name		string optional	World Wide Node Name (WWNN) of the LIF. All LIFs in a Vserver have the same WWNN as the Vserver's FCP service. Attributes: non-creatable, non-modifiable
port-address		string optional	Host port address of LIF. Attributes: non-creatable, non-modifiable
port-name		string optional	World Wide Port Name (WWPN) of the LIF. Attributes: non-creatable, non-modifiable
relative-port-id		integer optional	The SCSI Relative Target Port Identifier of the LIF. Attributes: non-creatable, non-modifiable
vserver		string optional	Vserver hosting the LIF. Attributes: key, non-creatable, non-modifiable

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.
vserver		string	Vserver containing this port name

FCP target service configuration. When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

Name	Range	Type	Description
is-available		boolean optional	true if the FCP Service is running, false otherwise. Attributes: non-creatable, non-modifiable
node-name		string optional	The world-wide node name (WWNN) of the FCP target in the Vserver. Attributes: optional-for-create, modifiable
vserver		string optional	Vserver hosting the FCP service. Attributes: key, non-creatable, non-modifiable

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.

Initiator group this initiator belogs to.

Name	Range	Type	Description
initiator-group-name		string	Name of initiator group.

Aliases for this WWPN

Name	Range	Type	Description
portname-alias		string	Alias for the WWPN