Skip to main content

Update a service policy for network interfaces

Contributors
PDFs

PATCH /network/ip/service-policies/{uuid}

Introduced In: 9.8

Updates a service policy for network interfaces.

  • network interface service-policy add-service

  • network interface service-policy modify-service

  • network interface service-policy remove-service

  • network interface service-policy rename

Parameters

Name Type In Required Description

uuid

string

path

True

UUID of the service policy

Request Body

Name Type Description

_links

_links

ipspace

ipspace

is_built_in

boolean

name

string

scope

string

Set to "svm" for interfaces owned by an SVM. Otherwise, set to "cluster".

services

array[string]

svm

svm

SVM, applies only to SVM-scoped objects.

uuid

string
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "ipspace": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "Default",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "name": "default-intercluster",
  "scope": "string",
  "services": [
    "data_nfs"
  ],
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
}

Response

Status: 200, Ok

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

1376669

Port must reside in the same IPspace as the interface's SVM.

2621740

An unexpected error when trying to determine whether the target Vserver was locked or not on this cluster.

53281911

Modifying the service policy is disallowed because policies on this SVM are managed by the system

53281929

Service policies cannot combine block and file services.

53281930

Service policies maintained by the system cannot be renamed.

53281931

Service policy names cannot start with "default-".

53281932

Service cannot be added because the service does not exist for the specified SVM or IPspace.

53281933

A Cluster-scoped service cannot be added to a SVM-scoped service policy.

53281934

An SVM-scoped service cannot be added to a Cluster-scoped service policy.

53281952

The service policy on an SVM cannot be updated to include a block service. Use built-in service policies for SAN services.

53281953

The service policy on an SVM cannot be updated to include a new service.

53281961

Service cannot be removed from the service policy because it is used by one or more interfaces.

53281963

Service cannot be removed from the service policy because it is used by one or more interfaces.

Also see the table of common errors in the Response body overview section of this documentation.

Name Type Description

error

returned_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

href

ipspace

Name Type Description

_links

_links

name

string

IPspace name

uuid

string

IPspace UUID

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.

ip_service_policy

Name Type Description

_links

_links

ipspace

ipspace

is_built_in

boolean

name

string

scope

string

Set to "svm" for interfaces owned by an SVM. Otherwise, set to "cluster".

services

array[string]

svm

svm

SVM, applies only to SVM-scoped objects.

uuid

string

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.