APIs in Category: portset
 API version 1.5

 
portset-add
portset-create
portset-destroy
portset-list-info
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.

portset-name
This is a simple string representing the name of the port set. Examples might be "internal_ports" or "myports".

portset-type
Port sets are of two types, fcp or iscsi. The string used should be either "fcp" or "iscsi".

portset-port-name
Port names are of the form "filername:slotletter". For example if the initiator was connected to the filer named 'buxton' using the 'a' port of the adapter in slot 4, it would be represented as 'buxton:4a'.

initiator-group-name
This is a simple string upto 255 characters representing the name of the initiator group. Some examples might be "my_init_group" or "solaris_init_group".

portset-id
An unique integer id that identifies the port set. This is used when binding to an igroup. There is no limit on the range upto the sizeof an int (0x3FFFFF).

portset-flags
Flags to denote state of port set. Such things as set type and validity can be determined from the flags.
bit 1 - Set if portset is for fcp
bit 2 - Set if portset is for iscsi
bit 3 - Set if portset is for vsa
bit 4 - Set if portset is valid in metafile

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

 
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
Type of the port set ("fcp" or "iscsi"). Currently only "fcp" is supported.
 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

 
portset-destroy [top]
Destroys an existing port set. By default a set cannot be destroyed if there are existing igroup associated with that pset.
Input Name Range Type Description
force boolean
optional
Forcibly destroy the portset, even if there are existing igroup bindings. Best practice is to attempt to unbind all the associated igroups before destroying it.
portset-name string
Name of the port set to destroy.
 Errno  Description
 EVDISK_ERROR_PORTSET_NO_SUCH_GROUP
 EVDISK_ERROR_INITGROUP_IS_BOUND
 EVDISK_ERROR_PORTSET_THROTTLE_EXCEEDED

 
portset-list-info [top]
Get information for port set(s).
Input Name Range Type Description
portset-name string
optional
Name of port set. If specified, only information for that set is returned. If not specified, information for all port sets are returned.
 
Output Name Range Type Description
portset-sets portset-info[]
List of port sets.
 Errno  Description
 EVDISK_ERROR_PORTSET_NO_SUCH_GROUP

 
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. 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"
 Errno  Description
 EVDISK_ERROR_PORTSET_INVALID_PORT_NAME
 EVDISK_ERROR_PORTSET_NO_SUCH_GROUP
 EVDISK_ERROR_PORTSET_NO_SUCH_PORT

 
Element definition: portset-info [top]
Information about a port set.
Name Range Type Description
portset-name string
Name of this port set.
portset-port-info portset-ports[]
Information about the ports belonging to the set.
portset-port-total integer
Total number of ports in the port set.
portset-type integer
Types are "fcp" or "iscsi"

 
Element definition: portset-ports [top]
Port(s) belonging to the portset.
Name Range Type Description
initiator-group-info portset-initiator-groups[]
Information about the initiator group(s) that are bound to the portset.
port-name string
Name of the port in the format of filer:slotletter.

 
Element definition: portset-initiator-groups [top]
Initiator groups(s) bound to the portset.
Name Range Type Description
initiator-group-name string
The initiator group name.