Enter Maintenance

Enter Maintenance

When in maintenance mode, users cannot access the machines. Each response entity in the result corresponds to a machine id in the input. All the listed privileges are required -

Privileges	Description
MACHINE_MAINTENANCE	Caller should have permission to this privilege, on the associated access group of machine's desktop pool to perform maintenance operation.
FORENSICS	Caller should have permission to this privilege to enforce operations on held machines.

Request

URI

POST

https://{api_host}//localhost/rest/inventory/v1/machines/action/enter-maintenance

COPY

Query Parameters

string

enforce

Optional

Only Forensics admin can set this value. If passed as "true", then this action is applicable for both held and non held vms. If passed as "false", then this action is applicable for only non held vms. If not passed at all, then this action is applicable for only non held vms.

Request Body

List of Machine Ids representing the machines to be put into maintenance mode.

Array of string of type(s) application/json

Optional

[
    {}
]

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

OK

[
    {
        "error_messages": [
            "Entity does not exist.",
            "Property is mandatory."
        ],
        "errors": [
            {
                "error_key": "inventory.machine.not.found",
                "error_message": "username cannot be empty"
            }
        ],
        "id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
        "key": "user1",
        "status_code": 200,
        "timestamp": 1561939200000
    }
]

400

Bad Request

Operation doesn't return any data structure

401

User is not authenticated

Operation doesn't return any data structure

403

Access to the resource is forbidden

Operation doesn't return any data structure

On This Page

Request

Query Parameters

200 Response Body

Errors

Inventory Operations

Add Custom Icon

Add Local Application Pools To GAE

Add Local Desktop Pools To GDE

Add Machines By Name

Add Rds Servers

Archive Machines

Assign Machine Aliases

Cancel Desktop Pool Task

Cancel Scheduled Maintenance

Cancel Scheduled Push Image

Check Application Pool Name Availability

Check Desktop Pool Name Availability

Check Farm Name Availability

Check Machine Prefix Availability

Check RDS Server Prefix Availability

Create Application Icon

Create Application Pool

Create Application Pool V2

Create Desktop Pool

Create Desktop Pool V2

Create Global Application Entitlement

Create Global Desktop Entitlement

Create Global Desktop Entitlement V2

Delete Application Pool

Delete Desktop Pool

Delete Global Application Entitlement

Delete Global Desktop Entitlement

Delete Machines

Delete Physical Machine

Delete RDS Server

Desktop Pool Apply Image

Desktop Pool Promote Pending Image

Disconnect Global Sessions

Disconnect Sessions

Enter Maintenance

Exit Maintenance

Farm Apply Image

Farm Promote Pending Image

Get Application Icon

Get Application Pool

Get Application Pool V2

Get Application Pool V3

Get Desktop Pool

Get Desktop Pool Task

Get Desktop Pool V2

Get Desktop Pool V3

Get Desktop Pool V4

Get Desktop Pool V5

Get Desktop Pool V6

Get Global Application Entitlement

Get Global Application Entitlement V2

Get Global Desktop Entitlement

Get Global Desktop Entitlement V2

Get Physical Machine

Get Physical Machine V2

Get Session Info

List Application Icons

List Application Pools

List Application Pools V2

List Application Pools V3

List Compatible Backup GA Es

List Compatible Backup GD Es

List Compatible Local Application Pools

List Compatible Local Desktop Pools

List Desktop Pools

List Desktop Pools V2

List Desktop Pools V3

List Desktop Pools V4

List Desktop Pools V5

List Desktop Pools V6

List Desktop Pool Tasks

List Global Application Entitlements

List Global Application Entitlements V2

List Global Desktop Entitlements

List Global Desktop Entitlements V2

List Installed Applications On Desktop Pool

List Installed Applications On Farm

List Local Application Pools

List Local Desktop Pools

List Machines V2

List Machines V3

List Physical Machines

List Physical Machines V2

List RDS Servers

List Session Info

Log Off Global Sessions

Log Off Sessions

Pause Desktop Pool Task

Query Global Sessions

Rebuild Machines

Recover Machines

Recover RDS Servers

Register Physical Machine

Register RDS Server

Remove Custom Icon

Remove Local Application Pools From GAE

Remove Local Desktop Pools From GDE

Remove Machines

Remove Rds Servers

Reset Global Sessions

Restart Global Sessions

Restart Machines

Restart Sessions

Resume Desktop Pool Task

Schedule Maintenance

Schedule Maintenance V2

Schedule Push Image

Schedule Push Image V2

Send Message To Global Sessions

Send Message To Sessions

Unassign Machine Aliases

Update Application Pool

Update Application Pool V2

Update Desktop Pool

Update Global Application Entitlement

Update Global Desktop Entitlement

Update RDS Server

Validate Installed Applications On Desktop Pool

Validate Installed Applications On Farm

Validate Specified Names