Retrieve NFS over TLS interface configurations
Accesses the NFS over TLS interface configurations to examine the current setup for secure NFS communication. Use this endpoint when you need to review the interface details involved in TLS-secured NFS operations.
HTTP method and endpoint
GET /protocols/nfs/tls/interfaces
Introduced in
ONTAP 9.15
Usage notes
Retrieves NFS over TLS interfaces.
Related ONTAP commands
-
vserver nfs tls interface show
Learn more
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
certificate.uuid |
string |
query |
False |
Filter by certificate.uuid |
certificate.name |
string |
query |
False |
Filter by certificate.name |
enabled |
boolean |
query |
False |
Filter by enabled |
interface.uuid |
string |
query |
False |
Filter by interface.uuid |
interface.name |
string |
query |
False |
Filter by interface.name |
interface.ip.address |
string |
query |
False |
Filter by interface.ip.address |
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_records |
boolean |
query |
False |
The default is true for GET calls. When set to false, only the number of records is 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.
|
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[nfs_tls_interface] |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"num_records": 1,
"records": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"certificate": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "string",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"interface": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"ip": {
"address": "10.10.10.7"
},
"name": "lif1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"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 |
certificate
Specifies the certificate that is used for creating NFS over TLS connections.
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
Certificate name |
uuid |
string |
Certificate UUID |
ip
IP information
| Name | Type | Description |
|---|---|---|
address |
string |
IPv4 or IPv6 address |
interface
Network interface.
| Name | Type | Description |
|---|---|---|
_links |
||
ip |
IP information |
|
name |
string |
The name of the interface. If only the name is provided, the SVM scope must be provided by the object this object is embedded in. |
uuid |
string |
The UUID that uniquely identifies the interface. |
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. |
nfs_tls_interface
| Name | Type | Description |
|---|---|---|
_links |
||
certificate |
Specifies the certificate that is used for creating NFS over TLS connections. |
|
enabled |
boolean |
Indicates whether NFS over TLS is enabled. |
interface |
Network interface. |
|
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. |