Module netapp_ontap.resources.ip_interface

Copyright © 2022 NetApp Inc. All rights reserved.

Overview

The following operations are supported:

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

Retrieving network interface information

The IP interfaces GET API retrieves and displays relevant information pertaining to the interfaces configured in the cluster. The response can contain a list of multiple interfaces or a specific interface. The fields returned in the response vary for different interfaces and configurations.

Examples

Retrieving all interfaces in the cluster

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


from netapp_ontap import HostConnection
from netapp_ontap.resources import IpInterface

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

[
    IpInterface(
        {
            "_links": {
                "self": {
                    "href": "/api/network/ip/interfaces/14531286-59fc-11e8-ba55-005056b4340f"
                }
            },
            "uuid": "14531286-59fc-11e8-ba55-005056b4340f",
            "name": "user-cluster-01_mgmt1",
        }
    ),
    IpInterface(
        {
            "_links": {
                "self": {
                    "href": "/api/network/ip/interfaces/145318ba-59fc-11e8-ba55-005056b4340f"
                }
            },
            "uuid": "145318ba-59fc-11e8-ba55-005056b4340f",
            "name": "user-cluster-01_clus2",
        }
    ),
    IpInterface(
        {
            "_links": {
                "self": {
                    "href": "/api/network/ip/interfaces/14531e45-59fc-11e8-ba55-005056b4340f"
                }
            },
            "uuid": "14531e45-59fc-11e8-ba55-005056b4340f",
            "name": "user-cluster-01_clus1",
        }
    ),
    IpInterface(
        {
            "_links": {
                "self": {
                    "href": "/api/network/ip/interfaces/245979de-59fc-11e8-ba55-005056b4340f"
                }
            },
            "uuid": "245979de-59fc-11e8-ba55-005056b4340f",
            "name": "cluster_mgmt",
        }
    ),
    IpInterface(
        {
            "_links": {
                "self": {
                    "href": "/api/network/ip/interfaces/c670707c-5a11-11e8-8fcb-005056b4340f"
                }
            },
            "uuid": "c670707c-5a11-11e8-8fcb-005056b4340f",
            "name": "lif1",
        }
    ),
]


Retrieving a specific Cluster-scoped interface

The following example shows the response when a specific Cluster-scoped interface is requested. The system returns an error when there is no interface with the requested UUID. SVM information is not returned for Cluster-scoped interfaces.


from netapp_ontap import HostConnection
from netapp_ontap.resources import IpInterface

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = IpInterface(uuid="245979de-59fc-11e8-ba55-005056b4340f")
    resource.get()
    print(resource)

IpInterface(
    {
        "_links": {
            "self": {
                "href": "/api/network/ip/interfaces/245979de-59fc-11e8-ba55-005056b4340f"
            }
        },
        "ip": {"netmask": "18", "address": "10.63.41.6", "family": "ipv4"},
        "vip": False,
        "state": "up",
        "ipspace": {
            "name": "Default",
            "uuid": "114ecfb5-59fc-11e8-ba55-005056b4340f",
            "_links": {
                "self": {
                    "href": "/api/network/ipspaces/114ecfb5-59fc-11e8-ba55-005056b4340f"
                }
            },
        },
        "services": ["management_core", "management_autosupport", "management_access"],
        "uuid": "245979de-59fc-11e8-ba55-005056b4340f",
        "service_policy": {
            "uuid": "9e0f4151-141b-11e9-851e-005056ac1ce0",
            "name": "default-management",
        },
        "location": {
            "home_node": {
                "_links": {
                    "self": {
                        "href": "/api/cluster/nodes/c1db2904-1396-11e9-bb7d-005056acfcbb"
                    }
                },
                "uuid": "c1db2904-1396-11e9-bb7d-005056acfcbb",
                "name": "user-cluster-01-a",
            },
            "node": {
                "_links": {
                    "self": {
                        "href": "/api/cluster/nodes/c1db2904-1396-11e9-bb7d-005056acfcbb"
                    }
                },
                "uuid": "c1db2904-1396-11e9-bb7d-005056acfcbb",
                "name": "user-cluster-01-a",
            },
            "failover": "broadcast_domain_only",
            "port": {
                "uuid": "c84d5337-1397-11e9-87c2-005056acfcbb",
                "node": {"name": "user-cluster-01-a"},
                "name": "e0d",
                "_links": {
                    "self": {
                        "href": "/api/network/ethernet/ports/c84d5337-1397-11e9-87c2-005056acfcbb"
                    }
                },
            },
            "auto_revert": False,
            "is_home": True,
            "home_port": {
                "uuid": "c84d5337-1397-11e9-87c2-005056acfcbb",
                "node": {"name": "user-cluster-01-a"},
                "name": "e0d",
                "_links": {
                    "self": {
                        "href": "/api/network/ethernet/ports/c84d5337-1397-11e9-87c2-005056acfcbb"
                    }
                },
            },
        },
        "enabled": True,
        "scope": "cluster",
        "name": "cluster_mgmt",
    }
)


Retrieving a specific SVM-scoped interface using a filter

The following example shows the response when a specific SVM-scoped interface is requested. The SVM object is only included for SVM-scoped interfaces.


from netapp_ontap import HostConnection
from netapp_ontap.resources import IpInterface

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    print(list(IpInterface.get_collection(name="lif1", fields="*")))

[
    IpInterface(
        {
            "_links": {
                "self": {
                    "href": "/api/network/ip/interfaces/c670707c-5a11-11e8-8fcb-005056b4340f"
                }
            },
            "ip": {"netmask": "24", "address": "10.10.10.11", "family": "ipv4"},
            "vip": False,
            "state": "up",
            "ipspace": {
                "name": "Default",
                "uuid": "114ecfb5-59fc-11e8-ba55-005056b4340f",
                "_links": {
                    "self": {
                        "href": "/api/network/ipspaces/114ecfb5-59fc-11e8-ba55-005056b4340f"
                    }
                },
            },
            "services": ["data_core", "data_nfs", "data_cifs", "data_flexcache"],
            "uuid": "c670707c-5a11-11e8-8fcb-005056b4340f",
            "service_policy": {
                "uuid": "9e53525f-141b-11e9-851e-005056ac1ce0",
                "name": "default-data-files",
            },
            "location": {
                "home_node": {
                    "_links": {
                        "self": {
                            "href": "/api/cluster/nodes/c1db2904-1396-11e9-bb7d-005056acfcbb"
                        }
                    },
                    "uuid": "c1db2904-1396-11e9-bb7d-005056acfcbb",
                    "name": "user-cluster-01-a",
                },
                "node": {
                    "_links": {
                        "self": {
                            "href": "/api/cluster/nodes/c1db2904-1396-11e9-bb7d-005056acfcbb"
                        }
                    },
                    "uuid": "c1db2904-1396-11e9-bb7d-005056acfcbb",
                    "name": "user-cluster-01-a",
                },
                "failover": "broadcast_domain_only",
                "port": {
                    "uuid": "c84d5337-1397-11e9-87c2-005056acfcbb",
                    "node": {"name": "user-cluster-01-a"},
                    "name": "e0d",
                    "_links": {
                        "self": {
                            "href": "/api/network/ethernet/ports/c84d5337-1397-11e9-87c2-005056acfcbb"
                        }
                    },
                },
                "auto_revert": False,
                "is_home": True,
                "home_port": {
                    "uuid": "c84d5337-1397-11e9-87c2-005056acfcbb",
                    "node": {"name": "user-cluster-01-a"},
                    "name": "e0d",
                    "_links": {
                        "self": {
                            "href": "/api/network/ethernet/ports/c84d5337-1397-11e9-87c2-005056acfcbb"
                        }
                    },
                },
            },
            "enabled": True,
            "scope": "svm",
            "svm": {
                "_links": {
                    "self": {
                        "href": "/api/svm/svms/c2134665-5a11-11e8-8fcb-005056b4340f"
                    }
                },
                "uuid": "c2134665-5a11-11e8-8fcb-005056b4340f",
                "name": "user_vs0",
            },
            "name": "lif1",
        }
    )
]


Retrieving specific fields and limiting the output using filters

The following example shows the response when a filter is applied (location.home_port.name=e0a) and only certain fields are requested. Filtered fields are in the output in addition to the default fields and requested fields.


from netapp_ontap import HostConnection
from netapp_ontap.resources import IpInterface

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    print(
        list(
            IpInterface.get_collection(
                fields="location.home_node.name,service_policy.name,ip.address,enabled",
                **{"location.home_port.name": "e0a"}
            )
        )
    )

[
    IpInterface(
        {
            "_links": {
                "self": {
                    "href": "/api/network/ip/interfaces/1d1c9dc8-4f17-11e9-9553-005056ac918a"
                }
            },
            "ip": {"address": "192.168.170.24"},
            "uuid": "1d1c9dc8-4f17-11e9-9553-005056ac918a",
            "service_policy": {"name": "default-cluster"},
            "location": {
                "home_node": {"name": "user-cluster-01-a"},
                "home_port": {"name": "e0a"},
            },
            "enabled": True,
            "name": "user-cluster-01-a_clus1",
        }
    ),
    IpInterface(
        {
            "_links": {
                "self": {
                    "href": "/api/network/ip/interfaces/d07782c1-4f16-11e9-86e7-005056ace7ee"
                }
            },
            "ip": {"address": "192.168.170.22"},
            "uuid": "d07782c1-4f16-11e9-86e7-005056ace7ee",
            "service_policy": {"name": "default-cluster"},
            "location": {
                "home_node": {"name": "user-cluster-01-b"},
                "home_port": {"name": "e0a"},
            },
            "enabled": True,
            "name": "user-cluster-01-b_clus1",
        }
    ),
]


Creating IP interfaces

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


Examples

Creating a Cluster-scoped IP interface using names

The following example shows the record returned after the creation of an IP interface on "e0d".


from netapp_ontap import HostConnection
from netapp_ontap.resources import IpInterface

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = IpInterface()
    resource.name = "cluster_mgmt"
    resource.ip = {"address": "10.63.41.6", "netmask": "18"}
    resource.enabled = True
    resource.scope = "cluster"
    resource.ipspace = {"name": "Default"}
    resource.location = {
        "auto_revert": False,
        "failover": "broadcast_domain_only",
        "home_port": {"name": "e0d", "node": {"name": "user-cluster-01-a"}},
    }
    resource.service_policy = {"name": "default-management"}
    resource.post(hydrate=True)
    print(resource)

IpInterface(
    {
        "_links": {
            "self": {
                "href": "/api/network/ip/interfaces/245979de-59fc-11e8-ba55-005056b4340f"
            }
        },
        "ip": {"netmask": "18", "address": "10.63.41.6"},
        "ipspace": {"name": "Default"},
        "uuid": "245979de-59fc-11e8-ba55-005056b4340f",
        "service_policy": {"name": "default-management"},
        "location": {
            "failover": "broadcast_domain_only",
            "auto_revert": False,
            "home_port": {"node": {"name": "user-cluster-01-a"}, "name": "e0d"},
        },
        "enabled": True,
        "scope": "cluster",
        "name": "cluster_mgmt",
    }
)


Creating a SVM-scoped IP interface using a mix of parameter types

The following example shows the record returned after the creation of a IP interface by specifying a broadcast domain as the location.


from netapp_ontap import HostConnection
from netapp_ontap.resources import IpInterface

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = IpInterface()
    resource.name = "Data1"
    resource.ip = {"address": "10.234.101.116", "netmask": "255.255.240.0"}
    resource.enabled = True
    resource.scope = "svm"
    resource.svm = {"uuid": "137f3618-1e89-11e9-803e-005056a7646a"}
    resource.location = {"auto_revert": True, "broadcast_domain": {"name": "Default"}}
    resource.service_policy = {"name": "default-data-files"}
    resource.post(hydrate=True)
    print(resource)

IpInterface(
    {
        "_links": {
            "self": {
                "href": "/api/network/ip/interfaces/80d271c9-1f43-11e9-803e-005056a7646a"
            }
        },
        "ip": {"netmask": "20", "address": "10.234.101.116"},
        "uuid": "80d271c9-1f43-11e9-803e-005056a7646a",
        "service_policy": {"name": "default-data-files"},
        "location": {"auto_revert": True},
        "enabled": True,
        "scope": "svm",
        "svm": {
            "_links": {
                "self": {"href": "/api/svm/svms/137f3618-1e89-11e9-803e-005056a7646a"}
            },
            "uuid": "137f3618-1e89-11e9-803e-005056a7646a",
            "name": "vs0",
        },
        "name": "Data1",
    }
)


Creating a Cluster-scoped IP interface without specifying the scope parameter

The following example shows the record returned after creating an IP interface on "e0d" without specifying the scope parameter. The scope is "cluster" if an "svm" is not specified.


from netapp_ontap import HostConnection
from netapp_ontap.resources import IpInterface

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = IpInterface()
    resource.name = "cluster_mgmt"
    resource.ip = {"address": "10.63.41.6", "netmask": "18"}
    resource.enabled = True
    resource.ipspace = {"name": "Default"}
    resource.location = {
        "auto_revert": False,
        "home_port": {"name": "e0d", "node": {"name": "user-cluster-01-a"}},
    }
    resource.service_policy = {"name": "default-management"}
    resource.post(hydrate=True)
    print(resource)

IpInterface(
    {
        "_links": {
            "self": {
                "href": "/api/network/ip/interfaces/245979de-59fc-11e8-ba55-005056b4340f"
            }
        },
        "ip": {"netmask": "18", "address": "10.63.41.6"},
        "ipspace": {"name": "Default"},
        "uuid": "245979de-59fc-11e8-ba55-005056b4340f",
        "service_policy": {"name": "default-management"},
        "location": {
            "auto_revert": False,
            "home_port": {"node": {"name": "user-cluster-01-a"}, "name": "e0d"},
        },
        "enabled": True,
        "scope": "cluster",
        "name": "cluster_mgmt",
    }
)


Creating an SVM-scoped IP interface without specifying the scope parameter

The following example shows the record returned after creating an IP interface on "e0d" without specifying the scope parameter. The scope is "svm" if the "svm" field is specified.


from netapp_ontap import HostConnection
from netapp_ontap.resources import IpInterface

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = IpInterface()
    resource.name = "Data1"
    resource.ip = {"address": "10.234.101.116", "netmask": "255.255.240.0"}
    resource.enabled = True
    resource.svm = {"uuid": "137f3618-1e89-11e9-803e-005056a7646a"}
    resource.location = {"auto_revert": True, "broadcast_domain": {"name": "Default"}}
    resource.service_policy = {"name": "default-data-files"}
    resource.post(hydrate=True)
    print(resource)

IpInterface(
    {
        "_links": {
            "self": {
                "href": "/api/network/ip/interfaces/80d271c9-1f43-11e9-803e-005056a7646a"
            }
        },
        "ip": {"netmask": "20", "address": "10.234.101.116"},
        "uuid": "80d271c9-1f43-11e9-803e-005056a7646a",
        "service_policy": {"name": "default-data-files"},
        "location": {"auto_revert": True},
        "enabled": True,
        "scope": "svm",
        "svm": {
            "_links": {
                "self": {"href": "/api/svms/137f3618-1e89-11e9-803e-005056a7646a"}
            },
            "uuid": "137f3618-1e89-11e9-803e-005056a7646a",
            "name": "vs0",
        },
        "name": "Data1",
    }
)


Updating IP interfaces

You can use the IP interfaces PATCH API to update the attributes of an IP interface.


Examples

Updating the auto revert flag of an IP interface

The following example shows how the PATCH request changes the auto revert flag to 'false'.


from netapp_ontap import HostConnection
from netapp_ontap.resources import IpInterface

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = IpInterface(uuid="80d271c9-1f43-11e9-803e-005056a7646a")
    resource.location = {"auto_revert": "false"}
    resource.patch()


Updating the service policy of an IP interface

The following example shows how the PATCH request changes the service policy to 'default-management'.


from netapp_ontap import HostConnection
from netapp_ontap.resources import IpInterface

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = IpInterface(uuid="80d271c9-1f43-11e9-803e-005056a7646a")
    resource.service_policy = {"name": "default-management"}
    resource.patch()


Deleting IP interfaces

You can use the IP interfaces DELETE API to delete an IP interface in the cluster.


Example

Deleting an IP Interface

The following DELETE request deletes a network IP interface.


from netapp_ontap import HostConnection
from netapp_ontap.resources import IpInterface

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = IpInterface(uuid="80d271c9-1f43-11e9-803e-005056a7646a")
    resource.delete()


Classes

class IpInterface (*args, **kwargs)

Allows interaction with IpInterface 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

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('IpInterface')] = 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 an IP interface.

  • network interface delete

Learn more


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 the details of all IP interfaces.

  • network interface show

Learn more


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 the details of all IP interfaces.

  • network interface show

Learn more


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('IpInterface')] = None, poll: bool = True, poll_interval: Union[int, NoneType] = None, poll_timeout: Union[int, NoneType] = None, connection: HostConnection = None, **kwargs) -> NetAppResponse

Updates an IP interface.

  • network interface migrate
  • network interface modify
  • network interface rename
  • network interface revert

Learn more


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('IpInterface')], *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[IpInterface], NetAppResponse]

Creates a new Cluster-scoped or SVM-scoped interface.

Required properties

  • name - Name of the interface to create.
  • ip.address - IP address for the interface.
  • ip.netmask - IP subnet of the interface.
  • ipspace.name or ipspace.uuid
  • Required for Cluster-scoped interfaces.
  • Optional for SVM-scoped interfaces.
  • svm.name or svm.uuid
  • Required for an SVM-scoped interface.
  • Invalid for a Cluster-scoped interface.
  • location.home_port or location.home_node or location.broadcast_domain - One of these properties must be set to a value to define where the interface will be located.
  • service_policy
  • for SVM scoped interfaces
    • default-data-files for interfaces carrying file-oriented NAS data traffic
    • default-data-blocks for interfaces carrying block-oriented SAN data traffic
    • default-management for interfaces carrying SVM management requests
  • for Cluster scoped interfaces
    • default-intercluster for interfaces carrying cluster peering traffic
    • default-management for interfaces carrying system management requests
    • default-route-announce for interfaces carrying BGP peer connections

Default property values

If not specified in POST, the following default property values are assigned: * scope * svm if svm parameter is specified. * cluster if svm parameter is not specified * enabled - true * location.auto_revert - true * service_policy * default-data-files if scope is svm * default-management if scope is cluster and IPspace is not Cluster * default-cluster if scope is svm and IPspace is Cluster * failover - Selects the least restrictive failover policy supported by all the services in the service policy. * ddns_enabled * true if the interface supports data_nfs or data_cifs services * false otherwise

  • network interface create

Learn more


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 an IP interface.

  • network interface delete

Learn more


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

  • network interface show

Learn more


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

Updates an IP interface.

  • network interface migrate
  • network interface modify
  • network interface rename
  • network interface revert

Learn more


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

Creates a new Cluster-scoped or SVM-scoped interface.

Required properties

  • name - Name of the interface to create.
  • ip.address - IP address for the interface.
  • ip.netmask - IP subnet of the interface.
  • ipspace.name or ipspace.uuid
  • Required for Cluster-scoped interfaces.
  • Optional for SVM-scoped interfaces.
  • svm.name or svm.uuid
  • Required for an SVM-scoped interface.
  • Invalid for a Cluster-scoped interface.
  • location.home_port or location.home_node or location.broadcast_domain - One of these properties must be set to a value to define where the interface will be located.
  • service_policy
  • for SVM scoped interfaces
    • default-data-files for interfaces carrying file-oriented NAS data traffic
    • default-data-blocks for interfaces carrying block-oriented SAN data traffic
    • default-management for interfaces carrying SVM management requests
  • for Cluster scoped interfaces
    • default-intercluster for interfaces carrying cluster peering traffic
    • default-management for interfaces carrying system management requests
    • default-route-announce for interfaces carrying BGP peer connections

Default property values

If not specified in POST, the following default property values are assigned: * scope * svm if svm parameter is specified. * cluster if svm parameter is not specified * enabled - true * location.auto_revert - true * service_policy * default-data-files if scope is svm * default-management if scope is cluster and IPspace is not Cluster * default-cluster if scope is svm and IPspace is Cluster * failover - Selects the least restrictive failover policy supported by all the services in the service policy. * ddns_enabled * true if the interface supports data_nfs or data_cifs services * false otherwise

  • network interface create

Learn more


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

class IpInterfaceSchema (*, 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 IpInterface object

Ancestors

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

Class variables

ddns_enabled GET POST PATCH

Indicates whether or not dynamic DNS updates are enabled. Defaults to true if the interface supports "data_nfs" or "data_cifs" services, otherwise false.

dns_zone GET POST PATCH

Fully qualified DNS zone name

Example: storage.company.com

enabled GET POST PATCH

The administrative state of the interface.

ip GET POST PATCH

The ip field of the ip_interface.

ipspace GET POST

The ipspace field of the ip_interface.

The links field of the ip_interface.

location GET POST PATCH

The location field of the ip_interface.

metric GET

The metric field of the ip_interface.

name GET POST PATCH

Interface name

Example: dataLif1

probe_port GET POST

Probe port for Cloud load balancer

Example: 64001

rdma_protocols GET POST PATCH

Supported RDMA offload protocols

scope GET POST

Set to "svm" for interfaces owned by an SVM. Otherwise, set to "cluster".

Valid choices:

  • svm
  • cluster
service_policy GET POST PATCH

The service_policy field of the ip_interface.

services GET

The services associated with the interface.

state GET

The operational state of the interface.

Valid choices:

  • up
  • down
statistics GET

The statistics field of the ip_interface.

svm GET POST

The svm field of the ip_interface.

uuid GET

The UUID that uniquely identifies the interface.

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

vip GET POST

True for a VIP interface, whose location is announced via BGP.