Retrieve NetBIOS information
Retrieves NetBIOS information to access details about NetBIOS configurations and status in your environment. This is useful for managing and troubleshooting CIFS services on your storage systems.
HTTP method and endpoint
GET /protocols/cifs/netbios
Introduced in
ONTAP 9.11
Related ONTAP commands
-
vserver cifs nbtstat
Learn more
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
wins_servers.state |
string |
query |
False |
Filter by wins_servers.state |
wins_servers.ip |
string |
query |
False |
Filter by wins_servers.ip |
time_left |
integer |
query |
False |
Filter by time_left |
suffix |
string |
query |
False |
Filter by suffix |
node.name |
string |
query |
False |
Filter by node.name |
node.uuid |
string |
query |
False |
Filter by node.uuid |
interfaces |
string |
query |
False |
Filter by interfaces |
svm.uuid |
string |
query |
False |
Filter by svm.uuid |
svm.name |
string |
query |
False |
Filter by svm.name |
state |
string |
query |
False |
Filter by state |
name |
string |
query |
False |
Filter by name |
scope |
string |
query |
False |
Filter by scope |
mode |
string |
query |
False |
Filter by mode |
name_registration_type |
string |
query |
False |
Filter by name_registration_type |
return_timeout |
integer |
query |
False |
The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.
|
fields |
array[string] |
query |
False |
Specify the fields to return. |
max_records |
integer |
query |
False |
Limit the number of records returned. |
return_records |
boolean |
query |
False |
The default is true for GET calls. When set to false, only the number of records is returned.
|
order_by |
array[string] |
query |
False |
Order results by specified fields and optional [asc |
Response
Status: 200, Ok
| Name | Type | Description |
|---|---|---|
_links |
||
num_records |
integer |
Number of Records. |
records |
array[netbios] |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"num_records": 1,
"records": [
{
"interfaces": [
[
"10.10.10.35"
]
],
"mode": "string",
"name": "CLUSTER_1",
"name_registration_type": "string",
"node": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "node1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"scope": "string",
"state": "string",
"suffix": "string",
"svm": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
},
"time_left": 0,
"wins_servers": [
{
"ip": "10.224.65.20",
"state": "string"
}
]
}
]
}
Error
Status: Default, Error
| Name | Type | Description |
|---|---|---|
error |
Example error
{
"error": {
"arguments": [
{
"code": "string",
"message": "string"
}
],
"code": "4",
"message": "entry doesn't exist",
"target": "uuid"
}
}
Definitions
See Definitions
href
| Name | Type | Description |
|---|---|---|
href |
string |
_links
| Name | Type | Description |
|---|---|---|
next |
||
self |
_links
| Name | Type | Description |
|---|---|---|
self |
node
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
|
uuid |
string |
svm
SVM, applies only to SVM-scoped objects.
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
The name of the SVM. This field cannot be specified in a PATCH method. |
uuid |
string |
The unique identifier of the SVM. This field cannot be specified in a PATCH method. |
server
| Name | Type | Description |
|---|---|---|
ip |
string |
Windows Internet Name Server (WINS) address which manages and maps the NetBIOS name of the CIFS server to their network IP addresses. The IP addresses are IPv4 addresses. |
state |
string |
Specifies the state of the WINS server. |
netbios
| Name | Type | Description |
|---|---|---|
interfaces |
array[string] |
|
mode |
string |
Specifies the mode in which the NetBIOS name service is configured. The supported values are:
|
name |
string |
Specifies the NetBIOS name. |
name_registration_type |
string |
Specifies the name registration type. |
node |
||
scope |
string |
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 |
string |
Specifies the registration state of the NetBIOS Name. |
suffix |
string |
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, applies only to SVM-scoped objects. |
|
time_left |
integer |
Specifies the registration time left with WINS, in minutes. |
wins_servers |
array[server] |
List of WINS |
error_arguments
| Name | Type | Description |
|---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
returned_error
| Name | Type | Description |
|---|---|---|
arguments |
array[error_arguments] |
Message arguments |
code |
string |
Error code |
message |
string |
Error message |
target |
string |
The target parameter that caused the error. |