Get List of vApp VSs Start/Stop Order

To get a list of VSs start/stop order during the vApp start/stop, use the following request:

1
2
GET /vapps/:vapp_id/startup_items.xml
GET /vapps/:vapp_id/startup_items.json

XML Request Example

1
curl -i -X GET -u user:userpass -H 'Accept: application/xml' -H 'Content-type: application/xml' --url http://onapp.test/vapps/2/startup_items.xml

JSON Request Example

1
curl -i -X GET -u user:userpass -H 'Accept: application/json' -H 'Content-type: application/json' --url http://onapp.test/vapps/2/startup_items.json

XML Output Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
<vapps_startup_items type="array">
  <vapps_startup_item>
	<id type="integer">2</id>
	<vapp_id type="integer">5</vapp_id>
	<virtual_machine_id type="integer">9</virtual_machine_id>
	<vm_name>virtuaal_server_label</vm_name>
	<order type="integer">1</order>
	<start_action>powerOn</start_action>
	<start_delay type="integer">0</start_delay>
	<stop_action>powerOff</stop_action>
	<stop_delay type="integer">0</stop_delay>
	<created_at type="dateTime">2018-03-20T16:06:15+00:00</created_at>
	<updated_at type="dateTime">2018-03-20T16:06:15+00:00</updated_at>
  </vapps_startup_item>
  <vapps_startup_item>...</vapps_startup_item>
</vapps_startup_items>

Where:

  • vapps_startup_items - the array of startup items

  • vapps_startup_item - the array of startup item parameters

  • id - the ID of the startup item

  • vapp_id - the ID of the vApp

  • virtual_machine_id - the ID of the virtual server

  • vm_name - the label of the virtual server that belongs to the vApp

  • order - the number that indicates the order in which to start and stop the virtual server

    Virtual servers with lower numbers are started first and stopped last. You cannot specify negative numbers. Virtual servers with the same numbers are started and stopped at the same time.

  • start_action - the powerOn action to apply to the virtual server when the vApp is started

  • start_delay - the delay in seconds after starting one virtual server and before starting the next virtual server

  • stop_action - the action to apply to the virtual server when the vApp is stopped. The available actions include:

    • powerOff -to power off the VS forcefully
    • guestShutdown - to shut down the VS gracefully
  • stop_delay - the delay in seconds to wait after stopping one virtual server and before stopping the next virtual server

  • created_at - the date when the startup item was created in the [YYYY][MM][DD]T[hh][mm][ss] format

  • updated_at - the date when the startup item was updated in the [YYYY][MM][DD]T[hh][mm][ss] format