# Module `netapp_ontap.resources.ip_subnet`

Copyright © 2022 NetApp Inc. All rights reserved.

This file has been automatically generated based on the ONTAP REST API documentation.

## Overview

The following operations are supported:

- Creation: POST network/ip/subnets
- Collection Get: GET network/ip/subnets
- Instance Get: GET network/ip/subnets/{uuid}
- Instance Patch: PATCH network/ip/subnets/{uuid}
- Instance Delete: DELETE network/ip/subnets/{uuid}

## Retrieving IP subnet information

The IP subnets GET API retrieves and displays relevant information pertaining to the subnets configured in the cluster. The response can contain a list of multiple subnets or a specific subnet.

## Examples

### Retrieving all subnets in the cluster

The following example shows the list of all subnets configured in a cluster.

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import IpSubnet

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

Try it out

    [
        IpSubnet(
            {
                "name": "Subnet-002",
                "_links": {
                    "self": {
                        "href": "/api/network/ip/subnets/451d8d99-582c-11ec-8572-005056acd597"
                    }
                },
                "uuid": "451d8d99-582c-11ec-8572-005056acd597",
            }
        ),
        IpSubnet(
            {
                "name": "Subnet-001",
                "_links": {
                    "self": {
                        "href": "/api/network/ip/subnets/615b722f-5795-11ec-8572-005056acd597"
                    }
                },
                "uuid": "615b722f-5795-11ec-8572-005056acd597",
            }
        ),
    ]

### Retrieving a specific subnet

The following example shows the response when a specific subnet is requested. This is equivalent to fields=*, which returns most of the fields. The system returns an error when there is no subnet with the requested UUID.

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import IpSubnet

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = IpSubnet(uuid="451d8d99-582c-11ec-8572-005056acd597")
        resource.get()
        print(resource)

Try it out

    IpSubnet(
        {
            "gateway": "10.2.1.1",
            "name": "Subnet-002",
            "subnet": {"netmask": "24", "family": "ipv4", "address": "10.2.1.0"},
            "_links": {
                "self": {
                    "href": "/api/network/ip/subnets/451d8d99-582c-11ec-8572-005056acd597"
                }
            },
            "broadcast_domain": {
                "uuid": "9a1dce3b-5780-11ec-8572-005056acd597",
                "name": "Default",
                "_links": {
                    "self": {
                        "href": "/api/network/ethernet/broadcast-domains/9a1dce3b-5780-11ec-8572-005056acd597"
                    }
                },
            },
            "uuid": "451d8d99-582c-11ec-8572-005056acd597",
            "ipspace": {
                "uuid": "6f62c691-5780-11ec-8572-005056acd597",
                "name": "Default",
                "_links": {
                    "self": {
                        "href": "/api/network/ipspaces/6f62c691-5780-11ec-8572-005056acd597"
                    }
                },
            },
        }
    )

### Retrieving all the fields for a specific subnet

The following example shows the response when all the fields for a specific subnet are requested, returning everything that fields=* returns plus the IP ranges and count fields. The system returns an error when there is no subnet with the requested UUID.

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import IpSubnet

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = IpSubnet(uuid="451d8d99-582c-11ec-8572-005056acd597")
        resource.get(fields="**")
        print(resource)

Try it out

    IpSubnet(
        {
            "available_ip_ranges": [
                {"end": "10.2.1.22", "start": "10.2.1.10", "family": "ipv4"},
                {"end": "10.2.1.200", "start": "10.2.1.101", "family": "ipv4"},
            ],
            "gateway": "10.2.1.1",
            "name": "Subnet-002",
            "ip_ranges": [
                {"end": "10.2.1.22", "start": "10.2.1.10", "family": "ipv4"},
                {"end": "10.2.1.200", "start": "10.2.1.101", "family": "ipv4"},
            ],
            "subnet": {"netmask": "24", "family": "ipv4", "address": "10.2.1.0"},
            "used_count": 0,
            "total_count": 113,
            "_links": {
                "self": {
                    "href": "/api/network/ip/subnets/451d8d99-582c-11ec-8572-005056acd597?fields=**"
                }
            },
            "available_count": 113,
            "broadcast_domain": {
                "uuid": "9a1dce3b-5780-11ec-8572-005056acd597",
                "name": "Default",
                "_links": {
                    "self": {
                        "href": "/api/network/ethernet/broadcast-domains/9a1dce3b-5780-11ec-8572-005056acd597"
                    }
                },
            },
            "uuid": "451d8d99-582c-11ec-8572-005056acd597",
            "ipspace": {
                "uuid": "6f62c691-5780-11ec-8572-005056acd597",
                "name": "Default",
                "_links": {
                    "self": {
                        "href": "/api/network/ipspaces/6f62c691-5780-11ec-8572-005056acd597"
                    }
                },
            },
        }
    )

## Creating IP subnets

You can use the IP subnets POST API to create IP subnets as shown in the following examples.

## Examples

### Creating an IP subnet using the minimum number of parameters.

The following example shows the record returned after the creation of an IP subnet.

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import IpSubnet

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = IpSubnet()
        resource.name = "Subnet-003"
        resource.broadcast_domain = {"uuid": "6577524b-5863-11ec-8981-005056a7077f"}
        resource.subnet = {"address": "10.3.0.0", "netmask": "16"}
        resource.post(hydrate=True)
        print(resource)

### Creating an IP subnet using all parameters.

The following example shows the record returned after the creation of an IP subnet setting all parameters.

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import IpSubnet

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = IpSubnet()
        resource.name = "Subnet-004"
        resource.ipspace = {
            "name": "Default",
            "uuid": "36569d0f-5863-11ec-8981-005056a7077f",
        }
        resource.broadcast_domain = {
            "name": "Default",
            "uuid": "6577524b-5863-11ec-8981-005056a7077f",
        }
        resource.subnet = {"address": "10.4.1.0", "netmask": "24"}
        resource.gateway = "10.4.1.1"
        resource.ip_ranges = [
            {"start": "10.4.1.30", "end": "10.4.1.39"},
            {"start": "10.4.1.150", "end": "10.4.1.229"},
        ]
        resource.fail_if_lifs_conflict = False
        resource.post(hydrate=True)
        print(resource)

## Updating IP subnets

You can use the IP subnets PATCH API to update the attributes of an IP subnet.

## Examples

### Updating the name of an IP subnet

The following example shows how the PATCH request changes the name.

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import IpSubnet

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = IpSubnet(uuid="0e0a19e7-59ba-11ec-8981-005056a7077f")
        resource.name = "Subnet-004-NewName"
        resource.patch()

### Updating the ip_ranges of an IP subnet

The following example shows how the PATCH request updates the ip_ranges.

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import IpSubnet

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = IpSubnet(uuid="0e0a19e7-59ba-11ec-8981-005056a7077f")
        resource.ip_ranges = [{"start": "10.4.1.20", "end": "10.4.1.239"}]
        resource.patch()

## Deleting IP subnets

You can use the IP subnets DELETE API to delete an IP subnet.

## Example

### Deleting an IP subnet

The following DELETE request deletes a specific network IP subnet.

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import IpSubnet

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = IpSubnet(uuid="0e0a19e7-59ba-11ec-8981-005056a7077f")
        resource.delete()

## Classes

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

  Allows interaction with IpSubnet 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('IpSubnet')] = None, body: Union[Resource, dict] = None, poll: bool = True, poll_interval: Optional[int] = None, poll_timeout: Optional[int] = None, connection: HostConnection = None, **kwargs) -> NetAppResponse`

    Deletes an IP subnet.

    ### Related ONTAP commands

    - `network subnet delete`

    ### Learn more

    - `DOC /network/ip/subnets`

    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 details for all subnets.

    ### Related ONTAP Commands

    - `network subnet show`

    ### Learn more

    - `DOC /network/ip/subnets`

    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 details for all subnets.

    ### Related ONTAP Commands

    - `network subnet show`

    ### Learn more

    - `DOC /network/ip/subnets`

    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 patch_collection(body: dict, *args, records: Iterable[_ForwardRef('IpSubnet')] = None, poll: bool = True, poll_interval: Optional[int] = None, poll_timeout: Optional[int] = None, connection: HostConnection = None, **kwargs) -> NetAppResponse`

    Updates an IP subnet.

    ### Related ONTAP commands

    - `network subnet modify`
    - `network subnet rename`
    - `network subnet add-ranges`
    - `network subnet remove-ranges`

    ### Learn more

    - `DOC /network/ip/subnets`

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

    All records on the host which match the query will be patched with the provided body.

    ## Args

    `body`
      A dictionary of name/value pairs to set on all matching members of the collection. The body argument will be ignored if records is provided.
    `*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 patch 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 patched on the host.
    `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 `NetAppResponse` object containing the details of the HTTP response.

    ## Raises

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

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

    Creates a new named subnet.

    ### Required properties

    - `name` - Name of the subnet to create.
    - `broadcast_domain` - Broadcast domain containing the subnet.
    - `ipspace` - IPspace containing the subnet. Required only if `broadcast_domain.uuid` is not provided.
    - `subnet.address` - IP address for the subnet.
    - `subnet.netmask` - IP netmask of the subnet.

    ### Recommended property values

    ### Default property values

    If not specified in POST, the following default property values are assigned: * `gateway` - no gateway * `ip_ranges` - empty * `fail_if_lifs_conflict` - true

    ### Related ONTAP commands

    - `network subnet create`

    ### Learn more

    - `DOC /network/ip/subnets`

    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: Optional[int] = None, poll_timeout: Optional[int] = None, **kwargs) -> NetAppResponse`

    Deletes an IP subnet.

    ### Related ONTAP commands

    - `network subnet delete`

    ### Learn more

    - `DOC /network/ip/subnets`

    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 details for a specific IP subnet.

    ### Related ONTAP commands

    - `network subnet show`

    ### Learn more

    - `DOC /network/ip/subnets`

    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 patch(self, hydrate: bool = False, poll: bool = True, poll_interval: Optional[int] = None, poll_timeout: Optional[int] = None, **kwargs) -> NetAppResponse`

    Updates an IP subnet.

    ### Related ONTAP commands

    - `network subnet modify`
    - `network subnet rename`
    - `network subnet add-ranges`
    - `network subnet remove-ranges`

    ### Learn more

    - `DOC /network/ip/subnets`

    Send the difference in the object's state to the host as a modification request.

    Calculates the difference in the object's state since the last time we interacted with the host and sends this in the request body.

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

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

    Creates a new named subnet.

    ### Required properties

    - `name` - Name of the subnet to create.
    - `broadcast_domain` - Broadcast domain containing the subnet.
    - `ipspace` - IPspace containing the subnet. Required only if `broadcast_domain.uuid` is not provided.
    - `subnet.address` - IP address for the subnet.
    - `subnet.netmask` - IP netmask of the subnet.

    ### Recommended property values

    ### Default property values

    If not specified in POST, the following default property values are assigned: * `gateway` - no gateway * `ip_ranges` - empty * `fail_if_lifs_conflict` - true

    ### Related ONTAP commands

    - `network subnet create`

    ### Learn more

    - `DOC /network/ip/subnets`

    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 IpSubnetSchema (*, 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 IpSubnet object

  ### Ancestors

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

  ### Class variables

  `available_count: Size GET`

    The available_count field of the ip_subnet.

  `available_ip_ranges: List[IpAddressRange] GET`

    The available_ip_ranges field of the ip_subnet.

  `broadcast_domain: BroadcastDomainSvm GET POST`

    The broadcast_domain field of the ip_subnet.

  `fail_if_lifs_conflict: bool POST PATCH`

    This action will fail if any existing interface is using an IP address in the ranges provided. Set this to false to associate any manually addressed interfaces with the subnet and allow the action to succeed.

  `gateway: str GET POST PATCH`

    The IP address of the gateway for this subnet.

    Example: 10.1.1.1

  `ip_ranges: List[IpAddressRange] GET POST PATCH`

    The ip_ranges field of the ip_subnet.

  `ipspace: Ipspace GET POST`

    The ipspace field of the ip_subnet.

  `links: SelfLink GET`

    The links field of the ip_subnet.

  `name: str GET POST PATCH`

    Subnet name

    Example: subnet1

  `subnet: IpInfo GET POST PATCH`

    The subnet field of the ip_subnet.

  `total_count: Size GET`

    The total_count field of the ip_subnet.

  `used_count: Size GET`

    The used_count field of the ip_subnet.

  `uuid: str GET`

    The UUID that uniquely identifies the subnet.

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