Use this object to access wincfg, iso2class, image2class, and hvm2pv utilities on a VDC.
|
Method |
Description |
|
Change administrator password of a Windows appliance |
|
|
Change computer name of a Windows appliance |
|
|
Display products that may be downloaded from Cloud Commons |
|
|
Download a product from Cloud Commons |
|
|
Apply the changes requested to the Windows appliance |
|
|
Convert unmanaged HVM appliance to a managed appliance |
|
|
Import virtual machine images as appliance classes |
Change administrator password of a Windows appliance
/api/v2/util/wincfg_passwd?app=application&comp=component&admin_pw=passwd&vdc=controller-name
Name of the application
Name of the Windows component
New administrator password
Name of the target virtual data center
asynchronous
GET
Change password for test:main.WIN03S.
GET http://192.168.123.200/api/v2/util/wincfg_passwd?app=test&comp=main.WIN03S&admin_pw=password&vdc=mygrid
<job>be805915-76b2-48c8-b8a0-b881cca66da6</job>
{
"job" : "be805915-76b2-48c8-b8a0-b881cca66da6"
}
Entity vdc mygrid not found - A VDC name was specified that is not configured in the WS_API application.
Missing required arguments (component). - Argument comp=component missing in the request.
Missing required arguments (app). - Argument app=app missing in the request.
Missing required arguments (admin_pw). - Argument admin_pw=password missing in the request.
Note: To get the status of job, issue a /api/v2/job/info? request with the job_id returned above as the argument. For more information about how to obtain the job status, refer to the job object.
Change computer name of a Windows appliance
/api/v2/util/wincfg_passwd?app=application&comp=component&comp_name=new-name&vdc=controller-name
Name of the application
Name of the Windows component
New computer name
Name of the target virtual data center
asynchronous
GET
Change computer name for test:main.WIN03S.
GET http://192.168.123.200/api/v2/util/wincfg_comp_name?app=test&comp=main.WIN03S&comp_name=WIN03TST&vdc=mygrid
<job>be805915-76b2-48c8-b8a0-b881cca66da6</job>
{
"job" : "be805915-76b2-48c8-b8a0-b881cca66da6"
}
Entity vdc mygrid not found - A VDC name was specified that is not configured in the WS_API application.
Missing required arguments (component). - Argument comp=component missing in the request.
Missing required arguments (app). - Argument app=app missing in the request.
Missing required arguments (comp_name). - Argument comp_name=component missing in the request.
Note: To get the status of job, issue a /api/v2/job/info? request with the job_id returned above as the argument. For more information about how to obtain the job status, refer to the job object.
Display products that may be downloaded from Cloud Commons
/api/v2/util/cloudstore_list?vdc=controller-name
Cloud Commons user name
Cloud Commons password
Name of the target virtual data center
synchronous
GET
List products.
GET http://192.168.123.200/api/v2/util/cloudstore_list?&user_name=username&user_password=password&vdc=mygrid
Entity vdc mygrid not found - A VDC name was specified that is not configured in the WS_API application.
Download a product from the Cloud Commons
/api/v2/util/cloudstore_get?order_id=order-id&user_name=username&user_password=password&vdc=controller-name
Cloud Commons order ID
Cloud Commons user name
Cloud Commons user password
Name of the target virtual data center
asynchronous
GET
Get a product with ID=123321.
GET http://192.168.123.200/api/v2/util/cloudstore_get?order_id=123321&user_name=test@CA.com&user_password=password&vdc=mygrid
<job>be805915-76b2-48c8-b8a0-b881cca66da6</job>
{
"job" : "be805915-76b2-48c8-b8a0-b881cca66da6"
}
Entity vdc mygrid not found - A VDC name was specified that is not configured in the WS_API application.
Missing required arguments (product_id). - Argument product_id=product_id missing in the request.
Missing required arguments (user_name). - Argument user_name=user_name missing in the request.
Missing required arguments (user_password). - Argument user_password=component missing in the request.
To get the status of job, issue a /api/v2/job/info? request with the job_id returned above as the argument. For more information about how to obtain the job status, refer to the job object.
Apply the changes requested to the Windows appliance
/api/v2/util/wincfg?app=application&comp=component&vdc=controller-name
Name of the application
Name of the windows component
Marketplace user password
Name of the target virtual data center
asynchronous
GET
Change admin password of a windows based appliance
GET http://192.168.123.200/api/v2/util/wincfg?app=WINAPP&component=main.WIN08S&admin_pw=password&vdc=mygrid
Change computer name of a windows based appliance
GET http://192.168.123.200/api/v2/util/wincfg?app=WINAPP&component=main.WIN08S&computer_name=WINTST&vdc=mygrid
{
"job" : "3f8c7462-eab5-48e7-94c1-ed5fc5b9cb97"
}
<job>358fd142-acba-42b2-bfde-d7deb0ebe03e</job>
Entity vdc mygrid not found - A VDC name was specified that is not configured in the WS_API application.
Missing required arguments (app)
- Argument app=app missing
Missing required arguments (comp)
- Argument app=app missing
This API is available with WS_API_r6-1.0.6-1 and above.
To get the status of job, issue a /api/v2/job/info? request with the job_id returned above as the argument. For more information about how to obtain the job status, refer to the job object.
Convert unmanaged HVM appliance to a managed appliance (running as HVM, PV or both)
/api/v2/util/hvm2pv?app=application&comp=component&vdc=controller-name
Name of the application
Name of the windows component
Name of the target virtual data center
Asynchronous
GET
Convert unmanaged ISO2CLASS singleton to a managed appliance running in PV mode GET
http://192.168.123.200/api/v2/util/hvm2pv?app=centos-hvm&component=main.iso2class&virt_mode=xen_pv&os=rh&arch=32&vdc=mygrid
{
"job" : "3f8c7462-eab5-48e7-94c1-ed5fc5b9cb97"
}
<job>358fd142-acba-42b2-bfde-d7deb0ebe03e</job>
Entity vdc mygrid not found - A VDC name was specified that is not configured in the WS_API application.
Missing required arguments (app)
- Argument app=app missing
Missing required arguments (comp)
- Argument app=app missing
Before using this object, bind the grid to the Marketplace using the appstore_bind object.
To get the status of job, issue a /api/v2/job/info? request with the job_id returned above as the argument. For more information about how to obtain the job status, refer to the job object.
Import virtual machine images as AppLogic appliance classes.
/api/v2/util/image2class?class=class&image=image&vdc=controller-name
Name of the AppLogic appliance class that will be created
The image or volumes to be imported.
Asynchronous
GET
Import an OVA image from the grid's impex volume as an unmanaged singleton class
GET http://192.168.123.200/api/v2/util/image2class?class=myapp:TOMCAT&image=tomcat.ova&unmanaged&vdc=mygrid
Import an OVA image from a URL, creating a managed catalog class, overriding resources specified in the .ovf descriptor
GET http://192.168.123.200/api/v2/util/image2class?class=/proto:TOMCAT&image=http%3A%2F%2Fexample.com%2Ftomcat.ova&user=user&pwd=password&managed&cpu=2&mem=512M&os=linux&vdc=mygrid
Upgrade a managed catalog class by replacing its volumes with those from an OVA image
GET http://192.168.123.200/api/v2/util/image2class?class=/proto:TOMCAT&image=tomcat.ova&upgrade&vdc=mygrid
{
"job" : "3f8c7462-eab5-48e7-94c1-ed5fc5b9cb97"
}
<job>358fd142-acba-42b2-bfde-d7deb0ebe03e</job>
Entity vdc mygrid not found - A VDC name was specified that is not configured in the WS_API application.
Missing required arguments (class)
- Argument class=class missing
Missing required arguments (image)
- Argument image=image missing
Before using this object, bind the grid to the Marketplace using the appstore_bind object.
To get the status of job, issue a /api/v2/job/info? request with the job_id returned above as the argument. For more information about how to obtain the job status, refer to the job object.
|
Copyright © 2013 CA Technologies.
All rights reserved.
|
|