Module netapp_ontap.resources.network_ip_options

Copyright © 2022 NetApp Inc. All rights reserved.

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

Overview

Cluster-wide options for the internet protocol. The following operations are supported:

  • Get: GET network/ip/options
  • Patch: PATCH network/ip/options

Retrieving the internet protocol options

The network ip options API retrieves and displays the names and values for the options that affect the behaviour of the internet protocol. The values of these options are applied to all of the nodes in the cluster.

Examples

Retrieving values for all cluster-wide internet protocol options

The following output shows the cluster-wide options for the internet protocol.


from netapp_ontap import HostConnection
from netapp_ontap.resources import NetworkIpOptions

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = NetworkIpOptions()
    resource.get()
    print(resource)

NetworkIpOptions(
    {
        "multipath_routing": {"enabled": False},
        "_links": {"self": {"href": "/api/network/ip/options"}},
    }
)


Modifying the values for the cluster-wide internet protocol options

The following output shows how to modify the values for the cluster-wide internet protocol option for multipath-routing.


from netapp_ontap import HostConnection
from netapp_ontap.resources import NetworkIpOptions

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = NetworkIpOptions()
    resource.multipath_routing.enabled = True
    resource.patch()


Classes

class NetworkIpOptions (*args, **kwargs)

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

Methods

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

Retrieves the internet protocol options.

  • network options multipath-routing 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: Optional[int] = None, poll_timeout: Optional[int] = None, **kwargs) -> NetAppResponse

Modifies the internet protocol options.

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

Inherited members

class NetworkIpOptionsSchema (*, 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 NetworkIpOptions object

Ancestors

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

Class variables

The links field of the network_ip_options.

multipath_routing: NetworkIpOptionsMultipathRouting GET PATCH

The multipath_routing field of the network_ip_options.