Skip to content

zFCP D-Bus API #594

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
joseivanlopez merged 11 commits into from
Jun 13, 2023
Merged

zFCP D-Bus API #594

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
e427219
[service] Add classes for managing zFCP devices
joseivanlopez Jun 7, 2023
654b61f
[service] D-Bus tree for zFCP controllers
joseivanlopez Jun 7, 2023
23d3c85
[service] D-Bus tree for zFCP disks
joseivanlopez Jun 7, 2023
a305b80
[service] D-Bus interface for managing zFCP
joseivanlopez Jun 7, 2023
36e1477
[service] Changelog
joseivanlopez Jun 7, 2023
c6b7b0b
[service] Better behaviour with allow_lun_scan
joseivanlopez Jun 7, 2023
81711fc
[service] Adapt to last changes in ruby-dbus
joseivanlopez Jun 7, 2023
13e4cfc
[service] Remove deactivate controller
joseivanlopez Jun 8, 2023
803ecaf
[service] Emit signal only when object changes
joseivanlopez Jun 8, 2023
65afad8
[service] Small improvements
joseivanlopez Jun 9, 2023
baa31ba
[service] D-Bus API documentation
joseivanlopez Jun 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 54 additions & 0 deletions doc/dbus/bus/org.opensuse.Agama.Storage1.ZFCP.Controller.bus.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
<node>
<interface name="org.freedesktop.DBus.Properties">
<method name="Get">
<arg name="interface_name" direction="in" type="s"/>
<arg name="property_name" direction="in" type="s"/>
<arg name="value" direction="out" type="v"/>
</method>
<method name="Set">
<arg name="interface_name" direction="in" type="s"/>
<arg name="property_name" direction="in" type="s"/>
<arg name="val" direction="in" type="v"/>
</method>
<method name="GetAll">
<arg name="interface_name" direction="in" type="s"/>
<arg name="value" direction="out" type="a{sv}"/>
</method>
<signal name="PropertiesChanged">
<arg name="interface" type="s"/>
<arg name="changed_properties" type="a{sv}"/>
<arg name="invalidated_properties" type="as"/>
</signal>
</interface>
<interface name="org.freedesktop.DBus.Introspectable">
<method name="Introspect">
<arg name="xml_data" direction="out" type="s"/>
</method>
</interface>
<interface name="org.opensuse.Agama.Storage1.ZFCP.Controller">
<method name="GetWWPNs">
<arg name="result" direction="out" type="as"/>
</method>
<method name="GetLUNs">
<arg name="wwpn" direction="in" type="s"/>
<arg name="result" direction="out" type="as"/>
</method>
<method name="Activate">
<arg name="result" direction="out" type="u"/>
</method>
<method name="ActivateDisk">
<arg name="wwpn" direction="in" type="s"/>
<arg name="lun" direction="in" type="s"/>
<arg name="result" direction="out" type="u"/>
</method>
<method name="DeactivateDisk">
<arg name="wwpn" direction="in" type="s"/>
<arg name="lun" direction="in" type="s"/>
<arg name="result" direction="out" type="u"/>
</method>
<property type="b" name="Active" access="read"/>
<property type="s" name="Channel" access="read"/>
</interface>
</node>
36 changes: 36 additions & 0 deletions doc/dbus/bus/org.opensuse.Agama.Storage1.ZFCP.Disk.bus.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
<node>
<interface name="org.freedesktop.DBus.Properties">
<method name="Get">
<arg name="interface_name" direction="in" type="s"/>
<arg name="property_name" direction="in" type="s"/>
<arg name="value" direction="out" type="v"/>
</method>
<method name="Set">
<arg name="interface_name" direction="in" type="s"/>
<arg name="property_name" direction="in" type="s"/>
<arg name="val" direction="in" type="v"/>
</method>
<method name="GetAll">
<arg name="interface_name" direction="in" type="s"/>
<arg name="value" direction="out" type="a{sv}"/>
</method>
<signal name="PropertiesChanged">
<arg name="interface" type="s"/>
<arg name="changed_properties" type="a{sv}"/>
<arg name="invalidated_properties" type="as"/>
</signal>
</interface>
<interface name="org.freedesktop.DBus.Introspectable">
<method name="Introspect">
<arg name="xml_data" direction="out" type="s"/>
</method>
</interface>
<interface name="org.opensuse.Agama.Storage1.ZFCP.Disk">
<property type="s" name="Name" access="read"/>
<property type="s" name="Channel" access="read"/>
<property type="s" name="WWPN" access="read"/>
<property type="s" name="LUN" access="read"/>
</interface>
</node>
35 changes: 30 additions & 5 deletions doc/dbus/bus/org.opensuse.Agama.Storage1.bus.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,9 @@
<arg name="interfaces" type="as"/>
</signal>
</interface>
<interface name="org.opensuse.Agama1.Issues">
<property type="a(ssuu)" name="All" access="read"/>
</interface>
<interface name="org.opensuse.Agama1.Progress">
<property type="u" name="TotalSteps" access="read"/>
<property type="(us)" name="CurrentStep" access="read"/>
Expand All @@ -49,10 +52,6 @@
<property type="aa{sv}" name="All" access="read"/>
<property type="u" name="Current" access="read"/>
</interface>
<interface name="org.opensuse.Agama1.Validation">
<property type="as" name="Errors" access="read"/>
<property type="b" name="Valid" access="read"/>
</interface>
<interface name="org.opensuse.Agama.Storage1">
<method name="Probe">
</method>
Expand All @@ -67,7 +66,7 @@
<arg name="settings" direction="in" type="a{sv}"/>
<arg name="result" direction="out" type="u"/>
</method>
<property type="a(ssa{sv})" name="AvailableDevices" access="read"/>
<property type="ao" name="AvailableDevices" access="read"/>
<property type="aa{sv}" name="VolumeTemplates" access="read"/>
<property type="o" name="Result" access="read"/>
</interface>
Expand All @@ -85,4 +84,30 @@
<property type="s" name="InitiatorName" access="readwrite"/>
<property type="b" name="IBFT" access="read"/>
</interface>
<interface name="org.opensuse.Agama.Storage1.DASD.Manager">
<method name="Probe">
</method>
<method name="Enable">
<arg name="devices" direction="in" type="ao"/>
<arg name="result" direction="out" type="u"/>
</method>
<method name="Disable">
<arg name="devices" direction="in" type="ao"/>
<arg name="result" direction="out" type="u"/>
</method>
<method name="SetDiag">
<arg name="devices" direction="in" type="ao"/>
<arg name="diag" direction="in" type="b"/>
<arg name="result" direction="out" type="u"/>
</method>
<method name="Format">
<arg name="devices" direction="in" type="ao"/>
<arg name="result" direction="out" type="u"/>
<arg name="job" direction="out" type="o"/>
</method>
</interface>
<interface name="org.opensuse.Agama.Storage1.ZFCP.Manager">
<method name="Probe">
</method>
</interface>
</node>
87 changes: 87 additions & 0 deletions doc/dbus/org.opensuse.Agama.Storage1.ZFCP.Controller.doc.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
<node>
<!--
Interface for managing a zFCP controller, see
https://www.ibm.com/docs/en/linux-on-systems?topic=cd-manually-configured-fcp-luns-1
-->
<interface name="org.opensuse.Agama.Storage1.ZFCP.Controller">
<!--
Gets the list of WWPNs (World Wide Port Name)
-->
<method name="GetWWPNs">
<!--
E.g., 0x500507630300c562 0x500507630300c563
-->
<arg name="result" direction="out" type="as"/>
</method>
<!--
Gets the list of LUNs (Local Unit Number)
-->
<method name="GetLUNs">
<!--
E.g., 0x500507630300c562
-->
<arg name="wwpn" direction="in" type="s"/>
<!--
E.g., 0x4010403300000000 0x4010403300000001 0x4010403300000002
-->
<arg name="result" direction="out" type="as"/>
</method>
<!--
Activates the zFCP controller.

If allow_lun_scan is active, then all LUNs are automatically activated.
-->
<method name="Activate">
<!--
Exit code of the chzdev command.
-->
<arg name="result" direction="out" type="u"/>
</method>
<!--
Activates a zFCP disk.
-->
<method name="ActivateDisk">
<!--
E.g., 0x500507630300c562
-->
<arg name="wwpn" direction="in" type="s"/>
<!--
E.g., 0x4010403300000000
-->
<arg name="lun" direction="in" type="s"/>
<!--
Exit code of the chzdev command.
-->
<arg name="result" direction="out" type="u"/>
</method>
<!--
Deactivates a zFCP disk.

If "allow_lun_scan" is active, then the disk cannot be deactivated.
-->
<method name="DeactivateDisk">
<!--
E.g., 0x500507630300c562
-->
<arg name="wwpn" direction="in" type="s"/>
<!--
E.g., 0x4010403300000000
-->
<arg name="lun" direction="in" type="s"/>
<!--
Exit code of the chzdev command.
-->
<arg name="result" direction="out" type="u"/>
</method>
<!--
Whether the controller is active.
-->
<property type="b" name="Active" access="read"/>
<!--
zFCP channel id (e.g., 0.0.fa00).
-->
<property type="s" name="Channel" access="read"/>
</interface>
</node>
25 changes: 25 additions & 0 deletions doc/dbus/org.opensuse.Agama.Storage1.ZFCP.Disk.doc.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
<node>
<!--
Interface for a zFCP disk
-->
<interface name="org.opensuse.Agama.Storage1.ZFCP.Disk">
<!--
Name of the SCSI device (e.g., /dev/sda)
-->
<property type="s" name="Name" access="read"/>
<!--
zFCP controller channel id (e.g., 0.0.fa00).
-->
<property type="s" name="Channel" access="read"/>
<!--
WWPN of the targer port (e.g., 0x500507630300c562)
-->
<property type="s" name="WWPN" access="read"/>
<!--
LUN of the SCSI device (e.g. 0x4010403300000000)
-->
<property type="s" name="LUN" access="read"/>
</interface>
</node>
30 changes: 30 additions & 0 deletions doc/dbus/org.opensuse.Agama.Storage1.doc.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
<node name="/org/opensuse/Agama/Storage1">
<interface name="org.opensuse.Agama.Storage1">
<method name="Probe">
</method>
<method name="Install">
</method>
<method name="Finish">
</method>
<!--
Whether the system is in a deprecated status.

The system is usually set as deprecated as effect of managing some kind of devices, for
example, when iSCSI sessions are created or when a zFCP disk is activated.

A deprecated system means that the probed system could not match with the current system.

It is expected that clients probe devices again if the system is deprecated.
-->
<property type="b" name="DeprecatedSystem" access="read"/>
</interface>
<interface name="org.opensuse.Agama.Storage1.ZFCP.Manager">
<!--
Probes the zFCP controllers and disks.
-->
<method name="Probe">
</method>
</interface>
</node>
Loading