|
APIs in Category: fcp |
API version 1.5 |
| fcp-adapter-clear-partner | [top] |
Removes the name of the partner adapter which the local adapter should takeover.
Input Name Range Type Description fcp-adapter string
Local FC adapter.
Errno Description EINTERNALERROR EADAPTERNOTFOUND EADAPTERINVALIDTYPE EOPNOTSUPPORTED EINVAL
License fcp
| fcp-adapter-config-down | [top] |
Bring the adapter offline. If FCP service is not running, then the adapters are automatically offlined. 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.
Input Name Range Type Description fcp-adapter string
FC adapter to bring offline.
Errno Description EINTERNALERROR EADAPTERNOTFOUND EADAPTERINVALIDTYPE EADAPTERPARTNER ENOTSTARTED 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 EINVAL
License fcp
| fcp-adapter-config-up | [top] |
Bring the adapter online. If FCP service is not running, then the adapters are automatically offlined. They cannot be brought online again until FCP service is started. The adapter may not be online immediately after the call returns, it may take up to a few seconds for the adapter to initialize.
Input Name Range Type Description fcp-adapter string
FC adapter to bring online.
Errno Description EINTERNALERROR EADAPTERNOTFOUND EADAPTERINVALIDTYPE EADAPTERPARTNER ENOTSTARTED 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.
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 Fiber 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
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.
Input Name Range Type Description fcp-adapter string
Local FC adapter. partner-adapter string
Partner FC adapter to takeover.
Errno Description EINTERNALERROR EADAPTERNOTFOUND EADAPTERINVALIDTYPE EOPNOTSUPPORTED EINVAL
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 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-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: dual_fabric, mixed, partner, standby, single_image
Errno Description EINTERNALERROR ENOTCLUSTERED
License fcp
| fcp-node-get-name | [top] |
Get the current FCP node name. This nodename is in the form of a Fibre Channel world wide name, which is in the form XX:XX:XX:XX:XX:XX:XX:XX where X is a hexadecimal digit.
Output Name Range Type Description node-name string
Current FCP node name.
Errno Description EINTERNALERROR EOPNOTSUPPORTED
License fcp
| fcp-node-set-name | [top] |
Set the current FCP node name. This nodename is in the form of a Fibre Channel world wide name, which is in the form XX:XX:XX:XX:XX:XX:XX:XX where X is a hexadecimal digit. All Fibre Channel Target Adapters must be offlined in order to change the nodename. Changes will take place when adapters are brought online.
Input Name Range Type Description node-name string
FCP node name.
Errno Description EINTERNALERROR EINVAL EALREADYSTARTED EOPNOTSUPPORTED
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
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 iSCSI 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. If cfmode is set to 'dual_fabric' the filer connects to the FC fabric in loop mode and all initiators need to have multipathing software. If cfmode is set to 'mixed' the filer connects to the FC fabric in loop mode and assigns multiple virtual identities to each physical FC target adapter. If cfmode is set to 'partner' the filer connects to the FC fabric in ptp mode. The B-port on each FC target adapter proxies commands for the partner over the cluster interconnect. If cfmode is set to 'standby' the B-port is in standby mode and takes over the partner WWNN and WWPN during a cluster takeover. A ptp connection is used in this case. 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. On filers with only one FCP target port the valid cfmodes are 'dual_fabric', and 'single_image' On filers with more than FCP target port the valid cfmodes are 'mixed', 'partner', 'standby' and 'single_image'. 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: dual_fabric, mixed, partner, standby, single_image force boolean
optional
Forcibly change the cfmode, overriding cluster partner checks
Errno Description ENOTCLUSTERED ESERVICENOTSTOPPED EINTERNALERROR EINVAL EPERM EVDISK_ERROR_PARTNER_NOT_REACHABLE
License fcp
| Element definition: fcp-adapter-initiators-info | [top] |
A list of initiators currently connected to the adapter.
Name Range Type Description adapter string
The name this adapter is given. fcp-connected-initiators fcp-connected-initiator-info[]
Information about the connected initiators
| 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. 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. 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. queue-depth integer
Counts the queue depth on the target HBA. scsi-requests-dropped integer
Number of SCSI requests being dropped. 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-config-adapter-info | [top] |
Configuration information for one FC adapter.
Name Range Type Description adapter string
Which 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. 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. 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. node-name string
optional
FC name of 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. pci-bus-width integer
optional
PCI bus width in bits. verbose only. pci-clock-speed integer
optional
PCI clock speed in MHz. verbose only. 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. port-name string
optional
FC port name of adapter. If an error occured while retrieving info for this adapter, this will not be returned. speed string
optonal
Speed configured for this adapter, "auto", "1Gb", "2Gb", "4Gb". 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. 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.
| 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
Node name of initiator. port-address integer
Fibre Channel host address it is connected to. port-name string
Port name of the initiator.
| 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.