Skip to main content
ONTAP REST API reference

Update the properties of an NFS over TLS interface

Contributors
PDFs

PATCH /protocols/nfs/tls/interfaces/{interface.uuid}

Introduced In: 9.15

Updates the properties of an NFS over TLS interface.

  • vserver nfs tls interface modify

  • vserver nfs tls interface enable

  • vserver nfs tls interface disable

Learn more

Parameters

Name Type In Required Description

interface.uuid

string

path

True

Network interface UUID.

Request Body

Name Type Description

_links

_links

certificate

certificate

Specifies the certificate that is used for creating NFS over TLS connections.

enabled

boolean

Indicates whether NFS over TLS is enabled.

interface

interface

Network interface.

svm

svm

SVM, applies only to SVM-scoped objects.
Example request 
{
  "_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"
  }
}
JSON
Copy

Response

Status: 200, Ok

Error

Status: Default

ONTAP Error Response codes

Error codes Description

2

The value provided is an invalid value for field "interface.uuid".

4

The entry doesn't exist

3277204

TLS already enabled/disabled on this LIF.

3277205

Cannot enable TLS because no certificate was provided.

3277206

The "enabled" is a required field.

3277210

The FQDN of the LIF IP address and the common name present in the certificate do not match. Update the certificate so that the common name and LIF FQDN match and retry the operation.

3277217

Failed to enable TLS on LIF on vserver because the certificate does not have LIF as subject alternate name.

92405900

Certificate not found for the SVM.

92406020

Only certificates of type 'server' are supported on the SVM.
Name Type Description

error

returned_error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}
JSON
Copy

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

self

href

certificate

Specifies the certificate that is used for creating NFS over TLS connections.

Name Type Description

_links

_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

_links

ip

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

_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

_links

certificate

certificate

Specifies the certificate that is used for creating NFS over TLS connections.

enabled

boolean

Indicates whether NFS over TLS is enabled.

interface

interface

Network interface.

svm

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.