GET /encapsulationSettings

Use this method to return information about the global encapsulation setting that is used during device management.

Authentication

Authentication with user name and password is required.

Request URL

GET https://{management_server_IP}/encapsulationSettings

Query parameters

None

Request body

None

Response codes

Code Description Comments
200 OK The request completed successfully.
403 Forbidden The orchestrator server was prevented from fulfilling the request. A descriptive error message is returned in the response body. Ensure that you have privileges to perform the request.
404 Not found A specified resource cannot be found. A descriptive error message is returned in the response body.
500 Internal Server Error An internal error occurred. A descriptive error message is returned in the response body.

Response body

Attributes Type Description
encapsulationEnabled Boolean Indicates whether encapsulation is enabled during device management. This can be one of the following values.
  • true. Encapsulation is enabled.

    When the global encapsulation setting is enabled and the device supports encapsulation, XClarity Administrator communicates with the device during the management process to change the device encapsulation mode to encapsulationLite and to change the firewall rules on the device to limit incoming requests to those only from XClarity Administrator.

    Important: For additional considerations, see /encapsulationSettings.
  • false. Encapsulation is disabled.

    The global encapsulation setting is disabled by default. When disabled, the device encapsulation mode is set to normal and the firewall rules are not changed as part of the management process.

The following example is returned if the request is successful.
{
   "encapsulationEnabled": true
}