Skip to main content

GET /encapsulationSettings

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

Authentication​

Authentication with username and password is required.

Request URL​

GET https://{management_server_IP}/encapsulationSettings

Query parameters​

None

Request body​

None

Response codes​

CodeDescriptionComments
200OKThe request completed successfully.
403ForbiddenThe 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.
404Not foundA specified resource cannot be found. A descriptive error message is returned in the response body.
500Internal Server ErrorAn internal error occurred. A descriptive error message is returned in the response body.

Response body​

AttributesTypeDescription
encapsulationEnabledBooleanIndicates 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
}