Update the FPolicy server status
- PDF of this doc site
Collection of separate PDF docs
Creating your file...
PATCH /protocols/fpolicy/{svm.uuid}/connections/{node.uuid}/{policy.name}/{server}
Introduced In: 9.10
Updates the status of an FPolicy server.
Related ONTAP commands
-
vserver fpolicy engine-connect
-
vserver fpolicy engine-disconnect
Request Body
Name | Type | Description |
---|---|---|
_links |
||
disconnected_reason |
Indicates the reason for FPolicy server disconnection. |
|
node |
||
policy |
||
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:
|
svm |
SVM, applies only to SVM-scoped objects. |
|
type |
string |
FPolicy server type. The possible values are:
|
update_time |
string |
Specifies the time at which FPolicy server is connected or disconnected. |
Example request
{
"_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 15:00:16 +0000"
}
Response
Status: 200, Ok
Error
Status: Default
ONTAP Error Response Codes
Error Code | Description |
---|---|
9764954 |
The specified policy does not exist |
9764911 |
Failed to connect to the FPolicy server. Reason: The specified entry does not exist |
9764912 |
Failed to disconnect the FPolicy server. Reason: The specified entry does not exist |
9764948 |
The specified policy is disabled. Using a disabled policy with this API is not supported. Use the 'PATCH /protocols/fpolicy/{svm.uuid}/policies/{name}' API to enable the policy |
9764963 |
The specified server is already connected |
9764964 |
The specified server is already disconnected |
Name | Type | Description |
---|---|---|
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 |
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 |
||
name |
string |
|
uuid |
string |
self_link
Name | Type | Description |
---|---|---|
self |
fpolicy_policy_reference
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
The name of the FPolicy Policy name. |
svm
SVM, applies only to SVM-scoped objects.
Name | Type | Description |
---|---|---|
_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 |
||
disconnected_reason |
Indicates the reason for FPolicy server disconnection. |
|
node |
||
policy |
||
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:
|
svm |
SVM, applies only to SVM-scoped objects. |
|
type |
string |
FPolicy server type. The possible values are:
|
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. |