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

Retrieve the status of FPolicy servers

PDFs

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

Introduced In: 9.10

Retrieves the statuses of FPolicy servers.

  • vserver fpolicy show-engine

  • vserver fpolicy show-passthrough-read-connection

Learn more

Parameters

Name Type In Required Description

passthrough_read

boolean

query

False

Whether to view only passthrough-read connections

svm.name

string

query

False

Filter by svm.name

type

string

query

False

Filter by type

node.name

string

query

False

Filter by node.name

node.uuid

string

query

False

Filter by node.uuid

session_uuid

string

query

False

Filter by session_uuid

policy.name

string

query

False

Filter by policy.name

disconnected_reason.message

string

query

False

Filter by disconnected_reason.message

disconnected_reason.code

integer

query

False

Filter by disconnected_reason.code

update_time

string

query

False

Filter by update_time

server

string

query

False

Filter by server

state

string

query

False

Filter by state

max_records

integer

query

False

Limit the number of records returned.

svm.uuid

string

path

True

UUID of the SVM to which this object belongs.

fields

array[string]

query

False

Specify the fields to return.

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.

  • Default value: 15

  • Max value: 120

  • Min value: 0

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_connection]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "disconnected_reason": {
        "code": 9307,
        "message": "TCP Connection to FPolicy server failed."
      },
      "node": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "node1",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "policy": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "string"
      },
      "server": "10.132.145.20",
      "session_uuid": "5224ec64-b336-11eb-841c-0050568e14c2",
      "state": "connected",
      "svm": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "svm1",
        "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
      },
      "type": "primary",
      "update_time": "2019-06-12 11:00:16 -0400"
    }
  ]
}

Error

Status: Default, 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

_links

Name Type Description

next

href

self

href

_links

Name Type Description

self

href

disconnected_reason

Indicates the reason for FPolicy server disconnection.

Name Type Description

code

integer

Reason ID for the FPolicy Server disconnection.

message

string

FPolicy server reason for disconnection message.

node

Name Type Description

_links

_links

name

string

uuid

string
Name Type Description

self

href

fpolicy_policy_reference

Name Type Description

_links

self_link

name

string

The name of the FPolicy Policy name.

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.

fpolicy_connection

Displays the connection status information of the FPolicy server.

Name Type Description

_links

_links

disconnected_reason

disconnected_reason

Indicates the reason for FPolicy server disconnection.

node

node

policy

fpolicy_policy_reference

server

string

IP address of the FPolicy server.

session_uuid

string

Unique session ID associated with each connection to the FPolicy server and it can be used to identify the established connection.

state

string

Specifies the FPolicy server connection state indicating if it is in the connected or disconnected state. The following is a list of the possible states:

  • connected - Connected

  • disconnected - Disconnected

svm

svm

SVM, applies only to SVM-scoped objects.

type

string

FPolicy server type. The possible values are:

  • primary - Primary server

  • secondary - Secondary server

update_time

string

Specifies the time at which FPolicy server is connected or disconnected.

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.