Skip to main content

PUT /encapsulationSettings

Use this method to change the global encapsulation setting during the device management process.

Authentication​

Authentication with username and password is required.

Request URL​

PUT https://{management_server_IP}/encapsulationSettings

Query parameters​

None

Request body​

AttributesRequired / OptionalTypeDescription
encapsulationEnabledRequiredBooleanIndicates 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 enables encapsulation.
{
   "encapsulationEnabled":true
}

Response codes​

CodeDescriptionComments
200OKThe request completed successfully.
400Bad RequestA query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body.
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.
500Internal Server ErrorAn internal error occurred. A descriptive error message is returned in the response body.

Response body​

None