Retrieve an NFS over TLS interface configuration
Accesses the configuration details of an NFS over TLS interface to review the current settings for secure NFS communication.
HTTP method and endpoint
GET /protocols/nfs/tls/interfaces/{interface.uuid}
Introduced in
ONTAP 9.15
Usage notes
Retrieves an NFS over TLS interface.
Related ONTAP commands
-
vserver nfs tls interface show
Learn more
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
interface.uuid |
string |
path |
True |
Network interface UUID. |
fields |
array[string] |
query |
False |
Specify the fields to return. |
Response
Status: 200, Ok
| 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. |
Example response
{
"_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
ONTAP Error Response codes
| Error codes | Description |
|---|---|
262197 |
The value provided is invalid for field "fields". |
| 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 |
|---|---|---|
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. |
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. |