Python help
-
@Butcat It worked thank you so much I never really worked with api's before so I am learning
-
@Studmuffn1134 said in Python help:
Reply
Is it the same code for the hosts or do I have to use different api links for host actions can you help me with that?
-
Hello @Studmuffn1134, welcome!
The provided python code will resembled yes however the path will be specific to the type and actions you need to perform. Also the returned payload will also be different.
You can find bellow some informations that can help you understand and use the Xen Orchestra API.Here is a summary provided when searching with google about REST APIs patterns:
Understanding REST: A Guide to API Design Patterns
REST (Representational State Transfer) is a widely-used software architectural style that defines how APIs should be designed. It emphasizes simplicity, scalability, and efficiency, making it a popular choice for building web services and applications. REST APIs use standard HTTP methods (such as GET, POST, PUT, and DELETE) to interact with resources, which are identified by URLs. This approach makes REST APIs intuitive and easy to work with.
To get the most out of REST, itâs important to understand its patterns and conventions. These patterns will not only improve your foundational knowledge but also help you interact with APIs.
REST API Path Structure
A typical REST API path follows a structured format, often resembling this pattern:
http://host_or_domain_name/<types>/<id>/<action_verb>Hereâs a breakdown of the components:
-
<types>: Represents the type of resource youâre interacting with (e.g., vms, users, networks).
-
<id>: A unique identifier for a specific resource (e.g., a VM ID or user ID).
-
<action_verb>: Specifies the action to be performed on the resource (e.g., actions, start, stop).
HTTP Methods in REST
REST APIs use specific HTTP methods to perform operations on resources:
-
GET: Retrieves data. For example, fetching a list of resources or details of a specific resource.
-
POST: Creates a new resource.
-
PUT: Replaces or updates an entire resource.
-
PATCH: Updates specific parts of a resource.
-
DELETE: Removes a resource.
Example: REST API Paths for Virtual Machines (VMs)
Letâs look at some examples using a vms resource type:List all VMs:
GET http://host/rest/v0/vmsThis returns a list of VM IDs.
Get details of a specific VM:
GET http://host/rest/v0/vms/<id>This returns detailed information about the VM with the specified ID.
List available actions for a VM:
GET http://host/rest/v0/vms/<id>/actionsThis returns all actions that can be performed on the specified VM (e.g., start, stop, reboot).
Perform an action on a VM:
POST http://host/rest/v0/vms/<id>/actions/<your-action>This performs the specified action (e.g., start, stop) on the VM.
Exploring Available REST Endpoints
If youâre working with a REST API like Xen Orchestra, you can explore the available endpoints by navigating to the base URL in your browser or using a tool like Postman. For example:GET http://host/rest/v0This will return a list of available resource types and operations, such as:
[ "/rest/v0/hosts", "/rest/v0/messages", "/rest/v0/networks", "/rest/v0/pifs", "/rest/v0/pools", "/rest/v0/srs", "/rest/v0/vbds", "/rest/v0/vdi-snapshots", "/rest/v0/vdis", "/rest/v0/vifs", "/rest/v0/vm-controllers", "/rest/v0/vm-snapshots", "/rest/v0/vm-templates", "/rest/v0/vms", "/rest/v0/backup", "/rest/v0/groups", "/rest/v0/restore", "/rest/v0/tasks", "/rest/v0/servers", "/rest/v0/users", "/rest/v0/dashboard", "/rest/v0/alarms", "/rest/v0/docs" ]From here, you can follow the REST patterns described above to query specific resources or perform actions.
Hope this help!
-
-
@Butcat This was very very very helpful. https://192.168.100.30:2223/rest/v0/host/d2f1374c-728d-4905-85cc-e0d7166a3fbf/actions is there no way to turn off a single host through the api. The interesting part is I have no actions in the host section with that host id?
-
Hi @Studmuffn1134,
Youâre rightâsome actions (like certain host operations) arenât fully available in the REST API yet. Right now, most "GET" methods work, and some actions (like those for VMs and snapshots) are implemented. However, the REST API is still a work in progress.
The Xen Orchestra team is currently focusing on:
-
Non-admin user management (coming soon).
-
Save/backup functionality (planned for the next few months).
Since not everything is ready in REST yet, you might need to use both REST and JSON-RPC to access all operations.
For JSON-RPC, check out:
-
-
@Butcat def shutdown_vm_hosts(host_id,xo_url,auth_token,use_force):
root_dir = os.path.dirname(os.path.abspath(file))
file_path = os.path.join((root_dir),"Certs\fullchain.pem")headers = { 'Content-Type':'application/json', 'Authorization':f'Bearer {auth_token}' } data = { "jsonrpc":"2.0", "method":"host.shutdown", "params":[host_id], "id":1 } try: response = requests.post( xo_url, headers=headers,data=json.dumps(data), verify=file_path ) print(f"Status code: {response.status_code}") if response.status_code in [200, 202, 204]: print(f"â Successfully initiated {'force' if use_force else 'clean'} shutdown") return True else: print(f"Error: {response.text}") return False except requests.exceptions.RequestException as e: print(f"Request failed: {e}") return False -
@Studmuffn1134 That is what i did and it still does not work I get a status code 200 but it never shuts the host off
-
@Studmuffn1134 LOL at "ThePlague"... (hackers unite!)
-
@TheNorthernLight Finally someone gets the reference But what do u think I am doing wrong
-
@Studmuffn1134 Sadly, I dont know squat about python, sorry!
-
@TheNorthernLight Well could you do it in a language you know and maybe i would be able to convert it>?
-
Did some "kicking" around in python, I don't python that much so "readers beware"
How did i figure it out, the french blog from here was useful, but only showed listing methods. I was still very confused as to how to call the vm.stop and which parameters it took.
Enter xo-cli
xo-cli uses jsonrpc but is CLi only, but you can get very nice info from it just have to register and call "list-methods". should be available on your xo VM
xo-cli register http://[yourXO].example.com [yourusername] #after registering/authenticating xo-cli list-commands | egrep 'vm\.' --color=alwayshere you will get a nice list of all "methods" in jsonrpc related to vm and a line about vm.stop:
vm.stop id=<string> [force=<boolean>] [forceShutdownDelay=<number>] [bypassBlockedOperation=<boolean>]
which was enough information to alter the french guy's (Baron) example into this:
import aiohttp import asyncio from jsonrpc_websocket import Server async def routine(): async with aiohttp.ClientSession() as client: server = Server('ws://[yourXO]/api/', client) await server.ws_connect() # signIn required result = await server.session.signIn(username='[xoAdmin]', password='[xoAdmin]') # email attribute is working in place of username #hard shutdown #result = await server.vm.stop(id='3f32beeb-ab3f-a8ac-087d-fdc7ed061b58', force=(bool(1))) #clean Shutdown result = await server.vm.stop(id='3f32beeb-ab3f-a8ac-087d-fdc7ed061b58', force=(bool(0))) print (result) asyncio.get_event_loop().run_until_complete(routine()) -
@Gurve Is this for the vm's on the server or the host itself i need the host itself
-
@Studmuffn1134 Sorry, must have somehow read another reply about vm and mixed them. But pretty sure you should be able to utilise the steps I did for host shutdown
xo-cli to get relevant api endpoints, xo-cli to get parameters for said endpoint and then press play
-
@Gurve Do i have to enable the xo-cli?
-
@Studmuffn1134 should be available in XO vm, it was atleast for me, I just used the XO installer script from github.
I did a quick search with xo cli now
xo-cli list-commands | egrep 'host.'
in case it looks weird "\." is just to escape the "." which just tells regex I am looking for an actual "."
import aiohttp import asyncio from jsonrpc_websocket import Server async def routine(): async with aiohttp.ClientSession() as client: server = Server('ws://[yourXO]/api/', client) await server.ws_connect() # signIn required result = await server.session.signIn(username='[yourXOusername]', password='[yourXOPassword]') # email attribute is working in place of username #hard shutdown VM #result = await server.vm.stop(id='3f32beeb-ab3f-a8ac-087d-fdc7ed061b58', force=(bool(1))) #clean Shutdown VM #result = await server.vm.stop(id='3f32beeb-ab3f-a8ac-087d-fdc7ed061b58', force=(bool(0))) #bypassbackup and bypassevacuate set off by default but include for wholeness of parameters result = await server.host.stop(id=[hostUUID],bypassBackupCheck=(bool(0)),bypassEvacuate=bool(0)) print (result) asyncio.get_event_loop().run_until_complete(routine())I just built all examples into one, here in the end is the host.stop example also
-
@Gurve '''def shutdown_vm_hosts(host_id,xo_url,auth_token,use_force):
async def routine(): async with aiohttp.ClientSession() as client: server = Server('ws://192.168.100.30:2223/api/', client) await server.ws_connect() # signIn required result = await server.session.signIn(username='ThePlague', password='No') # email attribute is working in place of username hostUUID ="d2f1374c-728d-4905-85cc-e0d7166a3fbf" #hard shutdown VM #result = await server.vm.stop(id='3f32beeb-ab3f-a8ac-087d-fdc7ed061b58', force=(bool(1))) #clean Shutdown VM #result = await server.vm.stop(id='3f32beeb-ab3f-a8ac-087d-fdc7ed061b58', force=(bool(0))) #bypassbackup and bypassevacuate set off by default but include for wholeness of parameters result = await server.host.stop(id=[hostUUID],bypassBackupCheck=(bool(0)),bypassEvacuate=bool(0)) print (result)''' Traceback (most recent call last): File "z:\Valera\School\Lakeland University\Finished\Programming 2\Python Programs\StudsPrograms\Shutdowntest.py", line 72, in <module> main() # second part of calling the main function ~~~~^^ File "z:\Valera\School\Lakeland University\Finished\Programming 2\Python Programs\StudsPrograms\Shutdowntest.py", line 70, in main shutdown_vm_hosts(l,XO_URL,AUTH_TOKEN,use_force=False) ~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "z:\Valera\School\Lakeland University\Finished\Programming 2\Python Programs\StudsPrograms\Shutdowntest.py", line 29, in shutdown_vm_hosts asyncio.get_event_loop().run_until_complete(routine()) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^ File "C:\Users\ThePlague\AppData\Local\Programs\Python\Python313\Lib\asyncio\base_events.py", line 725, in run_until_complete return future.result() ~~~~~~~~~~~~~^^ File "z:\Valera\School\Lakeland University\Finished\Programming 2\Python Programs\StudsPrograms\Shutdowntest.py", line 13, in routine await server.ws_connect() File "Z:\Valera\School\Lakeland University\Finished\Programming 2\Python Programs\StudsPrograms\.venv\Lib\site-packages\jsonrpc_websocket\jsonrpc.py", line 68, in ws_connect raise TransportError('Error connecting to server', None, exc) jsonrpc_base.jsonrpc.TransportError: ('Error connecting to server', ServerDisconnectedError('Server disconnected'))I tried that and that is the error code I get
-
@Studmuffn1134 I changed my link from ws:// to https:// and it now gives me this error File "Z:\Valera\School\Lakeland University\Finished\Programming 2\Python Programs\StudsPrograms.venv\Lib\site-packages\jsonrpc_base\jsonrpc.py", line 213, in parse_response
raise ProtocolError(code, message, data)
jsonrpc_base.jsonrpc.ProtocolError: (10, 'invalid parameters', {'error': {'message': 'invalid parameters', 'code': 10, 'data': {'errors': [{'instancePath': '/id', 'schemaPath': '#/properties/id/type', 'keyword': 'type', 'params': {'type': 'string'}, 'message': 'must be string'}]}}, 'id': '0a11ec72-9300-4030-a5d2-a5c0286f3811', 'jsonrpc': '2.0'})
