]>
git.datanom.net - omvzfs.git/blob - src/Zvol.php
2 require_once("Exception.php");
3 require_once("openmediavault/util.inc");
6 * XXX detailed description
12 class OMVModuleZFSZvol
{
32 * Array with properties assigned to the Zvol
34 * @var array $properties
43 * Constructor. If the Zvol already exists in the system the object will be updated with all
44 * associated properties from commandline.
46 * @param string $name Name of the new Zvol
50 public function __construct($name) {
52 $qname = preg_quote($name, '/');
53 $cmd = "zfs list -H -t volume";
54 $this->exec($cmd, $out, $res);
55 foreach ($out as $line) {
56 if (preg_match('/^' . $qname . '\t.*$/', $line)) {
57 $this->updateAllProperties();
58 $this->size
= $this->properties
["volsize"]["value"];
65 * Return name of the Zvol
67 * @return string $name
70 public function getName() {
75 * Get a single property value associated with the Zvol
77 * @param string $property Name of the property to fetch
78 * @return array The returned array with the property. The property is an associative array with
79 * two elements, <value> and <source>.
82 public function getProperty($property) {
83 return $this->properties
["$property"];
87 * Get an associative array of all properties associated with the Zvol
89 * @return array $properties Each entry is an associative array with two elements
90 * <value> and <source>
93 public function getProperties() {
94 return $this->properties
;
98 * Get the total size of the Zvol
100 * @return string $size
103 public function getSize() {
108 * Sets a number of Zvol properties. If a property is already set it will be updated with the new value.
110 * @param array $properties An associative array with properties to set
114 public function setProperties($properties) {
115 foreach ($properties as $newpropertyk => $newpropertyv) {
116 $cmd = "zfs set " . $newpropertyk . "=" . $newpropertyv . " " . $this->name
;
117 $this->exec($cmd,$out,$res);
118 $this->updateProperty($newpropertyk);
123 * Get all Zvol properties from commandline and update object properties attribute
128 private function updateAllProperties() {
129 $cmd = "zfs get -H all " . $this->name
;
130 $this->exec($cmd,$out,$res);
131 unset($this->properties
);
132 foreach ($out as $line) {
133 $tmpary = preg_split('/\t+/', $line);
134 $this->properties
["$tmpary[1]"] = array("value" => $tmpary[2], "source" => $tmpary[3]);
139 * Create a Zvol on commandline. Optionally provide a number of properties to set.
141 * @param string $size Size of the Zvol that should be created
142 * @param array $properties Properties to set when creatiing the dataset.
143 * @param boolean $sparse Defines if a sparse volume should be created.
147 public function create($size, array $properties = null, $sparse = null) {
148 $cmd = "zfs create -p ";
149 if (isset($sparse) && $sparse == true) {
152 $cmd .= "-V " . $size . " " . $this->name
. " 2>&1";
153 $this->exec($cmd,$out,$res);
154 $this->updateAllProperties();
155 $this->setProperties($properties);
156 $this->size
= $this->properties
["volsize"]["value"];
165 public function destroy() {
166 $cmd = "zfs destroy " . $this->name
;
167 $this->exec($cmd,$out,$res);
171 * Helper function to execute a command and throw an exception on error
172 * (requires stderr redirected to stdout for proper exception message).
174 * @param string $cmd Command to execute
175 * @param array &$out If provided will contain output in an array
176 * @param int &$res If provided will contain Exit status of the command
177 * @return string Last line of output when executing the command
178 * @throws OMVModuleZFSException
181 private function exec($cmd, &$out = null, &$res = null) {
182 $tmp = OMVUtil
::exec($cmd, $out, $res);
184 throw new OMVModuleZFSException(implode("\n", $out));
This page took 0.074013 seconds and 6 git commands to generate.