# Module `netapp_ontap.resources.netbios`

Copyright © 2022 NetApp Inc. All rights reserved.

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

Displays information about NBT connections for the cluster. Displays the IP address associated with the interfaces, the IP addresses of the WINS servers in use, and information about the registered NetBIOS names for the cluster. You can use this command to troubleshoot NetBIOS name resolution problems.

## Examples

### Retrieving full CIFS NetBIOS information for all SVMs in the clsuter

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import Netbios

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

Try it out

    [
        Netbios(
            {
                "svm": {"uuid": "99a3bd71-777f-11ec-95a1-1315568ef5fd", "name": "vs1"},
                "name_registration_type": "",
                "name": "CIFSERVER2",
                "node": {"uuid": "c2179c2c-777f-11ec-95a1-1315568ef5fd", "name": "vsim2"},
                "interfaces": ["172.10.144.44"],
                "state": "broadcast",
                "scope": "group",
                "mode": "h",
                "suffix": "00",
                "time_left": 0,
                "wins_servers": [{"ip": "10.10.10.10", "state": "inactive"}],
            }
        ),
        Netbios(
            {
                "svm": {"uuid": "99a3bd71-777f-11ec-95a1-1315568ef5fd", "name": "vs1"},
                "name_registration_type": "group",
                "name": "CIFSERVER2",
                "node": {"uuid": "c2179c2c-777f-11ec-95a1-1315568ef5fd", "name": "vsim2"},
                "interfaces": ["172.10.144.44"],
                "state": "broadcast",
                "scope": "",
                "mode": "h",
                "suffix": "20",
                "time_left": 0,
                "wins_servers": [{"ip": "10.10.10.10", "state": "inactive"}],
            }
        ),
    ]

### Retrieving CIFS NetBIOS Information for a particular SVM

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import Netbios

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        print(
            list(
                Netbios.get_collection(
                    return_timeout=15,
                    fields="*",
                    **{"svm.uuid": "45a3bd71-777f-11ec-95a1-1315568ef5fd"}
                )
            )
        )

Try it out

    [
        Netbios(
            {
                "svm": {"uuid": "45a3bd71-777f-11ec-95a1-1315568ef5fd", "name": "vs1"},
                "name_registration_type": "",
                "name": "CIFSERVER2",
                "node": {"uuid": "c2179c2c-777f-11ec-95a1-1315568ef5fd", "name": "vsim2"},
                "interfaces": ["172.10.144.44"],
                "state": "broadcast",
                "scope": "group",
                "mode": "h",
                "suffix": "00",
                "time_left": 0,
                "wins_servers": [{"ip": "10.10.10.10", "state": "inactive"}],
            }
        )
    ]

## Classes

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

  Allows interaction with Netbios 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 NetBIOS information.

    ### Related ONTAP commands

    - `vserver cifs nbstat`

    ### Learn more

    - `DOC /protocols/cifs/netbios`

    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 NetBIOS information.

    ### Related ONTAP commands

    - `vserver cifs nbstat`

    ### Learn more

    - `DOC /protocols/cifs/netbios`

    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.

  ### Inherited members

  - `Resource`:
    - `from_dict`
    - `get_collection_url`
    - `get_connection`
    - `instance_location`
    - `path_keys`
    - `poll`
    - `set_connection`
    - `to_dict`
`class NetbiosSchema (*, 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 Netbios object

  ### Ancestors

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

  ### Class variables

  `interfaces: List[str] GET POST PATCH`

    The interfaces field of the netbios.

  `mode: str GET POST PATCH`

    Specifies the mode in which the NetBIOS name service is configured. The supported values are:

    - p - Point to Point
    - h - Hybrid
    - m - Mixed
    - b - Broadcast

    Valid choices:

    - p
    - h
    - m
    - b
  `name: str GET POST PATCH`

    Specifies the NetBIOS name.

    Example: CLUSTER_1

  `name_registration_type: str GET POST PATCH`

    Specifies the name registration type.

    Valid choices:

    - registered
    - active
    - permanent
    - group *
  `node: Node GET POST PATCH`

    The node field of the netbios.

  `scope: str GET POST PATCH`

    Specifies the NetBIOS name scope. Scope is used as a name for the set of NetBIOS nodes that participate in a NetBIOS over TCP (NBT) virtual LAN.

  `state: str GET POST PATCH`

    Specifies the registration state of the NetBIOS Name.

    Valid choices:

    - must_register
    - must_unregister
    - wins
    - broadcast
    - name_released
    - wins_conflict
    - broadcast_conflict
  `suffix: str GET POST PATCH`

    Specifies the NetBIOS suffix. A NetBIOS suffix is the 16th character of the 16-character NetBIOS name. The NetBIOS suffix is used by Microsoft Networking software to identify functionality installed on the registered device.

  `svm: Svm GET POST PATCH`

    The svm field of the netbios.

  `time_left: Size GET`

    Specifies the registration time left with WINS, in minutes.

  `wins_servers: List[Server] GET POST PATCH`

    List of WINS