LAVA | API help

Help

Event notifications

Event notifications are handled by the lava-publisher service on the master. You can subscribe to these events through lava-publisher service and receive events such as:

metadata on the instance which was the source of the event
description of a status change on that instance.

To subscribe to these events, you can get the lava-publisher protocol and port via XML-RPC call from the server [ scheduler.get_publisher_event_socket ].

For more information, visit lava-publisher docs.

About XML-RPC API

LAVA Server offers API services as an XML-RPC server. You can interact with it using any XML-RPC client. For example, in python3 you can do this:

import xmlrpc.client
server = xmlrpc.client.ServerProxy("http://127.0.0.1/RPC2", allow_none=True)
print(server.system.listMethods())

The following python3 code shows how to authenticate using an XML-RPC client, when a method requires authentication.

WARNING: https:// scheme is recommended when using authentication.

  import xmlrpc.client
  username = "USERNAME"
  token = "TOKEN_STRING"
  hostname = "HOSTNAME"  # 127.0.0.1
  server = xmlrpc.client.ServerProxy("http://%s:%s@%s/RPC2" % (username, token, hostname), allow_none=True)
  print(server.system.listMethods())

NOTE: USERNAME is a valid username in the specified LAVA instance. TOKEN_STRING is a valid token associated with the above username in the same LAVA instance. HOSTNAME is the fully qualified domain name or IP address of the same LAVA instance.

In the above code snippet the ServerProxy string is constructed from different components, with separators, which are clearly illustrated as follows:
USERNAME:TOKEN_STRING@HOSTNAME/HANDLER

allow_none=True allows your client to match the server behaviour of handling an empty value as a null (None in Python, undef in Perl etc.) instead of as string like 'None'.

Available functions

Scheduler

scheduler

[ scheduler.all_device_types ] [ scheduler.all_devices ] [ scheduler.all_jobs ] [ scheduler.cancel_job ] [ scheduler.export_device_dictionary ] [ scheduler.get_device_config ] [ scheduler.get_device_status ] [ scheduler.get_device_type_by_alias ] [ scheduler.get_publisher_event_socket ] [ scheduler.get_recent_jobs_for_device ] [ scheduler.get_recent_jobs_for_device_type ] [ scheduler.import_device_dictionary ] [ scheduler.job_details ] [ scheduler.job_health ] [ scheduler.job_output ] [ scheduler.job_state ] [ scheduler.pending_jobs_by_device_type ] [ scheduler.put_into_maintenance_mode ] [ scheduler.put_into_online_mode ] [ scheduler.resubmit_job ] [ scheduler.submit_job ] [ scheduler.validate_pipeline_devices ] [ scheduler.validate_yaml ]

scheduler.aliases

[ scheduler.aliases.add ] [ scheduler.aliases.delete ] [ scheduler.aliases.list ] [ scheduler.aliases.show ]

scheduler.device_types

[ scheduler.device_types.add ] [ scheduler.device_types.get_health_check ] [ scheduler.device_types.get_template ] [ scheduler.device_types.list ] [ scheduler.device_types.perms_add ] [ scheduler.device_types.perms_delete ] [ scheduler.device_types.perms_list ] [ scheduler.device_types.set_health_check ] [ scheduler.device_types.set_template ] [ scheduler.device_types.show ] [ scheduler.device_types.update ]

scheduler.device_types.aliases

[ scheduler.device_types.aliases.add ] [ scheduler.device_types.aliases.delete ] [ scheduler.device_types.aliases.list ]

scheduler.devices

[ scheduler.devices.add ] [ scheduler.devices.delete ] [ scheduler.devices.get_dictionary ] [ scheduler.devices.list ] [ scheduler.devices.perms_add ] [ scheduler.devices.perms_delete ] [ scheduler.devices.perms_list ] [ scheduler.devices.set_dictionary ] [ scheduler.devices.show ] [ scheduler.devices.update ]

scheduler.devices.tags

[ scheduler.devices.tags.add ] [ scheduler.devices.tags.delete ] [ scheduler.devices.tags.list ]

scheduler.jobs

[ scheduler.jobs.cancel ] [ scheduler.jobs.configuration ] [ scheduler.jobs.definition ] [ scheduler.jobs.list ] [ scheduler.jobs.logs ] [ scheduler.jobs.queue ] [ scheduler.jobs.resubmit ] [ scheduler.jobs.show ] [ scheduler.jobs.submit ] [ scheduler.jobs.validate ]

scheduler.tags

[ scheduler.tags.add ] [ scheduler.tags.delete ] [ scheduler.tags.list ] [ scheduler.tags.show ]

scheduler.workers

[ scheduler.workers.add ] [ scheduler.workers.delete ] [ scheduler.workers.get_config ] [ scheduler.workers.get_env ] [ scheduler.workers.get_env_dut ] [ scheduler.workers.list ] [ scheduler.workers.set_config ] [ scheduler.workers.set_env ] [ scheduler.workers.set_env_dut ] [ scheduler.workers.show ] [ scheduler.workers.update ]

Results

[ results.get_testcase_results_csv ] [ results.get_testcase_results_yaml ] [ results.get_testjob_metadata ] [ results.get_testjob_results_csv ] [ results.get_testjob_results_yaml ] [ results.get_testjob_suites_list_csv ] [ results.get_testjob_suites_list_yaml ] [ results.get_testsuite_results_count ] [ results.get_testsuite_results_csv ] [ results.get_testsuite_results_yaml ] [ results.make_custom_query ] [ results.refresh_all_queries ] [ results.refresh_query ] [ results.run_query ]

System and Authentication

[ auth.groups.add ] [ auth.groups.delete ] [ auth.groups.list ] [ auth.groups.perms.add ] [ auth.groups.perms.delete ] [ auth.groups.perms.list ] [ auth.groups.show ] [ auth.users.add ] [ auth.users.delete ] [ auth.users.groups.add ] [ auth.users.groups.delete ] [ auth.users.groups.list ] [ auth.users.list ] [ auth.users.perms.add ] [ auth.users.perms.delete ] [ auth.users.perms.list ] [ auth.users.show ] [ auth.users.update ] [ system.api_version ] [ system.assign_perm_device ] [ system.assign_perm_device_type ] [ system.getCapabilities ] [ system.listMethods ] [ system.master_config ] [ system.methodHelp ] [ system.methodSignature ] [ system.multicall ] [ system.pipeline_network_map ] [ system.revoke_perm_device ] [ system.revoke_perm_device_type ] [ system.set_user_groups ] [ system.user_can_submit_to_types ] [ system.user_can_view_bundles ] [ system.user_can_view_devices ] [ system.user_can_view_jobs ] [ system.version ] [ system.whoami ]

scheduler.aliases.add

Name
----
`scheduler.aliases.add` (`name`)

Description
-----------
Create a device-type alias
Permission: lava_scheduler_app.add_alias

Arguments
---------
`name`: string
  Name of the alias
'device_type_name': string
  Name of the device type to alias

Return value
------------
None