Integration Guides › Web Service API Reference Guide › Valid Web API Objects › srv Object › shutdown Method (srv Object)

shutdown Method (srv Object)

Description

Shut a server down

Syntax

/api/v1/srv/shutdown?srv=srv&vdc=controller-name

/api/v1/srv/shutdown?&all&vdc=controller-name

Arguments

srv

Name of the server to be shutdown.

vdc

Name of the target virtual data center

Options

&all

Shut all servers down. Exclusive of the srv argument.

reason

Reason why the server is being shut down.

Transaction Type

asynchronous

Request Type

GET

Examples

Shut server srv1 down.

GET http://aux/api/v1/srv/shutdown?srv=srv1&reason=maintenance&vdc=mygrid

Shut all servers down on mygrid.

GET http://192.168.123.200/api/v1/srv/shutdown?&all&vdc=mygrid 

Sample Output

XML:

<opt></opt>

JSON:

{} 

HTTP Error Codes

404

Entity vdc mygrid not found - A VDC name was specified that is not configured in the WS_API application.