openMediaVault

https://docs.openmediavault.org/en/8.x/
Admin
openMediaVault is a complete network attached storage (NAS) solution based on Debian Linux with a...
Tokens:29,985
Snippets:446
Trust Score:9.7
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install a Package

Source: https://docs.openmediavault.org/en/8.x/various/apt.html

Use this command to install a specific package from the configured APT repositories.

```bash
$ apt-get install <packagename>
```

--------------------------------

### Install openmediavault Package

Source: https://docs.openmediavault.org/en/8.x/installation/on_debian.html

Installs the openmediavault package and its dependencies on a Debian system. Ensure LANG, DEBIAN_FRONTEND, and APT_LISTCHANGES_FRONTEND are set for non-interactive installation.

```bash
export LANG=C.UTF-8
export DEBIAN_FRONTEND=noninteractive
export APT_LISTCHANGES_FRONTEND=none
apt-get update
apt-get --yes --auto-remove --show-upgraded \
    --allow-downgrades --allow-change-held-packages \
    --no-install-recommends \
    --option DPkg::Options::="--force-confdef" \
    --option DPkg::Options::="--force-confold" \
    install openmediavault

```

--------------------------------

### Install OpenMediaVault Keyring

Source: https://docs.openmediavault.org/en/8.x/installation/on_debian.html

Installs gnupg and downloads the OpenMediaVault archive key, saving it to the system's keyring for package verification.

```bash
apt-get install --yes gnupg
wget --quiet --output-document=- https://packages.openmediavault.io/archive.key | gpg --dearmor --yes --output "/usr/share/keyrings/openmediavault-archive-keyring.gpg"
```

--------------------------------

### Install and Configure systemd-resolved

Source: https://docs.openmediavault.org/en/8.x/installation/on_debian.html

Installs and enables systemd-resolved, then configures DNS servers. This is a temporary configuration that needs to be made permanent after OpenMediaVault installation using 'omv-firstaid'.

```bash
apt-get install --yes systemd-resolved psmisc
systemctl enable --now systemd-resolved.service
systemctl restart systemd-resolved.service
resolvectl dns <INTERFACE> <DNS_SERVER_IP>
```

--------------------------------

### Example: Disable Zeroconf for ProFTPD

Source: https://docs.openmediavault.org/en/8.x/administration/general/network.html

A complete example showing how to disable Zeroconf for the ProFTPD service and apply the changes.

```bash
# omv-env set -- OMV_PROFTPD_ZEROCONF_ENABLED no
# omv-salt stage run prepare
# omv-salt deploy run avahi
```

--------------------------------

### Example: Customize Postfix Main Configuration

Source: https://docs.openmediavault.org/en/8.x/various/advset.html

This is a concrete example of appending a line to the Postfix main configuration file (`/etc/postfix/main.cf`) using SaltStack's `file.append` state.

```yaml
customize_postfix_main:
  file.append:
    - name: "/etc/postfix/main.cf"
    - text: |
        mynetworks = 127.0.0.0/8 168.100.189.0/28

```

--------------------------------

### Example Route Manifest

Source: https://docs.openmediavault.org/en/8.x/development/plugins.html

An example of a route manifest file, demonstrating how to define a URL, title, notification title, and the associated component for a web interface page.

```yaml
version: "1.0"
type: route
data:
  url: "/services/clamav/onaccess-scans/create"
  title: _("Create")
  notificationTitle: _("Created on-access scan.")
  component: omv-services-clamav-onaccess-scan-form-page

```

--------------------------------

### Samba Share Configuration Example

Source: https://docs.openmediavault.org/en/8.x/administration/services/samba.html

An example of a default share configuration for 'MyDocuments'. This defines access controls, browsing, and file permissions for the share.

```ini
[MyDocuments]
path = /media//dev/disk/by-label/VOLUME1/Documents/
guest ok = no
read only = no
browseable = yes
inherit acls = yes
inherit permissions = no
ea support = no
store dos attributes = no
printable = no
create mask = 0755
force create mode = 0644
directory mask = 0755
force directory mode = 0755
hide dot files = yes
valid users = "john"
invalid users =
read list =
write list = "john"

```

--------------------------------

### Troubleshoot GRUB Installation Error

Source: https://docs.openmediavault.org/en/8.x/installation/via_iso.html

This sequence of commands is used to manually install GRUB when the automated installer fails. It involves chrooting into the target system, installing GRUB to the correct device, and updating the GRUB configuration.

```bash
# Chroot.
chroot /target
# Replace [a-z] with the drive you want to install grub to.
# This is normally the drive you've selected to install OpenMediaVault on.
grub-install /dev/sd[a-z]
# Update GRUB.
update-grub
# Exit chroot.
exit
# Exit shell.
exit
```

--------------------------------

### Configure Database Nodes

Source: https://docs.openmediavault.org/en/8.x/development/tools/helper_functions.html

Example usage of configuration helper functions within a plugin post-installation script to add nodes and keys to the OMV database.

```bash
omv_config_add_node "/config/services" "${SERVICE_XPATH_NAME}"
omv_config_add_key "${SERVICE_XPATH}" "enable" "0"
omv_config_add_key "${SERVICE_XPATH}" "name" "MiniDLNA Server on OpenMediaVault"
omv_config_add_key "${SERVICE_XPATH}" "port" "8200"
omv_config_add_key "${SERVICE_XPATH}" "strict" "0"
omv_config_add_key "${SERVICE_XPATH}" "tivo" "0"
omv_config_add_key "${SERVICE_XPATH}" "rootcontainer" "."
omv_config_add_node "${SERVICE_XPATH}" "shares"
omv_config_add_key "${SERVICE_XPATH}" "loglevel" "error"
omv_config_add_key "${SERVICE_XPATH}" "extraoptions" ""
```

--------------------------------

### Dashboard Widget Manifest Example

Source: https://docs.openmediavault.org/en/8.x/development/plugins.html

Example of a dashboard widget manifest file for displaying CPU usage with a gauge chart.

```yaml
version: "1.0"
type: dashboard-widget
data:
  id: 9984d6cc-741b-4fda-85bf-fc6471a61e97
  permissions:
    role:
      - admin
  title: _("CPU Usage")
  type: chart
  chart:
    type: gauge
    min: 0
    max: 100
    displayValue: true
    request:
      service: System
      method: getInformation
    label:
      formatter: template
      formatterConfig: "{{ value | tofixed(1) }}%"
    dataConfig:
      - label: Usage
        prop: cpuUsage
        backgroundColor: "#4cd964"

```

--------------------------------

### Get All Configured Environment Variables

Source: https://docs.openmediavault.org/en/8.x/various/advset.html

This command retrieves all currently configured environment variables. It's useful for auditing or understanding the current setup.

```bash
# omv-env get

```

--------------------------------

### Navigation Item Manifest Example

Source: https://docs.openmediavault.org/en/8.x/development/plugins.html

Example of a navigation item manifest file for adding a new menu entry to the left-side navigation bar.

```yaml
version: "1.0"
type: navigation-item
data:
  path: "services.clamav.onaccess-scans"
  text: _("On Access Scans")
  position: 20
  icon: "mdi:file-eye"
  url: "/services/clamav/onaccess-scans"

```

--------------------------------

### Log File Manifest Example

Source: https://docs.openmediavault.org/en/8.x/development/plugins.html

Example of a log manifest file for integrating custom log files into the web interface, defining columns and data retrieval.

```yaml
version: "1.0"
type: log
data:
  id: clamav
  text: _("Antivirus")
  columns:
  - name: _("Date & Time")
    sortable: true
    prop: ts
    cellTemplateName: localeDateTime
    flexGrow: 1
  - name: _("Message")
    sortable: true
    prop: message
    flexGrow: 2
  request:
    service: LogFile
    method: getList
    params:
      id: clamav

```

--------------------------------

### Component Manifest Example

Source: https://docs.openmediavault.org/en/8.x/development/plugins.html

Example of a component manifest file for a form page, defining its name, type, configuration, fields, and buttons.

```yaml
version: "1.0"
type: component
data:
  name: omv-services-clamav-onaccess-scan-form-page
  type: formPage
  config:
    request:
      service: ClamAV
      get:
        method: getOnAccessPath
        params:
          uuid: "{{ _routeParams.uuid }}"
      post:
        method: setOnAccessPath
    fields:
      - type: confObjUuid
      - type: checkbox
        name: enable
        label: _("Enabled")
        value: false
      - type: sharedFolderSelect
        name: sharedfolderref
        label: _("Shared folder")
        hint: _("The location of the files to scan on-access.")
        validators:
          required: true
    buttons:
      - template: submit
        execute:
          type: url
          url: "/services/clamav/onaccess-scans"
      - template: cancel
        execute:
          type: url
          url: "/services/clamav/onaccess-scans"

```

--------------------------------

### Example Filesystem Mount Entry

Source: https://docs.openmediavault.org/en/8.x/various/fs_env_vars.html

This XML snippet represents a single filesystem entry in the configuration file. It includes details like UUID, device path, mount point, type, and mount options.

```xml
<mntent>
  <uuid>f767ee54-eb3a-44c5-b159-1840a289c84b</uuid>
  <fsname>/dev/disk/by-label/VOLUME1</fsname>
  <dir>/srv/dev-disk-by-label-VOLUME1</dir>
  <type>ext4</type>
  <opts>defaults,nofail,user_xattr,noexec,usrjquota=aquota.user,grpjquota=aquota.group,jqfmt=vfsv0,acl</opts>
  <freq>0</freq>
  <passno>2</passno>
  <hidden>0</hidden>
</mntent>
```

--------------------------------

### CSV User Import Example

Source: https://docs.openmediavault.org/en/8.x/administration/users.html

Example CSV data format for importing multiple users in bulk. Fields include name, UID, tags, email, password, shell, groups, and account modification status.

```csv
# <name>;<uid>;<tags>;<email>;<password>;<shell>;<group,group,...>;<disallowusermod>
user1;1001;user1;user1@myserver.com;password1;/bin/bash;sudo;1
user2;1002;user2;user2@my.com;password2;/bin/sh;;0
user3;1003;user3;user3@example.com;password3;/bin/false;;1
user4;1004;user4;user4@test.com;password4;;;1

```

--------------------------------

### RFC 4716 Public Key Example

Source: https://docs.openmediavault.org/en/8.x/administration/services/ssh.html

Example of a public key formatted in the RFC 4716 standard.

```text
---- BEGIN SSH2 PUBLIC KEY ----
Comment: "iPhone user1"
AAAAB3NzaC1yc2EAAAADAQABAAABAQDfSQulxffUktx2P6EikkjVxDw0tT8nCW8LHLx/kl
8t37xFQ5/OoL9m6rVzYy5CFGYt+l7DffWjL0Av7AqaM0ykZVmv2VEM6TmMo56LTlmyZdlz
X5+GEJgCQNtDxcIYAVuPXKpLtlB/uAGzwHdZWpAen+mHgWIi4va8N5QNn4rXpkREcvM1q4
snyAi+gyjAS2Dn4pm8zzrd9qQFnoRYzidbp5e2Rs3brOkwUco0ZkOME2Ff6SpLGaXz4DHH
qgdTqZwHaTXEwm6kDmglCQrauIPI/ggNqz9mVEspYkskR2PM4CAty8RkZD4MQe5K3EMAFR
aFobBSlhQ3ESCYWNXTS3bF
---- END SSH2 PUBLIC KEY ----
```

--------------------------------

### NFS Export Configuration

Source: https://docs.openmediavault.org/en/8.x/administration/services/nfs.html

Example entries for the /etc/exports file, including standard shares and the NFSv4 pseudo file system.

```text
/export/Shared_1 (fsid=1,rw,subtree_check,secure,root_squash)
/export/Videos 10.10.0.0/24 (fsid=2,rw,subtree_check,secure,nroot_squash)
/export (ro,fsid=0,root_squash,no_subtree_check,hide)
```

--------------------------------

### RSync Daemon Server Addresses

Source: https://docs.openmediavault.org/en/8.x/administration/services/rsync.html

Examples of how to specify remote RSync daemon server addresses for client jobs.

```shell
rsync://10.10.10.12/ModuleName
username@10.10.10.12::ModuleName
rsync://username@10.10.10.12:873/ModuleName
```

--------------------------------

### Standard Control Structures in PHP

Source: https://docs.openmediavault.org/en/8.x/development/coding_guideline.html

Examples of common control structures including for, switch, if-else, and foreach loops. These follow standard PHP syntax.

```php
for (i = 0; i < 10; i++) {
    if (foo(i)) {
        bar();
    }
}

switch (x) {
case 'a':
    ...
    break;
case "b":
    ...
    break;
default:
    ...
    break;
}

if (a) {
    foo();
} else {
    bar();
}

if (TRUE === $result)
    break;

foreach ($output as $outputk => $outputv) {
    foo();
}
```

--------------------------------

### Doxygen Documentation Comment for PHP Method

Source: https://docs.openmediavault.org/en/8.x/development/coding_guideline.html

Use Doxygen syntax for documentation comments. This example shows a method documentation block with return type and description.

```php
/**
 * Get the filesystem label.
 * @return string The filesystem label, otherwise FALSE.
 */
public function getLabel() {
    ...
}
```

--------------------------------

### Get RAID Creation Candidates with omv-rpc and jq

Source: https://docs.openmediavault.org/en/8.x/development/tools/omv_rpc.html

This command retrieves potential block devices for RAID creation. The output is piped to `jq` for pretty-printing the JSON response. Requires 'admin' user privileges.

```bash
# omv-rpc -u admin 'RaidMgmt' 'getCandidates' | jq
```

--------------------------------

### PHP Method Naming Convention

Source: https://docs.openmediavault.org/en/8.x/development/coding_guideline.html

Functions and methods must use camel case syntax. This example demonstrates the convention for method names.

```php
public function getGecos() {
...}

public function getHomeDirectory() {
...}
```

--------------------------------

### Example Output of Shared Folder Path Retrieval

Source: https://docs.openmediavault.org/en/8.x/administration/storage/sharedfolders.html

This is the expected output when successfully retrieving the full path of a shared folder using the `omv_get_sharedfolder_path` helper function.

```shell
$ /srv/dev-disk-by-label-VOLUME1/data_general/videos

```

--------------------------------

### Dirtymodules.json Example for Samba Changes

Source: https://docs.openmediavault.org/en/8.x/development/howitworks.html

This JSON file lists modules that need reconfiguration after database changes, specifically indicating that Samba and Zeroconf modules are affected. This is generated when changes are saved via the web interface.

```json
[
    "samba",
    "zeroconf"
]
```

--------------------------------

### Assign FTP Access Privileges

Source: https://docs.openmediavault.org/en/8.x/administration/services/ftp.html

Define access permissions for directories within the FTP server. This example restricts access to 'OR omvUser' for all operations, denying others.

```apache
<Directory /Videos>
  <Limit ALL>
    AllowUser OR omvUser
    DenyAll
  </Limit>
  <Limit READ DIRS>
    AllowUser OR omvUser
    DenyAll
  </Limit>
</Directory>

```

--------------------------------

### Run 'deploy' Stage

Source: https://docs.openmediavault.org/en/8.x/development/tools/omv_salt.html

Execute the 'deploy' stage, which includes preparing the system and deploying service configurations.

```bash
# omv-salt stage run deploy

```

--------------------------------

### Populate openmediavault Database

Source: https://docs.openmediavault.org/en/8.x/installation/on_debian.html

Populates the openmediavault configuration database with existing system settings, such as network configuration.

```bash
omv-confdbadm populate

```

--------------------------------

### Apply Configuration Changes

Source: https://docs.openmediavault.org/en/8.x/various/advset.html

After making custom configuration changes, these commands are necessary to restart the openmediavault engine and apply the new settings through SaltStack.

```bash
# monit restart omv-engined
# omv-salt stage run prepare
# omv-salt stage run deploy

```

--------------------------------

### List Available Stages

Source: https://docs.openmediavault.org/en/8.x/development/tools/omv_salt.html

View a list of available stages, which are collections of various deployment tasks.

```bash
# omv-salt stage list

```

--------------------------------

### Source Helper Functions

Source: https://docs.openmediavault.org/en/8.x/development/tools/helper_functions.html

Load the OpenMediaVault helper functions into the current shell session.

```bash
$ source /usr/share/openmediavault/scripts/helper-functions
```

--------------------------------

### Accessing the configuration database with nano

Source: https://docs.openmediavault.org/en/8.x/development/tools/omv_confdbadm.html

Manual editing of the configuration file is discouraged as it can lead to database corruption.

```bash
$ nano /etc/openmediavault/config.xml
```

--------------------------------

### SSH Remote Server Address

Source: https://docs.openmediavault.org/en/8.x/administration/services/rsync.html

Example of specifying a remote server address when using SSH for RSync transport.

```shell
username@10.10.0.12:/srv/dev-disk-by-label-VOLUME1/Documents
```

--------------------------------

### List All Environment Variables

Source: https://docs.openmediavault.org/en/8.x/various/advset.html

Use this command to retrieve a list of all available environment variables within the openmediavault system.

```bash
# omv-env list

```

--------------------------------

### Add OpenMediaVault Package Repositories

Source: https://docs.openmediavault.org/en/8.x/installation/on_debian.html

Appends the OpenMediaVault package repository configuration to the apt sources list, enabling the system to fetch packages from the official OpenMediaVault repositories.

```bash
cat <<EOF >> /etc/apt/sources.list.d/openmediavault.list
deb [signed-by=/usr/share/keyrings/openmediavault-archive-keyring.gpg] http://packages.openmediavault.org/public/ synchrony main
deb [signed-by=/usr/share/keyrings/openmediavault-archive-keyring.gpg] http://packages.openmediavault.io/ synchrony main
# deb [signed-by=/usr/share/keyrings/openmediavault-archive-keyring.gpg] http://downloads.sourceforge.net/project/openmediavault/packages/ synchrony main
## Uncomment the following line to add software from the proposed repository.
# deb [signed-by=/usr/share/keyrings/openmediavault-archive-keyring.gpg] http://packages.openmediavault.org/public/ synchrony-proposed main
# deb [signed-by=/usr/share/keyrings/openmediavault-archive-keyring.gpg] http://packages.openmediavault.io/ synchrony-proposed main
# deb [signed-by=/usr/share/keyrings/openmediavault-archive-keyring.gpg] http://downloads.sourceforge.net/project/openmediavault/packages/ synchrony-proposed main
## This software is not part of OpenMediaVault, but is offered by third-party
## developers as a service to OpenMediaVault users.
# deb [signed-by=/usr/share/keyrings/openmediavault-archive-keyring.gpg] http://packages.openmediavault.org/public/ synchrony partner
# deb [signed-by=/usr/share/keyrings/openmediavault-archive-keyring.gpg] http://packages.openmediavault.io/ synchrony partner
# deb [signed-by=/usr/share/keyrings/openmediavault-archive-keyring.gpg] http://downloads.sourceforge.net/project/openmediavault/packages/ synchrony partner
EOF
```

--------------------------------

### PHP Constant Naming Convention

Source: https://docs.openmediavault.org/en/8.x/development/coding_guideline.html

Constants should start with OMV_ and be all uppercase. This snippet illustrates the naming convention for constants.

```php
$OMV_DEFAULT_FILE = "/etc/default/openmediavault";
$OMV_JSONSCHEMA_SORTFIELD = '"type":["string","null"]';
```

--------------------------------

### Deploy fstab with omv-salt

Source: https://docs.openmediavault.org/en/8.x/administration/storage/filesystems.html

This command is used to write filesystem entries to `/etc/fstab` based on the configuration in `config.xml`. Entries managed by OpenMediaVault are identifiable by specific tags.

```bash
omv-salt deploy run fstab
```

--------------------------------

### List Available Deployment States

Source: https://docs.openmediavault.org/en/8.x/development/tools/omv_salt.html

Use this command to view all available deployment states for services.

```bash
# omv-salt deploy list

```

--------------------------------

### PHP Variable Naming Convention

Source: https://docs.openmediavault.org/en/8.x/development/coding_guideline.html

Variables must use camel case syntax. This example shows the naming convention for variables.

```php
$fsName
$outputFileName
```

--------------------------------

### Block Comments for Code Documentation

Source: https://docs.openmediavault.org/en/8.x/development/coding_guideline.html

Block comments can be used for documenting code sections. This example shows a block comment followed by a foreach loop.

```php
// Parse output:
// shadow:x:42:openmediavault
// snmp:x:112:
// sambashare:x:113:
// openmediavault:x:999:
// nut:x:114:
foreach ($output as $outputv) {
    ...
}
```

--------------------------------

### Run Deployment with Dirty States Appended

Source: https://docs.openmediavault.org/en/8.x/development/tools/omv_salt.html

Deploy all states, including any that are marked as dirty (saved in UI but not yet applied).

```bash
# omv-salt deploy run --append-dirty

```

--------------------------------

### Deploy Custom SaltStack Service Configuration

Source: https://docs.openmediavault.org/en/8.x/various/advset.html

After defining custom SaltStack states, use this command to deploy the configuration changes for a specific service. Replace `<SERVICE_NAME>` with the target service.

```bash
# omv-salt deploy run <SERVICE_NAME>

```

--------------------------------

### Get Specific Environment Variable Value

Source: https://docs.openmediavault.org/en/8.x/various/advset.html

Retrieve the value of a particular environment variable by specifying its name. Replace `<VARIABLE_NAME>` with the actual variable you need.

```bash
# omv-env get <VARIABLE_NAME>

```

--------------------------------

### Configure Loadcpufreq Service

Source: https://docs.openmediavault.org/en/8.x/administration/general/powermanagement.html

Enables the loadcpufreq service via the default configuration file.

```bash
ENABLE="true"
```

--------------------------------

### List Supported Service Discovery Variables

Source: https://docs.openmediavault.org/en/8.x/administration/general/network.html

Command to retrieve a list of environment variables supported for controlling service advertisement via Zeroconf/mDNS.

```bash

```

--------------------------------

### Deploy smartmontools Configuration

Source: https://docs.openmediavault.org/en/8.x/administration/storage/disks.html

Applies smartmontools configuration changes to the system. This command is necessary after manually editing configuration files.

```bash
$ omv-salt deploy run smartmontools

```

--------------------------------

### RPC Request to Get Samba Settings

Source: https://docs.openmediavault.org/en/8.x/development/howitworks.html

This JSON payload is sent to omv-engined to retrieve the current Samba service settings. It specifies the service and the method to be called.

```json
{
   "service":"SMB",
   "method":"getSettings",
   "params":null,
   "options":null
}
```

--------------------------------

### Run Deployment for Specific States

Source: https://docs.openmediavault.org/en/8.x/development/tools/omv_salt.html

Execute the deployment of one or more specified states. Replace <NAMES> with the actual state names.

```bash
# omv-salt deploy run <NAMES>...

```

```bash
# omv-salt deploy run avahi monit systemd

```

--------------------------------

### Editing Configuration File for Mount Options

Source: https://docs.openmediavault.org/en/8.x/various/fs_env_vars.html

This command opens the OpenMediaVault configuration file in the nano editor. It is used to manually change filesystem mount options by editing the <opts> line within <mntent> entries.

```shell
# nano /etc/openmediavault/config.xml
```

--------------------------------

### RPC Request to Get Samba Share List

Source: https://docs.openmediavault.org/en/8.x/development/howitworks.html

This JSON payload is used to request a list of Samba shares. It includes parameters for pagination and sorting, allowing for efficient retrieval of share information.

```json
{
   "service":"SMB",
   "method":"getShareList",
   "params":{
      "start":0,
      "limit":25,
      "sortfield":"sharedfoldername",
      "sortdir":"ASC"
   },
   "options":null
}
```

--------------------------------

### Multiline Function Parameters in PHP

Source: https://docs.openmediavault.org/en/8.x/development/coding_guideline.html

Functions with many parameters should be split across lines to adhere to the 80-character limit. Subsequent parameters are indented with one tab. This example shows how to format multiline parameters.

```php
throw new OMVException(OMVErrorMsg::E_EXEC_FAILED,
    $cmd, implode("\n", $output));

$dispatcher->notify(($data['uuid'] == $GLOBALS['OMV_UUID_UNDEFINED']) ?
    OMV_NOTIFY_CREATE : OMV_NOTIFY_MODIFY,
    "org.openmediavault.system.storage.hdparm", $object);
```

--------------------------------

### Inspect mntent entry in config.xml

Source: https://docs.openmediavault.org/en/8.x/administration/storage/filesystems.html

This XML structure represents a mounted filesystem entry in OpenMediaVault's configuration file. It contains essential details like UUID, device path, mount directory, filesystem type, and options.

```xml
<mntent>
        <uuid>f767ee54-eb3a-44c5-b159-1840a289c84b</uuid>
        <fsname>/dev/disk/by-label/VOLUME1</fsname>
        <dir>/srv/dev-disk-by-label-VOLUME1</dir>
        <type>ext4</type>
        <opts>defaults,nofail,user_xattr,aquota.user,grpjquota=aquota.group,jqfmt=vfsv0,acl</opts>
        <freq>0</freq>
        <passno>2</passno>
        <hidden>0</hidden>
</mntent>
```

--------------------------------

### Restarting a Systemd Unit for Plugin Debugging

Source: https://docs.openmediavault.org/en/8.x/troubleshooting.html

Execute a faulty systemd unit file manually to get more verbose output for debugging plugin errors. This can help identify issues caused by 'Option' parameters.

```bash
systemd restart <plug-in-daemon>
```

--------------------------------

### Enumerate Mounted Filesystems with omv-rpc

Source: https://docs.openmediavault.org/en/8.x/development/tools/omv_rpc.html

Use this command to retrieve a list of all mounted filesystems, including the root filesystem. Ensure you have the 'admin' user privileges.

```bash
# omv-rpc -u admin 'FileSystemMgmt' 'enumerateMountedFilesystems' '{"includeroot": true}'
```

--------------------------------

### Reading database values

Source: https://docs.openmediavault.org/en/8.x/development/tools/omv_confdbadm.html

Retrieve configuration data using a specific datamodel path.

```bash
# omv-confdbadm read --prettify conf.system.filesystem.mountpoint
```

--------------------------------

### Deploy Network Configuration

Source: https://docs.openmediavault.org/en/8.x/installation/on_debian.html

Re-deploys the network configuration using the services managed by openmediavault, specifically systemd-networkd. This step is necessary after populating the database.

```bash
omv-salt deploy run systemd-networkd

```

--------------------------------

### List environment variables

Source: https://docs.openmediavault.org/en/8.x/administration/general/network.html

Displays the current value of the ZEROCONF_ENABLED environment variable.

```bash
# omv-env list | grep ZEROCONF_ENABLED
```

--------------------------------

### Append Text to Configuration File using SaltStack

Source: https://docs.openmediavault.org/en/8.x/various/advset.html

This YAML snippet demonstrates how to use the `file.append` state in SaltStack to add lines to an existing configuration file. Ensure the `<PATH_OF_THE_FILE>` is correct.

```yaml
<UNIQUE_IDENTIFIER>:
  file.append:
    - name: "<PATH_OF_THE_FILE>"
    - text: |
        <LINE1>
        <LINE2>
        <...>

```
Tokens:
Raw