Merge pull request #196 from laszlof/add-server-resetstate

Add Server::resetState method

Author: haphan

doc/services/compute/v2/servers.rst

@@ -218,6 +218,14 @@ This operation will replace the root password for a server.
 .. sample:: compute/v2/servers/change_server_password.php
 .. refdoc:: OpenStack/Compute/v2/Models/Server.html#method_changePassword
 
+Reset server state
+------------------
+
+This operation will reset the state of the server.
+
+.. sample:: compute/v2/servers/reset_server_state.php
+.. refdoc:: OpenStack/Compute/v2/Models/Server.html#method_resetState
+
 Reboot server
 -------------
 
@@ -302,4 +310,4 @@ Further links
 -------------
 
 * Reference docs for Server class
-* API docs
+* API docs

samples/compute/v2/servers/reset_server_state.php

@@ -0,0 +1,21 @@
+<?php
+
+require 'vendor/autoload.php';
+
+$openstack = new OpenStack\OpenStack([
+    'authUrl' => '{authUrl}',
+    'region'  => '{region}',
+    'user'    => [
+        'id'       => '{userId}',
+        'password' => '{password}'
+    ],
+    'scope'   => ['project' => ['id' => '{projectId}']]
+]);
+
+$compute = $openstack->computeV2(['region' => '{region}']);
+
+$server = $compute->getServer([
+    'id' => '{serverId}',
+]);
+
+$server->resetState();

src/Compute/v2/Api.php

@@ -279,6 +279,19 @@ public function changeServerPassword(): array
         ];
     }
 
+
+    public function resetServerState(): array
+    {
+        return [
+            'method' => 'POST',
+            'path'   => 'servers/{id}/action',
+            'params' => [
+                'id'         => $this->params->urlId('server'),
+                'resetState' => $this->params->resetState()
+            ]
+        ];
+    }
+
     public function rebootServer(): array
     {
         return [

src/Compute/v2/Models/Server.php

@@ -183,6 +183,17 @@ public function changePassword(string $newPassword)
         ]);
     }
 
+    /**
+     * Issue a resetState call to the server.
+     */
+    public function resetState()
+    {
+        $this->execute($this->api->resetServerState(), [
+            'id'         => $this->id,
+            'resetState' => ['state' => 'active']
+        ]);
+    }
+
     /**
      * Reboots the server.
      *

src/Compute/v2/Params.php

@@ -15,6 +15,19 @@ public function urlId(string $type): array
         ]);
     }
 
+    public function resetState(): array
+    {
+        return [
+            'type'       => self::OBJECT_TYPE,
+            'location'   => self::JSON,
+            'sentAs'     => 'os-resetState',
+            'required'   => true,
+            'properties' => [
+                'state' => ['type' => self::STRING_TYPE]
+            ]
+        ];
+    }
+
     public function minDisk(): array
     {
         return [