ExecuteVolumeCommand
Executes predefined Encyclopedia volume control commands.
Request schema
<xsd:complexType name="ExecuteVolumeCommand">
<xsd:sequence>
<xsd:element name="VolumeName" type="xsd:string"/>
<xsd:element name="Command">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="StartPartitionPhaseOut"/>
<xsd:enumeration value="StartArchive"/>
<xsd:enumeration value="StopArchive"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
Request elements
VolumeName
The Encyclopedia volume on which to execute the commands.
Command
One or more of the following commands to execute:
StartPartitionPhaseOut
Starts the partition phase out.
StartArchive
Starts an archive pass.
StopArchive
Stops an archive pass if one is currently running. If an archive pass is not currently running, this command returns a Failed status. This command is asynchronous. This means that the call returns without waiting for the archive pass to stop. To find out the status of the archive pass after sending this command, use GetVolumeProperties.
Only a user with the Operator or Administrator role can issue this command.
Response schema
<xsd:complexType name="ExecuteVolumeCommandResponse">
<xsd:sequence>
<xsd:element name="Status">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Succeeded"/>
<xsd:enumeration value="Failed"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
Response elements
Status
The status of command execution. One of the following values:
Succeeded
The command succeeded.
Failed
The command failed.