# Module `netapp_ontap.resources.cifs_domain_preferred_dc`

Copyright © 2022 NetApp Inc. All rights reserved.

## Overview

You can use this API to display a CIFS domain preferred DC configuration of an SVM.

## Retrieving all CIFS domain preferred DC configurations of an SVM

The CIFS domain preferred DC GET endpoint retrieves all the configurations for a specific SVM.

## Examples

### Retrieving all the fields of all CIFS domain preferred DC configurations of an SVM

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import CifsDomainPreferredDc

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        print(
            list(
                CifsDomainPreferredDc.get_collection(
                    "1226670c-abc9-11eb-8de3-0050568eb0c4", fields="*"
                )
            )
        )

Try it out

    [
        CifsDomainPreferredDc({"fqdn": "host1", "server_ip": "4.4.4.4"}),
        CifsDomainPreferredDc({"fqdn": "host2", "server_ip": "11.11.11.11"}),
    ]

### Retrieving the CIFS domain preferred DC configuration of a specific SVM, "fqdn" and "server_ip"

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import CifsDomainPreferredDc

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = CifsDomainPreferredDc(
            "1226670c-abc9-11eb-8de3-0050568eb0c4", server_ip="4.4.4.4", fqdn="host1"
        )
        resource.get()
        print(resource)

Try it out

    CifsDomainPreferredDc({"fqdn": "host1", "server_ip": "4.4.4.4"})

## Creating a new CIFS domain preferred DC configuration

The CIFS domain preferred DC POST endpoint creates a new configuration. Both bulk and instance POST is supported.

## Examples

### Creating a single CIFS domain preferred DC configuration

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import CifsDomainPreferredDc

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = CifsDomainPreferredDc("1226670c-abc9-11eb-8de3-0050568eb0c4")
        resource.fqdn = "testing.com"
        resource.server_ip = "1.1.1.1"
        resource.post(hydrate=True, skip_config_validation=True, return_records=False)
        print(resource)

## Deleting an existing CIFS domain preferred DC configuration

The CIFS domain preferred DC DELETE endpoint deletes an existing configuration. Both bulk and instance delete is supported.

## Examples

### Deleting the CIFS domain preferred DC configuration of a specific SVM, "fqdn" and "server_ip"

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import CifsDomainPreferredDc

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = CifsDomainPreferredDc(
            "1226670c-abc9-11eb-8de3-0050568eb0c4", server_ip="4.4.4.4", fqdn="sample"
        )
        resource.delete()

      ### Deleting the CIFS domain preferred DC configurations of a specific SVM and "fqdn"

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import CifsDomainPreferredDc

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = CifsDomainPreferredDc("1226670c-abc9-11eb-8de3-0050568eb0c4")
        resource.delete(fqdn="sampl")

### Deleting all CIFS domain preferred DC configurations of a specific SVM

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import CifsDomainPreferredDc

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = CifsDomainPreferredDc("1226670c-abc9-11eb-8de3-0050568eb0c4")
        resource.delete(fqdn="*")

### Deleting the CIFS domain preferred DC configurations of a specific SVM, "fqdn" and set of "server_ips"

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import CifsDomainPreferredDc

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = CifsDomainPreferredDc("1226670c-abc9-11eb-8de3-0050568eb0c4")
        resource.delete(fqdn="sample", server_ip="3.3.3.3|4.4.4.4|1.1.1.1|2.2.2.2")

### Deleting the CIFS domain preferred DC configurations of a specifc SVM and set of "server_ips"

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import CifsDomainPreferredDc

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = CifsDomainPreferredDc("1226670c-abc9-11eb-8de3-0050568eb0c4")
        resource.delete(server_ip="3.3.3.3|4.4.4.4|1.1.1.1|2.2.2.2")

## Classes

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

  Allows interaction with CifsDomainPreferredDc 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('CifsDomainPreferredDc')] = 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 the CIFS domain preferred DC configuration of the specified SVM and domain.

    ### Related ONTAP commands

    - `vserver cifs domain preferred-dc delete`

    ### Learn more

    - `DOC /protocols/cifs/domains/{svm.uuid}/preferred-domain-controllers`

    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 CIFS domain preferred DC configuration of an SVM.

    ### Related ONTAP commands

    - `vserver cifs domain preferred-dc show`

    ### Learn more

    - `DOC /protocols/cifs/domains/{svm.uuid}/preferred-domain-controllers`

    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 CIFS domain preferred DC configuration of an SVM.

    ### Related ONTAP commands

    - `vserver cifs domain preferred-dc show`

    ### Learn more

    - `DOC /protocols/cifs/domains/{svm.uuid}/preferred-domain-controllers`

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

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

    ## Args

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

    ## Returns

    A list of `Resource` objects

    ## Raises

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

  `def post_collection(records: Iterable[_ForwardRef('CifsDomainPreferredDc')], *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[CifsDomainPreferredDc], NetAppResponse]`

    Creates a CIFS preferred DC configuration for an SVM.

    ### Important notes

    - In the case of bulk POST requests, the create operation should be performed serially since there can be interdependence between records. In order to avoid issues, it is advisable to always use the query parameter "serial_records=true".

    ### Required properties

    - `svm.uuid` - Existing SVM in which to create the preferred-dc.
    - `domain` - Fully Qualified Domain Name.
    - `server_ip` - IPv4/IPv6 address of the Preferred Domain Controller.

    #### The following parameters are optional:

    - skip_config_validation

    ### Related ONTAP commands

    - `vserver cifs domain preferred-dc add`

    ### Learn more

    - `DOC /protocols/cifs/domains/{svm.uuid}/preferred-domain-controllers`

    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 the CIFS domain preferred DC configuration of the specified SVM and domain.

    ### Related ONTAP commands

    - `vserver cifs domain preferred-dc delete`

    ### Learn more

    - `DOC /protocols/cifs/domains/{svm.uuid}/preferred-domain-controllers`

    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 the CIFS domain preferred DC configuration of an SVM.

    ### Related ONTAP commands

    - `vserver cifs domain preferred-dc show`

    ### Learn more

    - `DOC /protocols/cifs/domains/{svm.uuid}/preferred-domain-controllers`

    Fetch the details of the object from the host.

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

    ## Returns

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

    ## Raises

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

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

    Creates a CIFS preferred DC configuration for an SVM.

    ### Important notes

    - In the case of bulk POST requests, the create operation should be performed serially since there can be interdependence between records. In order to avoid issues, it is advisable to always use the query parameter "serial_records=true".

    ### Required properties

    - `svm.uuid` - Existing SVM in which to create the preferred-dc.
    - `domain` - Fully Qualified Domain Name.
    - `server_ip` - IPv4/IPv6 address of the Preferred Domain Controller.

    #### The following parameters are optional:

    - skip_config_validation

    ### Related ONTAP commands

    - `vserver cifs domain preferred-dc add`

    ### Learn more

    - `DOC /protocols/cifs/domains/{svm.uuid}/preferred-domain-controllers`

    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 CifsDomainPreferredDcSchema (*, 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 CifsDomainPreferredDc object

  ### Ancestors

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

  ### Class variables

  `fqdn GET POST`

    Fully Qualified Domain Name.

    Example: test.com

  `server_ip GET POST`

    IP address of the preferred domain controller (DC). The address can be either an IPv4 or an IPv6 address.

    Example: 4.4.4.4