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

Update a specific FPolicy engine configuration for an SVM

Contributors
PDFs

PATCH /protocols/fpolicy/{svm.uuid}/engines/{name}

Introduced In: 9.6

Updates a specific FPolicy engine configuration of an SVM. Modification of an FPolicy engine that is attached to one or more enabled FPolicy policies is not allowed.

  • fpolicy policy external-engine modify

Learn more

Parameters

Name Type In Required Description

name

string

path

True

svm.uuid

string

path

True

UUID of the SVM to which this object belongs.

Request Body

Name Type Description

name

string

Specifies the name to assign to the external server configuration.

port

integer

Port number of the FPolicy server application.

primary_servers

array[string]

secondary_servers

array[string]

type

string

The notification mode determines what ONTAP does after sending notifications to FPolicy servers. The possible values are:

  • synchronous - After sending a notification, wait for a response from the FPolicy server.

  • asynchronous - After sending a notification, file request processing continues.

    • Default value: 1

    • enum: ["synchronous", "asynchronous"]

    • Introduced in: 9.6
Example request 
{
  "name": "fp_ex_eng",
  "port": "9876",
  "primary_servers": [
    "10.132.145.20",
    "10.140.101.109"
  ],
  "secondary_servers": [
    "10.132.145.20",
    "10.132.145.21"
  ],
  "type": "string"
}

Response

Status: 200, Ok

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

9764922

The primary and secondary server has a redundant IP address

9764942

At least one FPolicy policy is using the FPolicy engine

9764886

FPolicy engine is a cluster-level FPolicy engine
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

fpolicy_engine

The engine defines how ONTAP makes and manages connections to external FPolicy servers.

Name Type Description

name

string

Specifies the name to assign to the external server configuration.

port

integer

Port number of the FPolicy server application.

primary_servers

array[string]

secondary_servers

array[string]

type

string

The notification mode determines what ONTAP does after sending notifications to FPolicy servers. The possible values are:

  • synchronous - After sending a notification, wait for a response from the FPolicy server.

  • asynchronous - After sending a notification, file request processing continues.

    • Default value: 1

    • enum: ["synchronous", "asynchronous"]

    • Introduced in: 9.6

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.