Module netapp_ontap.resources.dns

Copyright © 2022 NetApp Inc. All rights reserved.

Overview

Displays DNS information and controls the DNS subsytem. DNS domain name and DNS servers are required parameters.

Retrieving DNS information

The DNS GET endpoint retrieves all of the DNS configurations for all SVMs. DNS configuration for the cluster is retrieved via /api/cluster.

Examples

Retrieving all of the fields for all of the DNS configurations

from netapp_ontap import HostConnection
from netapp_ontap.resources import Dns

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

[
    Dns(
        {
            "domains": ["domain.example.com"],
            "scope": "cluster",
            "attempts": 1,
            "svm": {
                "_links": {
                    "self": {
                        "href": "/api/svm/svms/179d3c85-7053-11e8-b9b8-005056b41bd1"
                    }
                },
                "uuid": "27eff5d8-22b2-11eb-8038-0050568ed32c",
                "name": "clust-1",
            },
            "timeout": 2,
            "servers": ["44.44.44.44"],
            "_links": {
                "self": {
                    "href": "/api/name-services/dns/27eff5d8-22b2-11eb-8038-0050568ed32c"
                }
            },
        }
    ),
    Dns(
        {
            "domains": ["domainA.example.com"],
            "scope": "svm",
            "attempts": 1,
            "svm": {
                "_links": {
                    "self": {
                        "href": "/api/svm/svms/179d3c85-7053-11e8-b9b8-005056b41bd1"
                    }
                },
                "uuid": "179d3c85-7053-11e8-b9b8-005056b41bd1",
                "name": "vs1",
            },
            "timeout": 2,
            "servers": ["10.10.10.10"],
            "dynamic_dns": {
                "use_secure": False,
                "enabled": False,
                "time_to_live": "PT1H",
            },
            "_links": {
                "self": {
                    "href": "/api/name-services/dns/179d3c85-7053-11e8-b9b8-005056b41bd1"
                }
            },
        }
    ),
    Dns(
        {
            "domains": ["sample.example.com"],
            "scope": "svm",
            "attempts": 2,
            "svm": {
                "_links": {
                    "self": {
                        "href": "/api/svm/svms/19076d35-6e27-11e8-b9b8-005056b41bd1"
                    }
                },
                "uuid": "19076d35-6e27-11e8-b9b8-005056b41bd1",
                "name": "vs2",
            },
            "timeout": 2,
            "servers": ["11.11.11.11", "22.22.22.22", "33.33.33.33"],
            "dynamic_dns": {
                "use_secure": False,
                "enabled": True,
                "time_to_live": "PT3H",
            },
            "_links": {
                "self": {
                    "href": "/api/name-services/dns/19076d35-6e27-11e8-b9b8-005056b41bd1"
                }
            },
        }
    ),
]

Retrieving all DNS configurations whose domain name starts with dom*.

from netapp_ontap import HostConnection
from netapp_ontap.resources import Dns

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

[
    Dns(
        {
            "domains": ["domainA.example.com"],
            "svm": {
                "_links": {
                    "self": {
                        "href": "/api/svm/svms/179d3c85-7053-11e8-b9b8-005056b41bd1"
                    }
                },
                "uuid": "179d3c85-7053-11e8-b9b8-005056b41bd1",
                "name": "vs1",
            },
            "_links": {
                "self": {
                    "href": "/api/name-services/dns/179d3c85-7053-11e8-b9b8-005056b41bd1"
                }
            },
        }
    )
]

Retrieving the DNS configuration for a specific SVM

from netapp_ontap import HostConnection
from netapp_ontap.resources import Dns

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = Dns(**{"svm.uuid": "179d3c85-7053-11e8-b9b8-005056b41bd1"})
    resource.get()
    print(resource)

Dns(
    {
        "domains": ["domainA.example.com"],
        "scope": "svm",
        "attempts": 1,
        "source_address_match": True,
        "svm": {
            "_links": {
                "self": {"href": "/api/svm/svms/179d3c85-7053-11e8-b9b8-005056b41bd1"}
            },
            "uuid": "179d3c85-7053-11e8-b9b8-005056b41bd1",
            "name": "vs1",
        },
        "tld_query_enabled": True,
        "timeout": 2,
        "packet_query_match": True,
        "servers": ["10.10.10.10"],
        "dynamic_dns": {"use_secure": False, "enabled": False, "time_to_live": "P1D"},
        "_links": {
            "self": {
                "href": "/api/name-services/dns/179d3c85-7053-11e8-b9b8-005056b41bd1"
            }
        },
    }
)

Retrieving the advanced fields "DNS status", "tld_query_enable", "source_address_match", and "packet_query_match" using wildcards **

from netapp_ontap import HostConnection
from netapp_ontap.resources import Dns

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = Dns(**{"svm.uuid": "179d3c85-7053-11e8-b9b8-005056b41bd1"})
    resource.get(fileds="**")
    print(resource)

Dns(
    {
        "domains": ["domainA.example.com"],
        "status": [
            {
                "name_server": "10.10.10.10",
                "code": 0,
                "message": "Response time (msec): ",
                "state": "up",
            }
        ],
        "scope": "svm",
        "attempts": 1,
        "source_address_match": True,
        "svm": {
            "_links": {
                "self": {"href": "/api/svm/svms/179d3c85-7053-11e8-b9b8-005056b41bd1"}
            },
            "uuid": "179d3c85-7053-11e8-b9b8-005056b41bd1",
            "name": "vs1",
        },
        "tld_query_enabled": True,
        "timeout": 2,
        "packet_query_match": True,
        "servers": ["10.10.10.10"],
        "dynamic_dns": {"use_secure": False, "enabled": False, "time_to_live": "P1D"},
        "_links": {
            "self": {
                "href": "/api/name-services/dns/179d3c85-7053-11e8-b9b8-005056b41bd1"
            }
        },
    }
)

Creating a DNS configuration

The DNS POST endpoint creates a DNS configuration for the specified SVM.

Examples

Specifying only the required fields

from netapp_ontap import HostConnection
from netapp_ontap.resources import Dns

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = Dns()
    resource.svm = {"uuid": "179d3c85-7053-11e8-b9b8-005056b41bd1"}
    resource.domains = ["domainA.example.com"]
    resource.servers = ["10.10.10.10"]
    resource.post(hydrate=True)
    print(resource)

Specifying the optional fields as well

from netapp_ontap import HostConnection
from netapp_ontap.resources import Dns

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = Dns()
    resource.svm = {"uuid": "179d3c85-7053-11e8-b9b8-005056b41bd1"}
    resource.domains = ["domainA.example.com"]
    resource.servers = ["10.10.10.10"]
    resource.timeout = 2
    resource.attempts = 3
    resource.post(hydrate=True)
    print(resource)

Specifying the scope of the SVM

from netapp_ontap import HostConnection
from netapp_ontap.resources import Dns

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = Dns()
    resource.svm = {"uuid": "179d3c85-7053-11e8-b9b8-005056b41bd1"}
    resource.domains = ["domainA.example.com"]
    resource.servers = ["10.10.10.10"]
    resource.timeout = 2
    resource.attempts = 3
    resource.scope = "svm"
    resource.post(hydrate=True)
    print(resource)

Updating a DNS configuration

The DNS PATCH endpoint updates the DNS configuration for the specified SVM.

Examples

Updating both the DNS domains and servers

from netapp_ontap import HostConnection
from netapp_ontap.resources import Dns

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = Dns(**{"svm.uuid": "179d3c85-7053-11e8-b9b8-005056b41bd1"})
    resource.domains = ["domainA.example.com", "domainB.example.com"]
    resource.servers = ["10.10.10.10", "10.10.10.11"]
    resource.patch()

Updating the DNS servers only

from netapp_ontap import HostConnection
from netapp_ontap.resources import Dns

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = Dns(**{"svm.uuid": "179d3c85-7053-11e8-b9b8-005056b41bd1"})
    resource.servers = ["10.10.10.10"]
    resource.patch()

Updating the optional fields "timeout", "attempts", and "source_address_match"

from netapp_ontap import HostConnection
from netapp_ontap.resources import Dns

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = Dns(**{"svm.uuid": "179d3c85-7053-11e8-b9b8-005056b41bd1"})
    resource.timeout = 2
    resource.attempts = 3
    resource.source_address_match = True
    resource.patch()

from netapp_ontap import HostConnection
from netapp_ontap.resources import Dns

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = Dns(**{"svm.uuid": "179d3c85-7053-11e8-b9b8-005056b41bd1"})
    resource.timeout = 2
    resource.attempts = 3
    resource.dynamic_dns.enabled = True
    resource.dynamic_dns.time_to_live = "20h"
    resource.patch()

Deleting a DNS configuration

The DNS DELETE endpoint deletes the DNS configuration for the specified SVM.

Example

The following example shows a DELETE operation.

from netapp_ontap import HostConnection
from netapp_ontap.resources import Dns

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = Dns(**{"svm.uuid": "179d3c85-7053-11e8-b9b8-005056b41bd1"})
    resource.delete()

Classes

class Dns (*args, **kwargs)

Allows interaction with Dns 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('Dns')] = 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 DNS domain configuration of the specified SVM.

  • vserver services name-service dns 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 DNS configurations of all SVMs. Specify 'scope' as 'svm' to retrieve the DNS configuration of all the data SVMs. Specify 'scope' as 'cluster' to retrieve the DNS configuration of the cluster.

Advanced properties

  • 'tld_query_enabled'
  • 'source_address_match'
  • 'packet_query_match'
  • 'status' property retrieves the status of each name server of the DNS configuration for an SVM.
  • vserver services name-service dns show
  • vserver services name-service dns check
  • vserver services name-service dns dynamic-update 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 DNS configurations of all SVMs. Specify 'scope' as 'svm' to retrieve the DNS configuration of all the data SVMs. Specify 'scope' as 'cluster' to retrieve the DNS configuration of the cluster.

Advanced properties

  • 'tld_query_enabled'
  • 'source_address_match'
  • 'packet_query_match'
  • 'status' property retrieves the status of each name server of the DNS configuration for an SVM.
  • vserver services name-service dns show
  • vserver services name-service dns check
  • vserver services name-service dns dynamic-update 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('Dns')] = None, poll: bool = True, poll_interval: Union[int, NoneType] = None, poll_timeout: Union[int, NoneType] = None, connection: HostConnection = None, **kwargs) -> NetAppResponse

Updates DNS domain and server configurations of an SVM.

Important notes

  • Both DNS domains and servers can be modified.
  • The domains and servers fields cannot be empty.
  • IPv6 must be enabled if IPv6 family addresses are specified for the servers field.
  • The DNS server specified using the servers field is validated during this operation.
    The validation fails in the following scenarios:
  • The server is not a DNS server.
  • The server does not exist.
  • The server is unreachable.
  • The DNS server validation can be skipped by setting the property "skip_config_validation" to "true".
  • Dynamic DNS configuration can be modified.
  • If both DNS and Dynamic DNS parameters are modified, DNS parameters are updated first followed by Dynamic DNS parameters. If updating Dynamic DNS fails, then the updated DNS configuration is not reverted.

The following parameters are optional:

  • timeout
  • attempts
  • source_address_match
  • packet_query_match
  • tld_query_enabled
  • skip_config_validation
  • dynamic_dns.enabled
  • dynamic_dns.use_secure
  • dynamic_dns.time_to_live
  • vserver services name-service dns modify
  • vserver services name-service dns dynamic-update modify

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

Creates DNS domain and server configurations for an SVM.

Important notes

  • Each SVM can have only one DNS configuration.
  • The domain name and the servers fields cannot be empty.
  • IPv6 must be enabled if IPv6 family addresses are specified in the servers field.
  • Configuring more than one DNS server is recommended to avoid a single point of failure.
  • The DNS server specified using the servers field is validated during this operation.

    The validation fails in the following scenarios:
  • The server is not a DNS server.
  • The server does not exist.
  • The server is unreachable.
  • The DNS server validation can be skipped by setting the property "skip_config_validation" to "true".
  • Scope of the SVM can be specified using the "scope" parameter. "svm" scope refers to data SVMs and "cluster" scope refers to clusters.

The following parameters are optional:

  • timeout
  • attempts
  • source_address_match
  • packet_query_match
  • tld_query_enabled
  • skip_config_validation
  • scope

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 DNS domain configuration of the specified SVM.

  • vserver services name-service dns 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 DNS domain and server configuration of an SVM. By default, both DNS domains and servers are displayed.

Advanced properties

  • 'tld_query_enabled'
  • 'source_address_match'
  • 'packet_query_match'
  • 'status' property retrieves the status of each name server of the DNS configuration for an SVM.
  • vserver services name-service dns show
  • vserver services name-service dns check
  • vserver services name-service dns dynamic-update 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 DNS domain and server configurations of an SVM.

Important notes

  • Both DNS domains and servers can be modified.
  • The domains and servers fields cannot be empty.
  • IPv6 must be enabled if IPv6 family addresses are specified for the servers field.
  • The DNS server specified using the servers field is validated during this operation.
    The validation fails in the following scenarios:
  • The server is not a DNS server.
  • The server does not exist.
  • The server is unreachable.
  • The DNS server validation can be skipped by setting the property "skip_config_validation" to "true".
  • Dynamic DNS configuration can be modified.
  • If both DNS and Dynamic DNS parameters are modified, DNS parameters are updated first followed by Dynamic DNS parameters. If updating Dynamic DNS fails, then the updated DNS configuration is not reverted.

The following parameters are optional:

  • timeout
  • attempts
  • source_address_match
  • packet_query_match
  • tld_query_enabled
  • skip_config_validation
  • dynamic_dns.enabled
  • dynamic_dns.use_secure
  • dynamic_dns.time_to_live
  • vserver services name-service dns modify
  • vserver services name-service dns dynamic-update modify

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 DNS domain and server configurations for an SVM.

Important notes

  • Each SVM can have only one DNS configuration.
  • The domain name and the servers fields cannot be empty.
  • IPv6 must be enabled if IPv6 family addresses are specified in the servers field.
  • Configuring more than one DNS server is recommended to avoid a single point of failure.
  • The DNS server specified using the servers field is validated during this operation.

    The validation fails in the following scenarios:
  • The server is not a DNS server.
  • The server does not exist.
  • The server is unreachable.
  • The DNS server validation can be skipped by setting the property "skip_config_validation" to "true".
  • Scope of the SVM can be specified using the "scope" parameter. "svm" scope refers to data SVMs and "cluster" scope refers to clusters.

The following parameters are optional:

  • timeout
  • attempts
  • source_address_match
  • packet_query_match
  • tld_query_enabled
  • skip_config_validation
  • scope

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 DnsSchema (*, 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 Dns object

Ancestors

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

Class variables

attempts GET POST PATCH

Number of attempts allowed when querying the DNS name servers.

domains GET POST PATCH

The domains field of the dns.

dynamic_dns GET PATCH

The dynamic_dns field of the dns.

The links field of the dns.

packet_query_match GET POST PATCH

Indicates whether or not the query section of the reply packet is equal to that of the query packet.

scope GET POST

Set to "svm" for DNS owned by an SVM, otherwise set to "cluster".

Valid choices:

  • svm
  • cluster
servers GET POST PATCH

The servers field of the dns.

skip_config_validation POST PATCH

Indicates whether or not the validation for the specified DNS configuration is disabled.

source_address_match GET POST PATCH

Indicates whether or not the DNS responses are from a different IP address to the IP address the request was sent to.

status GET

Status of all the DNS name servers configured for the specified SVM.

svm GET POST PATCH

The svm field of the dns.

timeout GET POST PATCH

Timeout values for queries to the name servers, in seconds.

tld_query_enabled GET POST PATCH

Enable or disable top-level domain (TLD) queries.