shutdown_gateway ( $opt )

This operation shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the gateway in the body of your request.

The operation shuts down the gateway service component running in the storage gateway’s virtual machine (VM) and not the VM.

If you want to shut down the VM, it is recommended that you first shut down the gateway component in the VM to avoid unpredictable conditions.

After the gateway is shutdown, you cannot call any other API except StartGateway, DescribeGatewayInformation, and ListGateways. For more information, see ActivateGateway. Your applications cannot read from or write to the gateway’s storage volumes, and there are no snapshots taken.

When you make a shutdown request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to shut down. You can call the DescribeGatewayInformation API to check the status. For more information, see ActivateGateway.

If do not intend to use the gateway again, you must delete the gateway (using DeleteGateway) to no longer pay software charges associated with the gateway.

Access

public

Parameters

Parameter

Type

Required

Description

$opt

array

Optional

An associative array of parameters that can have the following keys:

  • GatewayARN - string - Required - The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
  • curlopts - array - Optional - A set of values to pass directly into curl_setopt(), where the key is a pre-defined CURLOPT_* constant.
  • returnCurlHandle - boolean - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This toggle is useful for manually managed batch requests.

Returns

Type

Description

CFResponse

A CFResponse object containing a parsed HTTP response.

Examples

Shutdown and start a gateway.

$sg = new AmazonStorageGateway();

// Shutdown the gateway
$response = $sg->shutdown_gateway(array('GatewayARN' => $gateway_arn));

sleep(10);

// Wait until shutdown
do
{
	sleep(10); echo '.';
	$response = $sg->describe_gateway_information(array('GatewayARN' => $gateway_arn));
	$status = (string) $response->body->GatewayState;
} while ($status !== 'SHUTDOWN');

// Start the gateway
$response = $sg->start_gateway(array('GatewayARN' => $gateway_arn));

// Wait until running
do
{
	sleep(10); echo '.';
	$response = $sg->describe_gateway_information(array('GatewayARN' => $gateway_arn));
	$status = (string) $response->body->GatewayState;
} while ($status !== 'RUNNING');

Source

Method defined in services/storagegateway.class.php | Toggle source view (6 lines) | View on GitHub

public function shutdown_gateway($opt = null)
{
    if (!$opt) $opt = array();
    
    return $this->authenticate('ShutdownGateway', $opt);
}

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback