9 Maintenance Mode
9.1 Get-anynodeMaintenanceMode
Returns whether the maintenance mode is active or not
Required Permissions
-
API
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
Return Value Structure
The response body is structured as MaintenanceMode JSON object. A description for its fields is at section 25.13.1. For the JSON schema refer to section 25.13.2.
9.2 Set-anynodeMaintenanceMode
Enables or disables the maintenance mode.
Required Permissions
-
API
-
Administration
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
ModeActive
Indicates if the maintenance mode should be activated or deactivated.
Type: Boolean
Return Value Structure
The response body is structured as MaintenanceMode JSON object. A description for its fields is at section 25.13.1. For the JSON schema refer to section 25.13.2.