APIs in Category: iscsi | API version 1.1

iscsi-adapter-list-info iscsi-auth-generate-chap-password iscsi-initiator-add-auth iscsi-initiator-delete-auth iscsi-initiator-get-auth iscsi-initiator-get-default-auth iscsi-initiator-list-auth-info iscsi-initiator-set-default-auth

NetApp Manage ONTAP

iscsi-adapter-list-info | [top]

> Display the configuration information for all the iscsi adaptors.

> Output Name | Range | Type | Description
> iscsi-config-adapters |  | iscsi-config-adapter-info[] | A list of iscsi adapter configuration information.

> 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.
> password |  | string optional encrypted | CHAP user password, required for auth-type equals to CHAP.
> user-name |  | string optional | CHAP user name, required for auth-type equals to CHAP.

> Errno | Description
> EISCSISECINVALIDINPUTERROR |  |
> EISCSISECPROCESSINGERROR |  |

> 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.
> user-name |  | string optional | 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.
> user-name |  | string optional | CHAP user name, returned only if auth-type is CHAP.

> Errno | Description
> EISCSISECINVALIDINPUTERROR |  |
> EISCSISECPROCESSINGERROR |  |
> EISCSISECINITNOTFOUNDERROR |  |

> License
> iscsi

iscsi-initiator-list-auth-info | [top]

> Display the default authentication and all the initiator specific authentication information. Password, if present is left out for security purposes.

> Output Name | Range | Type | Description
> iscsi-security-entries |  | iscsi-security-entry-info[] | List of authentication entries.

> Errno | Description
> EISCSISECINVALIDINPUTERROR |  |
> EISCSISECPROCESSINGERROR |  |

> 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.
> password |  | string optional encrypted | CHAP user password, required for auth-type equals to CHAP.
> user-name |  | string optional | CHAP user name, required for auth-type equals to CHAP.

> Errno | Description
> EISCSISECINVALIDINPUTERROR |  |
> EISCSISECPROCESSINGERROR |  |

> License
> iscsi

Element definition: iscsi-config-adapter-info | [top]

> This type contains 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 ao 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]

> This type contains 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.
> user-name |  | string optional | CHAP user name, returned only if auth-type is CHAP.

Element definition: iscsi-portal-address-info | [top]

> This type contains configuration information about an inet-address and port pair for a portal group.

> Name | Range | Type | Description
> id |  | integer | ID of this portal group.
> inet-address |  | string | inet-address.
> port |  | integer | The port that is being listened on for that address.