# mdevctl list -d
783e6dbb-ea0e-411f-94e2-717eaad438bf matrix vfio_ap-passthrough manual

# mdevctl modify -u 783e6dbb-ea0e-411f-94e2-717eaad438bf --addattr=assign_adapter --value=5
# mdevctl modify -u 783e6dbb-ea0e-411f-94e2-717eaad438bf --addattr=assign_adapter --value=6
# mdevctl modify -u 783e6dbb-ea0e-411f-94e2-717eaad438bf --addattr=assign_domain --value=0xab
# mdevctl modify -u 783e6dbb-ea0e-411f-94e2-717eaad438bf --addattr=assign_control_domain --value=0xab
# mdevctl modify -u 783e6dbb-ea0e-411f-94e2-717eaad438bf --addattr=assign_domain --value=4
# mdevctl modify -u 783e6dbb-ea0e-411f-94e2-717eaad438bf --addattr=assign_control_domain --value=4
# mdevctl list -dv
783e6dbb-ea0e-411f-94e2-717eaad438bf matrix vfio_ap-passthrough manual
  Attrs:
    @{0}: {"assign_adapter":"5"}
    @{1}: {"assign_adapter":"6"}
    @{2}: {"assign_domain":"0xab"}
    @{3}: {"assign_control_domain":"0xab"}
    @{4}: {"assign_domain":"4"}
    @{5}: {"assign_control_domain":"4"}

# mdevctl list -d -u 783e6dbb-ea0e-411f-94e2-717eaad438bf --dumpjson
{
  "mdev_type": "vfio_ap-passthrough",
  "start": "manual",
  "attrs": [
    {
      "assign_adapter": "5"
    },
    {
      "assign_adapter": "6"
    },
    {
      "assign_domain": "0xab"
    },
    {
      "assign_control_domain": "0xab"
    },
    {
      "assign_domain": "4"
    },
    {
      "assign_control_domain": "4"
    }
  ]
}

# mdevctl modify -u 783e6dbb-ea0e-411f-94e2-717eaad438bf --delattr --index=5
# mdevctl modify -u 783e6dbb-ea0e-411f-94e2-717eaad438bf --delattr --index=4
# mdevctl list -dv
783e6dbb-ea0e-411f-94e2-717eaad438bf matrix vfio_ap-passthrough manual
  Attrs:
    @{0}: {"assign_adapter":"5"}
    @{1}: {"assign_adapter":"6"}
    @{2}: {"assign_domain":"0xab"}
    @{3}: {"assign_control_domain":"0xab"}

# cat vfio_ap_device.json
{
  "mdev_type": "vfio_ap-passthrough",
  "start": "manual",
  "attrs": [
    {
      "assign_adapter": "5"
    },
    {
      "assign_domain": "0x47"
    },
    {
      "assign_domain": "0xff"
    }
  ]
}
# mdevctl define -p matrix --jsonfile vfio_ap_device.json
e2e73122-cc39-40ee-89eb-b0a47d334cae
# mdevctl list -dv
783e6dbb-ea0e-411f-94e2-717eaad438bf matrix vfio_ap-passthrough manual
  Attrs:
    @{0}: {"assign_adapter":"5"}
    @{1}: {"assign_adapter":"6"}
    @{2}: {"assign_domain":"0xab"}
    @{3}: {"assign_control_domain":"0xab"}
e2e73122-cc39-40ee-89eb-b0a47d334cae matrix vfio_ap-passthrough manual
  Attrs:
    @{0}: {"assign_adapter":"5"}
    @{1}: {"assign_domain":"0x47"}
    @{2}: {"assign_domain":"0xff"}

If the live command line option is specified any non-zero return code results in a live modification failure except for all call-outs return with return code 2 resulting in a live update not supported information. The return code is disruptive if also the option defined is provided and will prevent the update of the defined device configuration.

A notification event will follow if the live command line option is specified.

This event is only supported for the modify command.

Any non-zero return code (exempting 2) will prevent mdevctl from performing the primary command execution and mdevctl will abort early.

A notification event will follow only if an error code (exempting 2) is observed.

This event is not supported for the list, types, or version commands.

The same script used for the pre event is used for the post event.

Any return code is non-disruptive.

A notification event will always follow a post-command call-out.

This event is not supported for the list, types, or version commands.

The same script used for the pre event is used for the get event. If the script is not designed to support a get event, then the return code is 0.

For define, a non-zero return code (exempting 2) will disrupt the define command entirely.

For list, any return code is non-disruptive.

A script must return a JSON formatted array of device attributes on standard output. Example:

[
    {
        "attribute0": "VALUE"
    },
    {
        "attribute1": "VALUE"
    }
]

If a valid versioning JSON is returned on stdout by the script and the return code is NOT 2 the script is considered a positive match for the provided device type. A script providing versioning is the primary choice for a device type when mdevctl is executing callouts or in other words if a script which supports versioning is found the script is used for every event and action for the device type. Should no versioning supporting script be found the none versioning search pattern is used.

A script is provided on standard in with a versioning JSON describing the mdevctl supported version, actions and events. Example:

{
  "provides": {
    "version": 1,
    "actions": [
      "start",
      "stop",
      "define",
      "undefine",
      "modify",
      "attributes",
      "capabilities"
    ],
    "events": [
      "pre",
      "post",
      "notify",
      "get"
    ]
  }
}

A script that wants to support versioning must return a versioning JSON on standard output. The script should list all supported actions in the actions array and all supported events in the events array. It is possible to add additional actions or events in the array but if mdevctl did not have these in the arrays in provides they are ignored. Example:

{
  "supports": {
    "version": 1,
    "actions": [
      "start",
      "stop",
      "define",
      "undefine",
      "modify",
      "attributes",
      "capabilities"
    ],
    "events": [
      "pre",
      "post",
      "notify",
      "get"
    ]
  }
}

These scripts are stored in /usr/lib/mdevctl/scripts.d/notifiers. All notification scripts will be invoked during a notification event.

A non-zero return code is ignored.

This event is not supported for the list, types, or version commands.