LxdClient class

Manages a connection to the lxd server.

Constructors

LxdClient({String userAgent = 'lxd.dart', String? socketPath})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

userAgent ← String?

Sets the user agent sent in requests to lxd.

no getter

Methods

cancelOperation(String id) → Future<void>

Cancel the operation with id.

close() → void

Terminates all active connections. If a client remains unclosed, the Dart process may not terminate.

createInstance({String? architecture, String? description, String? name, required LxdRemoteImage image}) → Future<LxdOperation>

Creates a new instance from image.

deleteInstance(String name) → Future<LxdOperation>

Deletes the instance with name.

findRemoteImage(String url, String name) → Future<LxdRemoteImage?>

Finds the image with name (alias or fingeprint) on the Simplestreams server at url.

getCertificate(String fingerprint) → Future<LxdCertificate>

Gets information on a certificate with fingerprint.

getCertificates() → Future<List<String>>

Gets the fingerprints of the certificates provided by the LXD server.

getImage(String fingerprint) → Future<LxdImage>

Gets information on an image with fingerprint.

getImages({String? project, String? filter}) → Future<List<String>>

Gets the fingerprints of the images provided by the LXD server.

getInstance(String name) → Future<LxdInstance>

Gets information on the instance with name.

getInstances() → Future<List<String>>

Gets the names of the instances provided by the LXD server.

getInstanceState(String name) → Future<LxdInstanceState>

Gets runtime state of the instance with name.

getNetwork(String name) → Future<LxdNetwork>

Gets information on the network with name.

getNetworkAcl(String name) → Future<LxdNetworkAcl>

Gets information on the network ACL with name.

getNetworkAcls() → Future<List<String>>

Gets the names of the network ACLs provided by the LXD server.

getNetworkLeases(String name) → Future<List<LxdNetworkLease>>

Gets DHCP leases on the network with name.

getNetworks() → Future<List<String>>

Gets the names of the networks provided by the LXD server.

getNetworkState(String name) → Future<LxdNetworkState>

Gets the current network state of the network with name.

getOperation(String id) → Future<LxdOperation>

Get the current state of the operation with id.

getOperations() → Future<Map<String, List<String>>>

Get the operations in progress (keyed by type).

getProfile(String name) → Future<LxdProfile>

Gets information on the profile with name.

getProfiles() → Future<List<String>>

Gets the names of the profiles provided by the LXD server.

getProject(String name) → Future<LxdProject>

Gets information on the project with name.

getProjects() → Future<List<String>>

Gets the names of the projects provided by the LXD server.

getRemoteImages(String url) → Future<List<LxdRemoteImage>>

Gets the remote images available on the Simplestreams server at url.

getResources() → Future<LxdResources>

Gets system resources information.

getStoragePool(String name) → Future<LxdStoragePool>

Gets information on the pool with name.

getStoragePools() → Future<List<String>>

Gets the names of the storage pools provided by the LXD server.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

restartInstance(String name, {bool force = false}) → Future<LxdOperation>

Restarts the instance with name.

startInstance(String name, {bool force = false}) → Future<LxdOperation>

Starts the instance with name.

stopInstance(String name, {bool force = false}) → Future<LxdOperation>

Stops the instance with name.

toString() → String

A string representation of this object.

inherited

waitOperation(String id) → Future<LxdOperation>

Wait for the operation with id to complete.

Operators

operator ==(Object other) → bool

The equality operator.

inherited