Provides APIs for the management of nodedevs
#define VIR_NODE_DEVICE_EVENT_CALLBACK
typedef enum virConnectListAllNodeDeviceFlags typedef struct _virNodeDevice virNodeDevice typedef enum virNodeDeviceCreateXMLFlags typedef enum virNodeDeviceDefineXMLFlags typedef enum virNodeDeviceEventID typedef enum virNodeDeviceEventLifecycleType typedef virNodeDevice * virNodeDevicePtr typedef enum virNodeDeviceUpdateFlags typedef enum virNodeDeviceXMLFlags
int virConnectListAllNodeDevices (virConnectPtr conn,
virNodeDevicePtr ** devices,
unsigned int flags) int virConnectNodeDeviceEventDeregisterAny (virConnectPtr conn,
int callbackID) typedef virConnectNodeDeviceEventGenericCallback void virConnectNodeDeviceEventGenericCallback (virConnectPtr conn,
virNodeDevicePtr dev,
void * opaque) typedef virConnectNodeDeviceEventLifecycleCallback void virConnectNodeDeviceEventLifecycleCallback (virConnectPtr conn,
virNodeDevicePtr dev,
int event,
int detail,
void * opaque) int virConnectNodeDeviceEventRegisterAny (virConnectPtr conn,
virNodeDevicePtr dev,
int eventID,
virConnectNodeDeviceEventGenericCallback cb,
void * opaque,
virFreeCallback freecb) int virNodeDeviceCreate (virNodeDevicePtr dev,
unsigned int flags) virNodeDevicePtr virNodeDeviceCreateXML (virConnectPtr conn,
const char * xmlDesc,
unsigned int flags) virNodeDevicePtr virNodeDeviceDefineXML (virConnectPtr conn,
const char * xmlDesc,
unsigned int flags) int virNodeDeviceDestroy (virNodeDevicePtr dev) int virNodeDeviceDetachFlags (virNodeDevicePtr dev,
const char * driverName,
unsigned int flags) int virNodeDeviceDettach (virNodeDevicePtr dev) int virNodeDeviceFree (virNodeDevicePtr dev) int virNodeDeviceGetAutostart (virNodeDevicePtr dev,
int * autostart) const char * virNodeDeviceGetName (virNodeDevicePtr dev) const char * virNodeDeviceGetParent (virNodeDevicePtr dev) char * virNodeDeviceGetXMLDesc (virNodeDevicePtr dev,
unsigned int flags) int virNodeDeviceIsActive (virNodeDevicePtr dev) int virNodeDeviceIsPersistent (virNodeDevicePtr dev) int virNodeDeviceListCaps (virNodeDevicePtr dev,
char ** const names,
int maxnames) virNodeDevicePtr virNodeDeviceLookupByName (virConnectPtr conn,
const char * name) virNodeDevicePtr virNodeDeviceLookupSCSIHostByWWN (virConnectPtr conn,
const char * wwnn,
const char * wwpn,
unsigned int flags) int virNodeDeviceNumOfCaps (virNodeDevicePtr dev) int virNodeDeviceReAttach (virNodeDevicePtr dev) int virNodeDeviceRef (virNodeDevicePtr dev) int virNodeDeviceReset (virNodeDevicePtr dev) int virNodeDeviceSetAutostart (virNodeDevicePtr dev,
int autostart) int virNodeDeviceUndefine (virNodeDevicePtr dev,
unsigned int flags) int virNodeDeviceUpdate (virNodeDevicePtr dev,
const char * xmlDesc,
unsigned int flags) int virNodeListDevices (virConnectPtr conn,
const char * cap,
char ** const names,
int maxnames,
unsigned int flags) int virNodeNumOfDevices (virConnectPtr conn,
const char * cap,
unsigned int flags)
VIR_NODE_DEVICE_EVENT_CALLBACK¶#define VIR_NODE_DEVICE_EVENT_CALLBACKUsed to cast the event specific callback into the generic one for use for virConnectNodeDeviceEventRegisterAny()
virConnectListAllNodeDeviceFlags¶Flags used to filter either by capability or active state, the returned node devices.
enum virConnectListAllNodeDeviceFlags {
}
virNodeDevice¶struct virNodeDevice {
}
virNodeDeviceCreateXMLFlags¶enum virNodeDeviceCreateXMLFlags {
| VIR_NODE_DEVICE_CREATE_XML_VALIDATE | = | 1 (0x1; 1 << 0) | Validate the XML document against schema |
}
virNodeDeviceDefineXMLFlags¶enum virNodeDeviceDefineXMLFlags {
| VIR_NODE_DEVICE_DEFINE_XML_VALIDATE | = | 1 (0x1; 1 << 0) | Validate the XML document against schema |
}
virNodeDeviceEventID¶An enumeration of supported eventId parameters for virConnectNodeDeviceEventRegisterAny(). Each event id determines which signature of callback function will be used.
enum virNodeDeviceEventID {
| VIR_NODE_DEVICE_EVENT_ID_LIFECYCLE | = | 0 (0x0) | |
| VIR_NODE_DEVICE_EVENT_ID_UPDATE | = | 1 (0x1) | |
| VIR_NODE_DEVICE_EVENT_ID_LAST | = | 2 (0x2) | NB: this enum value will increase over time as new events are added to the libvirt API. It reflects the last event ID supported by this version of the libvirt API. |
}
virNodeDeviceEventLifecycleType¶a virNodeDeviceEventLifecycleType is emitted during node device lifecycle events
enum virNodeDeviceEventLifecycleType {
| VIR_NODE_DEVICE_EVENT_CREATED | = | 0 (0x0) | |
| VIR_NODE_DEVICE_EVENT_DELETED | = | 1 (0x1) | |
| VIR_NODE_DEVICE_EVENT_DEFINED | = | 2 (0x2) | |
| VIR_NODE_DEVICE_EVENT_UNDEFINED | = | 3 (0x3) | |
| VIR_NODE_DEVICE_EVENT_LAST | = | 4 (0x4) |
}
virNodeDevicePtr¶typedef virNodeDevice * virNodeDevicePtr;A virNodeDevicePtr is a pointer to a virNodeDevice structure. Get one via virNodeDeviceLookupByName, or virNodeDeviceCreate. Be sure to call virNodeDeviceFree when done using a virNodeDevicePtr obtained from any of the above functions to avoid leaking memory.
virNodeDeviceUpdateFlags¶Flags to control options for virNodeDeviceUpdate()
enum virNodeDeviceUpdateFlags {
| VIR_NODE_DEVICE_UPDATE_AFFECT_CURRENT | = | 0 (0x0) | affect live if node device is active, config if it's not active |
| VIR_NODE_DEVICE_UPDATE_AFFECT_LIVE | = | 1 (0x1; 1 << 0) | affect live state of node device only |
| VIR_NODE_DEVICE_UPDATE_AFFECT_CONFIG | = | 2 (0x2; 1 << 1) | affect persistent config only |
}
virNodeDeviceXMLFlags¶Flags used to provide the state of the returned node device configuration.
enum virNodeDeviceXMLFlags {
| VIR_NODE_DEVICE_XML_INACTIVE | = | 1 (0x1; 1 << 0) | dump inactive device configuration |
}
virConnectListAllNodeDevices¶int virConnectListAllNodeDevices (virConnectPtr conn, virNodeDevicePtr ** devices, unsigned int flags)
Collect the list of node devices, and allocate an array to store those objects.
Normally, all node devices are returned; however, flags can be used to filter the results for a smaller list of targeted node devices.
devices to NULL in case of error. On success, the array stored into devices is guaranteed to have an extra allocated element set to NULL but not included in the return count, to make iteration easier. The caller is responsible for calling virNodeDeviceFree() on each array element, then calling free() on devices.| Object | Permission | Condition |
|---|---|---|
| connect | search-node-devices | - |
| Object | Permission |
|---|---|
| node-device | getattr |
virConnectNodeDeviceEventDeregisterAny¶int virConnectNodeDeviceEventDeregisterAny (virConnectPtr conn, int callbackID)
Removes an event callback. The callbackID parameter should be the value obtained from a previous virConnectNodeDeviceEventRegisterAny() method.
virConnectNodeDeviceEventGenericCallback¶typedef void (*virConnectNodeDeviceEventGenericCallback) (virConnectPtr conn, virNodeDevicePtr dev, void * opaque)
A generic node device event callback handler, for use with virConnectNodeDeviceEventRegisterAny(). Specific events usually have a customization with extra parameters, often with opaque being passed in a different parameter position; use VIR_NODE_DEVICE_EVENT_CALLBACK() when registering an appropriate handler.
virConnectNodeDeviceEventLifecycleCallback¶typedef void (*virConnectNodeDeviceEventLifecycleCallback) (virConnectPtr conn, virNodeDevicePtr dev, int event, int detail, void * opaque)
This callback is called when a node device lifecycle action is performed, like added or removed.
The callback signature to use when registering for an event of type VIR_NODE_DEVICE_EVENT_ID_LIFECYCLE with virConnectNodeDeviceEventRegisterAny()
virConnectNodeDeviceEventRegisterAny¶int virConnectNodeDeviceEventRegisterAny (virConnectPtr conn, virNodeDevicePtr dev, int eventID, virConnectNodeDeviceEventGenericCallback cb, void * opaque, virFreeCallback freecb)
Adds a callback to receive notifications of arbitrary node device events occurring on a node device. This function requires that an event loop has been previously registered with virEventRegisterImpl() or virEventRegisterDefaultImpl().
If dev is NULL, then events will be monitored for any node device. If dev is non-NULL, then only the specific node device will be monitored.
Most types of events have a callback providing a custom set of parameters for the event. When registering an event, it is thus necessary to use the VIR_NODE_DEVICE_EVENT_CALLBACK() macro to cast the supplied function pointer to match the signature of this method.
The virNodeDevicePtr object handle passed into the callback upon delivery of an event is only valid for the duration of execution of the callback. If the callback wishes to keep the node device object after the callback returns, it shall take a reference to it, by calling virNodeDeviceRef(). The reference can be released once the object is no longer required by calling virNodeDeviceFree().
The return value from this method is a positive integer identifier for the callback. To unregister a callback, this callback ID should be passed to the virConnectNodeDeviceEventDeregisterAny() method.
| Object | Permission | Condition |
|---|---|---|
| connect | search-node-devices | - |
| Object | Permission |
|---|---|
| node-device | getattr |
virNodeDeviceCreate¶int virNodeDeviceCreate (virNodeDevicePtr dev, unsigned int flags)
Start a defined node device:
| Object | Permission | Condition |
|---|---|---|
| node-device | start | - |
virNodeDeviceCreateXML¶virNodeDevicePtr virNodeDeviceCreateXML (virConnectPtr conn, const char * xmlDesc, unsigned int flags)
Create a new device on the VM host machine, for example, virtual HBAs created using vport_create.
virNodeDeviceFree should be used to free the resources after the node device object is no longer needed.
| Object | Permission | Condition |
|---|---|---|
| node-device | write | - |
| node-device | start | - |
virNodeDeviceDefineXML¶virNodeDevicePtr virNodeDeviceDefineXML (virConnectPtr conn, const char * xmlDesc, unsigned int flags)
Define a new inactive persistent device or modify an existing persistent one from the XML description on the VM host machine, for example, a mediated device.
virNodeDeviceFree should be used to free the resources after the node device object is no longer needed.
| Object | Permission | Condition |
|---|---|---|
| node-device | write | - |
| node-device | save | - |
virNodeDeviceDestroy¶int virNodeDeviceDestroy (virNodeDevicePtr dev)
Destroy the device object. The virtual device (only works for vHBA currently) is removed from the host operating system. This function may require privileged access.
| Object | Permission | Condition |
|---|---|---|
| node-device | stop | - |
virNodeDeviceDetachFlags¶int virNodeDeviceDetachFlags (virNodeDevicePtr dev, const char * driverName, unsigned int flags)
Detach the node device from the node itself so that it may be assigned to a guest domain.
Depending on the hypervisor, this may involve operations such as unbinding any device drivers from the device, binding the device to a dummy device driver and resetting the device. Different backend drivers expect the device to be bound to different dummy devices. For example, QEMU's "kvm" backend driver (the default) expects the device to be bound to "pci-stub", but its "vfio" backend driver expects the device to be bound to "vfio-pci".
If the device is currently in use by the node, this method may fail.
Once the device is not assigned to any guest, it may be re-attached to the node using the virNodeDeviceReAttach() method.
| Object | Permission | Condition |
|---|---|---|
| node-device | detach | - |
virNodeDeviceDettach¶int virNodeDeviceDettach (virNodeDevicePtr dev)
Detach the node device from the node itself so that it may be assigned to a guest domain.
Depending on the hypervisor, this may involve operations such as unbinding any device drivers from the device, binding the device to a dummy device driver and resetting the device.
If the device is currently in use by the node, this method may fail.
Once the device is not assigned to any guest, it may be re-attached to the node using the virNodeDeviceReattach() method.
If the caller needs control over which backend driver will be used during PCI device assignment (to use something other than the default, for example VFIO), the newer virNodeDeviceDetachFlags() API should be used instead.
| Object | Permission | Condition |
|---|---|---|
| node-device | detach | - |
virNodeDeviceFree¶int virNodeDeviceFree (virNodeDevicePtr dev)
Drops a reference to the node device, freeing it if this was the last reference.
virNodeDeviceGetAutostart¶int virNodeDeviceGetAutostart (virNodeDevicePtr dev, int * autostart)
Provides a boolean value indicating whether the node device is configured to be automatically started when the host machine boots or the parent device becomes available.
| Object | Permission | Condition |
|---|---|---|
| node-device | read | - |
virNodeDeviceGetName¶const char * virNodeDeviceGetName (virNodeDevicePtr dev)
Just return the device name
virNodeDeviceGetParent¶const char * virNodeDeviceGetParent (virNodeDevicePtr dev)
Accessor for the parent of the device
| Object | Permission | Condition |
|---|---|---|
| node-device | read | - |
virNodeDeviceGetXMLDesc¶char * virNodeDeviceGetXMLDesc (virNodeDevicePtr dev, unsigned int flags)
Fetch an XML document describing all aspects of the device.
| Object | Permission | Condition |
|---|---|---|
| node-device | read | - |
virNodeDeviceIsActive¶int virNodeDeviceIsActive (virNodeDevicePtr dev)
Determine if the node device is currently active
| Object | Permission | Condition |
|---|---|---|
| node-device | read | - |
virNodeDeviceIsPersistent¶int virNodeDeviceIsPersistent (virNodeDevicePtr dev)
Determine if the node device has a persistent configuration which means it will still exist after shutting down
| Object | Permission | Condition |
|---|---|---|
| node-device | read | - |
virNodeDeviceListCaps¶int virNodeDeviceListCaps (virNodeDevicePtr dev, char ** const names, int maxnames)
Lists the names of the capabilities supported by the device.
namesnames or -1 in case of error.| Object | Permission | Condition |
|---|---|---|
| node-device | read | - |
virNodeDeviceLookupByName¶virNodeDevicePtr virNodeDeviceLookupByName (virConnectPtr conn, const char * name)
Lookup a node device by its name.
virNodeDeviceFree should be used to free the resources after the node device object is no longer needed.
| Object | Permission | Condition |
|---|---|---|
| node-device | getattr | - |
virNodeDeviceLookupSCSIHostByWWN¶virNodeDevicePtr virNodeDeviceLookupSCSIHostByWWN (virConnectPtr conn, const char * wwnn, const char * wwpn, unsigned int flags)
Lookup SCSI Host which is capable with 'fc_host' by its WWNN and WWPN.
virNodeDeviceFree should be used to free the resources after the node device object is no longer needed.
| Object | Permission | Condition |
|---|---|---|
| node-device | getattr | - |
virNodeDeviceNumOfCaps¶int virNodeDeviceNumOfCaps (virNodeDevicePtr dev)
Accessor for the number of capabilities supported by the device.
| Object | Permission | Condition |
|---|---|---|
| node-device | read | - |
virNodeDeviceReAttach¶int virNodeDeviceReAttach (virNodeDevicePtr dev)
Re-attach a previously detached node device to the node so that it may be used by the node again.
Depending on the hypervisor, this may involve operations such as resetting the device, unbinding it from a dummy device driver and binding it to its appropriate driver.
If the device is currently in use by a guest, this method may fail.
| Object | Permission | Condition |
|---|---|---|
| node-device | detach | - |
virNodeDeviceRef¶int virNodeDeviceRef (virNodeDevicePtr dev)
Increment the reference count on the dev. For each additional call to this method, there shall be a corresponding call to virNodeDeviceFree to release the reference count, once the caller no longer needs the reference to this object.
This method is typically useful for applications where multiple threads are using a connection, and it is required that the connection remain open until all threads have finished using it. ie, each new thread using a dev would increment the reference count.
virNodeDeviceReset¶int virNodeDeviceReset (virNodeDevicePtr dev)
Reset a previously detached node device to the node before or after assigning it to a guest.
The exact reset semantics depends on the hypervisor and device type but, for example, KVM will attempt to reset PCI devices with a Function Level Reset, Secondary Bus Reset or a Power Management D-State reset.
If the reset will affect other devices which are currently in use, this function may fail.
| Object | Permission | Condition |
|---|---|---|
| node-device | detach | - |
virNodeDeviceSetAutostart¶int virNodeDeviceSetAutostart (virNodeDevicePtr dev, int autostart)
Configure the node device to be automatically started when the host machine boots or the parent device becomes available.
| Object | Permission | Condition |
|---|---|---|
| node-device | write | - |
virNodeDeviceUndefine¶int virNodeDeviceUndefine (virNodeDevicePtr dev, unsigned int flags)
Undefine the device object. The virtual device is removed from the host operating system. This function may require privileged access.
| Object | Permission | Condition |
|---|---|---|
| node-device | delete | - |
virNodeDeviceUpdate¶int virNodeDeviceUpdate (virNodeDevicePtr dev, const char * xmlDesc, unsigned int flags)
Update the definition of an existing node device, either its live running configuration, its persistent configuration, or both.
| Object | Permission | Condition |
|---|---|---|
| node-device | write | - |
| node-device | save | !VIR_NODE_DEVICE_UPDATE_AFFECT_CONFIG|VIR_NODE_DEVICE_UPDATE_AFFECT_LIVE |
| node-device | save | VIR_NODE_DEVICE_UPDATE_AFFECT_CONFIG |
virNodeListDevices¶int virNodeListDevices (virConnectPtr conn, const char * cap, char ** const names, int maxnames, unsigned int flags)
Collect the list of node devices, and store their names in names
The use of this function is discouraged. Instead, use virConnectListAllNodeDevices().
If the optional 'cap' argument is non-NULL, then the count will be restricted to devices with the specified capability
names| Object | Permission | Condition |
|---|---|---|
| connect | search-node-devices | - |
| Object | Permission |
|---|---|
| node-device | getattr |
virNodeNumOfDevices¶int virNodeNumOfDevices (virConnectPtr conn, const char * cap, unsigned int flags)
Provides the number of node devices.
If the optional 'cap' argument is non-NULL, then the count will be restricted to devices with the specified capability
| Object | Permission | Condition |
|---|---|---|
| connect | search-node-devices | - |
| Object | Permission |
|---|---|
| node-device | getattr |