Retrieve the FPolicy engine configuration for all engines of an SVM

09/11/2024 Contributors

GET /protocols/fpolicy/{svm.uuid}/engines

Introduced In: 9.6

Retrieves FPolicy engine configurations of all the engines for a specified SVM. ONTAP allows creation of cluster-level FPolicy engines that act as a template for all the SVMs belonging to the cluster. These cluster-level FPolicy engines are also retrieved for the specified SVM.

fpolicy policy external-engine show

Learn more

DOC /protocols/fpolicy/{svm.uuid}/engines

Parameters

Name	Type	In	Required	Description
max_server_requests	integer	query	False	Filter by max_server_requests Max value: 10000 Min value: 1 Introduced in: 9.11
keep_alive_interval	string	query	False	Filter by keep_alive_interval Introduced in: 9.13
buffer_size.send_buffer	integer	query	False	Filter by buffer_size.send_buffer Max value: 7895160 Min value: 0 Introduced in: 9.11
buffer_size.recv_buffer	integer	query	False	Filter by buffer_size.recv_buffer Max value: 7895160 Min value: 0 Introduced in: 9.11
primary_servers	string	query	False	Filter by primary_servers
request_abort_timeout	string	query	False	Filter by request_abort_timeout Introduced in: 9.11
request_cancel_timeout	string	query	False	Filter by request_cancel_timeout Introduced in: 9.11
certificate.serial_number	string	query	False	Filter by certificate.serial_number Introduced in: 9.11
certificate.name	string	query	False	Filter by certificate.name Introduced in: 9.11
certificate.ca	string	query	False	Filter by certificate.ca Introduced in: 9.11
server_progress_timeout	string	query	False	Filter by server_progress_timeout Introduced in: 9.11
type	string	query	False	Filter by type
format	string	query	False	Filter by format Introduced in: 9.11
port	integer	query	False	Filter by port
ssl_option	string	query	False	Filter by ssl_option Introduced in: 9.11
resiliency.directory_path	string	query	False	Filter by resiliency.directory_path Introduced in: 9.11
resiliency.retention_duration	string	query	False	Filter by resiliency.retention_duration Introduced in: 9.11
resiliency.enabled	boolean	query	False	Filter by resiliency.enabled Introduced in: 9.11
secondary_servers	string	query	False	Filter by secondary_servers
status_request_interval	string	query	False	Filter by status_request_interval Introduced in: 9.11
name	string	query	False	Filter by name
svm.uuid	string	path	True	UUID of the SVM to which this object belongs.
fields	array[string]	query	False	Specify the fields to return.
max_records	integer	query	False	Limit the number of records returned.
return_records	boolean	query	False	The default is true for GET calls. When set to false, only the number of records is returned. Default value: 1
return_timeout	integer	query	False	The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached. Max value: 120 Min value: 0 Default value: 1
order_by	array[string]	query	False	Order results by specified fields and optional [asc

Name

Type

Required

Description

max_server_requests

integer

query

False

Filter by max_server_requests

Max value: 10000
Min value: 1
Introduced in: 9.11

keep_alive_interval

string

query

False

Filter by keep_alive_interval

Introduced in: 9.13

buffer_size.send_buffer

integer

query

False

Filter by buffer_size.send_buffer

Max value: 7895160
Min value: 0
Introduced in: 9.11

buffer_size.recv_buffer

integer

query

False

Filter by buffer_size.recv_buffer

Max value: 7895160
Min value: 0
Introduced in: 9.11

primary_servers

string

query

False

Filter by primary_servers

request_abort_timeout

string

query

False

Filter by request_abort_timeout

Introduced in: 9.11

request_cancel_timeout

string

query

False

Filter by request_cancel_timeout

Introduced in: 9.11

certificate.serial_number

string

query

False

Filter by certificate.serial_number

Introduced in: 9.11

certificate.name

string

query

False

Filter by certificate.name

Introduced in: 9.11

certificate.ca

string

query

False

Filter by certificate.ca

Introduced in: 9.11

server_progress_timeout

string

query

False

Filter by server_progress_timeout

Introduced in: 9.11

type

string

query

False

Filter by type

format

string

query

False

Filter by format

Introduced in: 9.11

port

integer

query

False

Filter by port

ssl_option

string

query

False

Filter by ssl_option

Introduced in: 9.11

resiliency.directory_path

string

query

False

Filter by resiliency.directory_path

Introduced in: 9.11

resiliency.retention_duration

string

query

False

Filter by resiliency.retention_duration

Introduced in: 9.11

resiliency.enabled

boolean

query

False

Filter by resiliency.enabled

Introduced in: 9.11

secondary_servers

string

query

False

Filter by secondary_servers

status_request_interval

string

query

False

Filter by status_request_interval

Introduced in: 9.11

name

string

query

False

Filter by name

svm.uuid

string

path

True

UUID of the SVM to which this object belongs.

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

Default value: 1

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

Max value: 120
Min value: 0
Default value: 1

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok

Name	Type	Description
_links	_links
num_records	integer	Number of records
records	array[fpolicy_engine]

Name

Type

Description

_links

num_records

integer

Number of records

records

array[fpolicy_engine]

Example response

{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "certificate": {
        "ca": "TASample1",
        "name": "Sample1-FPolicy-Client",
        "serial_number": "8DDE112A114D1FBC"
      },
      "format": "string",
      "keep_alive_interval": "PT2M",
      "max_server_requests": 500,
      "name": "fp_ex_eng",
      "port": 9876,
      "primary_servers": [
        "10.132.145.20",
        "10.140.101.109"
      ],
      "request_abort_timeout": "PT40S",
      "request_cancel_timeout": "PT20S",
      "resiliency": {
        "directory_path": "/dir1",
        "retention_duration": "PT3M"
      },
      "secondary_servers": [
        "10.132.145.20",
        "10.132.145.21"
      ],
      "server_progress_timeout": "PT1M",
      "ssl_option": "string",
      "status_request_interval": "PT10S",
      "svm": {
        "uuid": "string"
      },
      "type": "string"
    }
  ]
}

Error

Status: Default,

Name	Type	Description
error	returned_error

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

Name

Type

Description

href

string

_links

Name	Type	Description
next	href
self	href

Name

Type

Description

href

self

href

buffer_size

Specifies the send and receive buffer size of the connected socket for the FPolicy server.

Name	Type	Description
recv_buffer	integer	Specifies the receive buffer size of the connected socket for the FPolicy server. Default value is 256KB.
send_buffer	integer	Specifies the send buffer size of the connected socket for the FPolicy server. Default value 1MB.

Name

Type

Description

recv_buffer

integer

Specifies the receive buffer size of the connected socket for the FPolicy server. Default value is 256KB.

send_buffer

integer

Specifies the send buffer size of the connected socket for the FPolicy server. Default value 1MB.

certificate

Provides details about certificate used to authenticate the FPolicy server.

Name	Type	Description
ca	string	Specifies the certificate authority (CA) name of the certificate used for authentication if SSL authentication between the SVM and the FPolicy server is configured.
name	string	Specifies the certificate name as a fully qualified domain name (FQDN) or custom common name. The certificate is used if SSL authentication between the SVM and the FPolicy server is configured.
serial_number	string	Specifies the serial number of the certificate used for authentication if SSL authentication between the SVM and the FPolicy server is configured.

Name

Type

Description

string

Specifies the certificate authority (CA) name of the certificate used for authentication if SSL authentication between the SVM and the FPolicy server is configured.

name

string

Specifies the certificate name as a fully qualified domain name (FQDN) or custom common name. The certificate is used if SSL authentication between the SVM and the FPolicy server is configured.

serial_number

string

Specifies the serial number of the certificate used for authentication if SSL authentication between the SVM and the FPolicy server is configured.

resiliency

If all primary and secondary servers are down, or if no response is received from the FPolicy servers, file access events are stored inside the storage controller under the specified resiliency-directory-path.

Name	Type	Description
directory_path	string	Specifies the directory path under the SVM namespace, where notifications are stored in the files whenever a network outage happens.
enabled	boolean	Specifies whether the resiliency feature is enabled or not. Default is false.
retention_duration	string	Specifies the ISO-8601 duration, for which the notifications are written to files inside the storage controller during a network outage. The value for this field must be between 0 and 600 seconds. Default is 180 seconds.

Name

Type

Description

directory_path

string

Specifies the directory path under the SVM namespace, where notifications are stored in the files whenever a network outage happens.

enabled

boolean

Specifies whether the resiliency feature is enabled or not. Default is false.

retention_duration

string

Specifies the ISO-8601 duration, for which the notifications are written to files inside the storage controller during a network outage. The value for this field must be between 0 and 600 seconds. Default is 180 seconds.

svm

Name	Type	Description
uuid	string	SVM UUID

Name

Type

Description

uuid

string

SVM UUID

fpolicy_engine

Defines how ONTAP makes and manages connections to external FPolicy servers.

Name	Type	Description
buffer_size	buffer_size	Specifies the send and receive buffer size of the connected socket for the FPolicy server.
certificate	certificate	Provides details about certificate used to authenticate the FPolicy server.
format	string	The format for the notification messages sent to the FPolicy servers. The possible values are: xml - Notifications sent to the FPolicy server will be formatted using the XML schema. protobuf - Notifications sent to the FPolicy server will be formatted using Protobuf schema, which is a binary form.
keep_alive_interval	string	Specifies the ISO-8601 interval time for a storage appliance to send Keep Alive message to an FPolicy server. The allowed range is between 10 to 600 seconds.
max_server_requests	integer	Specifies the maximum number of outstanding requests for the FPolicy server. It is used to specify maximum outstanding requests that will be queued up for the FPolicy server. The value for this field must be between 1 and 10000. The default values are 500, 1000 or 2000 for Low-end(<64 GB memory), Mid-end(>=64 GB memory) and High-end(>=128 GB memory) Platforms respectively.
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]
request_abort_timeout	string	Specifies the ISO-8601 timeout duration for a screen request to be aborted by a storage appliance. The allowed range is between 0 to 200 seconds.
request_cancel_timeout	string	Specifies the ISO-8601 timeout duration for a screen request to be processed by an FPolicy server. The allowed range is between 0 to 100 seconds.
resiliency	resiliency	If all primary and secondary servers are down, or if no response is received from the FPolicy servers, file access events are stored inside the storage controller under the specified resiliency-directory-path.
secondary_servers	array[string]
server_progress_timeout	string	Specifies the ISO-8601 timeout duration in which a throttled FPolicy server must complete at least one screen request. If no request is processed within the timeout, connection to the FPolicy server is terminated. The allowed range is between 0 to 100 seconds.
ssl_option	string	Specifies the SSL option for external communication with the FPolicy server. Possible values include the following: no_auth When set to "no_auth", no authentication takes place. server_auth When set to "server_auth", only the FPolicy server is authenticated by the SVM. With this option, before creating the FPolicy external engine, the administrator must install the public certificate of the certificate authority (CA) that signed the FPolicy server certificate. mutual_auth When set to "mutual_auth", mutual authentication takes place between the SVM and the FPolicy server. This means authentication of the FPolicy server by the SVM along with authentication of the SVM by the FPolicy server. With this option, before creating the FPolicy external engine, the administrator must install the public certificate of the certificate authority (CA) that signed the FPolicy server certificate along with the public certificate and key file for authentication of the SVM.
status_request_interval	string	Specifies the ISO-8601 interval time for a storage appliance to query a status request from an FPolicy server. The allowed range is between 0 to 50 seconds.
svm	svm
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 x-nullable: true

Name

Type

Description

buffer_size

Specifies the send and receive buffer size of the connected socket for the FPolicy server.

certificate

Provides details about certificate used to authenticate the FPolicy server.

format

string

The format for the notification messages sent to the FPolicy servers. The possible values are:

xml - Notifications sent to the FPolicy server will be formatted using the XML schema.
protobuf - Notifications sent to the FPolicy server will be formatted using Protobuf schema, which is a binary form.

keep_alive_interval

string

Specifies the ISO-8601 interval time for a storage appliance to send Keep Alive message to an FPolicy server. The allowed range is between 10 to 600 seconds.

max_server_requests

integer

Specifies the maximum number of outstanding requests for the FPolicy server. It is used to specify maximum outstanding requests that will be queued up for the FPolicy server. The value for this field must be between 1 and 10000. The default values are 500, 1000 or 2000 for Low-end(<64 GB memory), Mid-end(>=64 GB memory) and High-end(>=128 GB memory) Platforms respectively.

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]

request_abort_timeout

string

Specifies the ISO-8601 timeout duration for a screen request to be aborted by a storage appliance. The allowed range is between 0 to 200 seconds.

request_cancel_timeout

string

Specifies the ISO-8601 timeout duration for a screen request to be processed by an FPolicy server. The allowed range is between 0 to 100 seconds.

resiliency

secondary_servers

array[string]

server_progress_timeout

string

Specifies the ISO-8601 timeout duration in which a throttled FPolicy server must complete at least one screen request. If no request is processed within the timeout, connection to the FPolicy server is terminated. The allowed range is between 0 to 100 seconds.

ssl_option

string

Specifies the SSL option for external communication with the FPolicy server. Possible values include the following:

no_auth When set to "no_auth", no authentication takes place.
server_auth When set to "server_auth", only the FPolicy server is authenticated by the SVM. With this option, before creating the FPolicy external engine, the administrator must install the public certificate of the certificate authority (CA) that signed the FPolicy server certificate.
mutual_auth When set to "mutual_auth", mutual authentication takes place between the SVM and the FPolicy server. This means authentication of the FPolicy server by the SVM along with authentication of the SVM by the FPolicy server. With this option, before creating the FPolicy external engine, the administrator must install the public certificate of the certificate authority (CA) that signed the FPolicy server certificate along with the public certificate and key file for authentication of the SVM.

status_request_interval

string

Specifies the ISO-8601 interval time for a storage appliance to query a status request from an FPolicy server. The allowed range is between 0 to 50 seconds.

svm

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
- x-nullable: true

error_arguments

Name	Type	Description
code	string	Argument code
message	string	Message argument

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.

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.

Retrieve the FPolicy engine configuration for all engines of an SVM

Creating your file...

Related ONTAP commands

Learn more

Parameters

Response

Error

Definitions