7.0
7.0
Docs menu
MENU

Get List of vApp Templates

To view a list of vApp templates, use the following request:

1
2

GET/catalogs/:id/vapp_templates.xml
GET/catalogs/:id/vapp_templates.json

XML Request Example

1

curl -i -X GET -u user:userpass --url http://onapp.test/catalogs/12/vapp_templates.xml -H 'Accept: application/xml' -H 'Content-type: application/xml'

JSON Request Example

1

curl -i -X GET -u user:userpass --url http://onapp.test/catalogs/12/vapp_templates.json -H 'Accept: application/json' -H 'Content-type: application/json'

XML Output Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

<vcloud_vapp_templates type="array">
  <vcloud_vapp_template>
    <id type="integer">16</id>
    <identifier>vappTemplate-1aa1fd44-3e72-4add-8810-89d90e2c8bc6</identifier>
    <label>vApp_1_nk</label>
    <created_at type="dateTime">2018-08-08T15:52:21+03:00</created_at>
    <updated_at type="dateTime">2018-09-05T20:45:50+03:00</updated_at>
    <virtual_machines type="array">
      <virtual_machine>
        <identifier>vm-4bdede71-b44a-46ca-a6ba-9f04e48b4333</identifier>
        <name>debian9_nadiia</name>
        <disks type="array">
          <disk>
            <instance_id>2000</instance_id>
            <label>Hard disk 1</label>
            <capacity>3072</capacity>
            <bus_type>6</bus_type>
            <bus_sub_type>VirtualSCSI</bus_sub_type>
          </disk>
        </disks>
        <nics type="array">
          <nic>
            <adapter_type>VMXNET3</adapter_type>
          </nic>
        </nics>
        <cpus>1</cpus>
        <cores_per_socket>1</cores_per_socket>
        <memory>1024</memory>
        <operating_system>debian8_64Guest</operating_system>
        <vmware_tools>10277</vmware_tools>
        <guest_customization>
          <enabled type="boolean">false</enabled>
          <change_sid type="boolean">false</change_sid>
          <join_domain_enabled type="boolean">false</join_domain_enabled>
          <use_org_settings type="boolean">false</use_org_settings>
          <admin_password_enabled type="boolean">true</admin_password_enabled>
          <admin_password_auto type="boolean">true</admin_password_auto>
          <admin_password nil="true"/>
          <admin_auto_logon_enabled type="boolean">false</admin_auto_logon_enabled>
          <admin_auto_logon_count type="integer">0</admin_auto_logon_count>
          <reset_password_required type="boolean">false</reset_password_required>
          <computer_name>debian9-001</computer_name>
          <script nil="true"/>
        </guest_customization>
      </virtual_machine>
    </virtual_machines>
    <catalog_item_id type="integer">18</catalog_item_id>
    <description>Description</description>
  </vcloud_vapp_template>
</vcloud_vapp_templates>

Where:

  • id - ID of the vApp template
  • identifier - the identifier of the vApp template
  • label - the name of the vApp template
  • created_at - the date in the [YYYY][MM][DD]T[hh][mm][ss]Z format
  • updated_at - the date in the [YYYY][MM][DD]T[hh][mm][ss]Z format
  • image virtual_machines - the array of virtual servers that are built from the template
    • virtual_machine - the array of the virtual server parameters
      • identifier - the identifier of the virtual server
      • name - the name of the virtual server
      • disks - the array of the virtual server disks
        • disk - the array of the disk parameters
          • instance_id - the ID of the disk
          • label - the label of the disk
          • capacity - the capacity of the disk in GB
          • bus_type - the bus type of the disk
          • bus_sub_type - the bus sub type of the disk
      • nics - the array of the virtual server NICs
        • nic - the array of the NIC parameters
          • adapter_type - the network adapter type provided for the VS
      • cpus - the number of allocated CPU cores
      • cores_per_socket - the number of cores per socket
      • memory - the number of RAM allocated to the VS
      • operating_system - the operating system used by the VS
      • vmware_tools - the ID of the VMware tools
      • guest_customization - the array of the guest customization parameters applied to the VS. The guest customization is available only for virtual servers with the VMware tools.
        • enabled - true if the guest customization is enabled; otherwise, false
        • change_sid - true if Change SID is enabled; otherwise, false. This parameter is applicable only for Windows VSs and runs Sysprep to change Windows SID. On Windows NT, VCD uses Sidgen. Running sysprep is a prerequisite for completing domain join.
        • join_domain_enabled - true if the VS is enabled to join a domain, otherwise, false
        • use_org_settings - true if the user org settings are enabled; otherwise, false
        • admin_password_enabled - true if the local administrator password is enabled; otherwise, false
        • admin_password_auto - true if the administrator password is generated automatically; otherwise, false
        • admin_password - the password of the administrator
        • admin_auto_logon_enabled - true if the administrator can be automatically logged in to the VS. This parameter applies only to Windows VSs.
        • admin_auto_logon_count - the number of automatic logins available for the administrator. After the indicated time is exceeded and you are not able to log in, the VS remains running and you need to enter your credentials. This option applies only if the admin_auto_logon_enabled parameter is true.
        • reset_password_required - true if the administrator is required to change the password on a first login to the VS; otherwise, false
        • computer_name - the VS computer name
        • script - the script for the guest customization
  • catalog_item_id - the ID of the catalog
  • image description - the description of the vApp template

Page History

v. 6.0

  • Added the following parameters:
    • virtual_machines array
    • description