|
APIs in Category: iscsi |
API version 1.2 |
| iscsi-adapter-config-down | [top] |
Configures the specified adapter down.
Input Name Range Type Description iscsi-adapter string
iscsi adapter.
Errno Description EADAPTERNOTFOUND EADAPTERPARTNER EALREADYSTARTED ENOTSTARTED
License iscsi
| iscsi-adapter-config-up | [top] |
Configures the specified adapter up.
Input Name Range Type Description iscsi-adapter string
iscsi adapter.
Errno Description EADAPTERNOTFOUND EADAPTERPARTNER EALREADYSTARTED ENOTSTARTED
License iscsi
| iscsi-adapter-initiators-list-info | [top] |
Get the list of initiators currently connected to any of the portal groups associated with specified adapter. Information returned for each initiator includes the target portal group number to which the initiator is connected, as well as the iSCSI initiator nodename and ISID. If no adapter is specified, information is returned for all initiators connected through any adapter in the system.
Input Name Range Type Description iscsi-adapter string
optional
Adapter to get initiator list for. If no adapter is specified, information is returned for all initiators connected through any iscsi adapter in the system. Output Name Range Type Description iscsi-adapters iscsi-adapter-initiators-info[]
A list of iscsi adapters containing list of initiators.
Errno Description EADAPTERNOTFOUND EINTERNALERROR
License iscsi
| iscsi-adapter-list-info | [top] |
Display the configuration information for iscsi adaptor(s).
Input Name Range Type Description iscsi-adapter string
optional
Returns configuration information for adapter if specified. If not specified, then configuration information for all adapters are returned. Output Name Range Type Description iscsi-config-adapters iscsi-config-adapter-info[]
A list of iscsi adapter configuration information.
Errno Description EADAPTERNOTFOUND
License iscsi
| iscsi-adapter-reset-stats | [top] |
Resets the stats for the specified iSCSI Adapter. If none specified, reset stats for all iSCSI adapters.
Input Name Range Type Description iscsi-adapter string
optional
Adapter to reset statistics for.
Errno Description EADAPTERNOTFOUND EINTERNALERROR
License iscsi
| iscsi-adapter-stats-list-info | [top] |
List the current iSCSI statistics for the adapter specified. Statistics returned include the different iSCSI PDU types transmitted and received, SCSI CDB's processed, and various iSCSI errors which may occur. If no adapter is specified, statistics information is returned for all adapters in the system. A value of "-1" for any stat indicates that that stats field is not meaningful for that adapter.
Input Name Range Type Description iscsi-adapter string
optional
Adapter to get statistics for. Output Name Range Type Description iscsi-adapter-stats iscsi-adapter-stats-info[]
List of iSCSI adapters and their statistics.
Errno Description EADAPTERNOTFOUND EINTERNALERROR
License iscsi
| iscsi-auth-generate-chap-password | [top] |
Generate a 128 bit random password that can be used as a CHAP secret.
Output Name Range Type Description secret string
A randomly generated 128 bit password.
Errno Description EISCSISECPROCESSINGERROR
License iscsi
| iscsi-initiator-add-auth | [top] |
Add initiator to the authentication list.
Input Name Range Type Description auth-type string
Authentication type, possible values : CHAP, none, deny. initiator string
Name of initiator. i.e. iqn.1987-06.com.initvendor1:appsrv.sn.2346. outbound-password string
optional
encrypted
Outbound CHAP user password. Outbound authentication is optional. If Outbound authentication is not specified, then the initiator can only do inbound traffic. outbound-user-name string
optional
Outbound CHAP user name. Outbound authentication is optional. If Outbound authentication is not specified, then the initiator can only do inbound traffic. password string
optional
encrypted
Inbound CHAP user password, required for auth-type equals to CHAP. user-name string
optional
Inbound CHAP user name, required for auth-type equals to CHAP.
Errno Description EISCSISECINVALIDINPUTERROR EISCSISECPROCESSINGERROR
License iscsi
| iscsi-initiator-auth-list-info | [top] |
Get authentication information for the specified initiator If no initiator is specified, get authentication infomation for all the known initiators. Password, if present is left out for security purposes.
Input Name Range Type Description initiator string
optional
Name of initiator. i.e. iqn.1987-06.com.initvendor1:appsrv.sn.2346. If initiator is not supplied, all initiators are returned. Output Name Range Type Description iscsi-security-entries iscsi-security-entry-info[]
List of authentication entries.
Errno Description EISCSISECINVALIDINPUTERROR EISCSISECPROCESSINGERROR EISCSISECINITNOTFOUNDERROR
License iscsi
| iscsi-initiator-delete-auth | [top] |
Delete initiator from the authentication list
Input Name Range Type Description initiator string
Name of initiator. i.e. iqn.1987-06.com.initvendor1:appsrv.sn.2346.
Errno Description EISCSISECINVALIDINPUTERROR EISCSISECINITNOTFOUNDERROR
License iscsi
| iscsi-initiator-get-auth | [top] |
Get the authentication info for an initiator, if auth type is CHAP, only the user-name is returned, password is not returned for security purposes.
Input Name Range Type Description initiator string
Name of initiator. i.e. iqn.1987-06.com.initvendor1:appsrv.sn.2346. If initiator is not found, default authenticatioin method is returned Output Name Range Type Description auth-type string
Authentication type, possible values : CHAP, none, deny. outbound-user-name string
optional
Outbound CHAP user name, returned only if auth-type is CHAP and outbound authentication is enabled for this initiator. user-name string
optional
Inbound CHAP user name, returned only if auth-type is CHAP.
Errno Description EISCSISECINVALIDINPUTERROR EISCSISECPROCESSINGERROR EISCSISECINITNOTFOUNDERROR
License iscsi
| iscsi-initiator-get-default-auth | [top] |
Get the default auth info for iscsi. If the auth type is CHAP, only the username is retuned, and not the password, for security purposes.
Output Name Range Type Description auth-type string
Authentication type, possible values : CHAP, none, deny. outbound-user-name string
optional
Outbound CHAP user name, returned only if auth-type is CHAP, and outbound authentication is set for initiator. user-name string
optional
Inbound CHAP user name, returned only if auth-type is CHAP.
Errno Description EISCSISECINVALIDINPUTERROR EISCSISECPROCESSINGERROR EISCSISECINITNOTFOUNDERROR
License iscsi
| iscsi-initiator-set-default-auth | [top] |
Configure the default authentication method. If an initiator is not configured with a specific authentication method using iscsi-security-add the default authentication method will be applied to it.
Input Name Range Type Description auth-type string
Authentication type, possible values : CHAP, none, deny. outbound-password string
optional
encrypted
Outbound CHAP user password. Outbound authentication is optional. If Outbound authentication is not specified, then the initiator can only do inbound traffic. outbound-user-name string
optional
Outbound CHAP user name. Outbound authentication is optional. If Outbound authentication is not specified, then the initiator can only do inbound traffic. password string
optional
encrypted
Inbound CHAP user password, required for auth-type equals to CHAP. user-name string
optional
Inbound CHAP user name, required for auth-type equals to CHAP.
Errno Description EISCSISECINVALIDINPUTERROR EISCSISECPROCESSINGERROR
License iscsi
| iscsi-node-get-name | [top] |
Return the current iscsi node name.
Output Name Range Type Description node-name string
Current iscsi node name.
Errno Description EINTERNALERROR
License iscsi
| iscsi-node-set-name | [top] |
Set the current iscsi node name.
Input Name Range Type Description node-name string
New iscsi node name to set.
Errno Description EINVAL EINTERNALERROR
License iscsi
| iscsi-service-start | [top] |
Start iSCSI service. Service will be avaliable once the call returns with success.
Errno Description EALREADYSTARTED EINTERNALERROR
License iscsi
| iscsi-service-status | [top] |
Get status of the iSCSI 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 iscsi
| iscsi-service-stop | [top] |
Stops iSCSI service. Service will be no available once the call returns with success.
Errno Description ENOTSTARTED EINTERNALERROR
License iscsi
| Element definition: iscsi-adapter-initiators-info | [top] |
A list of initiators currently connected to the adapter.
Name Range Type Description iscsi-connected-initiators iscsi-connected-initiator-info[]
Information about the connected initiators name string
The name this adapter is given.
| Element definition: iscsi-adapter-stats-info | [top] |
Statistics for one iSCSI adapter.
Name Range Type Description iscsi-cdb-stats iscsi-cdb-stats-info
Statistics of Command Descriptor Blocks. iscsi-error-stats iscsi-error-stats-info
Statistics of errors. iscsi-received-stats iscsi-received-stats-info
Statistics of PDUs received. iscsi-transmitted-stats iscsi-transmitted-stats-info
Statistics of PDUs transmitted. name string
The name this adapter is given.
| Element definition: iscsi-config-adapter-info | [top] |
Configuration information about a single iscsi adapter.
Name Range Type Description name string
The name this adapter is given. portal-addresses iscsi-portal-address-info[]
A list of portal group address + port that this adapter is listening on. state string
State of the adapter, either "online", "offline", "local", "partner", "error". "online" and "offline" is used when the adapter is used for the current host. "local" if the adapter is operating on behalf of the local host, and "partner" if the adapter is operating on behalf of the partner host. "error" is used if some an internal error occurred when tring to load this adapter info. status string
optional
A short status message explaining the state. i.e. if the adapter is offline, the reason for it, or if its "error" what the error is. This will not be returned if the state of the adapter is "online".
| Element definition: iscsi-security-entry-info | [top] |
Information about a single authenication entry.
Name Range Type Description auth-type string
Authentication type, possible values : CHAP, none, deny. initiator string
Name of initiator. i.e. iqn.1987-06.com.initvendor1:appsrv.sn.2346 or "default" if this is a default auth entry. outbound-user-name string
optional
Outbound CHAP user name, returned only if auth-type is CHAP, and outbound authentication is set for initiator. user-name string
optional
Inbound CHAP user name, returned only if auth-type is CHAP.
| Element definition: iscsi-cdb-stats-info | [top] |
Counts for Command Descriptor Blocks processed
Name Range Type Description data-in-blocks integer
Count of data in blocks. data-out-blocks integer
Count of data out blocks. error-status integer
Count of errors. success-status integer
Count of successes. total integer
Total Command Descriptor Blocks processed.
| Element definition: iscsi-connected-initiator-info | [top] |
Information about an initiator connected to an iSCSI adapter.
Name Range Type Description initiator-name string
Name of initiator. isid string
ISID in form of "xx:xx:xx:xx:xx:xx". portal-group-id integer
Target portal group number to which the initiator is connected.
| Element definition: iscsi-error-stats-info | [top] |
Counts for iSCSI errors.
Name Range Type Description digest integer
Count of digest errors. disconnects integer
Count of unexpected session disconnects. failed-logins integer
Count of failed logins. failed-logouts integer
Count of failed logouts. failed-task-mgt integer
Count of failed management tasks. failed-text-cmd integer
Count of failed text commands. invalid-header integer
Count of PDU discards due to invalid PDU header. outside-cmd-sn-window integer
Count of PDU discards due to PDU being outside of command sequence number window. protocol integer
Count of protocol errors. total integer
Total errors.
| Element definition: iscsi-portal-address-info | [top] |
Configuration information about an inet-addres and port pair for a portal group.
Name Range Type Description id integer
ID of this portal group. inet-address ip-address
inet-address. port integer
The port that is being listened on for that address.
| Element definition: iscsi-received-stats-info | [top] |
Counts for PDUs received.
Name Range Type Description data-out integer
Count of data out requests. login-req integer
Count of login requests. logout-req integer
Count of logout requests. nop-out integer
Count of NOP Out. scsi-cmd integer
Count of SCSI commands. scsi-task-mgt-cmd integer
Count of SCSI task management commands. snack integer
Count of SNACK requests. text-req integer
Count of text requests. total integer
Total PDUs received. unknown integer
Count of unknown PDUs.
| Element definition: iscsi-transmitted-stats-info | [top] |
Counts for PDUs transmitted.
Name Range Type Description async-msg integer
Count of asynchronous iSCSI messages. data-in integer
Count of data in PDUs. login-rsp integer
Count of login responses. logout-rsp integer
Count of logout responses. nop-in integer
Count of NOP In. ready-to-transmit integer
Count of ready to transmit PDUs reject integer
Count of reject PDUs. scsi-rsp integer
Count of scsi responses. scsi-task-mgt-rsp integer
Count of scsi task management responses. text-rsp integer
Count of text responses. total integer
Total PDUs transmitted.
| Element definition: ip-address | [top] |
One ip address, in dotted-decimal format (for example, "192.168.11.12").
[none]