Skip to main content
A newer release of this product is available.

Create a service policy for network interfaces

Contributors
PDFs

POST /network/ip/service-policies

Introduced In: 9.8

Creates a service policy for network interfaces.

Required properties

  • name - Name of the service policy to create.

  • ipspace.name or ipspace.uuid

    • Required for cluster-scoped service policies.

    • Optional for SVM-scoped service policies.

  • svm.name or svm.uuid

    • Required for SVM-scoped service policies.

    • Not valid for cluster-scoped service policies.

Default property values

If not specified in POST, the following default property values are assigned:

  • scope

    • svm if the svm parameter is specified

    • cluster if the svm parameter is not specified

Parameters

Name Type In Required Description

return_records

boolean

query

False

The default is false. If set to true, the records are returned.

  • Default value:

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

uuid

string
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "ipspace": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "exchange",
    "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

1966373

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

1967146

Svm.name does not exist.

1967147

Svm.uuid does not exist.

53281895

Custom service policies cannot be created on the specified svm

53281929

Service policies cannot combine block and file services.

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.

53281935

Scope is set to "svm" and svm.uuid or svm.name have not been specified.

53281936

The SVM is not in the specified IPspace.

53281937

Svm.uuid and svm.name are not valid parameters when scope is cluster.

53281938

Svm.uuid or svm.name specify a vserver that does not exist.

53281939

One or more of the svm.uuid, svm.name, ipspace.uuid, and ipspace.name have invalid values.

53281940

SVM or IPspace has not been specified.

53281941

SVM does not exist.

53281944

Ipspace.name does not exist.

53281945

Ipspace.uuid is not an IPspace.

53281946

Service policy already exists.

53281958

Service policies cannot contain multiple block-oriented services.
Name Type Description

error

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

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

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

uuid

string

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

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.