APIs in Category: iscsi | Vserver API version 1.15

iscsi-auth-generate-chap-password iscsi-connection-get-iter iscsi-initiator-add-auth iscsi-initiator-auth-get-iter iscsi-initiator-delete-auth iscsi-initiator-get-auth iscsi-initiator-get-default-auth iscsi-initiator-get-iter iscsi-initiator-modify-chap-params iscsi-initiator-set-default-auth iscsi-interface-accesslist-add iscsi-interface-accesslist-get-iter iscsi-interface-accesslist-remove iscsi-interface-disable iscsi-interface-enable iscsi-interface-get-iter iscsi-node-get-name iscsi-node-set-name iscsi-service-create iscsi-service-destroy iscsi-service-get-iter iscsi-service-start iscsi-service-status iscsi-service-stop iscsi-session-get-iter iscsi-stats-get-iter iscsi-target-alias-clear-alias iscsi-target-alias-get-alias iscsi-target-alias-set-alias iscsi-tpgroup-create iscsi-tpgroup-destroy iscsi-tpgroup-get-iter iscsi-tpgroup-interface-add iscsi-tpgroup-interface-delete

NetApp Manage ONTAP

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 |  |

> Vfiler-enabled
> Yes

> License
> iscsi

iscsi-connection-get-iter | [top]

> Iterate over a list of iSCSI Connection objects.

> Input Name | Range | Type | Description
> desired-attributes |  | iscsi-connection-list-entry-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 |  | iscsi-connection-list-entry-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the iSCSI Connection object. All iSCSI Connection 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 |  | iscsi-connection-list-entry-info[] optional | The list of attributes of iSCSI Connection objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more iSCSI Connection objects to return.
> num-records | [0..100] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

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. The initiator name must conform to RFC 3720, for example: "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.
> radius |  | boolean optional | "true" if RADIUS is the only forced CHAP authentication policy, Default is "false".
> user-name |  | string optional | Inbound CHAP user name, required for auth-type equals to CHAP.

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

> Vfiler-enabled
> Yes

> License
> iscsi

iscsi-initiator-auth-get-iter | [top]

> Iterate over a list of iSCSI initiator authentication configuration objects.

> Input Name | Range | Type | Description
> desired-attributes |  | iscsi-security-entry-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 |  | iscsi-security-entry-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the iSCSI initiator authentication configuration object. All iSCSI initiator authentication configuration 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 |  | iscsi-security-entry-info[] optional | The list of attributes of iSCSI initiator authentication configuration objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more iSCSI initiator authentication configuration objects to return.
> num-records | [0..100] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

iscsi-initiator-delete-auth | [top]

> Delete initiator from the authentication list

> Input Name | Range | Type | Description
> initiator |  | string | Name of initiator. The initiator name must conform to RFC 3720, for example: "iqn.1987-06.com.initvendor1:appsrv.sn.2346".

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

> Vfiler-enabled
> Yes

> 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. The initiator name must conform to RFC 3720, for example: "iqn.1987-06.com.initvendor1:appsrv.sn.2346". If initiator is not found, default authentication method is returned
> Output Name | Range | Type | Description
> auth-chap-policy |  | string optional | CHAP authentication path. Possible values: "radius", "local".
> 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 |  |

> Vfiler-enabled
> Yes

> 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-chap-policy |  | string optional | CHAP authentication path. possible values: "radius", "local".
> 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 |  |

> Vfiler-enabled
> Yes

> License
> iscsi

iscsi-initiator-get-iter | [top]

> Iterate over a list of remote iSCSI initiator objects.

> Input Name | Range | Type | Description
> desired-attributes |  | iscsi-initiator-list-entry-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 |  | iscsi-initiator-list-entry-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the remote iSCSI initiator object. All remote iSCSI 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 |  | iscsi-initiator-list-entry-info[] optional | The list of attributes of remote iSCSI initiator objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more remote iSCSI initiator objects to return.
> num-records | [0..100] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

iscsi-initiator-modify-chap-params | [top]

> Modify CHAP parameters to an existing per-initiator authentication info whose auth-type equals CHAP.

> Input Name | Range | Type | Description
> initiator |  | string | Name of initiator. The initiator name must conform to RFC 3720, for example: "iqn.1987-06.com.initvendor1:appsrv.sn.2346". The per-initiator authentication info must have an auth-type equal to CHAP.
> outbound-password |  | string optional encrypted | Outbound CHAP user password. If Outbound CHAP parameters are specified they will replace existing Outbound CHAP parameters. If no Outbound CHAP parameters were previously specified, then the specified Outbound CHAP parameters will enable mutual CHAP authentication. If no Outbound CHAP parameters are specified and no Outbound CHAP parameters exist, then one-way Inbound CHAP authentication will be continue to be used.
> outbound-user-name |  | string optional | Outbound CHAP user name. If Outbound CHAP parameters are specified they will replace existing Outbound CHAP parameters. If no Outbound CHAP parameters were previously specified, then the specified Outbound CHAP parameters will enable mutual CHAP authentication. If no Outbound CHAP parameters are specified and no Outbound CHAP parameters exist, then one-way Inbound CHAP authentication will be continue to be used.
> password |  | string optional encrypted | Inbound CHAP user password. If Inbound CHAP parameters are specified they will replace the existing Inbound CHAP parameters. If they are not specified, the existing Inbound CHAP parameters will continue to be used.
> radius |  | boolean optional | "true" if RADIUS is the only forced CHAP authentication policy, Default is "false".
> remove-outbound |  | boolean optional | Flag which indicates that mutual CHAP authentication is to be converted to one-way CHAP authentication. Outbound CHAP parameters must not be specified when remove-outbound is true. The default value is false.
> user-name |  | string optional | Inbound CHAP user name. If Inbound CHAP parameters are specified they will replace the existing Inbound CHAP parameters. If they are not specified, the existing Inbound CHAP parameters will continue to be used.

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

> Vfiler-enabled
> Yes

> 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-initiator-add-auth the default authentication method will be applied to it.

> Input Name | Range | Type | Description
> auth-type |  | string | 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.
> radius |  | boolean optional | "true" if RADIUS is the only forced CHAP authentication policy, Default is "false".
> user-name |  | string optional | Inbound CHAP user name, required for auth-type equals to CHAP.

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

> Vfiler-enabled
> Yes

> License
> iscsi

iscsi-interface-accesslist-add | [top]

> Add the iSCSI LIFs to the accesslist of the specified initiator

> Input Name | Range | Type | Description
> initiator |  | string | Initiator that can access the iSCSI LIFs
> interface-name |  | string | iSCSI LIF Name

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

iscsi-interface-accesslist-get-iter | [top]

> Iterate over a list of iSCSI Interface Accesslist objects.

> Input Name | Range | Type | Description
> desired-attributes |  | iscsi-interface-accesslist-entry-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 |  | iscsi-interface-accesslist-entry-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the iSCSI Interface Accesslist object. All iSCSI Interface Accesslist 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 |  | iscsi-interface-accesslist-entry-info[] optional | The list of attributes of iSCSI Interface Accesslist objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more iSCSI Interface Accesslist objects to return.
> num-records | [0..100] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

iscsi-interface-accesslist-remove | [top]

> Remove the iSCSI LIFs from the accesslist of the specified initiator

> Input Name | Range | Type | Description
> initiator |  | string | Initiator that can access the iSCSI LIFs
> interface-name |  | string | iSCSI LIF Name

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

iscsi-interface-disable | [top]

> Disables an interface for use by iSCSI

> Input Name | Range | Type | Description
> interface-name |  | string | Name of interface to disable. In Data ONTAP 7-Mode, this is the name of a physical ethernet interface, for example: "e0c". In Data ONTAP Cluster-Mode, this is the name of an iSCSI data LIF in the Vserver.

> Errno | Description
> EAPILICENSE |  |
> EINVALIDINPUTERROR |  |
> EINVALIDSTATE |  |

> Vfiler-enabled
> Yes

> License
> iscsi

iscsi-interface-enable | [top]

> Enables an interface for use by iSCSI

> Input Name | Range | Type | Description
> interface-name |  | string | Name of interface to enable. In Data ONTAP 7-Mode, this is the name of a physical ethernet interface, for example: "e0c". In Data ONTAP Cluster-Mode, this is the name of an iSCSI data LIF in the Vserver.

> Errno | Description
> EAPILICENSE |  |
> EINVALIDINPUTERROR |  |
> EINVALIDSTATE |  |

> Vfiler-enabled
> Yes

> License
> iscsi

iscsi-interface-get-iter | [top]

> Iterate over a list of iSCSI target interface objects.

> Input Name | Range | Type | Description
> desired-attributes |  | iscsi-interface-list-entry-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 |  | iscsi-interface-list-entry-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the iSCSI target interface object. All iSCSI target interface 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 |  | iscsi-interface-list-entry-info[] optional | The list of attributes of iSCSI target interface objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more iSCSI target interface objects to return.
> num-records | [0..100] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

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
> EAPILICENSE |  |

> Vfiler-enabled
> Yes

> 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; must be <= 128 chars, and conform to iSCSI rules

> Errno | Description
> EAPILICENSE |  |
> EINVALIDINPUTERROR |  |

> Vfiler-enabled
> Yes

> License
> iscsi

iscsi-service-create | [top]

> Create an iSCSI Service in a Vserver. Each Vserver requires an online iSCSI Service in order to serve data via the iSCSI protocol.

> Input Name | Range | Type | Description
> alias-name |  | string optional | The iSCSI target alias for the iSCSI service. If not provided, the Vserver name will be used.
> node-name |  | string optional | The iSCSI target name for the Vserver. The target-name must conform to RFC 3720. If not provided, one will be auto-generated.
> start |  | boolean optional | Determine the initial state of the iSCSI Service. If true, the service will be automatically started after creation completes. If false, the service will be left in the stopped state and the caller must subsequently call iscsi-service-start to start the service. The default is true.
> Output Name | Range | Type | Description
> node-name |  | string | The new iSCSI target name for the Vserver.

> Errno | Description
> EINTERNALERROR |  |

> License
> iSCSI

iscsi-service-destroy | [top]

> Destroy the iSCSI Service in a Vserver.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

> License
> iSCSI

iscsi-service-get-iter | [top]

> Iterate over the list of iSCSI Services.

> Input Name | Range | Type | Description
> desired-attributes |  | iscsi-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 |  | iscsi-service-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the iSCSI Service object. All iSCSI 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 |  | iscsi-service-info[] optional | The list of attributes of iSCSI Service objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more iSCSI Service objects to return.
> num-records | [0..100] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

iscsi-service-start | [top]

> Start iSCSI service. Service will be avaliable once the call returns with success.

> Errno | Description
> EALREADYSTARTED |  |
> EINTERNALERROR |  |
> EREVERTINPROGRESS |  |

> Vfiler-enabled
> Yes

> 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 |  |

> Vfiler-enabled
> Yes

> License
> iscsi

iscsi-service-stop | [top]

> Stops iSCSI service. Service will be not be available once the call returns with success.

> Errno | Description
> ENOTSTARTED |  |
> EINTERNALERROR |  |

> Vfiler-enabled
> Yes

> License
> iscsi

iscsi-session-get-iter | [top]

> Iterate over a list of iSCSI session objects.

> Input Name | Range | Type | Description
> desired-attributes |  | iscsi-session-list-entry-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 |  | iscsi-session-list-entry-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the iSCSI session object. All iSCSI session 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 |  | iscsi-session-list-entry-info[] optional | The list of attributes of iSCSI session objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more iSCSI session objects to return.
> num-records | [0..100] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

iscsi-stats-get-iter | [top]

> Iterate over a list of iscsi objects.

> Input Name | Range | Type | Description
> desired-attributes |  | iscsi-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 |  | iscsi-stats-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the iscsi object. All iscsi 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 |  | iscsi-stats-info[] optional | The list of attributes of iscsi objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more iscsi objects to return.
> num-records | [0..100] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

iscsi-target-alias-clear-alias | [top]

> Clear the current iscsi target alias

> Errno | Description
> EAPILICENSE |  |

> Vfiler-enabled
> Yes

> License
> iscsi

iscsi-target-alias-get-alias | [top]

> Return the current iscsi target alias

> Output Name | Range | Type | Description
> alias-name |  | string optional | Current iscsi target alias if alias-assigned is true.
> is-alias-assigned |  | boolean | True if alias assigned, false otherwise.

> Errno | Description
> EAPILICENSE |  |

> Vfiler-enabled
> Yes

> License
> iscsi

iscsi-target-alias-set-alias | [top]

> Set the current iscsi target alias

> Input Name | Range | Type | Description
> alias-name |  | string | New iscsi target alias to set; must be 128 bytes or less. Free form format otherwise, although a string of all blanks will be rejected

> Errno | Description
> EAPILICENSE |  |
> EINVALIDINPUTERROR |  |

> Vfiler-enabled
> Yes

> License
> iscsi

iscsi-tpgroup-create | [top]

> Create a new user defined target portal group.

> Input Name | Range | Type | Description
> tpgroup-name |  | string | Name of new user defined target portal group. Name must be <= 32 characters. In Data ONTAP 7-Mode, user defined target portal group names cannot end with "default" as this would conflict with names of default target portal groups. In Data ONTAP Cluster-Mode, user defined target portal groups cannot use the name of any defined logical interfaces (LIFs) in the vserver as this would conflict with names of default target portal groups.
> tpgroup-tag | [0..65535] | integer optional | Optional target portal group tag supplied by user. Default value is system generated.
> Output Name | Range | Type | Description
> tpgroup-tag | [0..65535] | integer | New target portal group tag.

> Errno | Description
> EAPILICENSE |  |
> EINVALIDINPUTERROR |  |
> EINTERNALERROR |  |

> Vfiler-enabled
> Yes

> License
> iscsi

iscsi-tpgroup-destroy | [top]

> Destroy a tpgroup. Only user defined target portal groups may be destroyed.

> Input Name | Range | Type | Description
> tpgroup-tag | [0..65535] | integer | Tag of portal group to destroy.

> Errno | Description
> EAPILICENSE |  |
> EINVALIDINPUTERROR |  |

> Vfiler-enabled
> Yes

> License
> iscsi

iscsi-tpgroup-get-iter | [top]

> Iterate over a list of iSCSI Target Portal Group objects.

> Input Name | Range | Type | Description
> desired-attributes |  | iscsi-tpgroup-list-entry-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 |  | iscsi-tpgroup-list-entry-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the iSCSI Target Portal Group object. All iSCSI Target Portal Group 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 |  | iscsi-tpgroup-list-entry-info[] optional | The list of attributes of iSCSI Target Portal Group objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more iSCSI Target Portal Group objects to return.
> num-records | [0..100] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

iscsi-tpgroup-interface-add | [top]

> Add an interface to a target portal group. Interfaces may only be added to a user defined target portal group.

> Input Name | Range | Type | Description
> interface-name |  | string | Name of network interface to add. In Data ONTAP 7-Mode, this is the name of a physical or virtual ethernet interface, for example: "e0c" or "vif1". In Data ONTAP Cluster-Mode, this is the name of an iSCSI data LIF in the Vserver.
> tpgroup-tag | [0..65535] | integer | Target portal group tag.

> Errno | Description
> EAPILICENSE |  |
> EINVALIDINPUTERROR |  |

> Vfiler-enabled
> Yes

> License
> iscsi

iscsi-tpgroup-interface-delete | [top]

> Remove an interface from a target portal group. Interfaces may only be removed from a user defined target portal group. Removing an interface will return it to the system defined default group for the interface.

> Input Name | Range | Type | Description
> interface-name |  | string | Name of network interface to remove. In Data ONTAP 7-Mode, this is the name of a physical or virtual ethernet interface, for example: "e0c" or "vif1" In Data ONTAP Cluster-Mode, this is the name of an iSCSI data LIF in the Vserver.
> tpgroup-tag | [0..65535] | integer | Target portal group tag.

> Errno | Description
> EAPILICENSE |  |
> EINVALIDINPUTERROR |  |

> Vfiler-enabled
> Yes

> License
> iscsi

Element definition: iscsi-connection-list-entry-info | [top]

> Information about an iSCSI connection. In Data ONTAP 7-Mode, connections are uniquely identified by the combination of 'session-id' and 'connection-id'. In Data ONTAP Cluster-Mode, sessions are uniquely identified within a Vserver by the combination of 'tpgroup-name', 'session-id' and 'connection-id'.

> Name | Range | Type | Description
> connection-id | [0..65535] | integer | Connection id
> connection-state |  | string | Current state of this connection. Possible values: "New_Connection", "Waiting_Tpgtag_Assignment", "Login_Waiting_Req", "Login_Req_Rcvd", "Login_Waiting_Auth", "Login_OK_New_Session_Requested", "Login_New_Session_Waiting_Reinstatement", "Login_OK_New_Conn_Requested", "Login_New_Conn_Waiting_Reinstatement", "Login_Send_Final_Resp", "Full_Feature_Phase", "Shutdown_Start", "Shutdown_Waiting_Sockio_Shutdown", "Shutdown_Sockio_Shutdown_Done", "Shutdown_Waiting_ImmDeliv_FFPCmds_Done", "Shutdown_ImmDeliv_FFPCmds_Done", "Shutdown_Recovery_Waiting_FFPCmds_Ready", "Shutdown_Recovery_Waiting_Logout_Rcvd", "Shutdown_Recovery_Logout_Rcvd", "Shutdown_Recovery_Waiting_FFPCmds_Reassigned", "Shutdown_Terminate_Abort_Seq_FFPCmds", "Shutdown_Terminate_Waiting_Seq_FFPCmds_Done", "Shutdown_Terminate_Seq_FFPCmds_Done".
> has-session |  | boolean | True if this connection is associated to a session, false otherwise.
> interface-name |  | string | Name of the network interface hosting this connection. In Data ONTAP 7-Mode, this is the name of a physical ethernet interface, for example: "e0c". In Data ONTAP Cluster-Mode, this is the name of an iSCSI data LIF in the Vserver.
> local-ip-address |  | string | Storage System iSCSI Target IP address.
> local-ip-port | [0..65535] | integer | Storage System iSCSI Target TCP port.
> remote-ip-address |  | string | Remote initiator IP address.
> remote-ip-port | [0..65535] | integer | Remote initiator TCP port.
> session-id | [0..65535] | integer | Session id for the associated session, or 0 if this connection is not yet associated to a session.
> tpgroup-name |  | string | The name of the target portal group associated with this session.
> tpgroup-tag | [0..65535] | integer | The tag of the target portal group associated with this session.
> vserver |  | string | Name of the vserver containing this connection.

Element definition: iscsi-initiator-list-entry-info | [top]

> Information about a single initiator.

> Name | Range | Type | Description
> initiator-aliasname |  | string | User-friendly name assigned to initiator.
> initiator-group-list |  | initiator-group-list-info[] | List of initiator groups containing this iSCSI initiator.
> initiator-nodename |  | string | Name of initiator. The initiator name must conform to RFC 3720, for example: "iqn.1987-06.com.initvendor1:appsrv.sn.2346".
> isid |  | string | ISID for this session selected by initiator represented as 6 hexadecimal octets separated by colons, for example: "40:01:37:00:00:00".
> target-session-id | [0..65535] | integer | iSCSI session identifier assigned by the target.
> tpgroup-name |  | string | The name of the target portal group associated with this session.
> tpgroup-tag | [0..65535] | integer | Tag of target portal group associated with this session.
> vserver |  | string | Name of the vserver this initiator is connected to.

Element definition: iscsi-interface-accesslist-entry-info | [top]

> Information about a single accesslist entry 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
> initiator |  | string optional | Initiator that can access the iSCSI LIFs Attributes: key, non-creatable, non-modifiable
> interface-name |  | string optional | iSCSI LIF Name Attributes: key, non-creatable, non-modifiable
> vserver |  | string optional | Vserver hosting the iSCSI LIF Attributes: key, non-creatable, non-modifiable

Element definition: iscsi-interface-list-entry-info | [top]

> Information about a single interface

> Name | Range | Type | Description
> current-node |  | string | Name of the node currently hosting the LIF.
> current-port |  | string | Name of the physical ethernet interface currently hosting the LIF.
> interface-name |  | string | Name of interface. In Data ONTAP 7-Mode, this is the name of a physical ethernet interface, for example: "e0c". In Data ONTAP Cluster-Mode, this is the name of an iSCSI data LIF in the Vserver.
> ip-address |  | string | iSCSI target portal IP address.
> ip-port | [0..65535] | integer | iSCSI target portal TCP port.
> is-interface-enabled |  | boolean | "true" if interface enabled for iSCSI, "false" otherwise.
> relative-port-id | [1..65535] | integer | The SCSI Relative Target Port Identifier of the LIF.
> tpgroup-name |  | string | Name of target portal group interface is associated with.
> tpgroup-tag | [0..65535] | integer | Id of target portal group interface is associated with.
> vserver |  | string optional | The name of the vserver containing this iSCSI data LIF.

Element definition: iscsi-security-entry-info | [top]

> Information about a single authentication entry.

> Name | Range | Type | Description
> auth-chap-policy |  | string optional | CHAP authentication path. Possible values: "local", "radius".
> auth-type |  | string | Authentication type. Possible values: "CHAP", "none", "deny".
> initiator |  | string | Name of initiator. The initiator name must conform to RFC 3720, for example: "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.
> vserver |  | string | Vserver containing this authentication information.

Element definition: iscsi-service-info | [top]

> iSCSI 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
> alias-name |  | string optional | The iSCSI target alias of the Vserver. Attributes: optional-for-create, modifiable
> is-available |  | boolean optional | true if the iSCSI Service is running, false otherwise. Attributes: non-creatable, non-modifiable
> node-name |  | string optional | The iSCSI target name of the Vserver. Attributes: optional-for-create, modifiable
> vserver |  | string optional | Vserver hosting the iSCSI service. Attributes: key, non-creatable, non-modifiable

Element definition: iscsi-session-list-entry-info | [top]

> Information about a single iSCSI session. In Data ONTAP 7-Mode, sessions are uniquely identified by the 'target-session-id'. In Data ONTAP Cluster-Mode, sessions are uniquely identified within a Vserver by the combination of 'tpgroup-name' and 'target-session-id'.

> Name | Range | Type | Description
> cmd-window-size | [0..2^31-1] | integer | Command window size.
> data-pdu-in-order |  | boolean | The DataPDUInOrder of the session as defined in RFC 3720.
> data-sequence-in-order |  | boolean | The DataSequenceInOrder of the session as defined in RFC 3720.
> default-time-to-retain | [0..3600] | integer | The DefaultTime2Retain of the session as defined in RFC 3720, in seconds.
> default-time-to-wait | [0..3600] | integer | The DefaultTime2Wait of the session as defined in RFC 3720, in seconds.
> error-recovery-level | [0..2] | integer | iSCSI ErrorRecoveryLevel as defined in RFC 3720.
> first-burst-length | [512..2^24-1] | integer | The FirstBurstLength of the session as defined in RFC 3720, in bytes.
> immediate-data-enabled |  | boolean | True if this session has immediate data enabled, false otherwise.
> initial-r2t-enabled |  | boolean | True if this session has R2T enabled, false otherwise.
> initiator-aliasname |  | string | The user-friendly name assigned to initiator.
> initiator-nodename |  | string | Name of initiator. The initiator name must conform to RFC 3720, for example: "iqn.1987-06.com.initvendor1:appsrv.sn.2346".
> iscsi-session-connection-list-entries |  | iscsi-session-connection-list-entry-info[] | List of TCP/IP connections associated with this session
> iscsi-sesssion-cmd-list-entries |  | iscsi-sesssion-cmd-list-entry-info[] | List of active commands associated with this session
> isid |  | string | ISID for this session selected by initiator represented as 6 hexadecimal octets separated by colons, for example: "40:01:37:00:00:00".
> max-burst-length | [512..2^24-1] | integer | The MaxBurstLength of the session as defined in RFC 3720, in bytes.
> max-connections | [0..65535] | integer | Maximum number of connections for this session.
> max-outstanding-r2t | [1..65535] | integer | The MaxOutstandingR2T of the session as defined in RFC 3720.
> session-type |  | string | Possible values: "normal" or "discovery".
> target-session-id | [0..65535] | integer | The iSCSI session identifier assigned by the storage system.
> tpgroup-name |  | string | The name of the target portal group associated with this session.
> tpgroup-tag | [0..65535] | integer | The tag of the target portal group associated with this session.
> vserver |  | string | The name of the vserver containing this session.

Element definition: iscsi-stats-info | [top]

> Statistics block

> 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.
> vserver |  | string | Vserver hosting the iSCSI service.

Element definition: iscsi-tpgroup-list-entry-info | [top]

> Information about a single portal group

> Name | Range | Type | Description
> interface-list-entries |  | interface-list-entry-info[] | List of interfaces associated with this tpgroup.
> is-user-defined |  | boolean | True if the target portal group is user defined, false if the target portal group is system defined.
> tpgroup-name |  | string | Portal group name.
> tpgroup-tag |  | integer | Portal group tag.
> vserver |  | string optional | Vserver containing this target portal group.

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: interface-list-entry-info | [top]

> Information about a single interface

> Name | Range | Type | Description
> interface-name |  | string | Name of network interface. In Data ONTAP 7-Mode, this is the name of a physical or virtual ethernet interface, for example: "e0c" or "vif0". In Data ONTAP Cluster-Mode, this is the name of an iSCSI data LIF in the Vserver.

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-error-stats-info | [top]

> Counts for iSCSI errors.

> Name | Range | Type | Description
> data-digest |  | integer | Count of digest errors.
> 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.
> hdr-digest |  | integer | Count of digest errors.
> 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-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-session-connection-list-entry-info | [top]

> Information about a single tcp connection

> Name | Range | Type | Description
> authentication-method |  | string | Authentication method of this connection. Possible values: "CHAP", "none".
> connection-id | [0..65535] | integer | Connection id within the session.
> data-digest-enabled |  | boolean | True if data digests are enabled on this connection, false otherwise.
> header-digest-enabled |  | boolean | True if header digests are enabled on this connection, false otherwise.
> initiator-max-rcv-data-segment-length | [512..2^24-1] | integer | Initiator's MaxRecvDataSegmentLength as defined in RFC 3720, in bytes.
> interface-name |  | string | Name of network interface hosting this connection. In Data ONTAP 7-Mode, this is the name of a physical ethernet interface, for example: "e0c". In Data ONTAP Cluster-Mode, this is the name of an iSCSI data LIF in the Vserver.
> local-ip-address |  | string | Local storage system iSCSI target interface address.
> local-ip-port | [0..65535] | integer | Local storage system iSCSI target TCP port.
> rcv-window-size | [0..2^30] | integer | TCP/IP receive window size, in octets.
> remote-ip-address |  | string | Remote initiator IP address.
> remote-ip-port | [0..65535] | integer | Remote initiator TCP port.
> target-max-rcv-data-segment-length | [512..2^24-1] | integer | Target's MaxRecvDataSegmentLength as defined in RFC 3720, in bytes.

Element definition: iscsi-sesssion-cmd-list-entry-info | [top]

> information about a particular command

> Name | Range | Type | Description
> cmd-state |  | string | State of iSCSI command. Possible values: "FREE" - Free, "Logout_Begin" - Logout - Begin, "Logout_Wait_For_Other_Conn" - Logout - Wait For Other Conn, "Logout_Build_and_Send_Resp" - Logout - Build and Send Resp, "Logout_Waiting_StatSN_ACK" - Logout - Waiting StatSN ACK, "Logout_Done" - Logout - Done, "Nopout_Begin" - Nopout - Begin, "Nopout_Build_And_Send_Resp" - Nopout - Build And Send Resp, "Nopout_Waiting_Resp_Sockio_Comp" - Nopout - Waiting Resp Sockio Comp, "Nopout_Resp_Sockio_Comp" - Nopout - Resp Sockio Comp, "Nopout_Waiting_StatSN_ACK" - Nopout - Waiting StatSN ACK, "Nopout_Done" - Nopout - Done, "Taskmgmt_Begin" - Taskmgmt - Begin, "Taskmgmt_Waiting_FFPCmds_Rcvd" - Taskmgmt - Waiting FFPCmds Rcvd, "Taskmgmt_FFPCmds_Rcvd" - Taskmgmt - FFPCmds Rcvd, "Taskmgmt_Waiting_FFPCmds_Complete" - Taskmgmt - Waiting FFPCmds Complete, "Taskmgmt_Build_And_Send_Resp" - Taskmgmt - Build And Send Resp, "Taskmgmt_Waiting_StatSN_ACK" - Taskmgmt - Waiting StatSN ACK, "Taskmgmt_Done" - Taskmgmt - Done, "Text_Begin" - Text - Begin, "Text_Waiting_Portal_List_Notify" - Text - Waiting Portal List Notify, "Text_Build_And_Send_Resp" - Text - Build And Send Resp, "Text_Waiting_Resp_Sockio_Comp" - Text - Waiting Resp Sockio Comp, "Text_Resp_Sockio_Comp" - Text - Resp Sockio Comp, "Text_Waiting_StatSN_ACK" - Text - Waiting StatSN ACK, "Text_Done" - Text - Done, "Scsicdb_Begin" - Scsicdb - Begin, "Scsicdb_Claim_Early_Udata" - Scsicdb - Claim Early Udata, "Scsicdb_Waiting_Udata_Rcvd" - Scsicdb - Waiting Udata Rcvd, "Scsicdb_Udata_Rcvd" - Scsicdb - Udata Rcvd, "Scsicdb_Ready_For_STSubmit" - Scsicdb - Ready For STSubmit, "Scsicdb_Udata_Not_Rcvd" - Scsicdb - Udata Not Rcvd, "Scsicdb_Udata_Waiting_Task_Reassignment" - Scsicdb - Udata Waiting Task Reassignment, "Scsicdb_Udata_Task_Reassigned" - Scsicdb - Udata Task Reassigned, "Scsicdb_Waiting_STLayer" - Scsicdb - Waiting STLayer, "Scsicdb_RD_STLayer_Called" - Scsicdb - RD STLayer Called, "Scsicdb_RD_Build_And_Send_R2T" - Scsicdb - RD Build And Send R2T, "Scsicdb_RD_Waiting_Burst" - Scsicdb - RD Waiting Burst, "Scsicdb_RD_Burst_Rcvd" - Scsicdb - RD Burst Rcvd, "Scsicdb_RD_Done" - Scsicdb - RD Done, "Scsicdb_RD_Burst_Not_Rcvd" - Scsicdb - RD Burst Not Rcvd, "Scsicdb_RD_Waiting_Task_Reassignment" - Scsicdb - RD Waiting Task Reassignment, "Scsicdb_RD_Task_Reassigned" - Scsicdb - RD Task Reassigned, "Scsicdb_SD_STLayer_Called" - Scsicdb - SD STLayer Called, "Scsicdb_SD_XDI_Done" - Scsicdb - SD XDI Done, "Scsicdb_SD_Waiting_DataSN_ACK" - Scsicdb - SD Waiting DataSN ACK, "Scsicdb_SD_Done" - Scsicdb - SD Done, "Scsicdb_SD_SNACK_Rcvd" - Scsicdb - SD SNACK Rcvd, "Scsicdb_SD_Task_Reassigned" - Scsicdb - SD Task Reassigned, "Scsicdb_SR_STLayer_Called" - Scsicdb - SR STLayer Called, "Scsicdb_SR_Build_And_Send_Resp" - Scsicdb - SR Build And Send Resp, "Scsicdb_SR_Waiting_StatSN_ACK" - Scsicdb - SR Waiting StatSN ACK, "Scsicdb_SR_Done" - Scsicdb - SR Done, "Scsicdb_SR_SNACK_Rcvd" - Scsicdb - SR SNACK Rcvd, "Scsicdb_SR_Task_Reassigned" - Scsicdb - SR Task Reassigned, "Scsicdb_SR_XDI_Done" - Scsicdb - SR XDI Done, "Scsicdb_SDR_STLayer_Called" - Scsicdb - SDR STLayer Called, "Scsicdb_SDR_XDI_Done" - Scsicdb - SDR XDI Done, "Scsicdb_SDR_Waiting_StatSN_ACK" - Scsicdb - SDR Waiting StatSN ACK, "Scsicdb_SDR_Done" - Scsicdb - SDR Done, "Scsicdb_SDR_SNACK_Rcvd" - Scsicdb - SDR SNACK Rcvd, "Scsicdb_SDR_Task_Reassigned" - Scsicdb - SDR Task Reassigned, "Scsicdb_Abort_Begin" - Scsicdb - Abort Begin, "Scsicdb_Abort_Build_And_Send_Resp" - Scsicdb - Abort Build And Send Resp, "Scsicdb_Abort_Waiting_StatSN_ACK" - Scsicdb - Abort Waiting StatSN ACK, "Scsicdb_Abort_Done" - Scsicdb - Abort Done, "Scsicdb_Abort_SNACK_Rcvd" - Scsicdb - Abort SNACK Rcvd, "Scsicdb_Abort_Task_Reassigned" - Scsicdb - Abort Task Reassigned, "Scsicdb_Abort_XDI_Done" - Scsicdb - Abort XDI Done, "Scsicdb_QFull_Begin" - Scsicdb - QFull Begin, "Scsicdb_QFull_Build_And_Send_Resp" - Scsicdb - QFull Build And Send Resp, "Scsicdb_QFull_Waiting_StatSN_ACK" - Scsicdb - QFull Waiting StatSN ACK, "Scsicdb_QFull_Done" - Scsicdb - QFull Done, "Scsicdb_XDI_Start" - Scsicdb - XDI Start, "Scsicdb_XDI_Waiting_Data_In_Sockio_Comp" - Scsicdb - XDI Waiting Data In Sockio Comp, "Scsicdb_Waiting_Scsitgt_Abort" - Scsicdb - Waiting Scsitgt Abort, "Done" - Done.
> cmd-sub-id | [0..2^32-1] | integer | Variety specific sub-id.
> cmd-type |  | string | Type of command being executed. Possible values: "Seq", "ITM", "Oth", "UNK".

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.