From 78e9bb837c258ac0ec7712b3d612cc2f407e731e Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Wed, 12 Jun 2024 05:50:42 +0200 Subject: Merging upstream version 256. Signed-off-by: Daniel Baumann --- man/org.freedesktop.machine1.xml | 57 ++++++++++++++++++++++++++++++++-------- 1 file changed, 46 insertions(+), 11 deletions(-) (limited to 'man/org.freedesktop.machine1.xml') diff --git a/man/org.freedesktop.machine1.xml b/man/org.freedesktop.machine1.xml index 1af77e0..8abef00 100644 --- a/man/org.freedesktop.machine1.xml +++ b/man/org.freedesktop.machine1.xml @@ -1,6 +1,6 @@ + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" > - - @@ -232,6 +233,8 @@ node /org/freedesktop/machine1 { + + @@ -284,9 +287,9 @@ node /org/freedesktop/machine1 { - + - + @@ -344,7 +347,7 @@ node /org/freedesktop/machine1 { unit for the calling client (utilizing the passed scope_properties) and move the leader PID into it. The method returns an object path for the registered machine object that implements the org.freedesktop.machine1.Machine interface (see below). Also see the - New Control Group + New Control Group Interfaces for details about scope units and how to alter resource control settings on the created machine at runtime. @@ -380,6 +383,10 @@ node /org/freedesktop/machine1 { AF_INET6) and a byte array containing the addresses. This is only supported for containers that make use of network namespacing. + GetMachineSSHInfo() retrieves the SSH information of a machine. This method + returns two strings, the SSH address which can be used to tell SSH where to connect, and the path + to the SSH private key required for the connection to succeed. + GetMachineOSRelease() retrieves the OS release information of a container. This method returns an array of key value pairs read from the os-release5 file in @@ -411,7 +418,7 @@ node /org/freedesktop/machine1 { host as arguments. CopyToMachine() does the opposite and copies files from a source directory on the host into a destination directory in the container. - CopyFromMachineWithFlags() and CopyToMachineWithFlags do the same but take an additional flags argument. + CopyFromMachineWithFlags() and CopyToMachineWithFlags() do the same but take an additional flags argument. RemoveImage() removes the image with the specified name. @@ -434,7 +441,7 @@ node /org/freedesktop/machine1 { Signals - MachineNew and MachineRemoved are sent whenever a new + MachineNew() and MachineRemoved() are sent whenever a new machine is registered or removed. These signals carry the machine name and the object path to the corresponding org.freedesktop.machine1.Machine interface (see below). @@ -461,6 +468,8 @@ node /org/freedesktop/machine1/machine/rawhide { Kill(in s who, in i signal); GetAddresses(out a(iay) addresses); + GetSSHInfo(out s ssh_address, + out s ssh_private_key_path); GetOSRelease(out a{ss} fields); GetUIDShift(out u shift); OpenPTY(out h pty, @@ -509,6 +518,12 @@ node /org/freedesktop/machine1/machine/rawhide { readonly s RootDirectory = '...'; @org.freedesktop.DBus.Property.EmitsChangedSignal("const") readonly ai NetworkInterfaces = [...]; + @org.freedesktop.DBus.Property.EmitsChangedSignal("const") + readonly u VSockCID = ...; + @org.freedesktop.DBus.Property.EmitsChangedSignal("const") + readonly s SSHAddress = '...'; + @org.freedesktop.DBus.Property.EmitsChangedSignal("const") + readonly s SSHPrivateKeyPath = '...'; @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly s State = '...'; }; @@ -550,6 +565,8 @@ node /org/freedesktop/machine1/machine/rawhide { + + @@ -592,6 +609,12 @@ node /org/freedesktop/machine1/machine/rawhide { + + + + + + @@ -603,9 +626,9 @@ node /org/freedesktop/machine1/machine/rawhide { take the same arguments as TerminateMachine() and KillMachine() on the Manager interface, respectively. - GetAddresses() and GetOSRelease() get the IP address and OS - release information from the machine. These methods take the same arguments as - GetMachineAddresses() and GetMachineOSRelease() of the + GetAddresses(), GetSSHInfo() and GetOSRelease() get the IP address, + SSH connection and OS release information from the machine. These methods take the same arguments as + GetMachineAddresses(), GetMachineSSHInfo() and GetMachineOSRelease() of the Manager interface, respectively. @@ -638,6 +661,15 @@ node /org/freedesktop/machine1/machine/rawhide { towards the container, the VM or the host. For details about this information see the description of CreateMachineWithNetwork() above. + VSockCID is the VSOCK CID of the VM if it is known, or + VMADDR_CID_ANY otherwise. + + SSHAddress is the address of the VM in a format ssh can understand + if it is known or the empty string. + + SSHPrivateKeyPath is the path to the SSH private key of the VM if it is known + or the empty string. + State is the state of the machine and is one of opening, running, or closing. Note that the state machine is not considered part of the API and states might be removed or added without this being considered API breakage. @@ -677,11 +709,14 @@ $ gdbus introspect --system \ The Manager Object CopyFromMachineWithFlags() and CopyToMachineWithFlags() were added in version 252. + GetMachineSSHInfo() was added in version 256. Machine Objects CopyFromWithFlags() and CopyToWithFlags() were added in version 252. + GetSSHInfo(), VSockCID, SSHAddress + and SSHPrivateKeyPath were added in version 256. -- cgit v1.2.3