APIs in Category: portset | Vserver API version 1.15

portset-add portset-create portset-destroy portset-get-iter portset-remove | Port sets are associated with igroups. If an igroup is not associated with a port set then an initiator that belongs to that igroup can see its target luns on all ports. If a port set is bound to an igroup then the initiator that belongs to that igroup can only see its target luns on the ports that belong to the port set.

NetApp Manage ONTAP

portset-add | [top]

> Add a port to an existing port set

> Input Name | Range | Type | Description
> portset-name |  | string | Name of port set.
> portset-port-name |  | string | This is the name of the port that is to be added to the portset. In Data ONTAP 7-Mode, it can be input in two styles. The filername:slotletter format will add the port from a specific filer. For example: "buxton:4a" The slotletter format will add the port from both the local and partner filers. For example: "4a" In Data ONTAP Cluster-Mode, the port name is the name of either an FCP data lif or an iSCSI target portal group.

> Errno | Description
> EVDISK_ERROR_PORTSET_NO_SUCH_SET |  |
> EVDISK_ERROR_PORTSET_HAS_PORT |  |
> EVDISK_ERROR_PORTSET_TOO_MANY_PORTS |  |
> EVDISK_ERROR_PORTSET_INVALID_PORT_NAME |  |
> EVDISK_ERROR_PORTSET_THROTTLE_EXCEEDED |  |
> EVDISK_ERROR_PORTSET_INVALID_PARTNER_PORT_NAME |  |
> EVDISK_ERROR_PORTSET_BOTH_INVALID_PORT_NAMES |  |
> EVDISK_ERROR_PORTSET_TOO_FEW_PORTS |  |
> EVDISK_ERROR_PORTSET_WRONG_TYPE |  |

portset-create | [top]

> Create a port set

> Input Name | Range | Type | Description
> portset-name |  | string | Name of the port set to create.
> portset-type |  | string | Protocols accepted for this portset. Possible values: "fcp", "iscsi", "mixed". "iscsi" and "mixed" are available in Data ONTAP Cluster-Mode only.

> Errno | Description
> EVDISK_ERROR_PORTSET_ALREADY_EXIST |  |
> EVDISK_ERROR_PORTSET_INVALID_TYPE |  |
> EVDISK_ERROR_PORTSET_IC_DOWN |  |
> EVDISK_ERROR_PORTSET_NO_SUCH_PORT |  |
> EVDISK_ERROR_PORTSET_WRONG_TYPE |  |
> EVDISK_ERROR_PORTSET_INVALID_PARTNER_PORT_NAME |  |
> EVDISK_ERROR_PORTSET_BOTH_INVALID_PORT_NAMES |  |
> EVDISK_ERROR_PORTSET_TOO_FEW_PORTS |  |

portset-destroy | [top]

> Destroys an existing port set. By default a set cannot be destroyed if there are existing igroup associated with that portset.

> Input Name | Range | Type | Description
> force |  | boolean optional | If 'false' or not specified, the request will fail if there are any igroups bound to this portset. If 'true', forcibly destroy the portset, even if there are existing igroup bindings. Best practice is to unbind all the associated igroups before destroying the igroup.
> portset-name |  | string | Name of the port set to destroy.

> Errno | Description
> EVDISK_ERROR_PORTSET_NO_SUCH_GROUP |  |
> EVDISK_ERROR_PORTSET_CANT_DESTROY_BOUND_PORTSET |  |
> EVDISK_ERROR_PORTSET_THROTTLE_EXCEEDED |  |
> EVDISK_ERROR_PORTSET_TOO_FEW_PORTS |  |

portset-get-iter | [top]

> Iterate over a list of portset objects.

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

> Errno | Description
> EINTERNALERROR |  |

portset-remove | [top]

> Removes a port from a port set.

> Input Name | Range | Type | Description
> portset-name |  | string | Name of the port set.
> portset-port-name |  | string | This is the name of the port that is to be removed from the portset. In Data ONTAP 7-Mode, it can be input in two styles. The filername:slotletter format will remove the port from a specific filer. For example: "buxton:4a" The slotletter format will remove the port from both the local and partner filers. For example: "4a" In Data ONTAP Cluster-Mode, the port name is the name of either an FCP data lif or an iSCSI target portal group.

> Errno | Description
> EVDISK_ERROR_PORTSET_INVALID_PORT_NAME |  |
> EVDISK_ERROR_PORTSET_NO_SUCH_GROUP |  |
> EVDISK_ERROR_PORTSET_NO_SUCH_PORT |  |
> EVDISK_ERROR_PORTSET_TOO_FEW_PORTS |  |
> EVDISK_ERROR_INITGROUP_ALREADY_BOUND |  |

Element definition: portset-info | [top]

> Information about a port set.

> Name | Range | Type | Description
> initiator-group-info |  | initiator-group-name[] | Information about the initiator group(s) that are bound to the portset.
> portset-name |  | string | Name of this port set.
> portset-port-info |  | portset-port-name[] | Information about the ports belonging to the set.
> portset-port-total | [0..1024] | integer | Total number of ports in the port set.
> portset-type |  | string | Possible values: "fcp", "iscsi", "mixed".
> vserver |  | string | Vserver containing this portset.

Element definition: initiator-group-name | [top]

> The name of an initiator group

> [none]

Element definition: portset-port-name | [top]

> String representing a member of a portset. In Data ONTAP 7-Mode, the port name is of the format "filer:slotletter" or "slotletter". In Data ONTAP Cluster-Mode, the port name is the name of an FCP data lif or iSCSI target portal group.

> [none]