Events#
Introduction#
Events are messages about actions that have occurred over LXD. Using the API endpoint /1.0/events
directly or via
lxc monitor
will connect to a WebSocket through which logs and lifecycle messages will be streamed.
Event types#
LXD Currently supports three event types.
Logging: Shows all logging messages regardless of the server logging level.
Operation: Shows all ongoing operations from creation to completion (including updates to their state and progress metadata).
Lifecycle: Shows an audit trail for specific actions occurring over LXD.
Event structure#
Example:#
location: cluster_name
metadata:
action: network-updated
requestor:
protocol: unix
username: root
source: /1.0/networks/lxdbr0
timestamp: "2021-03-14T00:00:00Z"
type: lifecycle
location
: The cluster member name (if clustered).timestamp
: Time that the event occurred in RFC3339 format.type
: The type of event this is (one oflogging
,operation
, orlifecycle
).metadata
: Information about the specific event type.
Logging event structure#
message
: The log message.level
: The log-level of the log.context
: Additional information included in the event.
Operation event structure#
id
: The UUID of the operation.class
: The type of operation (task, token, or websocket).description
: A description of the operation.created_at
: The operation’s creation date.updated_at
: The operation’s date of last change.status
: The current state of the operation.status_code
: The operation status code.resources
: Resources affected by this operation.metadata
: Operation specific metadata.may_cancel
: Whether the operation may be cancelled.err
: Error message of the operation.location
: The cluster member name (if clustered).
Lifecycle event structure#
action
: The lifecycle action that occurred.requestor
: Information about who is making the request (if applicable).source
: Path to what is being acted upon.context
: Additional information included in the event.
Supported lifecycle events#
Name |
Description |
Additional Information |
---|---|---|
|
A new certificate has been added to the server trust store. |
|
|
The certificate has been deleted from the trust store. |
|
|
The certificate’s configuration has been updated. |
|
|
The certificate for the whole cluster has changed. |
|
|
Clustering has been disabled for this machine. |
|
|
Clustering has been enabled for this machine. |
|
|
A new machine has joined the cluster. |
|
|
The cluster member has been removed from the cluster. |
|
|
The cluster member has been renamed. |
|
|
The cluster member’s configuration been edited. |
|
|
A join token for adding a cluster member has been created. |
|
|
The server configuration has changed. |
|
|
An alias has been created for an existing image. |
|
|
An alias has been deleted for an existing image. |
|
|
The alias for an existing image has been renamed. |
|
|
The configuration for an image alias has changed. |
|
|
A new image has been added to the image store. |
|
|
The image has been deleted from the image store. |
|
|
The local image copy has updated to the current source image version. |
|
|
The raw image file has been downloaded from the server. |
|
|
A one-time key to fetch this image has been created. |
|
|
The image’s configuration has changed. |
|
|
A backup of the instance has been created. |
|
|
The instance backup has been deleted. |
|
|
The instance backup has been renamed. |
|
|
The raw instance backup file has been downloaded. |
|
|
Connected to the console of the instance. |
|
|
The console buffer has been reset. |
|
|
The console log has been downloaded. |
|
|
A new instance has been created. |
|
|
The instance has been deleted. |
|
|
A command has been executed on the instance. |
|
|
A file on the instance has been deleted. |
|
|
The file has been pushed to the instance. |
|
|
The file has been downloaded from the instance. |
|
|
The instance’s specified log file has been deleted. |
|
|
The instance’s specified log file has been downloaded. |
|
|
The instance’s image metadata has been downloaded. |
|
|
The instance’s image metadata has changed. |
|
|
A new image template file for the instance has been created. |
|
|
The image template file for the instance has been deleted. |
|
|
The image template file for the instance has been downloaded. |
|
|
The instance has been put in a paused state. |
|
|
The instance has been renamed. |
|
|
The instance has restarted. |
|
|
The instance has been restored from a snapshot. |
|
|
The instance has resumed after being paused. |
|
|
The instance has shut down. |
|
|
The instance has started. |
|
|
The instance has stopped. |
|
|
The instance’s configuration has changed. |
|
|
A snapshot of the instance has been created. |
|
|
The instance snapshot has been deleted. |
|
|
The instance snapshot has been renamed. |
|
|
The instance snapshot’s configuration has changed. |
|
|
A network device has been created. |
|
|
The network device has been deleted. |
|
|
The network device has been renamed. |
|
|
The network device’s configuration has changed. |
|
|
The operation has been cancelled. |
|
|
A new profile has been created. |
|
|
The profile has been deleted. |
|
|
The profile has been renamed . |
|
|
The profile’s configuration has changed. |
|
|
A new project has been created. |
|
|
The project has been deleted. |
|
|
The project has been renamed. |
|
|
The project’s configuration has changed. |
|
|
A new storage pool has been created. |
|
|
The storage pool has been deleted. |
|
|
The storage pool’s configuration has changed. |
|
|
A new storage volume has been created. |
|
|
The storage volume has been deleted. |
|
|
The storage volume has been renamed. |
|
|
The storage volume has been restored from a snapshot. |
|
|
The storage volume’s configuration has changed. |
|
|
A new storage volume snapshot has been created. |
|
|
The storage volume’s snapshot has been deleted. |
|
|
The storage volume’s snapshot has been renamed. |
|
|
The configuration for the storage volume’s snapshot has changed. |