# Module `netapp_ontap.resources.portset`

Copyright © 2022 NetApp Inc. All rights reserved.

## Overview

A portset is a collection of Fibre Channel Protocol and/or iSCSI network interfaces from the portset's SVM.
Portsets are used to limit the network interfaces through which an initiator can connect to mapped LUNs. When a portset is bound to an initiator group (igroup), and the initiator group is mapped to a LUN, the initiators of the initiator group can only reach the LUN through the network interfaces in the portset.
Portsets are not recommended for new configurations. With modern releases of ONTAP, it is recommended to use multiple SVMs and initiator groups with no bound portset to load balance applications over multiple ports on a node. Selective LUN mapping will automatically limit the number of visible paths to a LUN from the client host to those required for efficient access and high availability. The REST portset API is primarily intended for legacy use.
The portset REST API allows you to create, delete, and discover portsets, and to add and remove network interaces from portsets.
A portset can be bound to one or more initiator groups. An initiator group (igroup) can be bound to at most one portset.
When a portset is created, the `protocol` property is used to restrict member network interfaces to Fibre Channel Procotol (fcp), iSCSI (iscsi), or both (mixed).
Zero or more network interfaces can be supplied when the portset is created. After creation, network interfaces can be added to or removed from the portset using the `/protocols/san/portsets/{portset.uuid}/interfaces` endpoint. See `POST /protocols/san/portsets/{portset.uuid}/interfaces` and `DELETE /protocols/san/portsets/{portset.uuid}/interfaces/{name}` for more details.

## Examples

### Creating a portset with no network interfaces

The example portset uses the default `mixed` protocol. Note that the `return_records` query parameter is used to obtain the newly created portset in the response.

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import Portset

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = Portset()
        resource.svm = {"name": "svm1"}
        resource.name = "portset1"
        resource.post(hydrate=True)
        print(resource)

Try it out

    Portset(
        {
            "svm": {
                "_links": {
                    "self": {"href": "/api/svm/svms/31484775-1e23-11eb-b2a8-005056bb3521"}
                },
                "uuid": "31484775-1e23-11eb-b2a8-005056bb3521",
                "name": "svm1",
            },
            "uuid": "5d7b1dfa-1ed7-11eb-8b0f-005056bb3521",
            "protocol": "mixed",
            "name": "portset1",
            "_links": {
                "self": {
                    "href": "/api/protocols/san/portsets/5d7b1dfa-1ed7-11eb-8b0f-005056bb3521"
                }
            },
        }
    )

### Creating an iSCSI portset with two network interfaces

Note that the `return_records` query parameter is used to obtain the newly created portset in the response.

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import Portset

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = Portset()
        resource.svm = {"name": "svm1"}
        resource.name = "portset2"
        resource.protocol = "iscsi"
        resource.interfaces = [{"ip": {"name": "lif1"}}, {"ip": {"name": "lif2"}}]
        resource.post(hydrate=True)
        print(resource)

Try it out

    Portset(
        {
            "interfaces": [
                {
                    "ip": {
                        "_links": {
                            "self": {
                                "href": "/api/network/ip/interfaces/f37bfb01-1e2a-11eb-b2a8-005056bb3521"
                            }
                        },
                        "ip": {"address": "192.168.1.100"},
                        "uuid": "f37bfb01-1e2a-11eb-b2a8-005056bb3521",
                        "name": "lif1",
                    },
                    "uuid": "f37bfb01-1e2a-11eb-b2a8-005056bb3521",
                    "_links": {
                        "self": {
                            "href": "/api/protocols/san/portsets/816c0d49-1ed7-11eb-8b0f-005056bb3521/interfaces/f37bfb01-1e2a-11eb-b2a8-005056bb3521"
                        }
                    },
                },
                {
                    "ip": {
                        "_links": {
                            "self": {
                                "href": "/api/network/ip/interfaces/f92178e7-1e2a-11eb-b2a8-005056bb3521"
                            }
                        },
                        "ip": {"address": "192.168.1.101"},
                        "uuid": "f92178e7-1e2a-11eb-b2a8-005056bb3521",
                        "name": "lif2",
                    },
                    "uuid": "f92178e7-1e2a-11eb-b2a8-005056bb3521",
                    "_links": {
                        "self": {
                            "href": "/api/protocols/san/portsets/816c0d49-1ed7-11eb-8b0f-005056bb3521/interfaces/f92178e7-1e2a-11eb-b2a8-005056bb3521"
                        }
                    },
                },
            ],
            "svm": {
                "_links": {
                    "self": {"href": "/api/svm/svms/31484775-1e23-11eb-b2a8-005056bb3521"}
                },
                "uuid": "31484775-1e23-11eb-b2a8-005056bb3521",
                "name": "svm1",
            },
            "uuid": "816c0d49-1ed7-11eb-8b0f-005056bb3521",
            "protocol": "iscsi",
            "name": "portset2",
            "_links": {
                "self": {
                    "href": "/api/protocols/san/portsets/816c0d49-1ed7-11eb-8b0f-005056bb3521"
                }
            },
        }
    )

### Retrieving a summary of all portsets

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import Portset

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        print(list(Portset.get_collection()))

Try it out

    [
        Portset(
            {
                "uuid": "5d7b1dfa-1ed7-11eb-8b0f-005056bb3521",
                "name": "portset1",
                "_links": {
                    "self": {
                        "href": "/api/protocols/san/portsets/5d7b1dfa-1ed7-11eb-8b0f-005056bb3521"
                    }
                },
            }
        ),
        Portset(
            {
                "uuid": "816c0d49-1ed7-11eb-8b0f-005056bb3521",
                "name": "portset2",
                "_links": {
                    "self": {
                        "href": "/api/protocols/san/portsets/816c0d49-1ed7-11eb-8b0f-005056bb3521"
                    }
                },
            }
        ),
        Portset(
            {
                "uuid": "b716b4d2-1ed7-11eb-8b0f-005056bb3521",
                "name": "portset3",
                "_links": {
                    "self": {
                        "href": "/api/protocols/san/portsets/b716b4d2-1ed7-11eb-8b0f-005056bb3521"
                    }
                },
            }
        ),
    ]

### Retrieving details for a specific portset

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import Portset

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = Portset(uuid="b716b4d2-1ed7-11eb-8b0f-005056bb3521")
        resource.get()
        print(resource)

Try it out

    Portset(
        {
            "interfaces": [
                {
                    "fc": {
                        "uuid": "164eb052-1e2b-11eb-b2a8-005056bb3521",
                        "wwpn": "20:01:00:50:56:bb:35:21",
                        "name": "lif5",
                        "_links": {
                            "self": {
                                "href": "/api/network/fc/interfaces/164eb052-1e2b-11eb-b2a8-005056bb3521"
                            }
                        },
                    },
                    "uuid": "164eb052-1e2b-11eb-b2a8-005056bb3521",
                    "_links": {
                        "self": {
                            "href": "/api/protocols/san/portsets/b716b4d2-1ed7-11eb-8b0f-005056bb3521/interfaces/164eb052-1e2b-11eb-b2a8-005056bb3521"
                        }
                    },
                },
                {
                    "fc": {
                        "uuid": "197ba2b7-1e2b-11eb-b2a8-005056bb3521",
                        "wwpn": "20:02:00:50:56:bb:35:21",
                        "name": "lif6",
                        "_links": {
                            "self": {
                                "href": "/api/network/fc/interfaces/197ba2b7-1e2b-11eb-b2a8-005056bb3521"
                            }
                        },
                    },
                    "uuid": "197ba2b7-1e2b-11eb-b2a8-005056bb3521",
                    "_links": {
                        "self": {
                            "href": "/api/protocols/san/portsets/b716b4d2-1ed7-11eb-8b0f-005056bb3521/interfaces/197ba2b7-1e2b-11eb-b2a8-005056bb3521"
                        }
                    },
                },
            ],
            "svm": {
                "_links": {
                    "self": {"href": "/api/svm/svms/31484775-1e23-11eb-b2a8-005056bb3521"}
                },
                "uuid": "31484775-1e23-11eb-b2a8-005056bb3521",
                "name": "svm1",
            },
            "uuid": "b716b4d2-1ed7-11eb-8b0f-005056bb3521",
            "protocol": "fcp",
            "name": "portset3",
            "_links": {
                "self": {
                    "href": "/api/protocols/san/portsets/b716b4d2-1ed7-11eb-8b0f-005056bb3521"
                }
            },
        }
    )

### Deleting a portset

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import Portset

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = Portset(uuid="b716b4d2-1ed7-11eb-8b0f-005056bb3521")
        resource.delete()

### Adding a network interface to a portset

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import PortsetInterface

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = PortsetInterface("5d7b1dfa-1ed7-11eb-8b0f-005056bb3521")
        resource.fc = {"name": "lif4"}
        resource.post(hydrate=True)
        print(resource)

### Adding multiple network interfaces to a portset in a single call

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import PortsetInterface

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = PortsetInterface("5d7b1dfa-1ed7-11eb-8b0f-005056bb3521")
        resource.records = [
            {"ip": {"name": "lif1"}},
            {"ip": {"name": "lif2"}},
            {"fc": {"name": "lif5"}},
        ]
        resource.post(hydrate=True)
        print(resource)

### Removing a network interface from a portset

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import PortsetInterface

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = PortsetInterface(
            "5d7b1dfa-1ed7-11eb-8b0f-005056bb3521",
            uuid="f92178e7-1e2a-11eb-b2a8-005056bb3521",
        )
        resource.delete()

## Classes

`class Portset (*args, **kwargs)`

  Allows interaction with Portset objects on the host

  Initialize the instance of the resource.

  Any keyword arguments are set on the instance as properties. For example, if the class was named 'MyResource', then this statement would be true:

      MyResource(name='foo').name == 'foo'

  ## Args

  `*args`
    Each positional argument represents a parent key as used in the URL of the object. That is, each value will be used to fill in a segment of the URL which refers to some parent object. The order of these arguments must match the order they are specified in the URL, from left to right.
  `**kwargs`
    each entry will have its key set as an attribute name on the instance and its value will be the value of that attribute.

  ### Ancestors

  - Resource

  ### Static methods

  `def count_collection(*args, connection: HostConnection = None, **kwargs) -> int`

    Fetch a count of all objects of this type from the host.

    This calls GET on the object to determine the number of records. It is more efficient than calling get_collection() because it will not construct any objects. Query parameters can be passed in as kwargs to determine a count of objects that match some filtered criteria.

    ## Args

    `*args`
      Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to get the count of bars for a particular foo, the foo.name value should be passed.
    `connection`
      The `HostConnection` object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
    `**kwargs`
      Any key/value pairs passed will be sent as query parameters to the host. These query parameters can affect the count. A return_records query param will be ignored.

    ## Returns

    On success, returns an integer count of the objects of this type. On failure, returns -1.

    ## Raises

    `NetAppRestError`: If the API call returned a status code >= 400, or if there is no connection available to use either passed in or on the library.

  `def delete_collection(*args, records: Iterable[_ForwardRef('Portset')] = None, body: Union[Resource, dict] = None, poll: bool = True, poll_interval: Union[int, NoneType] = None, poll_timeout: Union[int, NoneType] = None, connection: HostConnection = None, **kwargs) -> NetAppResponse`

    Deletes a portset.

    ### Related ONTAP commands

    - `lun portset delete`

    ### Learn more

    - `DOC /protocols/san/portsets`

    Delete all objects in a collection which match the given query.

    All records on the host which match the query will be deleted.

    ## Args

    `*args`
      Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to delete the collection of bars for a particular foo, the foo.name value should be passed.
    `records`
      Can be provided in place of a query. If so, this list of objects will be deleted from the host.
    `body`
      The body of the delete request. This could be a Resource instance or a dictionary object.
    `poll`
      If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
    `poll_interval`
      If the operation returns a job, this specifies how often to query the job for updates.
    `poll_timeout`
      If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
    `connection`
      The `HostConnection` object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
    `**kwargs`
      Any key/value pairs passed will be sent as query parameters to the host. Only resources matching this query will be deleted.

    ## Returns

    A `NetAppResponse` object containing the details of the HTTP response.

    ## Raises

    `NetAppRestError`: If the API call returned a status code >= 400

  `def find(*args, connection: HostConnection = None, **kwargs) -> Resource`

    Retrieves portsets.

    ### Related ONTAP commands

    - `lun portset show`

    ### Learn more

    - `DOC /protocols/san/portsets`

    Find an instance of an object on the host given a query.

    The host will be queried with the provided key/value pairs to find a matching resource. If 0 are found, None will be returned. If more than 1 is found, an error will be raised or returned. If there is exactly 1 matching record, then it will be returned.

    ## Args

    `*args`
      Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to find a bar for a particular foo, the foo.name value should be passed.
    `connection`
      The `HostConnection` object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
    `**kwargs`
      Any key/value pairs passed will be sent as query parameters to the host.

    ## Returns

    A `Resource` object containing the details of the object or None if no matches were found.

    ## Raises

    `NetAppRestError`: If the API call returned more than 1 matching resource.

  `def get_collection(*args, connection: HostConnection = None, max_records: int = None, **kwargs) -> Iterable[Resource]`

    Retrieves portsets.

    ### Related ONTAP commands

    - `lun portset show`

    ### Learn more

    - `DOC /protocols/san/portsets`

    Fetch a list of all objects of this type from the host.

    This is a lazy fetch, making API calls only as necessary when the result of this call is iterated over. For instance, if max_records is set to 5, then iterating over the collection causes an API call to be sent to the server once for every 5 records. If the client stops iterating before getting to the 6th record, then no additional API calls are made.

    ## Args

    `*args`
      Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to get the collection of bars for a particular foo, the foo.name value should be passed.
    `connection`
      The `HostConnection` object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
    `max_records`
      The maximum number of records to return per call
    `**kwargs`
      Any key/value pairs passed will be sent as query parameters to the host.

    ## Returns

    A list of `Resource` objects

    ## Raises

    `NetAppRestError`: If there is no connection available to use either passed in or on the library. This would be not be raised when get_collection() is called, but rather when the result is iterated.

  `def post_collection(records: Iterable[_ForwardRef('Portset')], *args, hydrate: bool = False, poll: bool = True, poll_interval: Union[int, NoneType] = None, poll_timeout: Union[int, NoneType] = None, connection: HostConnection = None, **kwargs) -> Union[List[Portset], NetAppResponse]`

    Creates a portset.

    ### Required properties

    - `svm.uuid` or `svm.name` - Existing SVM in which to create the portset.
    - `name` - Name of the portset.

    ### Recommended optional properties

    - `protocol` - The network protocol of the interfaces in the portset.
    - `interfaces` - Network interfaces to include in the portset. This property can be used to create the portset and populate it with network interfaces in a single request.

    ### Default property values

    If not specified in POST, the following default property values are assigned. * `protocol` - mixed - Data protocol of the portset's network interfaces.

    ### Related ONTAP commands

    - `lun portset create`

    ### Learn more

    - `DOC /protocols/san/portsets`

    Send this collection of objects to the host as a creation request.

    ## Args

    `records`
      A list of `Resource` objects to send to the server to be created.
    `*args`
      Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to create a bar for a particular foo, the foo.name value should be passed.
    `hydrate`
      If set to True, after the response is received from the call, a a GET call will be made to refresh all fields of each object. When hydrate is set to True, poll must also be set to True.
    `poll`
      If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
    `poll_interval`
      If the operation returns a job, this specifies how often to query the job for updates.
    `poll_timeout`
      If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
    `connection`
      The `HostConnection` object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
    `**kwargs`
      Any key/value pairs passed will be sent as query parameters to the host. Only resources matching this query will be patched.

    ## Returns

    A list of `Resource` objects matching the provided
    `type` `which` `have` `been` `created` `by` `the` `host` `and` `returned.` `This` `is` `_not_`
    `the` `same` `list` `that` `was` `provided`, `so` `to` `continue` `using` `the` `object`, `you`

    should save this list. If poll is set to False, then a `NetAppResponse` object is returned instead.

    ## Raises

    `NetAppRestError`: If the API call returned a status code >= 400

  ### Methods

  `def delete(self, body: Union[Resource, dict] = None, poll: bool = True, poll_interval: Union[int, NoneType] = None, poll_timeout: Union[int, NoneType] = None, **kwargs) -> NetAppResponse`

    Deletes a portset.

    ### Related ONTAP commands

    - `lun portset delete`

    ### Learn more

    - `DOC /protocols/san/portsets`

    Send a deletion request to the host for this object.

    ## Args

    `body`
      The body of the delete request. This could be a Resource instance or a dictionary object.
    `poll`
      If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
    `poll_interval`
      If the operation returns a job, this specifies how often to query the job for updates.
    `poll_timeout`
      If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
    `**kwargs`
      Any key/value pairs passed will be sent as query parameters to the host.

    ## Returns

    A `NetAppResponse` object containing the details of the HTTP response.

    ## Raises

    `NetAppRestError`: If the API call returned a status code >= 400

  `def get(self, **kwargs) -> NetAppResponse`

    Retrieves a portset.

    ### Related ONTAP commands

    - `lun portset show`

    ### Learn more

    - `DOC /protocols/san/portsets`

    Fetch the details of the object from the host.

    Requires the keys to be set (if any). After returning, new or changed properties from the host will be set on the instance.

    ## Returns

    A `NetAppResponse` object containing the details of the HTTP response.

    ## Raises

    `NetAppRestError`: If the API call returned a status code >= 400

  `def post(self, hydrate: bool = False, poll: bool = True, poll_interval: Union[int, NoneType] = None, poll_timeout: Union[int, NoneType] = None, **kwargs) -> NetAppResponse`

    Creates a portset.

    ### Required properties

    - `svm.uuid` or `svm.name` - Existing SVM in which to create the portset.
    - `name` - Name of the portset.

    ### Recommended optional properties

    - `protocol` - The network protocol of the interfaces in the portset.
    - `interfaces` - Network interfaces to include in the portset. This property can be used to create the portset and populate it with network interfaces in a single request.

    ### Default property values

    If not specified in POST, the following default property values are assigned. * `protocol` - mixed - Data protocol of the portset's network interfaces.

    ### Related ONTAP commands

    - `lun portset create`

    ### Learn more

    - `DOC /protocols/san/portsets`

    Send this object to the host as a creation request.

    ## Args

    `hydrate`
      If set to True, after the response is received from the call, a a GET call will be made to refresh all fields of the object.
    `poll`
      If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
    `poll_interval`
      If the operation returns a job, this specifies how often to query the job for updates.
    `poll_timeout`
      If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
    `**kwargs`
      Any key/value pairs passed will normally be sent as query parameters to the host. If any of these pairs are parameters that are sent as formdata then only parameters of that type will be accepted and all others will be discarded.

    ## Returns

    A `NetAppResponse` object containing the details of the HTTP response.

    ## Raises

    `NetAppRestError`: If the API call returned a status code >= 400

  ### Inherited members

  - `Resource`:
    - `from_dict`
    - `get_collection_url`
    - `get_connection`
    - `instance_location`
    - `path_keys`
    - `poll`
    - `set_connection`
    - `to_dict`
`class PortsetSchema (*, only: Union[Sequence[str], Set[str]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Dict = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: str = None)`

  The fields of the Portset object

  ### Ancestors

  - netapp_ontap.resource.ResourceSchema
  - marshmallow.schema.Schema
  - marshmallow.base.SchemaABC

  ### Class variables

  `igroups GET`

    An array initiator groups to which the portset is bound.

  `interfaces GET POST`

    An array of network interfaces that are members of the portset. These are the only network interfaces through which the initiators of a bound igroup can access mapped LUNs.
    Zero or more network interfaces can be supplied when the portset is created. After creation, network interfaces can be added or removed from the portset using the `/protocols/san/portsets/{portset.uuid}/interfaces` endpoint. See `POST /protocols/san/portsets/{portset.uuid}/interfaces` and `DELETE /protocols/san/portsets/{portset.uuid}/interfaces/{uuid}` for more details.

  `links GET`

    The links field of the portset.

  `name GET POST`

    The name of the portset. Required in POST.
    The name of a portset cannot be changed after creation.

    Example: portset1

  `protocol GET POST`

    The protocols supported by the portset. This restricts the type of network interfaces that can be added to the portset. Optional in POST; if not supplied, this defaults to mixed.
    The protocol of a portset cannot be changed after creation.

    Valid choices:

    - fcp
    - iscsi
    - mixed
  `svm GET POST`

    The svm field of the portset.

  `uuid GET`

    The unique identifier for a portset.

    Example: 1cd8a442-86d1-11e0-ae1c-123478563412