Skip to main content

/encapsulationSettings

Use this REST API to retrieve information about or modify Lenovo XClarity Administrator's global encapsulation setting.

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.

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.

Attention
If encapsulation is enabled and XClarity Administrator becomes unavailable before a device is unmanaged, necessary steps must be taken to disable encapsulation to establish communication with the device. For recovery procedures, see lenovoMgrAlert.mib file and Recovering management with a CMM after a management server failure.

HTTP methods​

GET, PUT

  • GET /encapsulationSettings
    Use this method to return information about the global encapsulation setting that is used during device management.
  • PUT /encapsulationSettings
    Use this method to change the global encapsulation setting during the device management process.