Retrieve the CIFS connection information for all SVMs
Accesses the CIFS connection details for all SVMs to examine connection configurations and troubleshoot issues related to CIFS protocols.
HTTP method and endpoint
GET /protocols/cifs/connections
Introduced in
ONTAP 9.11
Usage notes
Retrieves the CIFS connection information for all SVMs.
Related ONTAP commands
-
vserver cifs connection show
Learn more
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
client_port |
integer |
query |
False |
Filter by client_port |
node.uuid |
string |
query |
False |
Filter by node.uuid |
node.name |
string |
query |
False |
Filter by node.name |
client_ip |
string |
query |
False |
Filter by client_ip |
network_context_id |
integer |
query |
False |
Filter by network_context_id |
sessions.identifier |
integer |
query |
False |
Filter by sessions.identifier |
identifier |
integer |
query |
False |
Filter by identifier |
server_ip |
string |
query |
False |
Filter by server_ip |
svm.name |
string |
query |
False |
Filter by svm.name |
svm.uuid |
string |
query |
False |
Filter by svm.uuid |
fields |
array[string] |
query |
False |
Specify the fields to return. |
max_records |
integer |
query |
False |
Limit the number of records returned. |
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.
|
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[cifs_connection] |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"num_records": 1,
"records": [
{
"client_ip": "10.74.7.182",
"client_port": 12345,
"identifier": 22802,
"network_context_id": 22802,
"node": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "node1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"server_ip": "10.140.78.248",
"sessions": [
{
"identifier": 4622663542519103507
}
],
"svm": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
}
}
]
}
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 |
sessions
| Name | Type | Description |
|---|---|---|
identifier |
integer |
A unique 64-bit unsigned number represented as string used to represent each SMB session's identifier. |
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. |
cifs_connection
| Name | Type | Description |
|---|---|---|
client_ip |
string |
Specifies IP of the client. |
client_port |
integer |
"A unique 32-bit unsigned number used to represent the port number of the connection". |
identifier |
integer |
A unique 32-bit unsigned number used to represent each SMB session's connection ID. |
network_context_id |
integer |
A unique 32-bit unsigned number used to represent each SMB session's network context ID. |
node |
||
server_ip |
string |
Specifies the IP address of the SVM. |
sessions |
array[sessions] |
|
svm |
SVM, applies only to SVM-scoped objects. |
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. |