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 of logging, operation, or lifecycle).

• 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
certific ate-create d	A new certificate has been added to the server trust store.
certific ate-delete d	The certificate has been deleted from the trust store.
certific ate-update d	The certificate’s configuration has been updated.
``cluster- certificat e-updated` `	The certificate for the whole cluster has changed.
cluster- disabled	Clustering has been disabled for this machine.
cluster- enabled	Clustering has been enabled for this machine.
cluster- member-add ed	A new machine has joined the cluster.
cluster- member-rem oved	The cluster member has been removed from the cluster.
cluster- member-ren amed	The cluster member has been renamed.	old_name: the previous name.
cluster- member-upd ated	The cluster member’s configuration been edited.
cluster- token-crea ted	A join token for adding a cluster member has been created.
config-u pdated	The server configuration has changed.
image-al ias-create d	An alias has been created for an existing image.	target: the original instance.
image-al ias-delete d	An alias has been deleted for an existing image.	target: the original instance.
image-al ias-rename d	The alias for an existing image has been renamed.	old_name: the previous name.
image-al ias-update d	The configuration for an image alias has changed.	target: the original instance.
image-cr eated	A new image has been added to the image store.	type: container or vm.
image-de leted	The image has been deleted from the image store.
image-re freshed	The local image copy has updated to the current source image version.
image-re trieved	The raw image file has been downloaded from the server.	target: destination server.
image-se cret-creat ed	A one-time key to fetch this image has been created.
image-up dated	The image’s configuration has changed.
instance -backup-cr eated	A backup of the instance has been created.
instance -backup-de leted	The instance backup has been deleted.
instance -backup-re named	The instance backup has been renamed.	old_name: the previous name.
instance -backup-re trieved	The raw instance backup file has been downloaded.
instance -console	Connected to the console of the instance.	type: console or vga.
instance -console-r eset	The console buffer has been reset.
instance -console-r etrieved	The console log has been downloaded.
instance -created	A new instance has been created.
instance -deleted	The instance has been deleted.
instance -exec	A command has been executed on the instance.	command: the command to be executed.
instance -file-dele ted	A file on the instance has been deleted.	file: path to the file.
instance -file-push ed	The file has been pushed to the instance.	file-source: local file path. file-destination: destination file path. info: file information.
instance -file-retr ieved	The file has been downloaded from the instance.	file-source: instance file path. file-destination: destination file path.
instance -log-delet ed	The instance’s specified log file has been deleted.
instance -log-retri eved	The instance’s specified log file has been downloaded.
``instance -metadata- retrieved` `	The instance’s image metadata has been downloaded.
instance -metadata- updated	The instance’s image metadata has changed.
instance -metadata- template-c reated	A new image template file for the instance has been created.	path: relative file path.
instance -metadata- template-d eleted	The image template file for the instance has been deleted.	path: relative file path.
instance -metadata- template-r etrieved	The image template file for the instance has been downloaded.	path: relative file path.
instance -paused	The instance has been put in a paused state.
instance -renamed	The instance has been renamed.	old_name: the previous name.
``instance -restarted ``	The instance has restarted.
``instance -restored` `	The instance has been restored from a snapshot.	snapshot: name of the snapshot being restored.
instance -resumed	The instance has resumed after being paused.
``instance -shutdown` `	The instance has shut down.
instance -started	The instance has started.
instance -stopped	The instance has stopped.
instance -updated	The instance’s configuration has changed.
instance -snapshot- created	A snapshot of the instance has been created.
instance -snapshot- deleted	The instance snapshot has been deleted.
instance -snapshot- renamed	The instance snapshot has been renamed.	old_name: the previous name.
instance -snapshot- updated	The instance snapshot’s configuration has changed.
network- acl-create d	A new network acl has been created.
network- acl-delete d	The network acl has been deleted.
network- acl-rename d	The network acl has been renamed.	old_name: the previous name.
network- acl-update d	The network acl configuration has changed.
network- created	A network device has been created.
network- deleted	The network device has been deleted.
network- renamed	The network device has been renamed.	old_name: the previous name.
network- updated	The network device’s configuration has changed.
operatio n-cancelle d	The operation has been cancelled.
profile- created	A new profile has been created.
profile- deleted	The profile has been deleted.
profile- renamed	The profile has been renamed .	old_name: the previous name.
profile- updated	The profile’s configuration has changed.
project- created	A new project has been created.
project- deleted	The project has been deleted.
project- renamed	The project has been renamed.	old_name: the previous name.
project- updated	The project’s configuration has changed.
storage- pool-creat ed	A new storage pool has been created.	target: cluster member name.
storage- pool-delet ed	The storage pool has been deleted.
storage- pool-updat ed	The storage pool’s configuration has changed.	target: cluster member name.
storage- volume-bac kup-create d	A new backup for the storage volume has been created.	type: container, virtual-machine, image, or custom.
storage- volume-bac kup-delete d	The storage volume’s backup has been deleted.
storage- volume-bac kup-rename d	The storage volume’s backup has been renamed.	old_name: the previous name.
storage- volume-bac kup-retrie ved	The storage volume’s backup has been downloaded.
storage- volume-cre ated	A new storage volume has been created.	type: container, virtual-machine, image, or custom.
storage- volume-del eted	The storage volume has been deleted.
storage- volume-ren amed	The storage volume has been renamed.	old_name: the previous name.
storage- volume-res tored	The storage volume has been restored from a snapshot.	snapshot: name of the snapshot being restored.
storage- volume-upd ated	The storage volume’s configuration has changed.
storage- volume-sna pshot-crea ted	A new storage volume snapshot has been created.	type: container, virtua-machine, image, or custom.
storage- volume-sna pshot-dele ted	The storage volume’s snapshot has been deleted.
storage- volume-sna pshot-rena med	The storage volume’s snapshot has been renamed.	old_name: the previous name.
storage- volume-sna pshot-upda ted	The configuration for the storage volume’s snapshot has changed.
warning- acknowledg ed	The warning’s status has been set to “acknowledged”.
warning- deleted	The warning has been deleted.
warning- reset	The warning’s status has been set to “new”.