Halt Zone operation

The Halt Zone operation removes the application environment and the virtual platform for the specified Zone. This operation also changes the state of the Zone from the running state to the installed state.

The following table describes the elements for the adapter request:

Adapter request elements for the Halt Zone operation

Element	Definition	Required
<operation-type>	Defines the type of operation: Basic_Zone	Yes
<operation-name>	Defines the name of operation: Halt_Zone	Yes
<zone-name>	Specifies the name of the Zone that you want to halt	Yes
<host>	Specifies the host name of the Solaris computer hosting Solaris Zones	No
<port>	Specifies the port on which the SSH service is running on the host computer Default value: 22	No
<operation-timeout-secs>	Specifies the time, in seconds, to wait for the operation to complete on the target server If the operation is not successful within this interval, the adapter returns an error message. Default value: 300 seconds	No
<user-name>	Specifies the user name for the Solaris computer If no user name is specified, the request is executed with the user name specified in the adapter configuration.	No
<password>	Specifies the password corresponding to the user name	Conditional Required if you specify the <user-name> element

The following figure shows the sample adapter request for the Halt Zone operation:

Sample adapter request for the Halt Zone operation

<solaris-zones-request>
   <target>
         <host>vm-sol-abc<host>
         <user-name>admin<user-name>
         <password>adminpass</password>
         <port>8888</port>
   </target>
   <operation-type>Basic_Zone</operation-type>
   <operation-name>Halt_Zone</operation-name>
   <operation-timeout-secs>100</operation-timeout-secs>
   <zone-name>testzone</zone-name>
</solaris-zones-request>

Note

You need to specify the elements in the <target> block of the adapter request only if you want to override the elements specified in the adapter configuration.

The following figure shows the response for the sample adapter request:

Sample adapter response for the Halt Zone operation

<solaris-zones-response>
<metadata>
   <status>success</status>
</metadata>
<target-output host="vm-sol-abc">
   <metadata>
     <os-id>SunOS</os-id>
     <os-version>5.10</os-version>
     <status>success</status>
   </metadata>
   <operation-output>
     <metadata>
       <command>zoneadm -z testzone halt</command>
       <line-count>1</line-count>
       <execution-milliseconds>1718</execution-milliseconds>
       <exit-code>0</exit-code>
       <status>success</status>
     </metadata>
     <output>
       <line index="1">Operation Halt_Zone executed successfully!!</line>
     </output>
   </operation-output>
</target-output>
</solaris-zones-response>

Halt Zone operation

On this page