Exit Maintenance Mode operation

The Exit Maintenance Mode operation takes the host out of maintenance mode. This operation is blocked if any concurrent running maintenance-only host configurations operations are being performed on the specified host. For example, if the VMFS volumes are being upgraded.

Note

You can cancel this operation.

If the <status> response element contains success, the <Task> response element contains the ID of the queued task, which you can use to obtain the task status.

The following table describes the elements for the adapter request.

Adapter request elements for the Exit Maintenance Mode operation

Element	Definition	Required
<operation-type>	Defines the type of operation: Host	Yes
<operation-name>	Defines the name of operation: Exit_Maintenance_Mode	Yes
<soap-url>	Specifies the URL for the remote SOAP service running on the VMware VirtualCenter If the <soap-url> element is not specified, the request uses the VirtualCenter Server details specified in the adapter configuration. Default format for HTTPS: https://<hostName>:<port>/sdk/vim Default format for HTTP: http://<hostName>:<port>/sdk/vim Warning Note If you want to use an HTTP value, you might need to change the configuration of the VMware Infrastructure application.	No
<transport>	Specifies the transport protocol for the message If the <transport> element is not provided, the request uses the VirtualCenter Server details specified in the adapter configuration. Valid values: https-rpc (default), http-rpc Warning Note If the value of the <transport> element is https-rpc, you must install the security certificate for the VMware Virtual Center to the keystore of the peer on which the adapter is enabled.	No
<user-name>	Specifies the user name that is used for HTTP basic authentication on the VMware Virtual Center If no user name is specified, the request is executed with the user name that is specified in the configuration.	No
<password>	Specifies the password corresponding to <user-name>	Conditional; required if <user-name> is specified
<parameters>	Contains the <virtual-machine> element required to execute the operation	Yes
<host-system>	Specifies the DNS name for the host that you want to take out of the maintenance mode Valid values: Any string	Yes
<timeout>	Specifies the number of seconds to wait for the exit maintenance mode operation to succeed If this element is less than or equal to zero, no timeout occurs. Valid values: Any integer	Yes

The following code sample shows the sample adapter request for the Exit Maintenance Mode operation.

Sample adapter request for the Exit Maintenance Mode operation

<vmware-infrastructure-request>
   <operation-type>Host</operation-type>
   <operation-name>Exit_Maintenance_Mode</operation-name>
   <soap-url></soap-url>
   <transport></transport>
   <user-name></user-name>
   <password></password>
   <parameters>
<host-system>xyz.bmc.com</host-system>
<timeout>0</timeout>
    </parameters>
</vmware-infrastructure-request>

The following code sample shows the response for the sample Exit Maintenance Mode operation.

Sample adapter response for the Exit Maintenance Mode operation

<vmware-infrastructure-response>
     <metadata>
       <status>success</status>
     </metadata>
     <ExitMaintenanceMode_TaskResponse>
      <Task>task-7984</Task>
     </ExitMaintenanceMode_TaskResponse>
</vmware-infrastructure-response>

The following table shows the response element for the Exit Maintenance Mode operation.

Adapter response elements for the Exit Maintenance Mode operation

Element	Definition
<Task>	Specifies the task ID of the submitted task Use the task ID to obtain the status of the specified task. For information about using the task ID to check the task status, see Request and response for the Retrieve_Task_Status operation.

Exit Maintenance Mode operation

TrueSight Orchestration Content 20.19.02

On this page