Module `netapp_ontap.resources.cifs_domain`

Overview

Displays CIFS domain-related information of the specified SVM.

Examples

Retrieving all the fields of CIFS domain configurations of a specific SVM

from netapp_ontap import HostConnection
from netapp_ontap.resources import CifsDomain

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = CifsDomain(**{"svm.uuid": "6dd78167-c907-11eb-b2bf-0050568e7324"})
    resource.get()
    print(resource)

Try it out

CifsDomain(
    {
        "password_schedule": {
            "schedule_randomized_minute": 120,
            "schedule_weekly_interval": 4,
            "schedule_enabled": False,
            "schedule_description": "Tue@1:00",
        },
        "discovered_servers": [
            {
                "server_type": "kerberos",
                "preference": "preferred",
                "domain": "server02.com",
                "state": "undetermined",
                "server_name": "scspb0659002001",
                "node": {
                    "uuid": "4d9400f0-c84b-11eb-90ab-0050568e7324",
                    "name": "vsNode2",
                },
                "server_ip": "192.168.20.1",
            },
            {
                "server_type": "ms_ldap",
                "preference": "preferred",
                "domain": "server02.com",
                "state": "undetermined",
                "server_name": "scspb0659002001",
                "node": {
                    "uuid": "4d9400f0-c84b-11eb-90ab-0050568e7324",
                    "name": "vsNode2",
                },
                "server_ip": "192.168.20.1",
            },
            {
                "server_type": "ms_dc",
                "preference": "preferred",
                "domain": "server02.com",
                "state": "undetermined",
                "server_name": "scspb0659002001",
                "node": {
                    "uuid": "4d9400f0-c84b-11eb-90ab-0050568e7324",
                    "name": "vsNode2",
                },
                "server_ip": "192.168.20.1",
            },
        ],
        "svm": {"uuid": "6dd78167-c907-11eb-b2bf-0050568e7324", "name": "vs2"},
        "trust_relationships": [
            {
                "node": {
                    "uuid": "4d9400f0-c84b-11eb-90ab-0050568e7324",
                    "name": "vsNode2",
                },
                "trusted_domains": ["SERVER02.COM"],
                "home_domain": "SERVER02.COM",
            }
        ],
        "preferred_dcs": [{"fqdn": "server02.com", "server_ip": "192.168.20.1"}],
        "name_mapping": {"trusted_domains": ["SERVER03.COM", "SERVER04.COM"]},
    }
)

Applying rediscover_trusts query parameter and retrieving all the fields of CIFS domain configurations

from netapp_ontap import HostConnection
from netapp_ontap.resources import CifsDomain

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = CifsDomain(**{"svm.uuid": "6dd78167-c907-11eb-b2bf-0050568e7324"})
    resource.get(rediscover_trusts=True)
    print(resource)

Try it out

CifsDomain(
    {
        "password_schedule": {
            "schedule_randomized_minute": 120,
            "schedule_weekly_interval": 4,
            "schedule_enabled": False,
            "schedule_description": "Tue@1:00",
        },
        "discovered_servers": [
            {
                "server_type": "kerberos",
                "preference": "preferred",
                "domain": "server02.com",
                "state": "undetermined",
                "server_name": "scspb0659002001",
                "node": {
                    "uuid": "4d9400f0-c84b-11eb-90ab-0050568e7324",
                    "name": "vsNode2",
                },
                "server_ip": "192.168.20.1",
            },
            {
                "server_type": "ms_ldap",
                "preference": "preferred",
                "domain": "server02.com",
                "state": "undetermined",
                "server_name": "scspb0659002001",
                "node": {
                    "uuid": "4d9400f0-c84b-11eb-90ab-0050568e7324",
                    "name": "vsNode2",
                },
                "server_ip": "192.168.20.1",
            },
            {
                "server_type": "ms_dc",
                "preference": "preferred",
                "domain": "server02.com",
                "state": "undetermined",
                "server_name": "scspb0659002001",
                "node": {
                    "uuid": "4d9400f0-c84b-11eb-90ab-0050568e7324",
                    "name": "vsNode2",
                },
                "server_ip": "192.168.20.1",
            },
        ],
        "svm": {"uuid": "6dd78167-c907-11eb-b2bf-0050568e7324", "name": "vs2"},
        "trust_relationships": [
            {
                "node": {
                    "uuid": "a64c0906-c7dd-11eb-af15-0050568e403e",
                    "name": "vsNode1",
                },
                "trusted_domains": ["SERVER02.COM"],
                "home_domain": "SERVER02.COM",
            },
            {
                "node": {
                    "uuid": "4d9400f0-c84b-11eb-90ab-0050568e7324",
                    "name": "vsNode2",
                },
                "trusted_domains": ["SERVER02.COM"],
                "home_domain": "SERVER02.COM",
            },
        ],
        "preferred_dcs": [{"fqdn": "server02.com", "server_ip": "192.168.20.1"}],
        "name_mapping": {"trusted_domains": ["SERVER03.COM", "SERVER04.COM"]},
    }
)

Classes

class CifsDomain (*args, **kwargs)

Allows interaction with CifsDomain 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 find(*args, connection: HostConnection = None, **kwargs) -> Resource

Retrieves the CIFS domain-related information of all SVMs.

vserver cifs domain preferred-dc show
vserver cifs domain trusts show
vserver cifs domain discovered-servers show
vserver cifs domain name-mapping-search show
vserver cifs domain schedule show

Learn more

DOC /protocols/cifs/domains

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-related information of all SVMs.

vserver cifs domain preferred-dc show
vserver cifs domain trusts show
vserver cifs domain discovered-servers show
vserver cifs domain name-mapping-search show
vserver cifs domain schedule show

Learn more

DOC /protocols/cifs/domains

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.

Methods

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

Retrieves the CIFS domain-related information of the specified SVM.

Important notes

GET operation with query parameter rediscover_trusts and reset_discovered_servers returns available CIFS domain configurations and also triggers trusts rediscovery and discovered servers reset asynchronously for that SVM.

vserver cifs domain preferred-dc show
vserver cifs domain trusts show
vserver cifs domain discovered-servers show
vserver cifs domain name-mapping-search show
vserver cifs domain schedule show

Learn more

DOC /protocols/cifs/domains/{svm.uuid}

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

Inherited members

Resource:
- from_dict
- get_collection_url
- get_connection
- instance_location
- path_keys
- poll
- set_connection
- to_dict

class CifsDomainSchema (*, 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 CifsDomain object

Ancestors

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

Class variables

discovered_servers GET: Specifies the discovered servers records.
name_mapping GET: The name_mapping field of the cifs_domain.
password_schedule GET: The password_schedule field of the cifs_domain.
preferred_dcs GET: Specifies the preferred DC records.
svm GET: The svm field of the cifs_domain.
trust_relationships GET: Specifies the trusted domain records.

Overview

Examples

Retrieving all the fields of CIFS domain configurations of a specific SVM

Applying rediscover_trusts query parameter and retrieving all the fields of CIFS domain configurations

Classes

Args

Ancestors

Static methods

Args

Returns

Raises

Related ONTAP commands

Learn more

Args

Returns

Raises

Related ONTAP commands

Learn more

Args

Returns

Raises

Methods

Important notes

Related ONTAP commands

Learn more

Returns

Raises

Inherited members

Ancestors

Class variables