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

Retrieve status of an FPolicy server

Contributors
PDFs

GET /protocols/fpolicy/{svm.uuid}/connections/{node.uuid}/{policy.name}/{server}

Introduced In: 9.10

Retrieves the status of an FPolicy server.

  • vserver fpolicy show-engine

Learn more

Response

Status: 200, Ok
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

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.
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "disconnected_reason": {
    "code": 9370,
    "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-12T11:00:16-04:00"
}

Error

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

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

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

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.